data-service
latest
false
  • Data Service OpenAPI
Data Service API Guide
Automation CloudAutomation Cloud Public SectorAutomation Suite
Last updated May 9, 2024

Get Entity Records

Lists all the Entity's records.

API Endpoint

docs imageBaseURL/EntityService/<Entity>/read
  • BaseURL: https://govcloud.uipath.us/{organizationName}/{tenantName}/dataservice_/api

Request Headers

Header

Value

Authorization

Bearer <access_token>
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

start (Optional)

int32

Specifies the number of records to skip before retrieving the records from the query. Can be used together with the limit parameter to implement pagination. The records are ordered ascendingly by their IDs.

0

limit (Optional)

int32

Specifies the maximum number of records to be read from the entity. Can be used together with the start parameter to implement pagination. The maximum value is 1000.

100

expansionLevel (Optional)

int32

Specifies the depth of the related records to be retrieved. The value of this parameter can be 1, 2, or 3.

2

Responses

200 OK

{
  "TotalRecordCount": 0,
  "Value": [
    {
      "ClosingDate": "2021-03-04",
      "CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "CreateTime": "2021-03-04T10:20:47.791Z",
      "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:20:47.791Z"
    }
  ]
}{
  "TotalRecordCount": 0,
  "Value": [
    {
      "ClosingDate": "2021-03-04",
      "CreatedBy": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "CreateTime": "2021-03-04T10:20:47.791Z",
      "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:20:47.791Z"
    }
  ]
}

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
  • 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.