- Getting started
- About OData and references
- Enumerated types
- Authenticating
- Building API Requests
- Permissions per endpoint
- Response codes
- Health Check Endpoints
- Authentication
- Authentication methods
- External Applications (OAuth)
- ROPC (not recommended)
- Swagger definition
- Read me
- Authorizing API calls in Swagger
- Managing logical resources
- 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
- Robots requests
- Roles requests
- Schedules requests
- Settings requests
- Tasks requests
- Task Catalogs requests
- Task Forms requests
- Tenants Requests
- Transactions requests
- Users requests
- Webhooks requests
- Platform Management APIs
- Getting started
- About this guide
- Available resources
- API endpoint URL structure
- Enumeration List
- Scopes and permissions
- About scopes and permissions
- Platform Management scopes and permissions
- Platform Management APIs
- Audit Logs
- Get Audit Logs
- Download Audit Logs
- Groups
- Get All Groups
- Get Specific Group
- Delete Specific Group
- Create a New Local Group
- Update Group
- Robot Account
- Get All Robot Accounts
- Delete Robot Accounts
- Get Specific Robot Account
- Delete Specific Robot Account
- Create a New Robot Account
- Update Robot Account
- User
- Update User
- Delete Specific User
- Delete Users
- Settings
- Get Settings
- Update Settings
- Message Template
- Get Message Template
- Update a Message Template
- Get Message Template by Name
Orchestrator API guide
The Orchestrator API implementation is based on the OData protocol. OData (Open Data Protocol) is an ISO/IEC approved OASIS standard that defines a set of best practices for building and consuming RESTful APIs.
The Open Data Protocol (OData) enables the creation of REST-based data services, which allow resources, identified using URLs and defined in a data model, to be published and edited by Web clients using simple HTTP messages. This specification defines the core semantics and the behavioral aspects of the protocol.
https://{yourDomain}/odata. To change the default format to XML, append /?$format=xml to this URL.
The Orchestrator API provides custom methods for querying stats about various entities registered in Orchestrator. Each logical resource is an OData entity. All entities (such as Robot, Process, Queue) have properties, relationships, and 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
QueueDefinitionsendpoint should be used instead for external systems via API; - QueueProcessingRecords methods offer statistical and aggregate information about queues;
- RobotsService resources can be used by Orchestrator to communicate with the Robot.
Figure 2. Custom Orchestrator API methods