data-service
2022.4
false
  • Data Service OpenAPI
UiPath logo, featuring letters U and I in white

Data Service API Guide

Automation CloudAutomation Cloud Public SectorAutomation Suite
Last updated Apr 19, 2024

Delete Multiple Entity Records

Deletes multiple existing Entity records in a batch.

API Endpoint

docs imageBaseURL/EntityService/<Entity>/delete-batch
  • BaseURL:

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 Service should stop processing the remaining records when a record fails to process. If set to true, 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 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.

  • API Endpoint
  • Request Headers
  • Query Parameters
  • Request Body (Required)
  • Responses
  • 200 OK
  • 401 Unauthorized
  • 403 Forbidden

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.