Specs
GET
projects/{projectId}/specs
Retrieve all the spec sections for the specified project. For information about spec sections, see the Help documentation.
Note that this endpoint is not compatible with BIM 360 projects.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/submittals/v2/projects/:projectId/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. |
* Required
Request
URI Parameters
projectId string: UUID | The ID of the project.
Use the Data Management API to retrieve the project ID. For more information, see the Retrieve a Project ID tutorial. You need to convert the project ID into a project ID for the ACC API by removing the “b." prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7. |
Request
Query String Parameters
limit int | The number of results to return per page in the response payload. Possible values: 1 - 50 . Default value: 20 . For example, to limit the response to two results per page, use limit=2 . |
offset int | The page number from which you want to begin results; for example, offset=20 . For more details, see the JSON API Paging documentation. |
search string | Search for spec sections by querying a specified string within specific fields (identifier , title ), and retrieve the associated items that match the search criteria. This includes spec sections where the string matches part of a field. For example, search=1. |
sort string | Sort spec sections by specified fields. Separate multiple values with commas. To sort in descending or ascending order, add desc or asc after the sort criteria. For example, identifier asc .
Possible values: identifier , title . |
filter[identifier] string | Filter spec sections with the specified spec section ID (the spec section ID in the UI). You can specify multiple values. Separate multiple values with commas. For example, filter[identifier]=2. |
Response
HTTP Status Code Summary
200 OK | Successful retrieval of spec sections |
403 Forbidden | Unauthorized |
Response
Body Structure (200)
Expand all
pagination object | Pagination information. |
limit int | The maximum number of results to be displayed on each page. |
offset int | The number of results to skip before starting to display results on a page. |
totalResults int | The overall count of results available across all pages. |
previousUrl string | The URL to retrieve the preceding page of results, if applicable. Not returned on the first page of results. |
nextUrl string | The URL to retrieve the subsequent page of results, if available. If not included, this is the last page of data. |
results array: object | The list of spec sections. |
id string: UUID | The internal, globally unique identifier (UUID) for the spec section. |
title string | The title of the spec section. |
identifier string | The unique ID assigned to the spec section within the user interface (UI). |
createdBy string | The Autodesk ID of the user who created the spec section. |
createdAt datetime: ISO 8601 | The time and date when the spec section was created. |
updatedBy string | The Autodesk ID of the user who last updated the spec section. |
updatedAt datetime: ISO 8601 | The time and date when spec section was last updated. |
Example
Successful retrieval of spec sections
Request
curl -v 'https://developer.api.autodesk.com/construction/submittals/v2/projects/9eae7d59-1469-4389-bfb2-4114e2ba5545/specs' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 10,
"offset": 100,
"totalResults": 25,
"previousUrl": "https://developer.api.autodesk.com/construction/submittals/v2/projects/9eae7d59-1469-4389-bfb2-4114e2ba5545/settings/mappings?offset=10&limit=100",
"nextUrl": null
},
"results": [
{
"id": "e6111f96-8437-491e-a1ae-16fd53f0cbef",
"title": "Materials",
"identifier": "500",
"createdBy": "WD43ZJGKDFLFH",
"createdAt": "2018-02-01T12:09:24.198466Z",
"updatedBy": "WD43ZJGKDFLFH",
"updatedAt": "2018-02-01T12:09:24.198466Z"
}
]
}
Show More