Data Service - Delete multiple entity records

data-service

latest

false

Data Fabric API guide

OpenAPI

important :

Data Service is currently transitioning to Data Fabric, a process during which you may see both names used for different delivery options.

Delete multiple entity records

API reference for deleting multiple entity records in a batch in Data Service, with the endpoint URL, request parameters, and example payloads.

Deletes multiple existing entity records in a batch.

API endpoint

POST BaseURL/EntityService/<Entity>/delete-batch

Depending on the cloud platform you are using, use the associated Base URL.

Request headers

Header	Value
Authorization	Bearer `<access_token>`
Content-Type	application/json

Note:

Replace all the values between the angle brackets <...> with their corresponding use-case values.

The <access_token> is the one you received when you authorized the external application. It is available for 1 hour, then you need to generate a new one, or request a refresh token.

Query parameters

Query Parameter	Data Type	Description	Default Value
failOnFirst (optional)	`boolean`	Specifies if the Data Fabric / Data Service should stop processing the remaining records when a record fails to process. If set to `true`, Data Fabric / Data Service will stop processing the remaining records at the first failure.	`false`

Request body (required)

[
  "1we90a12-4512-670i-15hj-3d213k09qgs8",
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
[
  "1we90a12-4512-670i-15hj-3d213k09qgs8",
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
]

Responses

200 OK

{
  "successRecords": [
    {
      "ClosingDate": "2021-03-04",
      "CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "CreateTime": "2021-03-04T10:40:14.561Z",
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Logo": {
        "Name": "string",
        "Path": "string",
        "Size": 0,
        "Type": "string"
      },
      "Name": "string",
      "Nations": 0,
      "OlymipcsVersion": 0,
      "OpeningDate": "2021-03-04",
      "UpdatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "UpdateTime": "2021-03-04T10:40:14.561Z"
    }
  ],
  "failureRecords": {
    "error": "string",
    "record": {
      "ClosingDate": "2021-03-04",
      "CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "CreateTime": "2021-03-04T10:40:14.561Z",
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Logo": {
        "Name": "string",
        "Path": "string",
        "Size": 0,
        "Type": "string"
      },
      "Name": "string",
      "Nations": 0,
      "OlymipcsVersion": 0,
      "OpeningDate": "2021-03-04",
      "UpdatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "UpdateTime": "2021-03-04T10:40:14.561Z"
    }
  }
}
{
  "successRecords": [
    {
      "ClosingDate": "2021-03-04",
      "CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "CreateTime": "2021-03-04T10:40:14.561Z",
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Logo": {
        "Name": "string",
        "Path": "string",
        "Size": 0,
        "Type": "string"
      },
      "Name": "string",
      "Nations": 0,
      "OlymipcsVersion": 0,
      "OpeningDate": "2021-03-04",
      "UpdatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "UpdateTime": "2021-03-04T10:40:14.561Z"
    }
  ],
  "failureRecords": {
    "error": "string",
    "record": {
      "ClosingDate": "2021-03-04",
      "CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "CreateTime": "2021-03-04T10:40:14.561Z",
      "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Logo": {
        "Name": "string",
        "Path": "string",
        "Size": 0,
        "Type": "string"
      },
      "Name": "string",
      "Nations": 0,
      "OlymipcsVersion": 0,
      "OpeningDate": "2021-03-04",
      "UpdatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "UpdateTime": "2021-03-04T10:40:14.561Z"
    }
  }
}

401 Unauthorized

You are not authenticated to access Data Fabric / Data Service. Make sure your Assistant or Robot is connected to a modern folder in your account.

403 Forbidden

You don't have permission to access the entity, field or record or you are using an unsupported robot type. Please contact your administrator for necessary permissions.

On this page

API endpoint
Request headers
Query parameters
Request body (required)
Responses
200 OK
401 Unauthorized
403 Forbidden

Was this page helpful?

PREVIOUSUpdate multiple entity records

NEXTDownload file from record field

API endpoint​

Request headers​

Query parameters​

Request body (required)​

Responses​

200 OK​

401 Unauthorized​

403 Forbidden​