Page History
...
Code Block | ||||
---|---|---|---|---|
| ||||
{"message":"OK"} |
If the storage unit doesn't exist, a 400 response code with a STORAGE_UNIT_DOESNT_EXIST message is returned.
Code Block | ||||
---|---|---|---|---|
| ||||
{"message": "STORAGE_UNIT_DOESNT_EXIST"} |
Batch
Executes a list of JSON transactions against the storage unit. The batch expects a list of single line JSON strings.
...
If the batch operation is successful, a 200 response code and an OK message are returned if no transactions failed. A COMPLETED_WITH_ERRORS message if one or more transactions failed.
When it completes successfully:
Code Block | ||||
---|---|---|---|---|
| ||||
{"message":"OK"} |
When it completes with errors:
Code Block | ||||
---|---|---|---|---|
| ||||
{"message":"COMPLETED_WITH_ERRORS"} |
If the storage unit doesn't exist, a 400 response code with a STORAGE_UNIT_DOESNT_EXIST message is returned.
...
If the report parameter is specified, a 200 response code is returned with the list of processed keys and a status for each key, as well as a general report. An OK message value if no errors occurred or COMPLETED_WITH_ERRORS with one or more transactions failed.
When it completes successfully:
Code Block | ||||
---|---|---|---|---|
| ||||
{ "message":"COMPLETED_WITH_ERRORS", "batchErrors":[ { "keys": [ "APP_ZONE:69FCDBE0047FF81A784A3AF760132623", OK"} |
When it completes with errors:
Code Block | ||||
---|---|---|---|---|
| ||||
{ "message": "COMPLETED_WITH_ERRORS", "errors": [ { "key": "APP_ZONE:AD469379FA86CE1EA257DEB8EE14166Abatch1", "APP_ZONE:1863C3368B404DC11E1BEA42CBF063E4", "APP_ZONE:FE0821AE1E07FD24C877D77B48966589" ], "errors":"Request error", "event":"BatchEnd"} "error": "NEW_MERGE_POLICY_ERROR" }, { "key": "APP_ZONE:batch3", "error": "NEWER_VERSION_ALREADY_EXISTS" } ] } |
Delete
Deletes a scope or all scopes for a key in the specified storage unit.
...
Code Block | ||||
---|---|---|---|---|
| ||||
{"message":"OK"} |
If the storage unit doesn't exist, a 400 response code with a STORAGE_UNIT_DOESNT_EXIST message is returned.
Code Block | ||||
---|---|---|---|---|
| ||||
{"message": "STORAGE_UNIT_DOESNT_EXIST"} |
If the scope doesn't exist and the delete policy was MUSTEXIST, a 400 response code with a DELETED_SCOPE_DOESNT_EXIST message is returned.
Code Block | ||||
---|---|---|---|---|
| ||||
{"message": "DELETED_SCOPE_DOESNT_EXIST"} |
Delete All
Deletes the provided scope for all content records of the storage unit. If the scope is the global $record scope or it is not provided, all content records are deleted.
...
Code Block | ||||
---|---|---|---|---|
| ||||
{"message":"OK"} |
If the storage unit doesn't exist, a 400 response code with a STORAGE_UNIT_DOESNT_EXIST message is returned.
Code Block | ||||
---|---|---|---|---|
| ||||
{"message": "STORAGE_UNIT_DOESNT_EXIST"} |
If the scope doesn't exist and the delete policy was MUSTEXIST, a 400 response code with a DELETED_SCOPE_DOESNT_EXIST message is returned.
Code Block | ||||
---|---|---|---|---|
| ||||
{"message": "DELETED_SCOPE_DOESNT_EXIST"} |
Delete If
Deletes a content record scope based on a comparison criteria (X field is equal (EQ), greater than (GT), lesser than (LT) or not equal (NEQ) to a value).
...
Code Block | ||||
---|---|---|---|---|
| ||||
{"statusId": "id"} |
If the storage unit doesn't exist, a 400 response code with a STORAGE_UNIT_DOESNT_EXIST message is returned.
Code Block | ||||
---|---|---|---|---|
| ||||
{"message": "STORAGE_UNIT_DOESNT_EXIST"} |
Delete If Status
Returns the current status of the delete if processing execution for the storage unit.
...