Gets a parameter definition.
GET
v1/parameters/{parameterId}
Gets a parameter definition. For this endpoint, The User (Authorization token) does not need access to a given ACC account.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/parameters/v1/parameters/{parameterId} |
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
parameterId string | The parameter ID. |
Response
HTTP Status Code Summary
200 OK | Successful retrieval of the parameter definition. |
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)
id string | The parameter ID. |
name string | The parameter name. |
specId string | The parameter spec ID. Look up detailed information in the response of the GET /specs API. |
readOnly boolean | Indicates if the parameter is read-only or not in the application. |
Example
Successful retrieval of the parameter definition (200).
Request
curl -v 'https://developer.api.autodesk.com/parameters/v1/parameters/parameters.a5c6d0e9593b462c8a9c022269adaf48:a3ec4719e06743ef8e2f62228c631b17-1.0.0' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"id": "parameters.a5c6d0e9593b462c8a9c022269adaf48:a3ec4719e06743ef8e2f62228c631b17-1.0.0",
"name": "window width",
"specId": "autodesk.spec.aec:length-2.0.0",
"readOnly": true
}