- Data Service OpenAPI
- Get Entity Record by Id
- Get Entity Records
- Query Entity Records
- Delete Entity Record by Id
- Update Entity Record by Id
- Create Entity Record
- Create Multiple Entity Records
- Update Multiple Entity Records
- Delete Multiple Entity Records
- Download File from Record Field
- Upload File to Record Field
- Delete File From Record Field
Get Entity Records
Lists all the Entity's records.
BaseURL/EntityService/<Entity>/read- BaseURL:
https://govcloud.uipath.us/{organizationName}/{tenantName}/dataservice_/api
|
Header |
Value |
|---|---|
|
Authorization |
Bearer
<access_token> |
<...> with their corresponding use-case values.
<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 Parameter |
Data Type |
Description |
Default Value |
|---|---|---|---|
|
start (Optional) |
|
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) |
|
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) |
|
Specifies the depth of the related records to be retrieved. The value of this parameter can be 1, 2, or 3. |
2 |
{
"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"
}
]
}You are not authenticated to access Data Service. Make sure your Assistant or Robot is connected to a modern folder in your account.
