Update Document Review Comment

Updates the specified comment for the specified document.

Resource Information

Scope	documents Deprecated scope name: update_documentreview_documents_comments
App Type	Agency
Authorization Type	Access token
URI	/v4/documentReview/documents/{documentId}/comments/{commentId}?fields={fields}&lang={lang}
HTTP Method	PUT
Automation Version(s)	7.3.3.5

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
commentId	long	Yes	ï¿½	The comment ID.	7.3.3.5
comment	string	No	ï¿½	Comments or notes about the document.	7.3.3.5
createdBy	string	No	ï¿½	The unique user id of the individual who created the comment.	7.3.3.5
createdDate	dateTime	No	ï¿½	The date the comment was created.	7.3.3.5
discipline	discipline{}	No	ï¿½	The inspection discipline related to the document review.	7.3.3.5
discipline.text	string	No	ï¿½	The localized display text.	7.3.2
discipline.value	string	No	ï¿½	The value for the specified parameter.	7.3.2
pageNumber	Long	No	ï¿½	The document page number the comment applies to.	7.3.3.5
status	status{}	No	ï¿½	The document comment status.	7.3.3.5
status.text	string	No	ï¿½	The localized display text.	7.3.2
status.value	string	No	ï¿½	The value for the specified parameter.	7.3.2
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
lang	String	No	ï¿½	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

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.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

Example

Sample Response Body

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