Get Document Review Comments

Gets document comments specified by {commentIds}.

Resource Information

Scopedocuments

Deprecated scope name:   get_documentreview_documents_comments

App TypeAgency
Authorization TypeAccess token
URI /v4/documentReview/documents/{documentId}/comments/{commentIds}?isActive={isActive}&fields={fields}&lang={lang}
HTTP MethodGET
Automation Version(s)7.3.3.5

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
documentIdstringYes The document ID.7.3.2
fieldsstringNo 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
isActivestringYesY | NIndicates whether or not the item is active and available for use.7.3.3
langStringNo Indicates the language applied.7.3.2

Example

Sample Request Head

GET https://apis.accela.com/v4/documentReview/documents/154216/comments/47%2C48

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 8.0
result.commentstringComments or notes about the document.7.3.3.5
result.createdBystringThe unique user id of the individual who created the comment.7.3.3.5
result.createdDatedateTimeThe date the comment was created.7.3.3.5
result.disciplineresult.discipline{}The inspection discipline related to the document review.7.3.3.5
result.discipline.textstringThe localized display text.7.3.2
result.discipline.valuestringThe value for the specified parameter.7.3.2
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.5
result.pageNumberLongThe document page number the comment applies to.7.3.3.5
result.statusresult.status{}The document comment status.7.3.3.5
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "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
}