Update Document Review Task Status

Updates the status of the specified task for the specified document. A third party document review application can use the Update Document Review Task to sync the document task status between the third party tool and Automation.

Resource Information

Scope documents

Deprecated:  update_documentreview_documents_tasks
App Type Agency
Authorization Type Access token
URI /v4/documentReview/documents/{documentId}/tasks/{id}?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
department string No Get All Departments The department responsible for the document review task. 7.3.3.5
discipline string No The inspection discipline related to the document review. 7.3.3.5
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
id string Yes   The unique task identifier. Currently, a third-party document review tool supplies the task id that is stored in their system. 7.3.2
lang String No   Indicates the language applied. 7.3.2
staff string No Get All Department Staff The staff responsible for the document review task. 7.3.3.5
status status{} No   The document review task 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

Example

Sample Request Head

PUT https://apis.accela.com/v4/documentReview/documents/30050/tasks/28597

Sample Request Body

{
  "status": {
    "text": "Passed",
    "value": ""
  }
}

Response Information

Field Type Description Automation Version
result result{}   8.0
result.department string The department responsible for the document review task. 7.3.3.5
result.staff string The staff responsible for the document review task. 7.3.3.5
result.status result.status{} The document review task 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

{
  "status": 200
}