Update Document Review Comment

Updates the specified comment for the specified document.

Resource Information

Scopedocuments

Deprecated scope name:   update_documentreview_documents_comments

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

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
commentIdlongYes The comment ID.7.3.3.5
commentstringNo Comments or notes about the document.7.3.3.5
createdBystringNo The unique user id of the individual who created the comment.7.3.3.5
createdDatedateTimeNo The date the comment was created.7.3.3.5
disciplinediscipline{}No The inspection discipline related to the document review.7.3.3.5
discipline.textstringNo The localized display text.7.3.2
discipline.valuestringNo The value for the specified parameter.7.3.2
pageNumberLongNo The document page number the comment applies to.7.3.3.5
statusstatus{}No The document comment status.7.3.3.5
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

Example

Sample Request Head

PUT https://apis.accela.com/v4/documentReview/documents/30050/comments/14483

Sample Request Body

{
  "comment": "Duplicate info.",
  "pageNumber": 4,
  "status": {
    "value": "Open",
    "text": ""
  },
  "discipline": {
    "value": "Electricity",
    "text": ""
  },
  "createdDate ": "04/28/2015",
  "createdBy ": "System Admin"
}

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 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.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": {
    "id": 14483
  },
  "status": 200
}