orchestrator
2022.4
false
- 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
- 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
OUT OF SUPPORT
Orchestrator API guide
Last updated Dec 16, 2025
This request enables you to retrieve all the task catalogs in the classic folders that the user has access to.
GET
{OrchestratorURL}/odata/TaskCatalogs?$top=3
Request headers
|
Key |
Value |
|---|---|
|
Authorization |
Bearer |
Response code
200 OK
Response body
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#TaskCatalogs",
"@odata.count": 3,
"value": [
{
"Name": "Greatness",
"Description": null,
"LastModificationTime": "2019-10-30T16:45:57.533Z",
"Id": 7
},
{
"Name": "Orchestrator",
"Description": "Mother",
"LastModificationTime": "2019-10-30T16:57:44.1Z",
"Id": 12
},
{
"Name": "Credentials",
"Description": null,
"LastModificationTime": null,
"Id": 20
}
]
}{
"@odata.context": "{OrchestratorURL}/odata/$metadata#TaskCatalogs",
"@odata.count": 3,
"value": [
{
"Name": "Greatness",
"Description": null,
"LastModificationTime": "2019-10-30T16:45:57.533Z",
"Id": 7
},
{
"Name": "Orchestrator",
"Description": "Mother",
"LastModificationTime": "2019-10-30T16:57:44.1Z",
"Id": 12
},
{
"Name": "Credentials",
"Description": null,
"LastModificationTime": null,
"Id": 20
}
]
}This request enables you to retrieve task catalog details according to the
TaskCatalogId. The TaskCatalogId must be included in the request.
GET
{OrchestratorURL}/odata/TaskCatalogs(7)
Request headers
|
Key |
Value |
|---|---|
|
Authorization |
Bearer |
Response code
200 OK
Response body
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#TaskCatalogs/$entity",
"Name": "Orchestrator Catalog",
"Description": "da",
"LastModificationTime": "2020-02-05T13:31:09.45Z",
"Id": 7
}{
"@odata.context": "{OrchestratorURL}/odata/$metadata#TaskCatalogs/$entity",
"Name": "Orchestrator Catalog",
"Description": "da",
"LastModificationTime": "2020-02-05T13:31:09.45Z",
"Id": 7
}This request enables you to modify task catalog details based on the
TaskCatalogId. The TaskCatalogId must be included in the request.
GET
{OrchestratorURL}/odata/TaskCatalogs(7)/UiPath.Server.Configuration.OData.UpdateTaskCatalog
Request headers
|
Key |
Value |
|---|---|
|
Authorization |
Bearer |
Request body
{
"Name": "Orchestrator is life",
"Description": "We love Orchestrator"
}{
"Name": "Orchestrator is life",
"Description": "We love Orchestrator"
}Response code
200 OK