orchestrator
2024.10
true
- Getting Started
- Authentication
- Swagger Definition
- Orchestrator APIs
- Alerts Requests
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Personal Workspaces Requests
- Processes Requests
- Queue Items Requests
- Queue Retention Policy Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Storage Bucket Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
- Platform Management APIs
Orchestrator API Guide
Last updated Oct 21, 2024
[Preview] Get All Robot Accounts
Returns the list of all robot accounts from an organization, based on the organization ID.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'Note: To obtain the
{access_token}, make sure to authenticate through one of the methods described here.
|
Path param |
Data type |
Description |
|---|---|---|
|
(required) |
String |
The ID of the organization you want to retrieve the robot accounts for. |
|
Query param |
Data type |
Description |
|---|---|---|
|
(optional) |
String |
The key you want to search the robot accounts after. |
|
(optional) |
int32 |
Display the top N robot accounts. |
|
(optional) |
int32 |
Skip the top N robot accounts. |
|
(optional) |
int32 |
Specify the DTO property used to sort audit entries by. For example,
name, creationTime, id, etc.
|
|
(optional) |
int32 |
Specify the sorting order. For example, ascending (
asc) or descending (desc).
|
Let's say you gathered all the information needed to build the API call.
- Your
{baseURL}is:https://{yourDomain}/{organizationName}/{tenantName}/ -
Your
{access_token}is:1234(for length considerations). -
The
{partitionGlobalId}is:magic-7 -
You set the following query params:
searchTerm=bottop= 2, to display the top two entriesskip= 2, to skip the first two entriessortBy=name, to sort the entries by their namesortOrder=asc, to sort the entries from the earliest entry to the latest one
The call should look like below (cURL):
curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/magic-7?searchTerm=attended&top=2&skip=2&sortBy=name&sortOrder=asc' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/magic-7?searchTerm=attended&top=2&skip=2&sortBy=name&sortOrder=asc' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'Here's the response body for a successful audit entries retrieval:
{
"totalCount": 3,
"results": [
{
"id": "55-ab",
"name": "Bot5",
"displayName": "Bot5",
"creationTime": "2021-10-19T18:05:17.3465735",
"lastLoginTime": null,
"groupIds": [
"group1",
"group2",
"group3"
]
},
{
"id": "66-cd",
"name": "Bot6",
"displayName": "Bot6",
"creationTime": "2021-10-19T18:06:00.3088553",
"lastLoginTime": null,
"groupIds": [
"group1",
"group3"
]
},
{
"id": "77-ef",
"name": "Bot7",
"displayName": "Bot7",
"creationTime": "2021-10-19T18:05:31.4736281",
"lastLoginTime": null,
"groupIds": [
"group2"
]
}
]
}{
"totalCount": 3,
"results": [
{
"id": "55-ab",
"name": "Bot5",
"displayName": "Bot5",
"creationTime": "2021-10-19T18:05:17.3465735",
"lastLoginTime": null,
"groupIds": [
"group1",
"group2",
"group3"
]
},
{
"id": "66-cd",
"name": "Bot6",
"displayName": "Bot6",
"creationTime": "2021-10-19T18:06:00.3088553",
"lastLoginTime": null,
"groupIds": [
"group1",
"group3"
]
},
{
"id": "77-ef",
"name": "Bot7",
"displayName": "Bot7",
"creationTime": "2021-10-19T18:05:31.4736281",
"lastLoginTime": null,
"groupIds": [
"group2"
]
}
]
}
