Custom Entity

CustomEntities.batch_restore

Restores the deleted CustomEntity records with the given ids.

post/entities/{custom_entity_api_name}/batch-restore

Request

Path parameters

custom_entity_api_namestring required

API name of the custom entity whose records to work with.

Query parameters

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

string[] required

Response

Result per id, in request order: the id of the restored record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.