Task 2 - Create a Release
Key learnings
By the end of this task, you will be able to:
- Upload a dataset
- Create a Release
- Retrieve the created Release
The operations used in this task are as follows:
| Operation | HTTP Request | Description |
|---|---|---|
| Get Upload Urls | POST /products/{productId}/upload-urls | Create urls for upload. |
| Complete Upload | POST /products/{productId}/complete-upload | Marks the upload as complete. |
| Create a Release | POST /releases | Create a release with the uploaded dataset. |
| Get a Release | GET /releases/{releaseId} | Retrieve the release that was created. |
Step 1: Upload dataset
- Determine how many chunks you need
Zip up the folder containing the model, and all files related to the model Divide the size of the dataset zip file by 100MB to determine how many chunks you need to upload.
- Get upload URLs based on the number of chunks
Request
curl -L -X POST 'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/products/{{PRODUCT_ID}}/upload-urls?accessType={{ACCESS_TYPE}}&accessId={{ACCESS_ID}}' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
-d '{
"fileName": "Wall Release - April 2025.zip",
"parts": 3
}'
Response
- Split data into chunks and Upload each chunk to each upload url
For this walkthrough, we have three chunks to upload (three upload URLs in the response).
- Complete Upload
Request
curl -L -X POST 'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/products/{{PRODUCT_ID}}/complete-upload?accessType={{ACCESS_TYPE}}&accessId={{ACCESS_ID}}' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
-d '{
"objectKey": "{{OBJECTKEY_FROM_POST_UPLOADURL_RESPONSE}}",
"uploadKey": "{{UPLOAD_KEY_FROM_POST_UPLOADURL_RESPONSE}}",
"fileName": "Wall Release - April 2025.zip",
"fileSize": 300000000,
}'
Show More
Response
Step 2: Create Release
Now that we have uploaded the dataset, we can create a Release.
Request
curl -L -X POST 'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/releases?accessType={{ACCESS_TYPE}}&accessId={{ACCESS_ID}}' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
-d '{
"productId": "{{PRODUCT_ID}}",
"authoringAppVersion": "2025",
"dataSetLocation": "{{OBJECTKEY_DATASET_LOCATION}}",
"isConfigurable": true,
"sourceContext": {
"project": "\\Wall.ipj",
"baseModel": "Wall - 2025\\Wall Assembly.iam"
},
"parameters": [
{
"name": "Height",
"type": "NUMERIC",
"defaultValue": 96,
"unit": "in",
"isInput": true,
"allowCustomValue": true
},
{
"name": "Width",
"type": "NUMERIC",
"defaultValue": 18,
"unit": "in",
"isInput": true,
"allowCustomValue": true
},
],
"notes": "Wall Release - April 2025",
"thumbnails": [
{
"representation": "[Primary]",
"thumbnail": "{{OBJECTKEY_THUMBNAIL}}"
}
],
"rules": "{{OBJECTKEY_RULES}}",
"outputSettings": [
{
"type": "BOM",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "GLB",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "INV"
},
{
"type": "PDF",
"templatePaths": [
"Wall - 2025\\Wall.dwg"
]
},
{
"type": "SAT",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "STEP",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "THUMBNAIL",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "DWG",
"templatePaths": [
"Wall - 2025\\Wall.dwg"
]
},
{
"type": "RFA",
"family": "Wall-100",
"category": "Generic Models",
"representations": [
"[Primary]",
"Medium"
]
}
]
}'
Show More
Response
Returns a JSON response with status 201
{
"accessId": "{{ACCESS_ID}}",
"accessType": "{{ACCESS_TYPE}}",
"productId": "{{PRODUCT_ID}}",
"id": "{{RELEASE_ID}}",
"number": 2,
"authoringAppVersion": "2025",
"state": "ACTIVE",
"dataSetLocation": "<Objectkey of Dataset Location>",
"isConfigurable": true,
"sourceContext": {
"project": "\\Wall.ipj",
"baseModel": "Wall - 2025\\Wall Assembly.iam"
},
"parameters": [
{
"name": "Height",
"type": "NUMERIC",
"defaultValue": 96,
"unit": "in",
"isInput": true,
"allowCustomValue": true
},
{
"name": "Width",
"type": "NUMERIC",
"defaultValue": 18,
"unit": "in",
"isInput": true,
"allowCustomValue": true
}
],
"notes": "Wall Release - April 2025",
"thumbnails": [
{
"representation": "[Primary]",
"thumbnail": "<Objcetkey of thumbnail>"
}
],
"rules": "<Objectkey of rules>",
"layout": null,
"createdAt": "2025-04-24T17:08:58.028Z",
"updatedAt": "2025-04-24T17:08:58.028Z",
"outputSettings": [
{
"type": "BOM",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "GLB",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "INV"
},
{
"type": "PDF",
"templatePaths": [
"Wall - 2025\\Wall.dwg"
]
},
{
"type": "SAT",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "STEP",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "THUMBNAIL",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "DWG",
"templatePaths": [
"Wall - 2025\\Wall.dwg"
]
},
{
"type": "RFA",
"representations": [
"[Primary]",
"Medium"
],
"category": "Generic Models",
"family": "Wall-100"
}
]
}
Show More
Step 3: Retrieve created Release
Request
curl -L -X GET 'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/releases/{{RELEASE_ID}}?accessType={{ACCESS_TYPE}}&accessId={{ACCESS_ID}}' \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'
Response
Returns a JSON response with status 200 if found
{
"accessId": "{{ACCESS_ID}}",
"accessType": "{{ACCESS_TYPE}}",
"productId": "{{PRODUCT_ID}}",
"id": "{{RELEASE_ID}}",
"number": 2,
"authoringAppVersion": "2025",
"state": "ACTIVE",
"dataSetLocation": "<Objectkey of Dataset Location>",
"isConfigurable": true,
"sourceContext": {
"project": "\\Wall.ipj",
"baseModel": "Wall - 2025\\Wall Assembly.iam"
},
"parameters": [
{
"name": "Height",
"type": "NUMERIC",
"defaultValue": 96,
"unit": "in",
"isInput": true,
"allowCustomValue": true
},
{
"name": "Width",
"type": "NUMERIC",
"defaultValue": 18,
"unit": "in",
"isInput": true,
"allowCustomValue": true
}
...
],
"notes": "Wall Release - April 2025",
"thumbnails": [
{
"representation": "[Primary]",
"thumbnail": "<Objcetkey of thumbnail>"
}
],
"rules": "{{OBJECTKEY_RULES}}",
"layout": null,
"createdAt": "2024-12-01T07:09:55.181Z",
"updatedAt": "2024-12-01T07:09:55.181Z",
"outputSettings": [
{
"type": "BOM",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "GLB",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "INV"
},
{
"type": "PDF",
"templatePaths": [
"Wall - 2025\\Wall.dwg"
]
},
{
"type": "SAT",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "STEP",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "THUMBNAIL",
"representations": [
"[Primary]",
"Medium"
]
},
{
"type": "DWG",
"templatePaths": [
"Wall - 2025\\Wall.dwg"
]
},
{
"type": "RFA",
"representations": [
"[Primary]",
"Medium"
],
"category": "Generic Models",
"family": "Wall-100"
}
]
}
Show More