Get Upload URLs
POST
products/{productId}/upload-urls
Returns upload URLs to upload a file to a Product data set. 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}/upload-urls |
| 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
| fileName* string | The file name (will be encoded into the object key). |
| parts* int | Number of parts the file will be split into for upload. |
* Required
Response
HTTP Status Code Summary
| 200 OK | The URLs to upload a file to a Product data set were 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. |
| productId string: UUID | The unique identifier of Product. |
| urls array: string | Signed URLs to upload file parts to. |
| uploadKey string | Key that identifies the upload process. |
| uploadExpiration string | Expiration time of the upload process. |
| urlExpiration string | Expiration time of the signed URLs. |
| objectKey string | Key that uniquely identifies the uploaded file. |
Example
The URLs to upload a file to a Product data set were retrieved successfully.
Request
curl -v 'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/products/efa26924-2f08-4e35-b14d-456601d6dfc0/upload-urls?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 '{
"fileName": "",
"parts": ""
}'
Show More
Response
{
"accessType": "ACC",
"accessId": "",
"productId": "",
"urls": [
""
],
"uploadKey": "",
"uploadExpiration": "",
"urlExpiration": "",
"objectKey": ""
}
Show More
