Adds parameters to a parameter collection.
POST
v1/accounts/{accountId}/groups/{groupId}/collections/{collectionId}/parameters:batch-share
Adds the parameters specified in the request body to the parameter collection identified in the request path. The parameters can then be discovered by listing the parameters in the collection. The request body may identify up to fifty parameters.
Resource Information
| Method and URI | POST https://developer.api.autodesk.com/parameters/v1/accounts/{accountId}/groups/{groupId}/collections/{collectionId}/parameters:batch-share |
| Authentication Context | user context required |
| Required OAuth Scopes | data:write |
| 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 |
| 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
List of parameter identifiers
Expand all
| parameters array: object | List of parameter identifiers |
| id string | Parameter identifier |
Response
HTTP Status Code Summary
| 201 Created | Response indicating success for a adding all of the parameters to the designated collection. |
| 207 | Response indicating partial success for adding parameters to 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 (201)
Expand all
| results array: object | List of parameters for which the operation was successful |
| id string | Parameter identifier |
Response
Body Structure (207)
Expand all
| results array: object | List of parameters for which the operation was successful |
| id string | Parameter identifier |
| errors array: object | List of parameters for which the operation was not successful. |
| id string | The resource ID. |
| title string | The error title. |
| detail string | The error detail. |
| code string | The error code. |
Example
Successfully associated parameters with the given collection (201).
Request
curl -v 'https://developer.api.autodesk.com/parameters/v1/accounts/009777bb-e1e5-4577-9800-0789677e4616/groups/009777bb-e1e5-4577-9800-0789677e4616/collections/34379084-e8fb-49e1-ae18-fb8a8625698f/parameters:batch-share' \
-X 'POST' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '{
"parameters": [
{
"id": "parameters.d05ec054ef8046ad9c80fc742f29027c:000ccf6716504165b73d20739f7dc1bf-1.0.0"
},
{
"id": "parameters.d05ec054ef8046ad9c80fc742f29027c:43d641e6cb594e8688cad2ca38ed6c95-1.0.0"
},
{
"id": "parameters.d05ec054ef8046ad9c80fc742f29027c:8d2dd2df37b84b80bf2defaff4598891-1.0.0"
}
]
}'
Show More
Response
{
"results": [
{
"id": "parameters.d05ec054ef8046ad9c80fc742f29027c:000ccf6716504165b73d20739f7dc1bf-1.0.0"
},
{
"id": "parameters.d05ec054ef8046ad9c80fc742f29027c:43d641e6cb594e8688cad2ca38ed6c95-1.0.0"
},
{
"id": "parameters.d05ec054ef8046ad9c80fc742f29027c:8d2dd2df37b84b80bf2defaff4598891-1.0.0"
}
]
}
Show More
