OpenAPI Reference
Comments
Comments attached to workspace content.
Query Parameters
subjectType*string
What the comment thread hangs off, which decides how subjectId is interpreted.
Value in
- "record"
- "change_request"
- "operation"
- "commit"
subjectId*string
The subject's id, interpreted according to subjectType.
Length
1 <= lengthResponse Body
application/json
curl -X GET "https://example.com/api/v1/comments?subjectType=record&subjectId=string"[ { "id": "string", "subjectType": "record", "subjectId": "string", "recordId": "string", "changeRequestId": "string", "operationId": "string", "commitId": "string", "authorId": "string", "author": null, "body": "string", "mentions": [], "createdAt": "string", "updatedAt": "string" }]Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/comments" \ -H "Content-Type: application/json" \ -d '{ "subjectType": "record", "subjectId": "string", "body": "string" }'{ "id": "string", "subjectType": "record", "subjectId": "string", "recordId": "string", "changeRequestId": "string", "operationId": "string", "commitId": "string", "authorId": "string", "author": null, "body": "string", "mentions": [], "createdAt": "string", "updatedAt": "string"}Query Parameters
page?integer
1-indexed, not 0-indexed.
Range
1 <= value <= 9007199254740991Default
1pageSize?integer
Mentions per page. Capped at 100.
Range
1 <= value <= 100Default
50Response Body
application/json
curl -X GET "https://example.com/api/v1/comments/mentions"{ "items": [ { "commentId": "string", "subjectType": "record", "body": "string", "authorId": "string", "author": null, "createdAt": "string", "unread": true, "href": "string" } ], "total": -9007199254740991, "unreadCount": -9007199254740991}Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/comments/mentions/read" \ -H "Content-Type: application/json" \ -d '{ "commentId": "string" }'{ "marked": -9007199254740991, "unreadCount": -9007199254740991}