curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/files/initmultipartupload \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"externalId": "my.known.id",
"directory": "<string>",
"source": "<string>",
"mimeType": "image/jpeg",
"metadata": {},
"assetIds": [
4503599627370496
],
"dataSetId": 4503599627370496,
"sourceCreatedTime": 1730204346000,
"sourceModifiedTime": 1730204346000,
"securityCategories": [
4503599627370496
],
"labels": [
{
"externalId": "my.known.id"
}
]
}
'{
"items": [
{
"name": "<string>",
"id": 4503599627370496,
"uploaded": true,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"uploadId": "<string>",
"uploadUrls": [
"uploadURL_for_part_1",
"uploadURL_for_part_2",
"uploadURL_for_part_3"
],
"externalId": "my.known.id",
"directory": "<string>",
"source": "<string>",
"mimeType": "image/jpeg",
"metadata": {},
"assetIds": [
4503599627370496
],
"dataSetId": 4503599627370496,
"sourceCreatedTime": 1730204346000,
"sourceModifiedTime": 1730204346000,
"securityCategories": [
4503599627370496
],
"labels": [
{
"externalId": "my.known.id"
}
],
"geoLocation": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
123
]
},
"properties": {}
},
"uploadedTime": 1730204346000,
"instanceId": {
"space": "<string>",
"externalId": "<string>"
}
}
]
}curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/files/initmultipartupload \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"externalId": "my.known.id",
"directory": "<string>",
"source": "<string>",
"mimeType": "image/jpeg",
"metadata": {},
"assetIds": [
4503599627370496
],
"dataSetId": 4503599627370496,
"sourceCreatedTime": 1730204346000,
"sourceModifiedTime": 1730204346000,
"securityCategories": [
4503599627370496
],
"labels": [
{
"externalId": "my.known.id"
}
]
}
'{
"items": [
{
"name": "<string>",
"id": 4503599627370496,
"uploaded": true,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"uploadId": "<string>",
"uploadUrls": [
"uploadURL_for_part_1",
"uploadURL_for_part_2",
"uploadURL_for_part_3"
],
"externalId": "my.known.id",
"directory": "<string>",
"source": "<string>",
"mimeType": "image/jpeg",
"metadata": {},
"assetIds": [
4503599627370496
],
"dataSetId": 4503599627370496,
"sourceCreatedTime": 1730204346000,
"sourceModifiedTime": 1730204346000,
"securityCategories": [
4503599627370496
],
"labels": [
{
"externalId": "my.known.id"
}
],
"geoLocation": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
123
]
},
"properties": {}
},
"uploadedTime": 1730204346000,
"instanceId": {
"space": "<string>",
"externalId": "<string>"
}
}
]
}Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
If 'overwrite' is set to true, and the POST body content specifies a 'externalId' field, fields for the file found for externalId can be overwritten. The default setting is false.
If metadata is included in the request body, all of the original metadata will be overwritten. The actual file will be overwritten after a successful upload with the uploadUrls from the response. If there is no successful upload, the current file contents will be kept.
File-Asset mappings only change if explicitly stated in the assetIds field of the POST json body. Do not set assetIds in request body if you want to keep the current file-asset mappings.
The 'parts' parameter specifies how many uploadURLs should be returned, for uploading the file contents in parts. See main endpoint description for more details.
1 <= x <= 250Fields to be set for the file.
Name of the file.
256The external ID provided by the client. Must be unique for the resource type.
255"my.known.id"
Directory containing the file. Must be an absolute, unix-style path.
512The source of the file.
128File type. E.g. text/plain, application/pdf, ..
256"image/jpeg"
Custom, application specific metadata. String key -> String value. Limits: Maximum length of key is 128 bytes, value 10240 bytes, up to 256 key-value pairs, of total size at most 10240.
Show child attributes
1 - 1000 elementsA server-generated ID for the object.
1 <= x <= 9007199254740991The dataSet Id for the item.
1 <= x <= 9007199254740991The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The security category IDs required to access this file.
100A server-generated ID for the object.
1 <= x <= 9007199254740991A list of the labels associated with this resource item.
10Show child attributes
Geographic metadata.
Show child attributes
The response for a successful request to initiate upload of multiple parts for a file.
Show child attributes
Was this page helpful?