- 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
- Processes 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
- About this guide
- Available resources
- API endpoint URL structure
- Enumeration List
Orchestrator API Guide
In this section, you can learn to construct API requests by understanding the URL structure of UiPath® endpoints.
The base URL is the starting point for all API requests. It serves as the foundation for constructing the endpoint URL. The base URL is https://{yourDomain}.
api - signifies the entry point to the API platform management resources, for example /api/Group/The resource path specifies the exact resource or operation you wish to perform. It might include keywords like Group, RobotAccount, Setting, depending on the purpose of the request.
/Group/{partitionGlobalId}/{groupId}partitionGlobalId - the ID of the organization.
groupId - the ID of the group.
Query parameters are additional parameters attached to the URL to provide more context or filters for the requested data. These are often preceded by a ? symbol and separated by & symbols. For instance, you might use query parameters to specify filtering criteria or pagination instructions
