Lists parameter specs.
GET
v1/specs
Lists parameter specs used in the system. Specs define data types and describe, for example, how data is stored and presented to the user. For more information about the definition of specs, please refer to the Field Guide. 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/specs |
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
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 spec IDs split by comma. With this query parameter, you can get the specified specs in an array. |
Response
HTTP Status Code Summary
200 OK | Successful retrieval of the parameter specs used in the system. |
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
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 | The parameter spec ID. |
name string | The user-facing name of the spec. |
disciplineId string | The discipline ID. Look up detailed information in the response of the GET /disciplines API. |
applicableUnitIds array: string | The identifiers of the units applicable to this spec. This field exists only for measurable specs that are associated with units of measurement, such as “Length” or “Acceleration”. It is null for non-measurable specs such as “Text” or “Yes/No”. |
storageUnitId string | The identifier of the storage unit of this spec. This field exists only for measurable specs that are associated with units of measurement, such as “Length” or “Acceleration”. It is null for non-measurable specs such as “Text” or “Yes/No”. The storage unit is the unit of measurement that quantifies values of this parameter in persistent storage. When writing parameter values, client applications must ensure that the values written are quantified according to each parameter’s storage unit. A unit conversion might be necessary if input values are quantified differently. |
valueTypeId string | The identifier of the storage value type, which could be Bool, Int64, Float64, Reference, String or a type ID. |
Example
Successful retrieval of the specs (200).
Request
curl -v 'https://developer.api.autodesk.com/parameters/v1/specs'
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
Response
{
"pagination": {
"offset": 0,
"limit": 50,
"totalResults": 161,
"nextUrl": "https://developer.api.autodesk.com/parameters/v1/specs?offset=50&limit=50"
},
"results": [
{
"id": "autodesk.spec.aec:numberOfPoles-2.0.0",
"name": "Number of Poles",
"disciplineId": "autodesk.spec.discipline:electrical-1.0.0",
"applicableUnitIds": null,
"storageUnitId": null,
"valueTypeId": "Int64"
},
{
"id": "autodesk.spec.aec:multilineText-2.0.0",
"name": "Multiline Text",
"disciplineId": "autodesk.spec:discipline-1.0.0",
"applicableUnitIds": null,
"storageUnitId": null,
"valueTypeId": "String"
},
{
"id": "autodesk.spec.aec.electrical:apparentPower-2.0.0",
"name": "Apparent Power",
"disciplineId": "autodesk.spec.discipline:electrical-1.0.0",
"applicableUnitIds": [
"autodesk.unit.unit:watts-1.0.1",
"autodesk.unit.unit:kilowatts-1.0.1",
"autodesk.unit.unit:britishThermalUnitsPerSecond-1.0.1",
"autodesk.unit.unit:britishThermalUnitsPerHour-1.0.1",
"autodesk.unit.unit:caloriesPerSecond-1.0.1",
"autodesk.unit.unit:kilocaloriesPerSecond-1.0.1",
"autodesk.unit.unit:voltAmperes-1.0.1",
"autodesk.unit.unit:kilovoltAmperes-1.0.1",
"autodesk.unit.unit:horsepower-1.0.1"
],
"storageUnitId": "autodesk.unit.unit:watts-1.0.1",
"valueTypeId": "Float64"
}
]
}
Show More