Create Document Review Comments

Adds a comment to the specified document.

Resource Information


Deprecated scope name:   create_documentreview_documents_comments

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

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
commentstringNo Comments or notes about the document.
createdBystringNo The unique user id of the individual who created the comment.
createdDatedateTimeNo The date the comment was created.
disciplinediscipline{}No The inspection discipline related to the document review.
discipline.textstringNo The localized display text.7.3.2
discipline.valuestringNo The value for the specified parameter.7.3.2
idlongNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.
pageNumberLongNo The document page number the comment applies to.
statusstatus{}No The document comment status.
status.textstringNo The localized display text.7.3.2
status.valuestringNo The value for the specified parameter.7.3.2
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
langStringNo Indicates the language applied.7.3.2


Sample Request Head


Sample Request Body

  "comment": "Need more info.",
  "pageNumber": 2,
  "status": {
    "value": "Closed",
    "text": ""
  "discipline": {
    "value": "Electricity",
    "text": ""
  " createdDate ": "04/29/2015",
  " createdBy ": "System Admin"

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.2
result.codestringA code identifying an associated item7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.isSuccessbooleanIndicates whether or not the operation on the item is successful. 7.3.2
result.messagestringA text message related to the operation.7.3.2
statusintegerThe record status.7.3.3


Sample Response Body

  "result": {
    "id": 14483
  "status": 200