Updates parameters.
PATCH
v1/accounts/{accountId}/groups/{groupId}/collections/{collectionId}/parameters
Updates a list of parameters (maximum amount per request is 10) with the given properties, including description and the metadata with isHidden, revitCategoryBindingIds, instanceTypeAssociation and labelIds.
Resource Information
| Method and URI | PATCH https://developer.api.autodesk.com/parameters/v1/accounts/{accountId}/groups/{groupId}/collections/{collectionId}/parameters |
| Authentication Context | user context required |
| Required OAuth Scopes | data:read data:write |
| Data Format | JSON |
Note: Data will be updated according to the JSON Merge Patch protocol.
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 |
| Region string | The region the account’s data is provisioned in. Currently supports US, EMEA, and AUS. Default is US. |
* Required
Request
URI Parameters
| accountId string: UUID or string: b.UUID | The Autodesk Construction Cloud account ID. |
| groupId string | The group ID. Currently, only one group is supported, and group id is equal to account id. (Supporting multiple groups is considered for future enhancement) |
| collectionId string | The collection ID. |
Request
Body Structure
Object:Array
Expand all
| id* string | The parameter ID. |
| description string | The parameter description. The length of the parameter description is limited to 250 characters. |
| metadata array: object | The parameter metadata. It may vary from one product to another. For example, to support the use of a parameter in Revit, the metadata object might record category bindings and an instance/type assignment. |
| id string | The metadata ID. It could be isHidden, isArchived, instanceTypeAssociation, labelIds, categoryBindingIds, groupBindingId. |
| value one of | The metadata value. |
| 0 boolean | When the ID is
isHidden, this value indicates if the parameter is hidden or not in the application.When the ID is
isArchived, this value indicates if the parameter is archived or not. |
| 1 string | When the ID is
instanceTypeAssociation, the value is an enumerated string value to indicate if the parameter is associated with element instances, element types, or neither.Possible values:
NONE, INSTANCE, TYPEWhen the ID is
groupBindingId, the value is the group Binding ID, which can be looked up in the results of the GET /classifications/groups?filter[bindable]=true API. |
| 2 array: string | When the ID is
categoryBindingIds, the value is the category Binding IDs, which can be looked up in the results of the GET /classifications/categories?filter[bindable]=true API.When the ID is
labelIds, the value is the label IDs, which can be looked up in the results of the GET /accounts/:accountId/labels API. |
* Required
Response
HTTP Status Code Summary
| 200 OK | Successfully updated the given parameters. |
| 207 Partial Success | Successfully updated some parameters, with errors for some parameters in the batch. |
| 400 Bad Request | The request could not be understood by the server due to malformed syntax. This may occur when parameter validation fails, such as when the parameter name is too long or contains prohibited symbols. The response should include what validation rule was violated. |
| 401 Unauthorized | Request has not been applied because it lacks valid authentication credentials for the target resource. |
| 403 Forbidden | The server understood the request but refuses to authorize it. |
| 404 Not Found | The resource cannot be found. |
| 406 Not Acceptable | The server cannot produce a response matching the list of acceptable values defined in the request. |
| 410 | Access to the target resource is no longer available. |
| 429 Too Many Requests | User has sent too many requests in a given amount of time. |
| 500 Internal Server Error | An unexpected error occurred on the server. |
| 503 Service Unavailable | Server is not ready to handle the request. |
Response
Successfully Updated Parameters (200)
Body Structure (200)
Expand all
| results array: object | |
| id string | The parameter ID. |
| description string | The parameter description. The length of the parameter description is limited to 250 characters. |
| metadata array: object | The parameter metadata. It may vary from one product to another.
For example, to support the use of a parameter in Revit, the metadata object might record category bindings and an instance/type assignment.
|
| anyOf | |
| 0 object | An object with a string ID and a Boolean value. The ID could be one of the below:
“isHidden” to indicate if the parameter is hidden or not in the application.
“isArchived” to indicate if the parameter is archived or not.
|
| id string | The metadata ID. |
| value boolean | Boolean value of the metadata. |
| 1 object | An object with a string ID and an enumerated string value.
The ID could be “instanceTypeAssociation” to indicate if the parameter is associated with element instances, element types, or neither.
Possible values: NONE, INSTANCE, TYPE |
| id string | The metadata ID. |
| value string | The metadata value. |
| 2 object | An object with a string ID and a string array value. The ID could be “labelIds” to list all the labels attached to this parameter. |
| id string | The metadata ID. |
| value array: string | The metadata value. |
| 3 object | An object with a string ID and an object value. The ID could be “group” to indicate the group for this parameter. |
| id string | The metadata ID. |
| value object | The metadata value. |
| bindingId string | The binding ID of the group, which can be looked up in the results of the GET /classifications/groups API. |
| id string | The group ID, which can be looked up in the results of the GET /classifications/groups API. |
| 4 object | An object with a string ID and an object value. The ID could be “categories” to indicate the categories of this parameter. |
| id string | The metadata ID. |
| value array: object | The metadata value. |
| bindingId string | The category binding ID, which can be looked up in the results of the GET /classifications/categories API. |
| id string | The category ID, which can be looked up in the results of the GET /classifications/categories API. |
| 5 object | An object with a string ID and a string value. The ID could be “specCategoryId” to indicate the spec category ID of this family type parameter. |
| id string | The metadata ID. |
| value string | The metadata value. |
| createdBy string | User that created the parameter. |
| createdAt string | A Time ISO 8601 Timestamp in UTC Timezone indicating when the parameter was created. |
Note: Responses may include pimPropBehavior and pimPropDMBehavior for each parameter. This is for internal use only.
Partial Success Updating Parameters (207)
Body Structure (207)
Expand all
| results array: object | |
| id string | The parameter ID. |
| description string | The parameter description. The length of the parameter description is limited to 250 characters. |
| metadata array: object | The parameter metadata. It may vary from one product to another.
For example, to support the use of a parameter in Revit, the metadata object might record category bindings and an instance/type assignment.
|
| anyOf | |
| 0 object | An object with a string ID and a Boolean value. The ID could be one of the below:
“isHidden” to indicate if the parameter is hidden or not in the application.
“isArchived” to indicate if the parameter is archived or not.
|
| id string | The metadata ID. |
| value boolean | Boolean value of the metadata. |
| 1 object | An object with a string ID and an enumerated string value.
The ID could be “instanceTypeAssociation” to indicate if the parameter is associated with element instances, element types, or neither.
Possible values: NONE, INSTANCE, TYPE |
| id string | The metadata ID. |
| value string | The metadata value. |
| 2 object | An object with a string ID and a string array value. The ID could be “labelIds” to list all the labels attached to this parameter. |
| id string | The metadata ID. |
| value array: string | The metadata value. |
| 3 object | An object with a string ID and an object value. The ID could be “group” to indicate the group for this parameter. |
| id string | The metadata ID. |
| value object | The metadata value. |
| bindingId string | The binding ID of the group, which can be looked up in the results of the GET /classifications/groups API. |
| id string | The group ID, which can be looked up in the results of the GET /classifications/groups API. |
| 4 object | An object with a string ID and an object value. The ID could be “categories” to indicate the categories of this parameter. |
| id string | The metadata ID. |
| value array: object | The metadata value. |
| bindingId string | The category binding ID, which can be looked up in the results of the GET /classifications/categories API. |
| id string | The category ID, which can be looked up in the results of the GET /classifications/categories API. |
| 5 object | An object with a string ID and a string value. The ID could be “specCategoryId” to indicate the spec category ID of this family type parameter. |
| id string | The metadata ID. |
| value string | The metadata value. |
| createdBy string | User that created the parameter. |
| createdAt string | A TimeISO 8601 Timestamp in UTC Timezone indicating when the parameter was created. |
| errors array: object | |
| id string | The resource ID. |
| title string | The error title. |
| detail string | The error detail. |
| code string | The error code. |
Note: Responses may include pimPropBehavior and pimPropDMBehavior for each parameter. This is for internal use only.
Example
Successfully Updated Parameters (200).
Request
curl -v 'https://developer.api.autodesk.com/parameters/v1/accounts/009777bb-e1e5-4577-9800-0789677e4616/groups/009777bb-e1e5-4577-9800-0789677e4616/collections/a9974bd0-546d-4cba-a434-cdea5fb70bf8/parameters' \
-X 'PATCH' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '[
{
"id": "parameters.009777bbe1e5457798000789677e4616:9fa3644ac1984fca987fe1d5dc701120-1.0.0",
"description": "The width of a window",
"metadata": [
{
"id": "instanceTypeAssociation",
"value": "INSTANCE"
},
{
"id": "labelIds",
"value": [
"ACVA-80318-CKKJ-05645"
]
},
{
"id": "categoryBindingIds",
"value": [
"ACFV-53198-BRVZ-83753"
]
}
]
},
{
"id": "parameters.009777bbe1e5457798000789677e4616:885621e67e7f4e49b9754b657ea476dc-1.0.0",
"description": "the length of an entire window when several are combined",
"metadata": [
{
"id": "isHidden",
"value": true
}
]
}
]'
Show More
Response
{
"results": [
{
"id": "parameters.009777bbe1e5457798000789677e4616:9fa3644ac1984fca987fe1d5dc701120-1.0.0",
"name": "window width",
"description": "The width of a window",
"specId": "autodesk.spec.aec:length-2.0.0",
"readOnly": false,
"metadata": [
{
"id": "isHidden",
"value": false
},
{
"id": "isArchived",
"value": false
},
{
"id": "instanceTypeAssociation",
"value": "INSTANCE"
},
{
"id": "categories",
"value": [
{
"bindingId": "ACFV-53198-BRVZ-83753",
"id": "autodesk.revit.category.family:abutmentFoundations-1.0.0"
}
]
},
{
"id": "labelIds",
"value": [
"ACVA-80318-CKKJ-05645"
]
},
{
"id": "group",
"value": null
},
{
"id": "pimPropBehavior",
"value": null
},
{
"id": "pimPropDMBehavior",
"value": null
}
],
"createdBy": "200809200167579",
"createdAt": "2022-10-18T17:16:05+0000"
},
{
"id": "parameters.009777bbe1e5457798000789677e4616:885621e67e7f4e49b9754b657ea476dc-1.0.0",
"name": "window length",
"description": "the length of an entire window when several are combined",
"specId": "autodesk.spec.aec:length-2.0.0",
"readOnly": false,
"metadata": [
{
"id": "isHidden",
"value": true
},
{
"id": "isArchived",
"value": false
},
{
"id": "instanceTypeAssociation",
"value": "INSTANCE"
},
{
"id": "categories",
"value": [
{
"bindingId": "ACFV-53198-BRVZ-83753",
"id": "autodesk.revit.category.family:windows-1.0.0"
}
]
},
{
"id": "labelIds",
"value": [
"ACVA-80318-CKKJ-05645"
]
},
{
"id": "group",
"value": null
},
{
"id": "pimPropBehavior",
"value": null
},
{
"id": "pimPropDMBehavior",
"value": null
}
],
"createdBy": "200809200167579",
"createdAt": "2022-10-18T17:16:05+0000"
}
]
}
Show More
Partial Success Updating Parameters (207).
Request
curl -v 'https://developer.api.autodesk.com/parameters/v1/accounts/009777bb-e1e5-4577-9800-0789677e4616/groups/009777bb-e1e5-4577-9800-0789677e4616/collections/a9974bd0-546d-4cba-a434-cdea5fb70bf8/parameters' \
-X 'PATCH' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '[
{
"id": "parameters.009777bbe1e5457798000789677e4616:9fa3644ac1984fca987fe1d5dc701120-1.0.0",
"description": "The width of a window",
"metadata": [
{
"id": "instanceTypeAssociation",
"value": "INSTANCE"
},
{
"id": "labelIds",
"value": [
"ACVA-80318-CKKJ-05645"
]
},
{
"id": "categoryBindingIds",
"value": [
"ACFV-53198-BRVZ-83753"
]
}
]
},
{
"id": "parameters.009777bbe1e5457798000789677e4616:885621e67e7f4e49b9754b657ea476dc-1.0.0",
"description": "the length of an entire window when several are combined",
"metadata": [
{
"id": "isHidden",
"value": true
}
]
}
]'
Show More
Response
{
"results": [
{
"id": "parameters.3141915a7869420d80958d16d4756946:00016da1684048688663e3cbf876bfea-1.0.0",
"name": "S Video_shw",
"description": "good one",
"specId": "autodesk.spec:spec.int64-2.0.0",
"readOnly": false,
"metadata": [
{
"id": "isHidden",
"value": true
},
{
"id": "isArchived",
"value": true
},
{
"id": "instanceTypeAssociation",
"value": "NONE"
},
{
"id": "categories",
"value": [
{
"bindingId": "ACFT-94206-BGDE-78534",
"id": "autodesk.revit.category.family:abutmentFoundations-1.0.0"
}
]
},
{
"id": "labelIds",
"value": [
"ACYF-88321-BMDM-59319"
]
},
{
"id": "group",
"value": null
},
{
"id": "pimPropBehavior",
"value": "TIMELESS"
},
{
"id": "pimPropDMBehavior",
"value": null
}
],
"createdBy": "VW9JXYURN8WQKYYU",
"createdAt": "2022-12-12T16:19:25+0000"
}
],
"errors": [
{
"id": "parameters.3141915a7869420d80958d16d4756946:00016da1684048688663e3cbf876bfec-1.0.0",
"code": "PARAMETER-NOT-FOUND",
"title": "Parameter not found",
"detail": "The parameter with the given ID does not exist"
}
]
}
Show More
