Delete Document Review Comments

Deletes the specified comments for the specified document.

Resource Information

Scopedocuments

Deprecated scope name:   delete_documentreview_documents_comments

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

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
commentIdsstringYes Comma-delimited comment ID's.7.3.3.5
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

DELETE https://apis.accela.com/v4/documentReview/documents/30050/comments/14483,14484

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 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

Example

Sample Response Body

{
  "status": 200,
  "result": [
    {
      "id": "14483"
    },
    {
      "id": "14484"
    }
  ]
}