Opportunity Comments
GET
opportunities/{opportunityId}/comments/{commentId}
Retrieves the specified comment associated with the specified opportunity.
To access the “Opportunity Comment” data, the user making the request must be a verified employee of the company owning the opportunity and must be associated with an office that has a Pro subscription to Bid Board. The opportunity comments can only be accessed via the API if the office, identified by the ‘owningOfficeId’ for the opportunity, has a Bid Board Pro subscription. Contact your sales representative to gain access to the BuildingConnected API.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/buildingconnected/v2/opportunities/{opportunityId}/comments/{commentId} |
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
opportunityId string | The ID of the opportunity. To find the opportunity ID, call GET opportunities |
commentId string | The ID of the comment associated with the opportunity. |
Response
HTTP Status Code Summary
200 OK | OK |
400 Bad Request | The parameters of the requested operation 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 | The requested resource could not be found. |
429 Too Many Requests | Rate limit exceeded; wait some time before retrying. The ‘Retry-After’ header might provide the amount of the time to wait. |
500 Internal Server Error | An unknown error occurred on the server. |
Response
Body Structure (200)
id string | The ID of the comment.
Max length: 24 |
opportunityId string | The ID of this opportunity associated with the comment.
Max length: 24 |
createdAt datetime: ISO 8601 | The date and time the comment was created, in ISO 8601 format. |
createdBy string | The ID of the user who created the comment. |
updatedAt datetime: ISO 8601 | The date and time the comment was last updated, in ISO 8601 format. |
content string | The content of the comment. Note that this may include HTML content, for example, <b></b> or & . |
userName string | The name of the user who added the comment. |
Example
OK
Request
curl -v 'https://developer.api.autodesk.com/construction/buildingconnected/v2/opportunities/:opportunityId/comments/:commentId' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"id": "5c3f0a5c9ca3dda548312ea5",
"opportunityId": "5c3f0a5c9ca3dda548312ea5",
"createdAt": "2020-01-13T17:20:29.492Z",
"createdBy": "",
"updatedAt": "2020-01-15T17:20:29.492Z",
"content": "<p>This is a <i>styled</i> comment</p>",
"userName": ""
}
Show More