Orchestrator
latest
false
- 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
- Process Data Retention Policy 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
Orchestrator API Guide
Last updated Nov 13, 2023
Available Operations
CRUD Operations
These types of operations are available on logical resources most. CRUD operations include GET, POST, PUT and DELETE requests, but please note that not all logical resources make use of all these verbs due to both technical and business reasons.
Requesting Data
It is possible to request particular information from a particular resource, in conjunction with GET operations, through OData-specific parameters.
They enable you to query, filter, sort, select and expand information. More details can be found in the official OData documentation.
Custom Actions
The following custom actions and actions which are not tied to a logical resource are available in the Orchestrator API:
- Stats methods provide aggregates information on different entities;
- Account methods provide authentication methods to Orchestrator;
- Queues methods are used by the Robot to access queues, while the
QueueDefinitions
endpoint should be used instead for external systems via API; - QueueProcessingRecords methods offer statistical and aggregate information about queues;
Note: You can request
data by day, hour, and minute, but it is only displayed if it is a maximum of 90 days
old.
- RobotsService resources can be used by
Orchestrator to communicate with the Robot.