Batch Review
When you create a batch task, it has an option to review the items. To enable it, the review
field of the Task object must be set to true
.
To see the review items and check if they are valid or need corrections, you can use the Get Task Review Items by SID method. It will return the Batch Review Response object with the list of the items, which can be reviewed.
The Download CSV of Task Review Items by SID method can also be used to download the list of the task review items in the CSV format for a more convenient visual representation.
If the changes look correct, you can make a PATCH
or PUT
request to change the status
from pending_review
to approved
. If the items look incorrect, the batch request can be prevented from proceeding by changing the status
to cancelled
.
Batch Review Response Object
Attribute | Data Type | Description |
---|---|---|
method read only | string | The batch review method. Values accepted in this field are: |
review_items read only | array of objects | Items to be reviewed before approving the batch task. Refer to the table below for more information. |
type read only | string | The batch task type. Values accepted in this field are |
Batch Review Item Object
Attribute | Data Type | Description |
---|---|---|
description read only | string | The batch review item description. |
fields read only | object | The batch review item fields, which require reviewing. |
sid read only | string | The batch review item secure ID. |
version read only | integer | The batch review item version. |