Orchestrator API Guide

DELIVERY:

Last updated Oct 31, 2024

Task Catalogs Requests

Retrieve Task Catalogs in a Folder

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
        }
    ]
}

Retrieve Task Catalog Details

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
}

Update Task Catalog

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"
}