End Batch

Download this manual as a PDF file

The End Batch API should be used when all files have been uploaded to ZAP for a batch upload. On success the batch upload will move into the Processing state.

Method URL PUT http://<zapi_url>:<zapi_port>/api/v2/batch/<batch_id>
HTTP Method PUT
Content Type application/json
Required Headers Authorization (set to ZAPI token)

Request Arguments

Arguments Data Type How To Use
uploads_complete bool Set to true

Response Payload

Optional Arguments Data Type How To Use
batch_id string  
state state The new state

Example Request Payload

{
   "uploads_complete" : true
}

Example Response Payload

{
     "batch_id" : "b1cc71aef9989ead80012ac",
     "state" : "Processing"
}