Mark Upload Complete
POST
products/{productId}/complete-upload
Marks a Product data set upload as complete. The Product is specified by the client provided productId URI parameter.
Resource Information
| Method and URI | POST https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/products/{productId}/complete-upload |
| Authentication Context | user context required |
| Required OAuth Scopes | data:read data:write data:create account:read |
| Data Format | JSON |
Request
Headers
| Authorization* string | Must be Bearer <token>, where <token> is obtained via a three-legged OAuth flow. |
| Content-Type* string | Must be application/json |
* Required
Request
URI Parameters
| productId string: UUID | The unique identifier of Product. |
Request
Query String Parameters
| accessType* enum:string | The type of integration or service used to determine access context.
Possible values: ACC, BIM360, FUSION, CONTENTCATALOG |
| accessId* string | A composite string of identifiers that define the access scope for the given access type. |
* Required
Request
Body Structure
| objectKey* string | Key that uniquely identifies a file uploaded through our service (retrieved when requesting upload URLs). |
| uploadKey* string | Key used to identify a specific upload process (retrieved when requesting upload URLs). |
| fileName* string | Default filename suggested to users when downloading the file. |
| fileSize* int | Size of the uploaded file in bytes (used to validate the uploaded data). |
| contentType string | Custom content type of the uploaded file. |
| disposition string | Custom content disposition of the uploaded file. |
* Required
Response
HTTP Status Code Summary
| 200 OK | The metadata for the uploaded file was retrieved successfully. |
| 400 Bad Request | The server could not process your request. It is likely due to incorrect formatting or missing information. The response body may indicate what is wrong. Please review and resubmit your request. |
| 401 Unauthorized | The supplied authorization header was invalid or the token scope was not acceptable. Verify your authentication credentials and try again. |
| 403 Forbidden | The request was valid but lacked the necessary permissions. Verify your credentials and permissions before sending the request again. |
| 429 Too Many Requests | The server has received too many requests within the allowed time window. Please wait before retrying. |
| 500 Internal Server Error | An unexpected error occurred on the server. Please try again later. |
Response
Body Structure (200)
| accessType enum:string | The type of integration or service used to determine access context.
Possible values: ACC, BIM360, FUSION, CONTENTCATALOG |
| accessId string | A composite string of identifiers that define the access scope for the given access type. |
| objectKey string | Key that uniquely identifies the uploaded file. |
| productId string: UUID | Unique identifier of the associated product. |
| contentType string | Content type of the uploaded file. |
| fileName string | Name of the uploaded file. |
| fileSize int | Size of the uploaded file in bytes. |
Example
The metadata for the uploaded file was retrieved successfully.
Request
curl -v 'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/products/efa26924-2f08-4e35-b14d-456601d6dfc0/complete-upload?accessType=ACC&accessId=12345678-1234-1234-1234-1234567890ab|urn:adsk.wipstg:fs.folder:co.ObAD7BpLXdKZiXK_OSJBow' \
-X 'POST' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '{
"objectKey": "",
"uploadKey": "",
"fileName": "",
"fileSize": "",
"contentType": "",
"disposition": ""
}'
Show More
Response
{
"accessType": "ACC",
"accessId": "",
"objectKey": "",
"productId": "",
"contentType": "",
"fileName": "",
"fileSize": ""
}
Show More
