Comments
GET
comments
Retrieves all the comments associated with a BIM 360 Project Management RFI.
Note that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects.
Resource Information
| Method and URI | GET https://developer.api.autodesk.com/bim360/rfis/v2/containers/:containerId/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. |
* Required
Request
URI Parameters
| containerId string | The ID of the container. Each project is assigned a container that stores all the RFIs for the project. To find the ID, see the Retrieve a Container ID tutorial. |
| rfiId string | The ID of the RFI. |
Request
Query String Parameters
| limit int | The number of RFIs to return in the response payload. Acceptable values: 1-200. Default value: 10. For example, to limit the response to two RFIs per page, use limit=2 |
| offset int | The page number that you want to begin RFI results from. For example, to begin the results from page three, use offset=3 |
| sort array: string | The fields to sort the list by |
| 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 after the specfied date, in the following format: YYYY-MM-DDThh:mm:ss.sz, or a date range in the following format: YYYY-MM-DDThh:mm:ss.sz..YYYY-MM-DDThh:mm:ss.sz. |
| filter[createdBy] array: string | Retrieves comments that were created by the specified user. Use the user’s Autodesk ID. For example, filter[created]=PER8KQPK2JRT. To find the ID call GET users/me and check user.id. |
Response
HTTP Status Code Summary
| 200 OK | Comment Records |
| 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 projects/users. |
| 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
Comment Records
Request
curl -v 'https://developer.api.autodesk.com/bim360/rfis/v2/containers/:containerId/rfis/:rfiId/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