Get Document Review Comments

Gets document comments specified by {commentIds}.

Resource Information


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}
Automation Version(s)

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
documentIdstringYesThe document ID.7.3.2
fieldsstringNoComma-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
langStringNoIndicates the language applied.7.3.2


Sample Request Head


Response Information

FieldTypeDescriptionAutomation Version
result.commentstringComments or notes about the document.
result.createdBystringThe unique user id of the individual who created the comment.
result.createdDatedateTimeThe date the comment was created.
result.disciplineresult.discipline{}The inspection discipline related to the document review.
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.
result.pageNumberLongThe document page number the comment applies to.
result.statusresult.status{}The document comment status.
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


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