- 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
- 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
API endpoint URL structure
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
