Get Release
GET
releases/{releaseId}
Returns the details of a Release. The Release is specified by the client provided releaseId URI parameter.
Resource Information
| Method and URI | GET https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/releases/{releaseId} |
| 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. |
* Required
Request
URI Parameters
| releaseId string: UUID | The unique identifier of Release. |
Request
Query String Parameters
| accessType* enum:string | The type of integration or service used to determine access context.
Possible values: ACC, BIM360, FUSION, CONTENTCATALOG, BRIDGE, PUBLIC |
| accessId* string | A composite string of identifiers that define the access scope for the given access type. |
* Required
Response
HTTP Status Code Summary
| 200 OK | The Release 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. |
| 404 Not Found | The requested resource could not be found on the server. Review the request and try 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)
Expand all
| accessType enum:string | The type of integration or service used to determine access context.
Possible values: ACC, BIM360, FUSION, CONTENTCATALOG, BRIDGE, PUBLIC |
| 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. |
| id string: UUID | The unique identifier of Release. |
| number int | The Release number. |
| state enum:string | The Release state.
Possible values: ACTIVE, INACTIVE, OBSOLETE |
| isConfigurable boolean |
|
| dataSetLocation string | The objectKey for data set. |
| notes string | The Release notes for this Dynamic Content Definition.
Max length: 500 |
| rules string | The objectKey for rules. |
| layout string | The objectKey for layout. |
| parameters array | The list of parameters. |
| oneOf array:oneOf | |
| Boolean input object | Boolean input type. |
| name string | The unique name for an input parameter. |
| isInput boolean |
|
| type enum:string | Defines this input parameter to be of boolean type. Will always be: BOOLEAN |
| defaultValue boolean |
|
| Text input object | Text input type. |
| name string | The unique name for an input parameter. |
| isInput boolean |
|
| type enum:string | Defines this input parameter to be of text type. Will always be: TEXT |
| defaultValue string | A text value. |
| allowCustomValue boolean |
|
| Numeric input object | Numeric input type. |
| name string | The unique name for an input parameter. |
| isInput boolean |
|
| type enum:string | Defines this input parameter to be of numeric type. Will always be: NUMERIC |
| defaultValue number | A default numeric value. |
| unit string | The unit of this input parameter. |
| allowCustomValue boolean |
|
| createdAt datetime: ISO 8601 | The timestamp(ISO 8601) when the resource was created. |
| updatedAt datetime: ISO 8601 | The timestamp(ISO 8601) when the resource was last updated. |
| authoringAppVersion | The version of the Authoring app. |
| anyOf | The version of the Authoring app. |
| 0 enum:string | The version of the Inventor app.
Possible values: 2024, 2025, 2026 |
| 1 string | The version of the Fusion app. |
| sourceContext | The source context for this Release. |
| anyOf | The source context for this Release. |
| 0 object | The Inventor source context for this Release. |
| project string | The relative path to project file. |
| baseModel string | The relative path to base model. |
| 1 object | The Fusion source context for this Release. |
| name string | The name of the Fusion project. |
| thumbnails | The list of thumbnails for this Release. |
| anyOf | The list of thumbnails for this Release. |
| 0 array: object | The list of Inventor thumbnails. |
| representation string | The representation of the thumbnail. |
| thumbnail string | The objectKey for thumbnail. |
| 1 array: object | The list of Fusion thumbnails. |
| thumbnail string | The objectKey for thumbnail. |
| outputSettings | The list of Output settings for this Release. |
| anyOf | The list of Output settings for this Release. |
| 0 array | The list of Output settings. |
| oneOf array:oneOf | |
| Inventor RFA Output object | The definition for available options for RFA Outputs. |
| type enum:string | Defines this Output definition to be of RFA type. Will always be: RFA |
| representations array: string | The available representations for this Output. |
| category string | The category to be set on generated Revit family. |
| family string | The name for the generated Revit family. |
| Inventor BCD Output object | The definition for available options for BCD Outputs. |
| type enum:string | Defines this Output definition to be of BCD type. Will always be: BCD |
| representations array: string | The available representations for this Output. |
| category string | The category to be set on generated Revit family. |
| family string | The name for the generated Revit family. |
| Inventor BOM Output object | The definition for available options for BOM Outputs. |
| type enum:string | Defines this Output definition to be of BOM type. Will always be: BOM |
| representations array: string | The available representations for this Output. |
| Inventor INV Output object | The definition for available options for INV Outputs. |
| type enum:string | Defines this Output definition to be of INV type. Will always be: INV |
| Inventor DWG Output object | The definition for available options for DWG Outputs. |
| type enum:string | Defines this output definition to be of DWG type Will always be: DWG |
| templatePaths array: string | The relative path to drawing template files |
| Inventor Thumbnail Output object | The definition for available options for THUMBNAIL Outputs. |
| type enum:string | Defines this Output definition to be of THUMBNAIL type. Will always be: THUMBNAIL |
| representations array: string | The available representations for this Output. |
| Inventor GLB Output object | The definition for available options for GLB Outputs. |
| type enum:string | Defines this Output definition to be of GLB type. Will always be: GLB |
| representations array: string | The available representations for this Output. |
| Inventor STL Output object | The definition for available options for STL Outputs. |
| type enum:string | Defines this Output definition to be of STL type. Will always be: STL |
| representations array: string | The available representations for this Output. |
| Inventor STEP Output object | The definition for available options for STEP Outputs. |
| type enum:string | Defines this Output definition to be of STEP type. Will always be: STEP |
| representations array: string | The available representations for this Output. |
| Inventor PDF Output object | The definition for available options for PDF Outputs. |
| type enum:string | Defines this output definition to be of PDF type Will always be: PDF |
| templatePaths array: string | The relative path to drawing template files |
| Inventor IDW Output object | The definition for available options for IDW Outputs. |
| type enum:string | Defines this output definition to be of IDW type Will always be: IDW |
| templatePaths array: string | The relative path to drawing template files |
| Inventor SAT Output object | The definition for available options for SAT Outputs. |
| type enum:string | Defines this Output definition to be of SAT type. Will always be: SAT |
| representations array: string | The available representations for this Output. |
| Inventor SVF Output object | The definition for available options for SVF Outputs. |
| type enum:string | Defines this Output definition to be of SVF type. Will always be: SVF |
| representations array: string | The available representations for this Output. |
| Inventor DWG3D Output object | The definition for available options for DWG3D Outputs. |
| type enum:string | Defines this Output definition to be of DWG3D type. Will always be: DWG3D |
| representations array: string | The available representations for this Output. |
| 1 array | The list of Output settings. |
| oneOf array:oneOf | |
| Fusion RFA Output object | The definition for available options for RFA Outputs. |
| type enum:string | Defines this Output definition to be of RFA type. Will always be: RFA |
| category string | The category to be set on generated Revit family. |
| family string | The name for the generated Revit family. |
| Fusion BCD Output object | The definition for available options for BCD Outputs. |
| type enum:string | Defines this Output definition to be of BCD type. Will always be: BCD |
| category string | The category to be set on generated Revit family. |
| family string | The name for the generated Revit family. |
| Fusion Thumbnail Output object | The definition for available options for THUMBNAIL Outputs. |
| type enum:string | Defines this Output definition to be of THUMBNAIL type. Will always be: THUMBNAIL |
| Fusion STEP Output object | The definition for available options for STEP Outputs. |
| type enum:string | Defines this Output definition to be of STEP type. Will always be: STEP |
| Fusion SAT Output object | The definition for available options for SAT Outputs. |
| type enum:string | Defines this Output definition to be of SAT type. Will always be: SAT |
| Fusion F3D Output object | The definition for available options for F3D Outputs. |
| type enum:string | Defines this Output definition to be of F3D type. Will always be: F3D |
Example
The Release was retrieved successfully.
Request
curl -v 'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/releases/efa26924-2f08-4e35-b14d-456601d6dfc0?accessType=ACC&accessId=12345678-1234-1234-1234-1234567890ab|urn:adsk.wipstg:fs.folder:co.ObAD7BpLXdKZiXK_OSJBow' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"accessType": "ACC",
"accessId": "",
"productId": "",
"id": "",
"number": "",
"state": "ACTIVE",
"isConfigurable": "",
"dataSetLocation": "",
"notes": "",
"rules": "",
"layout": "",
"parameters": [
{
"name": "",
"isInput": "",
"type": "BOOLEAN",
"defaultValue": ""
}
],
"createdAt": "",
"updatedAt": "",
"authoringAppVersion": {},
"sourceContext": {},
"thumbnails": {},
"outputSettings": {}
}
Show More
