Comments
GET
comments
This endpoint is deprecated. We will continue supporting it until September 1, 2022. We recommend migrating to the BIM 360 API endpoints, which are compatible with ACC projects.
Retrieves all the comments associated with an RFI.
Note that this endpoint is not compatible with BIM 360 projects.
For developers who are using both BIM 360 and ACC projects, we recommend using the BIM 360 RFIs API, which supports both BIM 360 and ACC projects.
Note that we do not currently support ACC RFI attachments.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/rfis/v2/projects/:projectId/rfis/:rfiId/comments |
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. |
x-ads-region string | The region to which your request should be routed. If not set, the request is routed automatically but may incur a small latency increase. Possible values: US , EMEA . |
* Required
Request
URI Parameters
projectId string | The ID of the project. |
rfiId string | The ID of the RFI. |
Request
Query String Parameters
limit int | The maximum number of comments to return in the response payload. Acceptable values: 1-200. Default value: 10. For example, to limit the response to two comments per page, use limit=2 |
offset int | The page number that you want to begin comment results from. For example, to begin the results from page three, use offset=3 |
sort array: string | The fields to sort the list by. For example, sort=createdAt . |
fields array: string | Specify which attributes you want to see in the response. Separate multiple values with commas. For example, fields=title,description . |
filter[createdAt] string | Retrieves comments created between a date range, in the following format: filter[createdAt]=YYYY-MM-DDThh:mm:ssZ..YYYY-MM-DDThh:mm:ssZ . To filter by a single date, enter timestamps with the same date, but different times. For example, 2021-03-31T00:00:00Z..2021-03-31T23:59:00Z . |
filter[createdBy] array: string | Retrieves comments created by the user. For example, filter[createdBy]=PER8KQPK2JRT . |
Response
HTTP Status Code Summary
200 OK | Success |
400 Bad Request | The parameters are invalid |
401 Unauthorized | The provided bearer token is not valid |
403 Forbidden | The user or service represented by the bearer token does not have permission to perform this operation |
404 Not Found | RFI not found |
500 Internal Server Error | An unknown error occurred on the server |
Response
Body Structure (200)
Expand all
results array: object | The list of comments. |
id string | The ID of the comment. |
rfiId string | The ID of the RFI associated with the comment. |
body string | The content of the comment. |
createdBy string | The Autodesk ID of the user who created the comment. To check the name of the user, call GET users/:user_id (BIM 360 or ACC). |
createdAt datetime: ISO 8601 | The timestamp of the date and time the comment was created, in the following format: YYYY-MM-DDThh:mm:ss.sz . |
updatedAt datetime: ISO 8601 | The timestamp of the date and time the comment was updated, in the following format: YYYY-MM-DDThh:mm:ss.sz . |
pagination object | The pagination object. |
limit int | The number of items per page. |
offset int | The page number that the results begin from. |
totalResults int | The number of items in the response. |
Example
Success
Request
curl -v 'https://developer.api.autodesk.com/construction/rfis/v2/projects/21a3f98d-34a8-4d4c-a362-3cc9de44f8aa/rfis/94ce6921-e8f9-4bc5-bf5a-1a8f543a2564/comments' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"results": [
{
"id": "94ce6921-e8f9-4bc5-bf5a-1a8f543a2564",
"rfiId": "0d302fc6-00a5-45ca-a9df-4427b9247c81",
"body": "This needs more attention.",
"createdBy": "PER8KQPK2JRT",
"createdAt": "2018-08-01T08:56:48.699Z",
"updatedAt": "2019-08-01T08:56:48.699Z"
}
],
"pagination": {
"limit": 10,
"offset": 0,
"totalResults": 97
}
}
Show More