List parameter collections in the given group
GET
v1/accounts/{accountId}/groups/{groupId}/collections
Lists all parameter collections in the specified group.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/parameters/v1/accounts/{accountId}/groups/{groupId}/collections |
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). |
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. |
Response
HTTP Status Code Summary
200 OK | Successful retrieval of all parameter collections within a group. |
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. If the account is not yet activated there will be a “Account is not activated” message. See Step-by-Step tutorials for how to activate your account |
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
pagination object | The information for paginating records returned by the endpoint. |
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. |
totalResults int | The total number of results that match the query irrespective of limit. |
nextUrl string | Link that will return the next page of data. If not included, this is the last page of data. |
results array: object | |
id string | ID of the collection. It must contain only alphanumeric characters, underscores, or dots (.) and must have a length of at least 2 characters and no more than 64 characters. |
title string | A human-friendly collection title. |
description string | A short description of the collection. |
group object | The details of the group that owns this collection. |
id string | Identifier of the group. It must contain only alphanumeric characters or underscores and must have a length of at least 2 characters and no more than 64 characters. |
account object | The details of the account that owns this collection. |
id string | Identifier of the account. |
createdBy string | User that created the collection. |
createdAt string | A Time ISO 8601 Timestamp in UTC Timezone, indicating when the collection was created. |
updatedBy string | User that last modified the details of the collection. |
updatedAt string | A Time ISO 8601 Timestamp in UTC Timezone, indicating when the collection was modified most recently. |
Example
Successful retrieval of all parameter collections within a group (200).
Request
curl -v 'https://developer.api.autodesk.com/parameters/v1/accounts/009777bb-e1e5-4577-9800-0789677e4616/groups/009777bb-e1e5-4577-9800-0789677e4616/collections' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"offset": 0,
"limit": 20,
"totalResults": 1
},
"results": [
{
"id": "36416b47-4478-4c58-9a13-a924169a9813",
"title": "A Test Collection",
"description": "A Collection for testing parameter management",
"group": {"id": "009777bb-e1e5-4577-9800-0789677e4616" },
"account": {"id": "009777bb-e1e5-4577-9800-0789677e4616" },
"createdBy": "KK7SLSD6ZBFP",
"createdAt": "2023-07-10T18:11:15+0000",
"updatedBy": "KK7SLSD6ZBFP",
"updatedAt": "2023-07-10T18:11:15+0000"
}
]
}
Show More