API Service Documentation

Command: batch

Batch multiple commands into one call

The single parameter "json" must be a well-encoded JSON string, where the top level is an array of plain objects.
Each object then represents the name-value pairs that you would normally send via normal POST

The response is another JSON encoded string that is an array of plain objects.
Each object or error string corresponds to the objects sent in the request in the same order.

Request

NameTypeRequiredExample
jsonJSON Encoded StringY[{"ai_command":"remove_volume","record_id":1001},{"ai_command":"remove_volume","record_id":"1002"},{"ai_command":"remove_volume","bad_param":"1003"}]

Response

NameTypeExample
responseJSON Encoded String[{"status":0,"record_id":1003},{"status":1,"status_message":"Record does not exist"},"ERROR: Required parameter \"record_id\" missing"]