Lists disciplines.
GET
v1/disciplines
Lists disciplines used in the system. Currently, disciplines used in Revit are included. 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/disciplines |
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 discipline IDs split by comma. With this query parameter, you can get the specified disciplines in an array. |
Response
HTTP Status Code Summary
200 OK | Successful retrieval of the disciplines. |
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 discipline ID. |
name string | The discipline name. |
Example
Successful retrieval of the disciplines (200).
Request
curl -v 'https://developer.api.autodesk.com/parameters/v1/disciplines'
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
Response
{
"pagination": {
"offset": 0,
"limit": 50,
"totalResults": 8
},
"results": [
{
"typeId": "autodesk.spec.discipline:architecture-1.0.0",
"name": "Architecture"
},
{
"typeId": "autodesk.spec.discipline:electrical-1.0.0",
"name": "Electrical"
},
{
"typeId": "autodesk.spec.discipline:energy-1.0.0",
"name": "Energy"
},
{
"typeId": "autodesk.spec.discipline:hvac-1.0.0",
"name": "HVAC"
},
{
"typeId": "autodesk.spec.discipline:infrastructure-1.0.0",
"name": "Infrastructure"
},
{
"typeId": "autodesk.spec.discipline:piping-1.0.0",
"name": "Piping"
},
{
"typeId": "autodesk.spec.discipline:structural-1.0.0",
"name": "Structural"
},
{
"typeId": "autodesk.spec:discipline-1.0.0",
"name": "Common"
}
]
}
Show More