Gets document comments specified by {commentIds}.
| Scope | documents Deprecated scope name: get_documentreview_documents_comments |
| App Type | Agency |
| Authorization Type | Access token |
| URI | /v4/documentReview/documents/{documentId}/comments/{commentIds}?isActive={isActive}&fields={fields}&lang={lang} |
| HTTP Method | GET |
| Automation Version(s) | 7.3.3.5 |
| Field or Parameter | Type | Required | Values | Description | Automation Version |
|---|---|---|---|---|---|
| documentId | string | Yes | � | The document ID. | 7.3.2 |
| fields | string | No | � | Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored. | 7.3.2 |
| isActive | string | Yes | Y | N | Indicates whether or not the item is active and available for use. | 7.3.3 |
| lang | String | No | � | Indicates the language applied. | 7.3.2 |
| Field | Type | Description | Automation Version |
|---|---|---|---|
| result[] | result{} | � | 8.0 |
| result.comment | string | Comments or notes about the document. | 7.3.3.5 |
| result.createdBy | string | The unique user id of the individual who created the comment. | 7.3.3.5 |
| result.createdDate | dateTime | The date the comment was created. | 7.3.3.5 |
| result.discipline | result.discipline{} | The inspection discipline related to the document review. | 7.3.3.5 |
| result.discipline.text | string | The localized display text. | 7.3.2 |
| result.discipline.value | string | The value for the specified parameter. | 7.3.2 |
| result.id | long | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.3.5 |
| result.pageNumber | Long | The document page number the comment applies to. | 7.3.3.5 |
| result.status | result.status{} | The document comment status. | 7.3.3.5 |
| result.status.text | string | The localized display text. | 7.3.2 |
| result.status.value | string | The value for the specified parameter. | 7.3.2 |
| status | integer | The record status. | 7.3.3 |
{
"result": [
{
"pageNumber": 0,
"comment": "13123",
"id": 49,
"createdBy": "ADMIN",
"createdDate": "2015-05-13 20:48:27",
"status": "Open",
"subject": "Sticky Note"
},
{
"pageNumber": 0,
"id": 46,
"createdBy": "ADMIN",
"createdDate": "2015-06-01 20:41:06",
"status": "Open",
"subject": "Install all GFCI Installation"
}
],
"status": 200
}