Lists parameters in a parameter collection.
GET
v1/accounts/{accountId}/groups/{groupId}/collections/{collectionId}/parameters
Lists parameters in a parameter collection.
Resource Information
Method and URI | GET 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 Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token>, where <token> is obtained via a three-legged OAuth flow. |
Region string | The region the account’s data is provisioned in. Currently supports US and EMEA . 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
Query String Parameters
offset int | Offset from the start of the collection to the first entry in the page. Zero based. |
limit int | Determines the maximum number of objects that MAY be returned. A query MAY return fewer than the value of limit due to filtering or other reasons. |
ids string | The parameter IDs split by comma. With this query parameter, you can get the specified parameters in an array. |
Response
HTTP Status Code Summary
200 OK | Successful retrieval of the parameters within the designated collection. |
400 Bad Request | The request could not be understood by the server due to malformed syntax. |
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
Body Structure (200)
Expand all
id string | The parameter ID. |
name string | The parameter name. |
description string | The parameter description. |
specId string | The parameter spec ID. See the field guide about the definition of spec.” |
valueTypeId string | The identifier of the storage value type, which could be a primitive type ID, such as Bool, Int64, Float64, String, DateTime, URI, Date, or a complex type ID. |
readOnly boolean | Indicates if the parameter is read-only or not in the application. |
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.
Example
Successful retrieval of the 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/e284ed9a-df49-4d4f-80bc-cd4de91db4cb/parameters' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 50,
"offset": 0,
"totalResults": 1
},
"results": [
{
"id": "parameters.009777bbe1e5457798000789677e4616:a3ec4719e06743ef8e2f62228c631b17-1.0.0",
"name": "Hidden2",
"readOnly": false,
"description": null,
"specId": "autodesk.spec.aec:length-2.0.0",
"metadata": [
{
"id": "isArchived",
"value": false
},
{
"id": "isHidden",
"value": false
},
{
"id": "labelIds",
"value": [
"ACRD-00685-EFPT-41973"
]
},
{
"id": "instanceTypeAssociation",
"value": "NONE"
},
{
"id": "categories",
"value": [
{
"bindingId": "ACFT-94206-BGDE-78534",
"typeId": "autodesk.revit.category.family:abutmentFoundations-1.0.0"
}
]
},
{
"id": "group",
"value": null
}
],
"createdBy": "JFGVKSJ7FF9M",
"createdAt": "2022-06-28T01:50:43.000Z"
}
]
}
Show More