projects/{projectId}/responses
Retrieves all the responses for the specified project. For more information about submittal item responses, see the Help documentation.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/submittals/v2/projects/:projectId/responses |
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. |
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. |
Response
HTTP Status Code Summary
200 OK | A list of responses for the specified project. |
401 Unauthorized | Invalid Authorization header. Verify and try again. |
403 Forbidden | The user is not authorized to perform this action. |
404 Not Found | The specified resource was not found. |
500 Internal Server Error | An unexpected error occurred on the server while processing the request. |
Response
Body Structure (200)
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 all responses for the specified project. |
id string: UUID | The internal, globally unique identifier (UUID) for the response. |
key string | Not relevant |
value string | The content of the response. |
platformId string | Not relevant |
isActive boolean | true : if the response was not deleted.
|
categoryId string | The type of response. Possible values: 1 (Approved), 2 (Revise and submit), 3 (Rejected). |
isApproval boolean | true : settings this response for a submittal item means an approval.
This attribute is taken from the related categoryId |
isInUse boolean | true : if the response is currently associated with a submittal item.
|
createdBy string | The Autodesk ID of the user who created the response. |
createdAt datetime: ISO 8601 | The time and date when the response was created. |
updatedAt datetime: ISO 8601 | The time and date when the response was last updated. |
updatedBy string | The Autodesk ID of the user who last updated the response. |
Example
A list of responses for the specified project.
Request
curl -v 'https://developer.api.autodesk.com/construction/submittals/v2/projects/9eae7d59-1469-4389-bfb2-4114e2ba5545/responses' \
-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/responses?limit=5&offset=10",
"nextUrl": null
},
"results": [
{
"id": "5bab7f9b-61cf-45bc-8bce-f88ddd9d380e",
"key": "my response",
"value": "Approved",
"platformId": "approved",
"isActive": false,
"categoryId": "1",
"isApproval": false,
"isInUse": false,
"createdBy": "WD43ZJGKDFLFH",
"createdAt": "2018-02-01T12:09:24.198466Z",
"updatedAt": "2018-02-01T12:09:24.198466Z",
"updatedBy": "WD43ZJGKDFLFH"
}
]
}