Packages Requests

Retrieving All Available Versions for a Specific Package

GET

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='QueueItemsProcessing')

Request headers

Key	Value
Authorization	Bearer

Response code

200 OK

Response body

{
  "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Processes",
  "@odata.count": 2,
 "value": [
        {
            "IsActive": true,
            "SupportsMultipleEntryPoints": false,
            "MainEntryPointPath": null,
            "RequiresUserInteraction": true,
            "TargetFramework": "Legacy",
            "Title": null,
            "Version": "1.0.6981.35861",
            "Key": "QueueItemsProcessing:1.0.6981.35861",
            "Description": "Process items from an Orchestrator queue.",
            "Published": "2021-07-23T16:40:07.793Z",
            "IsLatestVersion": false,
            "OldVersion": null,
            "ReleaseNotes": null,
            "Authors": "petrina.calota",
            "ProjectType": "Undefined",
            "Tags": null,
            "Id": "QueueItemsProcessing",
            "Arguments": {
                "Input": "[{\"name\":\"argument1\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"argument2\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"argument3\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
                "Output": null
            }
        }
    ]
}

Downloading a Specific Package Version

The request below enables you to download the package with the "add_queue_items" name, and the 1.0.6654.27080 version.

GET

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Processes/UiPath.Server.Configuration.OData.DownloadPackage(key='add_queue_items:1.0.6654.27080')

Request headers

Key	Value
Authorization	Bearer

Response code

200 OK

Retrieving the Arguments of a Package

The following GET request to the /odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='key') endpoint returns all the In and Out arguments of a specific package, their type, and if they have a default value. The In, Out, or In/Out arguments of a project become input and output parameters in Orchestrator.

GET

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='input_output_test%3A1.3.5')

Request headers

Key	Value
Authorization	Bearer

Response code

200 OK

Response body

{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Core.Arguments.ArgumentMetadata",
    "Input": "[\r\n  {\r\n    \"name\": \"age\",\r\n    \"type\": \"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n    \"required\": false,\r\n    \"hasDefault\": false\r\n  },\r\n  {\r\n    \"name\": \"Array\",\r\n    \"type\": \"System.Int32[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n    \"required\": false,\r\n    \"hasDefault\": true\r\n  },\r\n  {\r\n    \"name\": \"trueOrFalse\",\r\n    \"type\": \"System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n    \"required\": false,\r\n    \"hasDefault\": true\r\n  },\r\n  {\r\n    \"name\": \"dateNow\",\r\n    \"type\": \"System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n    \"required\": false,\r\n    \"hasDefault\": true\r\n  },\r\n  {\r\n    \"name\": \"stringNew\",\r\n    \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n    \"required\": false,\r\n    \"hasDefault\": false\r\n  },\r\n  {\r\n    \"name\": \"arrayStrings\",\r\n    \"type\": \"System.String[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n    \"required\": false,\r\n    \"hasDefault\": false\r\n  },\r\n  {\r\n    \"name\": \"inOutTry\",\r\n    \"type\": \"System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n    \"required\": false,\r\n    \"hasDefault\": false\r\n  }\r\n]",
    "Output": "[\r\n  {\r\n    \"name\": \"output\",\r\n    \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n  },\r\n  {\r\n    \"name\": \"inOutTry\",\r\n    \"type\": \"System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n  }\r\n]"
}

Changing the Parameters at Package Level

It is possible to update the input and output parameters of a project by making a POST request to the /odata/Processes/UiPath.Server.Configuration.OData.SetArguments endpoint.

Note:

This call overrides all prior parameters and offers validation.

Additionally, please note that this endpoint can be used to change the input and output parameters of an automation package only if you did not upload it to Orchestrator through the API, the Packages page, or the NuGet feed.

If you want to update the values of input parameters only, you can do so at process level , at job level , and/or schedule level .

POST

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Processes/UiPath.Server.Configuration.OData.SetArguments

Request headers

Key	Value
Authorization	Bearer

Request body

{
  "key": "input_output_test:1.3.6",
  "arguments": {
    "Input": "[{\"name\":\"arg1\", \"type\": \"System.String\", \"required\": false}]", 
    "Output": "[{\"name\":\"outputArg\", \"type\":\"System.String\", \"required\":false}]"
  }
}

Response code

200 OK

Retrieving Packages

GET

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Processes

Request headers

Key	Value
Authorization	Bearer

Response code

200 OK

Response body

{
  "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Processes",
  "@odata.count": 2,
    "value": [
        {
            "IsActive": false,
            "SupportsMultipleEntryPoints": false,
            "MainEntryPointPath": null,
            "RequiresUserInteraction": true,
            "TargetFramework": "Legacy",
            "Title": null,
            "Version": "1.0.6981.35861",
            "Key": "QueueItemsProcessing:1.0.6981.35861",
            "Description": "Process items from an Orchestrator queue.",
            "Published": "2021-07-23T16:40:07.7933333Z",
            "IsLatestVersion": false,
            "OldVersion": null,
            "ReleaseNotes": null,
            "Authors": "petrina.calota",
            "ProjectType": "Undefined",
            "Tags": null,
            "Id": "QueueItemsProcessing",
            "Arguments": {
                "Input": "[{\"name\":\"argument1\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"argument2\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"argument3\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
                "Output": null
            }
        }
    ]
}