Get Output
GET
outputs/{outputId}
Returns the details of an Output of a Variant. The Output is specified by the client provided outputId URI parameter.
Resource Information
| Method and URI | GET https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/outputs/{outputId} |
| 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
| outputId string: UUID | The unique identifier of Output. |
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 Output 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
| oneOf one of | |
| RFA Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of RFA type. Will always be: RFA |
| settings | |
| anyOf | |
| 0 object | |
| representation string | The representation for this Output. |
| version enum:string | The application version for this Output.
Possible values: 2024, 2025, 2026 |
| category string | The category to be set on generated Revit family. |
| family string | The name for the generated Revit family. |
| 1 object | |
| version enum:string | The application version for this Output.
Possible values: 2024, 2025, 2026 |
| category string | The category to be set on generated Revit family. |
| family string | The name for the generated Revit family. |
| BCD Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of BCD type. Will always be: BCD |
| settings | |
| anyOf | |
| 0 object | |
| representation string | The representation for this Output. |
| category string | The category to be set on generated Revit family. |
| family string | The name for the generated Revit family. |
| 1 object | |
| category string | The category to be set on generated Revit family. |
| family string | The name for the generated Revit family. |
| BOM Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of BOM type. Will always be: BOM |
| settings object | |
| representation string | The representation for this Output. |
| INV Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of INV type. Will always be: INV |
| settings object | |
| DWG Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of DWG type. Will always be: DWG |
| settings object | |
| templatePath string | The relative path to Drawing Template File. |
| Thumbnail Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of THUMBNAIL type. Will always be: THUMBNAIL |
| settings | |
| anyOf | |
| 0 object | |
| representation string | The representation for this Output. |
| 1 object | |
| GLB Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of GLB type. Will always be: GLB |
| settings object | |
| representation string | The representation for this Output. |
| STL Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of STL type. Will always be: STL |
| settings object | |
| representation string | The representation for this Output. |
| STEP Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of STEP type. Will always be: STEP |
| settings | |
| anyOf | |
| 0 object | |
| representation string | The representation for this Output. |
| 1 object | |
| PDF Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of PDF type. Will always be: PDF |
| settings object | |
| templatePath string | The relative path to Drawing Template File. |
| IDW Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of IDW type. Will always be: IDW |
| settings object | |
| templatePath string | The relative path to Drawing Template File. |
| SAT Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of SAT type. Will always be: SAT |
| settings | |
| anyOf | |
| 0 object | |
| representation string | The representation for this Output. |
| 1 object | |
| SVF Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of SVF type. Will always be: SVF |
| settings object | |
| representation string | The representation for this Output. |
| DWG3D Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of DWG3D type. Will always be: DWG3D |
| settings object | |
| representation string | The representation for this Output. |
| F3D Output object | |
| 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. |
| id string: UUID | The unique identifier of Output. |
| variantId string: UUID | The unique identifier of Variant. |
| status enum:string | The status of the Output.
Possible values: PENDING, SUCCESS, FAILED |
| 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. |
| type enum:string | Defines this Output definition to be of F3D type. Will always be: F3D |
| settings object |
Example
The Output was retrieved successfully.
Request
curl -v 'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/outputs/12345678-1234-1234-1234-1234567890ab?accessType=ACC&accessId=12345678-1234-1234-1234-1234567890ab|urn:adsk.wipstg:fs.folder:co.ObAD7BpLXdKZiXK_OSJBow' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"accessType": "ACC",
"accessId": "",
"id": "",
"variantId": "",
"status": "PENDING",
"createdAt": "",
"updatedAt": "",
"type": "RFA",
"settings": {}
}
Show More
