Update Product
PATCH
products/{productId}
Updates a Dynamic Content Definition / Product specified by the client provided productId
URI parameter.
Resource Information
Method and URI | PATCH https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/products/{productId} |
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
name string | The name of the Product |
state enum:string | The state of the Product.
Possible values: AVAILABLE , ARCHIVED |
defaultRelease string: UUID | The unique identifier of Release. |
isPublic boolean |
|
publisherId string: UUID | The unique identifier of Publisher. |
classification string | The classification of the Product. |
tags array: string | The Product tags. |
Response
HTTP Status Code Summary
200 OK | The Dynamic Content Definition / Product was updated 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)
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. |
id string: UUID | The unique identifier of Product. |
name string | The name of the Product |
authoringApp enum:string | The Authoring application.
Possible values: INVENTOR , FUSION |
defaultRelease string: UUID | The unique identifier of Release. |
releaseCount number | The number of Releases for the Product. |
state enum:string | The state of the Product.
Possible values: AVAILABLE , ARCHIVED |
isPublic boolean |
|
publisherId string: UUID | The unique identifier of Publisher. |
classification string | The classification of the Product. |
tags array: string | The Product tags. |
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 Dynamic Content Definition / Product was updated successfully.
Request
curl -v 'https://developer.api.autodesk.com/industrialized-construction/informed-design/v1/products/efa26924-2f08-4e35-b14d-456601d6dfc0?accessType=ACC&accessId=12345678-1234-1234-1234-1234567890ab|urn:adsk.wipstg:fs.folder:co.ObAD7BpLXdKZiXK_OSJBow' \
-X 'PATCH' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '{
"name": "",
"state": "AVAILABLE",
"defaultRelease": "",
"isPublic": "",
"publisherId": "",
"classification": "",
"tags": [
""
]
}'
Show More
Response
{
"accessType": "ACC",
"accessId": "",
"id": "",
"name": "",
"authoringApp": "INVENTOR",
"defaultRelease": "",
"releaseCount": "",
"state": "AVAILABLE",
"isPublic": "",
"publisherId": "",
"classification": "",
"tags": [
""
],
"createdAt": "",
"updatedAt": ""
}
Show More