...
An intialise request will return a 200 HTTP response with a JSON version of the batch deletion job (see Schema)
TERMINATING BATCH DELETIONS
...
Name | Description |
|---|---|
_id | The id of the batch delete job. |
organisation | The id of the organisation that this job belongs to. |
filter | A stringified JSON Mongo query - records matching this filter are deleted |
pageSize | Total records deleted per batch (defaults to 1000, no way to customise outside of code change and rebuild) |
deleteCount | How many records have been deleted so far |
total | Total number of statements found for deletion at initialise |
processing | Boolean value; is there a deletion batch currently being actioned |
done | Boolean value; has the job finished or been terminated |
createdAt | When this document was created |
updatedAt | When this document was last updated |
...
The Batch Delete model may be retrieved using the GET REST or Connection APIs but other HTTP methods are disabled (PUT, PATCH, DELETE) and are instead replaced by the initialise and terminate routes specified above.
EXAMPLES: (USING THE CONNECTION API)
...