Create Outputs
POST
outputs
Create Outputs of a Variant.
Resource Information
Method and URI | POST https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/outputs |
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
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
Request
Body Structure
Expand all
variantId* string: UUID | The unique identifier of Variant. |
onComplete object |
|
verb* enum:string | The HTTP verb to use for the callback.
Possible values: POST , PUT , PATCH , GET |
url* string | The URL to send the callback to. |
onProgress object |
|
verb* enum:string | The HTTP verb to use for the callback.
Possible values: POST , PUT , PATCH , GET |
url* string | The URL to send the callback to. |
outputs* | The array of Outputs payload. |
anyOf* | The array of Outputs payload. |
0* array | The array of Inventor Outputs payload. |
oneOf* array:oneOf | |
Inventor RFA Output* object | |
type* enum:string | Defines this Output definition to be of RFA type. Will always be: RFA |
settings* object | |
representation* string | The representation for this Output. |
version enum:string | The application version for this Output.
Possible values: 2024 , 2025 , 2026 |
Inventor BOM Output* object | |
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. |
Inventor INV Output* object | |
type* enum:string | Defines this Output definition to be of INV type. Will always be: INV |
settings* object | |
Inventor DWG Output* object | |
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. |
Inventor Thumbnail Output* object | |
type* enum:string | Defines this Output definition to be of THUMBNAIL type. Will always be: THUMBNAIL |
settings* object | |
representation* string | The representation for this Output. |
Inventor GLB Output* object | |
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. |
Inventor STL Output* object | |
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. |
Inventor STEP Output* object | |
type* enum:string | Defines this Output definition to be of STEP type. Will always be: STEP |
settings* object | |
representation* string | The representation for this Output. |
Inventor PDF Output* object | |
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. |
Inventor IDW Output* object | |
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. |
Inventor SAT Output* object | |
type* enum:string | Defines this Output definition to be of SAT type. Will always be: SAT |
settings* object | |
representation* string | The representation for this Output. |
Inventor SVF Output* object | |
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. |
Inventor DWG3D Output* object | |
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. |
Inventor BCD Output* object | |
type* enum:string | Will always be: BCD |
settings* object | |
representation* string | The representation for this Output. |
1* array | The array of Fusion Outputs payload. |
oneOf* array:oneOf | |
Fusion RFA Output* object | |
type* enum:string | Defines this Output definition to be of RFA type. Will always be: RFA |
settings* object | |
version* enum:string | The application version for this Output.
Possible values: 2024 , 2025 , 2026 |
Fusion BCD Output* object | |
type* enum:string | Defines this Output definition to be of BCD type. Will always be: BCD |
settings* object | |
Fusion SAT Output* object | |
type* enum:string | Defines this Output definition to be of SAT type. Will always be: SAT |
settings* object | |
Fusion STEP Output* object | |
type* enum:string | Defines this Output definition to be of STEP type. Will always be: STEP |
settings* object | |
Fusion Thumbnail Output* object | |
type* enum:string | Defines this Output definition to be of THUMBNAIL type. Will always be: THUMBNAIL |
settings* object | |
Fusion F3D Output* object | |
type* enum:string | Defines this Output definition to be of F3D type. Will always be: F3D |
settings* object |
* Required
Response
HTTP Status Code Summary
201 Created | The request succeeded. An Outputs Request was created and an asynchronous process to generate Outputs was started. |
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 (201)
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. |
releaseId string: UUID | The unique identifier of Release. |
outputsRequestId string: UUID | The unique identifier of Outputs Request. |
logFile string | The URL to log file. |
status enum:string | The status of the Outputs Request.
Possible values: PENDING , SUCCESS , FAILED |
outputs | |
anyOf | |
0 array | The array of Inventor Outputs. |
oneOf array:oneOf | |
Inventor RFA Output object | |
type enum:string | Defines this Output definition to be of RFA type. Will always be: RFA |
settings 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. |
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. |
Inventor BCD Output object | |
type enum:string | Defines this Output definition to be of BCD type. Will always be: BCD |
settings 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. |
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. |
Inventor BOM Output object | |
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. |
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. |
Inventor INV Output object | |
type enum:string | Defines this Output definition to be of INV type. Will always be: INV |
settings 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. |
Inventor DWG Output object | |
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. |
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. |
Inventor Thumbnail Output object | |
type enum:string | Defines this Output definition to be of THUMBNAIL type. Will always be: THUMBNAIL |
settings object | |
representation string | The representation for this Output. |
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. |
Inventor GLB Output object | |
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. |
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. |
Inventor STL Output object | |
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. |
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. |
Inventor STEP Output object | |
type enum:string | Defines this Output definition to be of STEP type. Will always be: STEP |
settings object | |
representation string | The representation for this Output. |
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. |
Inventor PDF Output object | |
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. |
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. |
Inventor IDW Output object | |
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. |
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. |
Inventor SAT Output object | |
type enum:string | Defines this Output definition to be of SAT type. Will always be: SAT |
settings object | |
representation string | The representation for this Output. |
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. |
Inventor SVF Output object | |
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. |
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. |
Inventor DWG3D Output object | |
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. |
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. |
1 array | The array of Fusion Outputs. |
oneOf array:oneOf | |
Fusion RFA Output object | |
type enum:string | Defines this Output definition to be of RFA type. Will always be: RFA |
settings 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. |
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. |
Fusion BCD Output object | |
type enum:string | Defines this Output definition to be of BCD type. Will always be: BCD |
settings object | |
category string | The category to be set on generated Revit family. |
family string | The name for the generated Revit family. |
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. |
Fusion SAT Output object | |
type enum:string | Defines this Output definition to be of SAT type. Will always be: SAT |
settings 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. |
Fusion STEP Output object | |
type enum:string | Defines this Output definition to be of STEP type. Will always be: STEP |
settings 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. |
Fusion Thumbnail Output object | |
type enum:string | Defines this Output definition to be of THUMBNAIL type. Will always be: THUMBNAIL |
settings 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. |
Fusion F3D Output object | |
type enum:string | Defines this Output definition to be of F3D type. Will always be: F3D |
settings 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. |
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. |
Example
The request succeeded. An Outputs Request was created and an asynchronous process to generate Outputs was started.
Request
curl -v 'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/outputs?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 '{
"variantId": "",
"onComplete": {
"verb": "POST",
"url": ""
},
"onProgress": {
"verb": "POST",
"url": ""
},
"outputs": {}
}'
Show More
Response
{
"accessType": "ACC",
"accessId": "",
"productId": "",
"releaseId": "",
"outputsRequestId": "",
"logFile": "",
"status": "PENDING",
"outputs": {},
"createdAt": "",
"updatedAt": ""
}
Show More