Create Document Review Comments

Adds a comment to the specified document.

Resource Information

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

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
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
id	long	No	ï¿½	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.3.5
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

POST https://apis.accela.com/v4/documentReview/documents/154694/comments

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

Field	Type	Description	Automation Version
result	result{}	ï¿½	7.3.2
result.code	string	A code identifying an associated item	7.3.2
result.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.isSuccess	boolean	Indicates whether or not the operation on the item is successful.	7.3.2
result.message	string	A text message related to the operation.	7.3.2
status	integer	The record status.	7.3.3

Example

Sample Response Body

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