The following objects are used in multiple endpoints within the Upload API.
Response Body
| Element | Description | Type | Notes |
|---|---|---|---|
| id | Alphanumeric ID of the uploaded file. | string | None |
| properties | List of non-system properties that can be added to supplement the system properties. | array | Not included in the response if non-system properties have not been used in the upload. |
| hasContent | True/false indicator of whether the upload includes associated content. | Boolean | An upload that does not include associated content consists only of metadata. |
| isChunked | True/false indicator or whether the upload includes file chunks. | Boolean | None |
| fileName | The name of the uploaded file. | string | None |
| mimeType | The MIME type of the uploaded file. | string | None |
| encoding | The type of encoding used for text files. | string | None |
| fileSize | The size of the uploaded file. | integer | Values are in bytes. If the size is unknown, -1 is returned. |
| isChunksCompleted | True/false indicator of whether the number of uploaded file chunks matches the total number of chunks that compose the upload. | Boolean | None |
| chunkCount | The number of file chunks that have been uploaded. | integer | None |
| chunks | List of the names of the file chunks that compose the upload. | array | None |
| chunkIndexes | List of index positions for different file chunk uploads. | array | The overall file chunk index starts at 0. |
Sample Response
{
"id": "string",
"properties": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
},
"hasContent": true,
"isChunked": true,
"fileName": "string",
"mimeType": "plain/text",
"encoding": "UTF-8",
"fileSize": 0,
"isChunksCompleted": true,
"chunkCount": 0,
"chunks": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"chunkIndexes": [
0
]
}