UiPath Orchestrator

Suggest Edits

About OData and References

 

The Orchestrator API implementation is based on the OData protocol. OData (Open Data Protocol) is an ISO/IEC approved, OASIS standard that defines a set of best practices for building and consuming RESTful APIs.

The Open Data Protocol (OData) enables the creation of REST-based data services, which allow resources, identified using URLs and defined in a data model, to be published and edited by Web clients using simple HTTP messages. This specification defines the core semantics and the behavioral aspects of the protocol.

For more information on OData protocol principles and definitions, we recommend checking their official documentation.

Suggest Edits

API References

 

The Orchestrator API Swagger definition can be accessed as follows, depending on your deployment type:

  • on-premise - add the following suffix: /swagger/ui/index#/ to your Orchestrator URL. For example, https://myOrchestrator.com/swagger/ui/index#/.
  • Cloud Platform - add the account and service name, as well as the /swagger/ui/index#/ suffix to the URL. For example, https://platform.uipath.com/[AccountLogicalName]/[ServiceName]/swagger/ui/index#/.
    Find your Account Logical Name in the Site URL field of the Account Settings window.

Important!

Please note that if you are using Cloud Platform, all requests to Orchestrator endpoints should include /[AccountLogicalName]/[ServiceName]/.

The API you see in Swagger is directly dependant on the Orchestrator instance you use. To easily make requests directly in the Swagger documentation, just log in to Orchestrator in another tab. This feature is available starting with the 2017.1 version.

The guide herein is built to support the Swagger documentation, by providing examples for the more trickier Orchestrator endpoints.

A PowerShell library for interacting with your instance of Orchestrator is available here. If you prefer to work with Postman, a small collection is available at this link, which can be imported by clicking the Run in Postman button.

Important!

Starting with 2018.1.3, in Swagger, you can use Windows Authentication to make requests. Previously, you could only make GET requests. POST/PUT/DELETE operations were not supported.

If a user is assigned to more than one tenant, when making requests, the first tenant is always used.

Suggest Edits

Logical Resources and Metadata

 

The following logical resources in Orchestrator can be manipulated using API methods:

  • Account
  • Alerts
  • Assets
  • AuditLogs
  • Environments
  • Folders
  • Jobs
  • Logs
  • Permissions
  • Processes
  • ProcessSchedules
  • QueueDefinitions
  • QueueItemComments
  • QueueItemEvents
  • QueueItems
  • QueueProcessingRecords
  • Queues
  • Releases
  • RobotLogs
  • Robots
  • RobotsService
  • Roles
  • Sessions
  • Settings
  • Stats
  • Status
  • Tenants
  • UserLoginAttempts
  • Users

The Orchestrator API provides custom methods for querying stats about various entities registered in Orchestrator. Each logical resource is an OData entity. All entities (such as Robot, Process, Queue) have properties, relationships, and operations.

Suggest Edits

Available Operations

 

CRUD Operations

These types of operations are available on logical resources most. CRUD operations include GET, POST, PUT and DELETE requests, but please note that not all logical resources make use of all these verbs due to both technical and business reasons.

Requesting Data

It is possible to request particular information from a particular resource, in conjunction with GET operations, through OData-specific parameters.

They enable you to query, filter, sort, select and expand information. More details can be found in the official OData documentation.

Custom Actions

The following custom actions and actions which are not tied to a logical resource are available in the Orchestrator API:

  • Stats methods provide aggregates information on different entities;
  • Account methods provide authentication methods to Orchestrator;
  • Queues methods are used by the Robot to access queues, while the QueueDefinitions endpoint should be used instead for external systems via API;
  • QueueProcessingRecords methods offer statistical and aggregate information about queues;
  • RobotsService resources can be used by Orchestrator to communicate with the Robot.
Suggest Edits

Managing Logical Resources

 

About the Response and Request Schema

To view the response and request schema click the Expand Operations button next to the resource you are interested in.

In the Response Class section, you can view the entire model of the resource along with explanations about how to populate parameters, or an example of how the information you have requested can look like.

The Parameters section contains all the available parameters supported by the selected resource, along with a short explanation. Additionally, all the supported parameters can be populated with information so that you can actually try the Orchestrator API as you read the documentation.

Listing Operations

To view all the operations available for a specific resource, click the List Operations button next to the resource of interest.

Using the Response Model to Build Request Parameters

The response model of any resource is there to help you understand its structure and how to use it in future requests. It has the following anatomy:

  • The main entity or Dto (data transfer object) and its properties. For each property, the following information is displayed:
    • the accepted value type, written in parenthesis;
    • required or optional - optional parameters are marked as such;
    • an explanation regarding the parameter and the maximum accepted values.
  • The second level entity - only displayed if the main entity contains a resource as a parameter; Please note that there can be multiple second level entities, depending on the main resource.

The total number of resource levels depends on the main entity. For example, RobotDto has three levels, while EnvironmentsDto has two.

Suggest Edits

Building API Requests

 

Important!

For accessing resources in a folder, each request must contain either the FolderId or FolderPath in an HTTP header. This header may be encoded (using Base64 UTF-16 encoding) or plain text.

For example:

  • X-UIPATH-OrganizationUnitId "FolderId"
  • X-UIPATH-FolderPath-Encoded "{Encoded FolderPath value}", or
  • X-UIPATH-FolderPath "PlainText FolderPath value"

If you upgraded and had Organization Units enabled in your previous Orchestrator instance, each OU is migrated as a new Classic folder. Read more about Folders here.

When using the Orchestrator API in conjunction with MSXML, the 204 No Content response may result in a 1223 Status Code and cause errors.

GET Requests

GET requests are usually the simplest ones to make. They help you retrieve data and use generic OData clauses:

  • $top
  • $filter
  • $expand
  • $select
  • $orderby
  • $skip

$top

This clause helps you limit the amount of data you retrieve. It has an upper cap that is determined by the endpoint you are making calls to and the number of such resources that exist on you Orchestrator instances.

For example, this request https://platform.uipath.com/odata/Environments?$top=10 returns the first 10 environments available in the Community Edition of Orchestrator. However, if only 5 environments exist, only those are retrieved.

$filter

This OData clause is used to filter a specific resource according to its properties.

For example, one can filter according to:

  • numeric properties:
    • https://platform.uipath.com/odata/Environments?$filter=Id%20eq%2015 - requests a specific environment based on its Id
  • text properties:
    • https://platform.uipath.com/odata/Environments?$filter=contains(Name,'N')&$top=10 - returns the first 10 environments whose name contains the letter "N"
  • boolean properties:
    • https://platform.uipath.com/odata/Processes?$filter=Title%20eq%20'test'%20%26%20IsLatestVersion%20eq%20true - returns all processes that contain the word "test" and represent the latest version
  • enumerable properties:
    • https://platform.uipath.com/odata/QueueItems?$filter=Priority%20eq%20'High' - returns all queue items that have a High priority
  • the propery of a property:
    • https://platform.uipath.com/odata/Jobs?$top=10$filter=Robot/MachineName%20eq%20'Documentation' - returns the first 10 jobs that were executed by any Robot that exists on the "Documentation" machine

Filter parameters can be combined using logical operators "and", "or" and/or "not" and can be grouped with parentheses "( )", such as the following request:

  • https://platform.uipath.com/odata/Jobs?$top=10&$filter=Robot/MachineName eq 'LAVINIA-PC' and (not(Source eq 'Manual') or StartTime gt 2017-10-28T12:13:00.07Z) - displays the top 10 jobs that are being executred manually or after "2017-10-28T12:13:00.07Z", by a Robot deployed on the "LAVINIA-PC" machine.

$expand

This clause is used to fully load navigation properties of the requested resource.

For example, the following query returns the top 1st job and expands the Robots that executed it, as follows:


GET
https://platform.uipath.com/odata/Jobs?$top=1&$expand=Robot

Request

Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

Response

Content-Type: application/json
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Jobs",
    "@odata.count": 11,
    "value": [
        {
            "Key": "d3780aac-1e80-49b0-bfd3-c8ec6a3939db",
            "StartTime": "2018-01-15T18:03:42.51Z",
            "EndTime": "2018-01-15T18:03:44.353Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "c08beec5-243c-4e08-854d-7c100cd35214",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:03:41.56Z",
            "StartingScheduleId": null,
            "Id": 125153,
            "Robot": {
                "LicenseKey": null,
                "MachineName": "DESKTOP-PMFQGCB",
                "Name": "RoboDrulea",
                "Username": "ALEX",
                "Description": null,
                "Type": "Unattended",
                "Password": null,
                "RobotEnvironments": "",
                "Id": 758,
                "ExecutionSettings": null
            }
        }
    ]
}

$select

This OData clause enables you to specify a subset of resource properties that you want to be returned. If you want to extract multiple resources, you can separate them by using a comma.

For example, to extract only the Id and Name of the first 5 Robots you can use the following query.


GET
https://platform.uipath.com/odata/Robots?$top=5&$select=Id, Name

Request

Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

Response

Content-Type: application/json
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Robots(Id,Name)",
    "@odata.count": 5,
    "value": [
        {
            "Id": 749,
            "Name": "DocBot"
        },
        {
            "Id": 752,
            "Name": "vio"
        },
        {
            "Id": 759,
            "Name": "Stan"
        },
        {
            "Id": 771,
            "Name": "!~#$%^&*()_+=-"
        },
        {
            "Id": 772,
            "Name": "mr robot"
        }
    ]
}

$orderby

The $orderby clause enables you to sort retrieved resources. As with the $select clause, the resources you want to order by are separated by commas, and they can be sorted in an ascending (asc) or descending (desc) order. If neither of these operators are specified, resources are automatically sorted in an ascending manner.

For example, this query displays the first 2 queue items according to their creation time, in ascending order.


GET
https://platform.uipath.com/odata/QueueItems?$top=2&$orderby=CreationTime asc

Request

Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

Response

Content-Type: application/json
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#QueueItems",
    "@odata.count": 1386,
    "value": [
        {
            "QueueDefinitionId": 187,
            "OutputData": null,
            "Status": "New",
            "ReviewStatus": "None",
            "ReviewerUserId": null,
            "Key": "c662d000-4f5b-4681-86bd-b163124d8e2c",
            "Reference": "1",
            "ProcessingExceptionType": null,
            "DueDate": null,
            "Priority": "Low",
            "DeferDate": null,
            "StartProcessing": null,
            "EndProcessing": null,
            "SecondsInPreviousAttempts": 0,
            "AncestorId": null,
            "RetryNumber": 0,
            "SpecificData": "{\"DynamicProperties\":{\"Category\":\"UI Automation.Element.Mouse\"}}",
            "CreationTime": "2018-01-10T16:56:07.133Z",
            "Progress": null,
            "RowVersion": "AAAAAABCVfs=",
            "Id": 1038158,
            "ProcessingException": null,
            "SpecificContent": {
                "Category": "UI Automation.Element.Mouse"
            },
            "Output": null
        },
        {
            "QueueDefinitionId": 187,
            "OutputData": null,
            "Status": "New",
            "ReviewStatus": "None",
            "ReviewerUserId": null,
            "Key": "1b5735cb-97ce-4206-bd7c-040647eba5ab",
            "Reference": "0",
            "ProcessingExceptionType": null,
            "DueDate": null,
            "Priority": "Low",
            "DeferDate": null,
            "StartProcessing": null,
            "EndProcessing": null,
            "SecondsInPreviousAttempts": 0,
            "AncestorId": null,
            "RetryNumber": 0,
            "SpecificData": "{\"DynamicProperties\":{\"Category\":\"UI Automation.Element.Mouse\"}}",
            "CreationTime": "2018-01-10T17:01:26.363Z",
            "Progress": null,
            "RowVersion": "AAAAAABCVf4=",
            "Id": 1038160,
            "ProcessingException": null,
            "SpecificContent": {
                "Category": "UI Automation.Element.Mouse"
            },
            "Output": null 
        }
    ]
}

$skip

This clause enables you to skip the first n number of items, in an indicated filter. For example, this query returns the 3rd, 4th, and 5th Robots in the ascending (alphabetical) order of their name.


GET
https://platform.uipath.com/odata/Robots?$top=5&$orderby=Name asc&$skip=2

Request

Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

Response

Content-Type: application/json
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Robots",
    "@odata.count": 5,
    "value": [
        {
            "LicenseKey": null,
            "MachineName": "midragomir",
            "Name": "mr-Rob",
            "Username": "uipath\\mircea.dragomir",
            "Description": "Alerts",
            "Type": "NonProduction",
            "Password": null,
            "RobotEnvironments": "",
            "Id": 902,
            "ExecutionSettings": null
        },
        {
            "LicenseKey": null,
            "MachineName": "DESKTOP-PMFQGCB",
            "Name": "Stan",
            "Username": "Alex",
            "Description": null,
            "Type": "Unattended",
            "Password": null,
            "RobotEnvironments": "doc_env,a_invoke_env,Group1",
            "Id": 759,
            "ExecutionSettings": null
        },
        {
            "LicenseKey": null,
            "MachineName": "ROPRDWAPP02",
            "Name": "vio",
            "Username": "ROPRDWAPP02\\administrator",
            "Description": null,
            "Type": "Development",
            "Password": null,
            "RobotEnvironments": "doc_env,a_invoke_env",
            "Id": 752,
            "ExecutionSettings": null
        }
    ]
}

POST Requests

The POST HTTP verb helps you create new items, subordinate to other resources. When creating a new resource, POST to the parent, and Orchestrator takes care of associating the new resource with the parent, assigning an ID, and other required information. The data is added through the body of the request, and the response is the entire created object.

You can add new items to a queue, create new assets, environments or processes, assign a reviewer to one or multiple failed transactions, and the list goes on.

Important!

Special characters cannot be escaped in the body of POST requests. To use special characters you need to first declare the parameter you use them in as string, using the following format "Parameter@odata.type": "#String". For a better understanding, please see how the Specific Content parameter was populated in the example below.

The example below enables us to add an item to the "DocQueue" queue, with a high priority, defer and due dates, and two arguments with values.


POST
https://platform.uipath.com/odata/Queues/UiPathODataSvc.AddQueueItem

Request

Content-Type: application/json
{
	"itemData": {
		"Priority": "High",
		"DeferDate": "2018-03-21T13:42:27.654Z",
		"DueDate": "2018-03-25T13:42:27.654Z",
		"Name": "DocQueue",
		"SpecificContent": {
			"Email@odata.type": "#String",
			"Email": "obrian@uipath.com", 
			"Name@odata.type": "#String",
			"Name": "O'Brian"
		}
	}
}

Response

Content-Type: application/json
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#queueItem/$entity",
    "QueueDefinitionId": 188,
    "OutputData": null,
    "Status": "New",
    "ReviewStatus": "None",
    "ReviewerUserId": null,
    "Key": "e9cb2205-0232-4b99-9556-52dc2e686663",
    "Reference": null,
    "ProcessingExceptionType": null,
    "DueDate": "2018-03-25T13:42:27.654Z",
    "Priority": "High",
    "DeferDate": "2018-03-21T13:42:27.654Z",
    "StartProcessing": null,
    "EndProcessing": null,
    "SecondsInPreviousAttempts": 0,
    "AncestorId": null,
    "RetryNumber": 0,
    "SpecificData": "{\"DynamicProperties\":{\"Email\":\"obrian@uipath.com\",\"Name\":\"O'brian\"}}",
    "CreationTime": "2018-03-21T15:31:27.2699068Z",
    "Progress": null,
    "RowVersion": "AAAAAABDGLk=",
    "Id": 1050947,
    "ProcessingException": null,
    "SpecificContent": {
        "Email": "obrian@uipath.com",
        "Name": "O'Brian"
    },
    "Output": null
}}

PUT Requests

PUT is usually required when you want to update the contents of a resource. In general, requests are made to a specific entity by adding its Id in the URL. Note that a PUT call replaces the existing entity with the contents of the request or, if none exists at the designated location, attempts to create it.

It is possible to update queues, environments, organization units, comments on transactions, processes and other resources' details.

The example below changes the description of the environment with Id 312, as well as its type. The response was 200 OK, which means that the information was changed.


PUT
https://platform.uipath.com/odata/Environments(312)

Request

Content-Type: application/json
{
	"Id": 312,
	"Name": "doc_env",
	"Description": "Change the environment description and type through an API PUT call",
	"Type": "Test"
}

Response

Content-Type: application/json
200 OK

The updated information in Orchestrator's GUI:

PATCH Requests

PATCH is used to update the contents of an existing entity, with the desired entity specified by adding its Id in the URL. The body of the request contains only those contents that you want to change. This is distinguished from a PUT call which replaces the current entity with the contents of the subsequent request.

It is possible to use a PATCH request to update Machines, Processes, Robots, Tenants, Users (except the Organization Unit and Roles), and Webhooks entities.

In the below example, we update the Robot with Id 497 to add a description, noting that the only parameter that needs to be included is Description:


PUT
https://platform.uipath.com/odata/Robots(497)

Request

Content-Type: application/json
{
	"Id": 497,
	"Description": "Updating a robot description through an API PATCH call.",
	"Type": "Test"
}

Response

Content-Type: application/json
200 OK

The updated information in Orchestrator's GUI:

DELETE Requests

Using this HTTP verb enables you to mark a specified item as deleted in the database. The resource is usually indicated with the help of its Id in the URL you make the call to. A 204 response should let you know that your request was successful.

It is possible to delete assets, environments, queue item comments, processes, roles, tenants, users and many others.

For example, the call below deletes the queue item comment with the 289 Id. Please note that you can only delete your own comments.


DELETE
https://platform.uipath.com/odata/QueueItemComments(289)

Request

Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

Response

Content-Type: application/json
204 No Content
Suggest Edits

Permissions Per Endpoint

 

Execution Media

Action
Permissions

GET - /odata/ExecutionMedia

ExecutionMedia.View

GET - /odata/ExecutionMedia(Id)

ExecutionMedia.View

GET - /odata/ExecutionMedia/UiPath.Server.Configuration.OData.DownloadMediaByJobId(jobId={jobId})

ExecutionMedia.View

POST - /odata/ExecutionMedia/UiPath.Server.Configuration.OData.DeleteMediaByJobId

ExecutionMedia.View

Folders

Action
Permissions

GET - /odata/Folders

Folders.View or Subfolders.View

POST - /odata/Folders

Folders.Create or Subfolders.Create

DELETE - /odata/Folders{Id}

Folders.Delete or Subfolders.Delete

GET - /odata/Folders{Id}

Folders.View or Subfolders.View

PUT - /odata/Folders{Id}

Folders.Edit or Subfolders.Edit

POST - /odata/Folders/UiPath.Server.Configuration.OData.AssignUsers

Folders.Edit or Subfolders.Edit and Users.View and Roles.View

GET - /odata/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key={key},includeInherited={includeInherited})

Folders.View or Subfolders.View and Users.View

POST - /odata/Folders{Id}/UiPath.Server.Configuration.OData.RemoveUserFromFolder

Folders.Edit or Subfolders.Edit and Users.View

Libraries

Action
Permissions

GET - /odata/Libraries

Libraries.View

GET - /odata/Libraries/UiPath.Server.Configuration.OData.GetVersions(packageId='{packageId}')

Libraries.View

GET - /odata/Libraries/UiPath.Server.Configuration.OData.DownloadPackage(key='{key}')

Libraries.View

DELETE - /odata/Libraries('{Id}')

Libraries.Delete

POST - /odata/Libraries/UiPath.Server.Configuration.OData.UploadPackage

Libraries.Create

Alerts

Action
Permissions

GET - /odata/Alerts

Alerts.View

GET - /odata/Alerts/UiPath.Server.Configuration.OData.GetUnreadCount()

Alerts.View

POST - /odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead

Alerts.View

POST - /odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlert

Alerts.Create

Assets

Action
Permissions

GET - /odata/Assets

Assets.View

POST - /odata/Assets

Assets.Create

PUT - /odata/Assets({Id})

Assets.Edit

DELETE - /odata/Assets({Id})

Assets.Delete

POST - /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByNameForRobotKey

Assets.View

GET - /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId(robotId={robotId},assetName='{assetName}')

Assets.View

AuditLogs

Action
Permissions

GET - /odata/AuditLogs

Audit.View

GET - /odata/AuditLogs/UiPath.Server.Configuration.OData.Reports()

Audit.View

GET - /odata/AuditLogs/UiPath.Server.Configuration.OData.GetAuditLogDetails(auditLogId={auditLogId})

Audit.View

Environments

Action
Permissions

GET - /odata/Environments

Environments.View

GET - /odata/Environments({Id})

Environments.View

GET - /odata/Environments/UiPath.Server.Configuration.OData.GetRobotsForEnvironment(key={key})

Environments.View & Robots.View

GET - /odata/Environments/UiPath.Server.Configuration.OData.GetRobotIdsForEnvironment(key={key})

Environments.View & Robots.View

POST - /odata/Environments

Environments.Create

PUT - /odata/Environments({Id})

Environments.Edit

DELETE - /odata/Environments({Id})

Environments.Delete

POST - /odata/Environments({Id})/UiPath.Server.Configuration.OData.AddRobot

Environments.Edit

POST - /odata/Environments({Id})/UiPath.Server.Configuration.OData.RemoveRobot

Environments.Edit

POST - /odata/Environments({Id})/UiPath.Server.Configuration.OData.SetRobots

Environments.Edit

Jobs

Action
Permissions

GetJobs

Jobs.View

GetJobs(Id)

Jobs.View

StartJobs

Jobs.Create

StopJob

Jobs.Edit

StopJobs

Jobs.Edit

Logs

Action
Permissions

SubmitLogs

Logs.Create

PostLogs

Logs.Create

Permissions

Action
Permissions

GetPermissions

-

Processes

Action
Permissions

GET - /odata/Processes

Packages.View

GET - /odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='{processId}')

Packages.View

DELETE - /odata/Processes('{Id}')

Packages.Delete

POST - /odata/Processes/UiPath.Server.Configuration.OData.UploadPackage

Packages.Create

GET - /odata/Processes/UiPath.Server.Configuration.OData.DownloadPackage(key='{key}')

Packages.View

GET - /odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='{key}')

Packages.View

POST - /odata/Processes/UiPath.Server.Configuration.OData.SetArguments

Packages.Edit

QueueDefinitions

Action
Permissions

GetQueueDefinitions

Queues.View

GetQueueDefinitions(Id)

Queues.View

Reports

Queues.View & Transactions.View

PutQueueDefinitions(Id)

Queues.Edit

PostQueueDefinitions

Queues.Create

DeleteQueueDefinitions(Id)

Queues.Delete

QueueItemComments

Action
Permissions

GetQueueItemComments

Queues.View & Transactions.View

GetQueueItemCommentsHistory

Queues.View & Transactions.View

GetQueueItemComments(Id)

Queues.View & Transactions.View

PostQueueItemComments

Queues.View & Transactions.Edit

PutQueueItemComments(Id)

Queues.View & Transactions.Edit

DeleteQueueItemComments(Id)

Queues.View & Transactions.Edit

LicensesNamedUser

Action
Permissions

GET - /odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='{robotType}')

License.View

LicensesRuntime

Action
Permissions

GET - /odata/LicensesRuntime/UiPath.Server.Configuration.OData.GetLicensesRuntime(robotType='robotType')

License.View

POST - /odata/LicensesRuntime('{Key}')/UiPath.Server.Configuration.OData.ToggleEnabled

Machines.Edit

QueueItemEvents

Action
Permissions

GET - /odata/QueueItemEvents

Queues.View & Transactions.View

GET - /odata/QueueItemEvents/UiPath.Server.Configuration.OData.GetQueueItemEventsHistory(queueItemId=queueItemId)

Queues.View & Transactions.View

GET - /odata/QueueItemEvents(Id)

Queues.View & Transactions.View

QueueItems

Action
Permissions

GetQueueItems

Queues.View & Transactions.View

GetQueueItems(Id)

Queues.View & Transactions.View

SetTransactionProgress

Queues.View & Transactions.Edit

GetItemProcessingHistory

Queues.View & Transactions.View

SetItemReviewStatus

Queues.View & Transactions.Edit

DeleteQueueItems(Id)

Queues.View & Transactions.Delete

DeleteBulk

Queues.View & Transactions.Delete

SetItemReviewer

Queues.View & Transactions.Edit

UnsetItemReviewer

Queues.View & Transactions.Edit

GetReviewers

Queues.View & Transactions.Edit

QueueProcessingRecords

Action
Permissions

RetrieveLastDaysProcessingRecords

Queues.View & Transactions.View

RetrieveQueuesProcessingStatus

Queues.View

Queues

Action
Permissions

SetTransactionResult

Queues.View & Transactions.Edit

AddQueueItem

Queues.View & Transactions.Create

StartTransaction

Queues.View & Transactions.View & Transactions.Create & Transactions.Edit

BulkAddQueueItems

Queues.View & Transactions.Create

Releases

Action
Permissions

GET - /odata/Releases({Id})

Processes.View

GET - /odata/Releases

Processes.View

POST - /odata/Releases

Processes.Create

DELETE - /odata/Releases({Id})

Processes.Delete

PATCH - /odata/Releases({Id})

Processes.Edit

PUT - /odata/Releases({Id})

Processes.Edit

POST - /odata/Releases({Id})/UiPath.Server.Configuration.OData.UpdateToSpecificPackageVersion

Processes.Edit

POST - /odata/Releases({Id})/UiPath.Server.Configuration.OData.UpdateToLatestPackageVersion

Processes.Edit

POST - /odata/Releases/UiPath.Server.Configuration.OData.UpdateToLatestPackageVersionBulk

Processes.Edit

POST - /odata/Releases({Id})/UiPath.Server.Configuration.OData.RollbackToPreviousReleaseVersion

Processes.Edit

UserLoginAttempts

Action
Permissions

GET - /odata/UserLoginAttempts({Id})

Requires authentication.

RobotLogs

Action
Permissions

GetRobotLogs

Logs.View

GetTotalCount

Logs.View

Reports

Logs.View

Robots

Action
Permissions

GET - /odata/Robots

Robots.View

GET - /odata/Robots({Id})

Robots.View

POST - /odata/Robots

Robots.Create

PUT - /odata/Robots({Id})

Robots.Edit

PATCH - /odata/Robots({Id})

Robots.Edit

DELETE - /odata/Robots({Id})

Robots.Delete

POST - /odata/Robots/UiPath.Server.Configuration.OData.DeleteBulk

Robots.Delete

GET - /odata/Robots/UiPath.Server.Configuration.OData.GetMachineNameToLicenseKeyMappings()

Robots.Create & Machines.View

GET - /odata/Robots/UiPath.Server.Configuration.OData.GetUsernames()

Robots.View

GET - /odata/Robots/UiPath.Server.Configuration.OData.GetRobotsForProcess(processId='{processId}')

Robots.View & Environments.View & Processes.View

POST - /odata/Robots/UiPath.Server.Configuration.OData.ConvertToFloating

Robots.Edit

ProcessSchedules

Action
Permissions

GetProcessSchedules

Schedules.View

GetProcessSchedules(Id)

Schedules.View

GetRobotIdsForSchedule

Schedules.View

PostProcessSchedules

Schedules.Create

PutProcessSchedules(Id)

Schedules.Edit

SetEnabled

Schedules.Edit

DeleteProcessSchedules(Id)

Schedules.Delete

Sessions

Action
Permissions

GetSessions

Robots.View

Roles

Action
Permissions

GetRoles

Roles.View

GetRoles(Id)

Roles.View

PostRoles

Roles.Create

PutRoles(Id)

Roles.Edit

DeleteRoles(Id)

Roles.Delete

SetUsers

Users.Edit

GetUsersForRole

Roles.View & Users.View

GetUserIdsForRole

Roles.View or Users.View

Settings

Action
Permissions

GetSettings

Settings.View

GetSettings(Id)

Settings.View

PutSettings(Id)

Settings.Edit

UpdateBulk

Settings.Edit

GetWebSettings

Requires authentication.

GetExecutionSettingsConfiguration

Settings.Edit or Robots.Create or Robots.Edit

GetConnectionString

Settings.View

UploadLicense

License.Create or License.Edit

DeleteLicense

License.Deletes

GetLicense

Requires authentication.

Stats

Action
Permissions

GetSessionsStats

Robots.View

GetJobsStats

Jobs.View

Users

Action
Permissions

GetUsers

Users.View

GetUsers(Id)

Users.View

PostUsers

Users.Create

PutUsers

Users.Edit

PatchUsers(Id)

Users.Edit

DeleteUsers(Id)

Users.Delete

GetCurrentPermissions

Requires authentication.

ToggleRole

Users.Edit

ImportUsers

Users.Create

SetActive

Users.Edit

ChangeCulture

Requires authentication.

Machines

Action
Permissions

GET - /odata/Machines

Machines.View

GET - /odata/Machines({Id})

Machines.View

POST - /odata/Machines

Machines.Create

PUT - /odata/Machines({Id})

Machines.Edit

DELETE - /odata/Machines({Id})

Machines.Delete

POST - /odata/Machines/UiPath.Server.Configuration.OData.DeleteBulk

Machines.Delete

PATCH - /odata/Machines({Id})

Machines.Edit

Webhooks

Action
Permissions

GetWebhooks

Webhooks.View

GetWebhooks(Id)

Webhooks.View

PostWebhooks

Webhooks.Create

PutWebhooks(Id)

Webhooks.Edit

PatchWebhooks(Id)

Webhooks.Edit

DeleteWebhooks

Webhooks.Delete

Ping

Webhooks.View

GetEventTypes

Webhooks.View

TriggerCustom

Webhooks.View

Suggest Edits

Authenticating

 

The authentication system for the UiPath Orchestrator API uses a bearer token. It requires you to use the credentials you also use to log in to the user interface.

Note!

By default, the bearer token expires after 30 minutes.

For example, to authenticate to the Orchestrator API do the following:

  1. Make a POST request to the https://platform.uipath.com/api/account/authenticate URL with your Orchestrator login credentials, as in the following example:

POST
https://platform.uipath.com/api/account/authenticate

Request

Content-Type: application/json
{
    "tenancyName" : "Documentation",
    "usernameOrEmailAddress" : "Documentation",
    "password" : "DocumentationAPItest"
}

Response

Content-Type: application/json
{
    "result": "Rr22VaC0D6MkzFShb0gKqaw3vYUJSMmo4jJWk5crDYtSbZkxPFuOC9ApMEnug2q8WxEGPkVwmNoaSXzxOBwia1Ecrldg5BUXXErU_VNOo_yt7X_GDF8sMTyErSqO9Gfe7RSinIueQU6Q_axlY4jDnCP5r2LHrAJVdyM8Tg9x3WHnR8MOgeOl290uTsSOM1ezGG-OmFarRqFUPiN2-iE_mo1KNW-9AmT87-p1-ZYTusLaGyTS9jKVGtRhMjjB0l9VyOFvINhjptq8zotCo5cOOVWJeuvh-307ZdcUWHxkFTwoGDS_DpC4D7JrKfp4oWeSkA0SSy95RfzT8KRTmsJGQV0k8VD6HE3aa_7c-FGrCDjRVtDSkTgpQcQFrIXD8kT4P52a_18doKaSB-asQ8scYe_o73fCL4VtqLDb2ZWlAwEChVmorcFjbXnejxuAubjoKaoJH10gzc5_IiCPI8pM-Zm09Z5D1ljsNjWJ_LrmOR3dijuuKUGvCDtyCCCU_JrPRxmdYSXZmHHx_3joAux0-A",
    "targetUrl": null,
    "success": true,
    "error": null,
    "unAuthorizedRequest": false,
    "__abp": true
}
  1. Copy the string in the result parameter of the HTTP response to the Clipboard. This represents the bearer token and can be used in all future requests as follows:
    • as an Authorization header with the Bearer xxxxxxxxxxxxx value, where xxxxxxxxxxxxx represents the string previously copied;
    • if your API testing tool supports it, select the bearer token authorization type and input the string previously copied.

If you are using Swagger to try our API, just log in to your Orchestrator instance in a separate tab.

The Orchestrator API Swagger definition can be accessed as follows, depending on your deployment type:

  • on-premise - add the following suffix: /swagger/ui/index#/ to your Orchestrator URL. For example, https://myOrchestrator.com/swagger/ui/index#/.
  • Cloud Platform - add the account and service name, as well as the /swagger/ui/index#/ suffix to the URL. For example, https://platform.uipath.com/[AccountName]/[ServiceName]/swagger/ui/index#/.

Important!

The Swagger authentication expires according to the parameters set in your Orchestrator instance. By default, it is set to 30 minutes. You can change it by modifying the value of the Auth.Cookie.Expire parameter, in the Web.config file.

Suggest Edits

Environments Requests

 

Important!

Starting with v2018.3, the concept of environment type has been removed and is no longer displayed in the user interface. Rest assured, backward compatibility is still maintained as this option was not removed from the Orchestrator API. However, please note that all new environments created in the user interface are of type Dev.

Retrieve the Environments a Package is Associated With

The following call helps you display only the environments assigned to the "add_queue_items" package.


GET
http://platform.uipath.com/odata/Releases?$filter=ProcessKey eq 'add_queue_items'&$select=EnvironmentName

Request

Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

Response

Content-Type: application/json
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Releases(EnvironmentName)",
    "@odata.count": 2,
    "value": [
        {
            "EnvironmentName": "clean_env"
        },
        {
            "EnvironmentName": "doc_env"
        }
    ]
}

Retrieve all Processes According to an Indicated Environment

The following example lets you retrieve all the processes that are associated with the "doc_env" environment.


GET
https://platform.uipath.com/odata/Releases?$filter=EnvironmentName eq 'doc_env'

Request

Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

Response

Content-Type: application/json
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Releases",
    "@odata.count": 5,
    "value": [
        {
            "Key": "663119a9-cd88-4345-ad9a-e91e96c97eb2",
            "ProcessKey": "add_queue_items",
            "ProcessVersion": "1.0.6586.22741",
            "IsLatestVersion": false,
            "IsProcessDeleted": false,
            "Description": null,
            "Name": "add_queue_items_doc_env",
            "EnvironmentId": 312,
            "EnvironmentName": "doc_env",
            "Id": 422
        },
        {
            "Key": "57fb1bd5-f8fd-40b4-be7b-4a18f34fe293",
            "ProcessKey": "DataScraping",
            "ProcessVersion": "1.0.6586.22750",
            "IsLatestVersion": false,
            "IsProcessDeleted": false,
            "Description": null,
            "Name": "DataScraping_doc_env",
            "EnvironmentId": 312,
            "EnvironmentName": "doc_env",
            "Id": 421
        },
        {
            "Key": "cabdbd2e-0c92-4abe-9266-ac053d660bbc",
            "ProcessKey": "in_progress_items",
            "ProcessVersion": "1.0.6640.35909",
            "IsLatestVersion": false,
            "IsProcessDeleted": false,
            "Description": null,
            "Name": "in_progress_items_doc_env",
            "EnvironmentId": 312,
            "EnvironmentName": "doc_env",
            "Id": 598
        },
        {
            "Key": "795cbab2-8008-4a54-b1cb-f9ff1ece139e",
            "ProcessKey": "new_activities_tests",
            "ProcessVersion": "1.0.6586.22737",
            "IsLatestVersion": false,
            "IsProcessDeleted": false,
            "Description": null,
            "Name": "new_activities_tests_doc_env",
            "EnvironmentId": 312,
            "EnvironmentName": "doc_env",
            "Id": 423
        },
        {
            "Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
            "ProcessKey": "Release_Project",
            "ProcessVersion": "1.0.6589.35468",
            "IsLatestVersion": false,
            "IsProcessDeleted": false,
            "Description": "rockerii",
            "Name": "Release_Project_doc_env",
            "EnvironmentId": 312,
            "EnvironmentName": "doc_env",
            "Id": 440
        }
    ]
}
Suggest Edits

Robots Requests

 

Retrieving Robot Statuses

Note:

If you want to extract the value of the LicenseKey parameter, you have to make a GET request to the /odata/Robots(Id) endpoint.

According to Its Id

The following example enables you to view the current status of the Robot with the 749 Id.


GET
https://platform.uipath.com/odata/Sessions?$top=10&$filter=Robot/Id eq 749&$select=State

Request

Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

Response

Content-Type: application/json
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Sessions(State)",
    "@odata.count": 1,
    "value": [
        {
            "State": "Available"
        }
    ]
}

According to Its Name

The following example enables you to view the current status of the Robot with the DocBot Name.


GET
https://platform.uipath.com/odata/Sessions?$top=10&$filter=Robot/Name eq 'DocBot'&$select=State

Request

Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

Response

Content-Type: application/json
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Sessions(State)",
    "@odata.count": 1,
    "value": [
        {
            "State": "Available"
        }
    ]
}

Retrieving Robot Information According to its State

The example below requests the first 10 Robots that have the Available status and sent a heartbeat in the last 2 minutes. Only the relevant robot information is displayed. You can check the heartbeat by using the Reporting Time parameter and subtract 2 minutes from the current time. As you might know, if a Robot has not sent a heartbeat in the last 2 minutes, it is flagged as unresponsive.


GET
https://platform.uipath.com/odata/Sessions?$top=10&$filter=State eq 'Available' and ReportingTime gt 2018-03-05T03:48:04.147Z&$select=Robot&$expand=Robot

Request

Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

Response

Content-Type: application/json
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Sessions(Robot)",
    "@odata.count": 2,
    "value": [
        {
            "Robot": {
            		"LicenseKey": null,
                "MachineName": "MBOBOC",
                "Name": "DocBot",
                "Username": "UIPATH\\MADALINA.BOBOC",
                "Description": null,
                "Type": "NonProduction",
                "Password": null,
                "RobotEnvironments": "doc_env,WR_env,Group1",
                "Id": 749,
                "ExecutionSettings": null
            }
        },
        {
            "Robot": {
            		"LicenseKey": null,
                "MachineName": "midragomir",
                "Name": "mr-Rob",
                "Username": "uipath\\mircea.dragomir",
                "Description": "Alerts",
                "Type": "NonProduction",
                "Password": null,
                "RobotEnvironments": "",
                "Id": 902,
                "ExecutionSettings": null
            }
        }
    ]
}

The following example looks for the top 10 Robots that have the Disconnected status and expands Robot information.


GET
https://platform.uipath.com/odata/Sessions?$top=10&$filter=State eq 'Disconnected'&$expand=Robot

Request

Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

Response

Content-Type: application/json
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Sessions",
    "@odata.count": 2,
    "value": [
        {
            "State": "Disconnected",
            "ReportingTime": "2018-01-15T18:47:07.93Z",
            "Info": null,
            "IsUnresponsive": false,
            "Id": 718,
            "Robot": {
            		"LicenseKey": null,
                "MachineName": "DESKTOP-PMFQGCB",
                "Name": "Stan",
                "Username": "Alex",
                "Description": null,
                "Type": "Unattended",
                "Password": null,
                "RobotEnvironments": "doc_env,a_invoke_env,Group1",
                "Id": 759,
                "ExecutionSettings": null
            }
        },
        {
            "State": "Disconnected",
            "ReportingTime": "2018-01-18T18:14:14.34Z",
            "Info": null,
            "IsUnresponsive": false,
            "Id": 730,
            "Robot": {
            		"LicenseKey": null,
                "MachineName": "DESKTOP-PMFQGCB",
                "Name": "!~#$%^&*()_+=-",
                "Username": "dragomirmir",
                "Description": null,
                "Type": "NonProduction",
                "Password": null,
                "RobotEnvironments": "WR_env",
                "Id": 771,
                "ExecutionSettings": null
            }
        }
    ]
}

Retrieving Robot Information According to Its Id

The following example retrieves the details of the Robot with the 216 Id. Please note that this Robot uses smart card authentication.


GET
https://platform.uipath.com/odata/Robots(216)

Request

Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Robots/$entity",
  "LicenseKey": "fdcde999-994d-4dec-a99a-5eb9998e2351",
  "MachineName": "DOC",
  "MachineId": 84,
  "Name": "admin",
  "Username": "admin",
  "Description": null,
  "Version": "18.4.0.90",
  "Type": "Unattended",
  "HostingType": "Standard",
  "Password": "••••••••••••••••••••",
  "CredentialType": "SmartCard",
  "RobotEnvironments": "",
  "Id": 216,
  "ExecutionSettings": {}
}

Retrieving All Robots That Can Execute a Specific Process

The following example makes a request to the /odata/Robots/UiPath.Server.Configuration.OData.GetRobotsForProcess. It enables you to identify, on the fly, which Robots can execute the package with the input_output_arguments_example id.


GET
https://platform.uipath.com/odata/Robots/UiPath.Server.Configuration.OData.GetRobotsForProcess(processId='input_output_arguments_example')

Request

Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Robots",
  "@odata.count": 2,
  "value": [
    {
      "LicenseKey": null,
      "MachineName": "DESKTOP-ASBD",
      "MachineId": 129,
      "Name": "Stan",
      "Username": "Alex",
      "Description": null,
      "Version": null,
      "Type": "Unattended",
      "HostingType": "Standard",
      "Password": null,
      "RobotEnvironments": "doc_env,a_invoke_env,Group1",
      "Id": 759,
      "ExecutionSettings": null
    },
    {
      "LicenseKey": null,
      "MachineName": "Doc",
      "MachineId": 1066,
      "Name": "DocBot",
      "Username": "uipath\\documentation",
      "Description": null,
      "Version": "18.3.0.558",
      "Type": "NonProduction",
      "HostingType": "Standard",
      "Password": null,
      "RobotEnvironments": "doc_env",
      "Id": 1684,
      "ExecutionSettings": null
    }
  ]
}

Retrieving Robot Logs According to the Robot Name

The following example enables you to view Robot logs for the Robot named DocBot.


GET
https://platform.uipath.com/odata/RobotLogs?$top=100&$skip=200&$filter=RobotName eq 'DocBot'

Request

Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

Response

Content-Type: application/json
    {
    "@odata.context": "https://platform.uipath.com/odata/$metadata#RobotLogs",
    "@odata.count": 202,
    "value": [
        {
            "Level": "Info",
            "WindowsIdentity": "UIPATH\\john.smith",
            "ProcessName": "TestingSequence_DOC",
            "TimeStamp": "2019-10-14T13:55:18.2473626Z",
            "Message": "TestingSequence_DOC execution started",
            "JobKey": "e49c0012-ee01-45e4-884c-0ce1f2aa6fbb",
            "RawMessage": "{\r\n  \"message\": \"TestingSequence_DOC execution started\",\r\n  \"level\": \"Information\",\r\n  \"logType\": \"Default\",\r\n  \"timeStamp\": \"2019-10-14T13:55:18.2473626+00:00\",\r\n  \"fingerprint\": \"972a32c3-95d9-4264-ae5d-af589bf4f0b5\",\r\n  \"windowsIdentity\": \"UIPATH\\\\petrina.calota\",\r\n  \"machineName\": \"LAPTOP-IN7198N3\",\r\n  \"processName\": \"TestingSequence_DOC\",\r\n  \"processVersion\": \"1.1.7024.37929\",\r\n  \"jobId\": \"e49c0012-ee01-45e4-884c-0ce1f2aa6fbb\",\r\n  \"robotName\": \"G\",\r\n  \"machineId\": 229978,\r\n  \"organizationUnitId\": 67543,\r\n  \"fileName\": \"Main\"\r\n}",
            "RobotName": "DocBot",
            "MachineId": 229978,
            "Id": 0
        },
        {
            "Level": "Info",
            "WindowsIdentity": "UIPATH\\john.smith",
            "ProcessName": "TestingSequence_DOC",
            "TimeStamp": "2019-10-14T13:57:21.4985672Z",
            "Message": "TestingSequence_DOC execution ended",
            "JobKey": "e49c0012-ee01-45e4-884c-0ce1f2aa6fbb",
            "RawMessage": "{\r\n  \"message\": \"TestingSequence_DOC execution ended\",\r\n  \"level\": \"Information\",\r\n  \"logType\": \"Default\",\r\n  \"timeStamp\": \"2019-10-14T13:57:21.4985672+00:00\",\r\n  \"fingerprint\": \"e973b4f2-deec-4290-978b-3a8af0769b35\",\r\n  \"windowsIdentity\": \"UIPATH\\\\petrina.calota\",\r\n  \"machineName\": \"LAPTOP-IN7198N3\",\r\n  \"processName\": \"TestingSequence_DOC\",\r\n  \"processVersion\": \"1.1.7024.37929\",\r\n  \"jobId\": \"e49c0012-ee01-45e4-884c-0ce1f2aa6fbb\",\r\n  \"robotName\": \"G\",\r\n  \"machineId\": 229978,\r\n  \"organizationUnitId\": 67543,\r\n  \"totalExecutionTimeInSeconds\": 123,\r\n  \"totalExecutionTime\": \"00:02:03\",\r\n  \"fileName\": \"Main\"\r\n}",
            "RobotName": "DocBot",
            "MachineId": 229978,
            "Id": 0
        }
  ]
}

Note

GET requests for Robot logs stored using Elasticsearch only retrieve the first 10000 entries. This is due to an Elasticsearch limitation, and it does not occur if you are using SQL.
Using $top and $skip parameters which go beyond the 10000 limit returns the following error message: Depth of pagination is limited in Elasticsearch by the max_result_window index setting. Make sure skip + take is lower than 10000.

Only the following condition-verb combinations are supported when parameterizing requests for Robot logs stored using Elasticsearch: RobotName eq, JobKey eq, MachineId eq, Level ge, TimeStamp gt.

Editing Robot Information

The following example changes the type and name of the Robot with the 749 Id.

Important!

When making PUT requests to the Robots endpoint please take into account the following:

  • the Robot username and password are not updated when you send the same username and a null or empty password.
  • if a new username is sent with a null or empty password, the Robot credentials are updated and the new username is used.

PUT
https://platform.uipath.com/odata/Robots(749)

Request

Content-Type: application/json

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "LicenseKey": "8ec4t984-b2d7-44f2-b5be-0a64ee9a487b",
  "MachineName": "MBOBOC",
  "Name": "DocBot",
  "Type": "Development",
  "Id": 749,
  "Username": "UIPATH\\JustAnotherRobot"
}

	

  



			

			
Deleting Robots


Deleting a Single Robot


			

			

  

    

    

      DELETE
      

        https://platform.uipath.com/odata/Robots(79)
      

    

  





  

  

    
Request

    
Content-Type: application/json

    

	

  

   

  

    
Response

    

    
204 No Content
	

  



			

			
Deleting Several Robots


To delete multiple Robots at the same time perform a POST request to the /Robots/UiPath.Server.Configuration.OData.DeleteBulk endpoint.


			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Robots/UiPath.Server.Configuration.OData.DeleteBulk
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
	"robotIds": [119, 120]
}

	

  

   

  

    
Response

    

    
204 No Content
	

  



			

		

	

	

		

		

	


Suggest Edits
Retrieving License Information
 



	

		

			
The following request can only be performed on one tenant at a time. If you are using Swagger, this query is executed on the tenant you are logged into Orchestrator when making the request. If you are using an API testing tool, then the tenant you make this request for is the one used to generate the bearer token.


			

			

  

    

    

      GET
      

        	https://platform.uipath.com/odata/Settings/UiPath.Server.Configuration.OData.GetLicense
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#UiPath.Application.Dto.License.LicenseDto",
    "ExpireDate": 1545392350,
    "IsRegistered": true,
    "Concurrent": false,
    "IsExpired": false,
    "AllowedRobots": {
        "Unattended": 50,
        "Attended": 50,
        "NonProduction": 50,
        "Development": 50
    },
    "DefinedRobots": {
        "Unattended": 1,
        "Attended": 0,
        "NonProduction": 3,
        "Development": 1
    },
    "ConcurrentRobots": {
        "Unattended": 0,
        "Attended": 0,
        "NonProduction": 0,
        "Development": 0
    }
}

	

  



			

		

	

	

		

		

	


Suggest Edits
Packages Requests
 



	

		

			
Retrieving All Available Versions for a Specific Package


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='input_output_arguments_example')
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Processes",
  "@odata.count": 2,
  "value": [
    {
      "IsActive": true,
      "Title": null,
      "Version": "1.0.3",
      "Key": "input_output_arguments_example:1.0.3",
      "Description": "Blank Process",
      "Published": "2018-10-09T10:04:33.4667132Z",
      "IsLatestVersion": true,
      "OldVersion": null,
      "ReleaseNotes": null,
      "Authors": "madalina.boboc",
      "Id": "input_output_arguments_example",
      "Arguments": {
        "Input": "[\r\n  {\r\n    \"name\": \"LinkedInUsername\",\r\n    \"type\": \"System.String, 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\": \"LinkedInPassword\",\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]",
        "Output": "[\r\n  {\r\n    \"name\": \"ExtractedDataTable\",\r\n    \"type\": \"System.Data.DataTable, System.Data, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n  }\r\n]"
      }
    },
    {
      "IsActive": false,
      "Title": null,
      "Version": "1.0.2",
      "Key": "input_output_arguments_example:1.0.2",
      "Description": "Blank Process",
      "Published": "2018-09-07T15:53:36.4774871Z",
      "IsLatestVersion": false,
      "OldVersion": null,
      "ReleaseNotes": null,
      "Authors": "madalina.boboc",
      "Id": "input_output_arguments_example",
      "Arguments": 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://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.DownloadPackage(key='add_queue_items:1.0.6654.27080')
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    

    
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://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='input_output_test%3A1.3.5')
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
	"@odata.context": "https://platform.uipath.com/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. 


			

			

				
Important!
				

				
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://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.SetArguments
      

    

  





  

  

    
Request

    
Content-Type: application/json

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

    

    
200 OK

	

  



			

		

	

	

		

		

	


Suggest Edits
Processes Requests
 



	

		

			
Retrieving Processes According to Their Name


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Releases?$filter=%20Name%20eq%20'all_activities_DocEnv'
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Releases",
  "@odata.count": 1,
  "value": [
    {
      "Key": "01b7cf62-98e0-4a69-9a65-be7514643229",
      "ProcessKey": "all_activities",
      "ProcessVersion": "1.0.6666.26728",
      "IsLatestVersion": false,
      "IsProcessDeleted": false,
      "Description": null,
      "Name": "all_activities_DocEnv",
      "EnvironmentId": 7,
      "EnvironmentName": "DocEnv",
      "InputArguments": null,
      "Id": 6,
      "Arguments": null
    }
  ]
}

	

  



			

			
Changing the Value of the Input Parameters of a Specific Process


The following PATCH request to the /odata/Releases(Id) endpoint enables you to add or change the values of specific input parameters, at process level. If you want to add these values when starting a job, please see the Job Requests topic.


			

			

				
Important!
				

				
Please note that a maximum of 10.000 characters is accepted for the entire length of the JSON representation of input parameters, including argument names, all the escaped characters, spaces, brackets, and arguments values.


				

			

			

  

    

    

      PATCH
      

        https://platform.uipath.com/odata/Releases(55)
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
  "Arguments": {
    "Input": "{\"age\":27,\"trueOrFalse\":false,\"stringNew\":\"testing\"}"
  }
}

	

  

   

  

    
Response

    

    
200 OK

	

  



			

		

	

	

		

		

	


Suggest Edits
Libraries Requests
 



	

		

			
Retrieving Libraries from a Specific Author


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Libraries?$filter=Authors%20eq%20'madalina.boboc'
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Libraries",
  "@odata.count": 1,
  "value": [
    {
      "Title": null,
      "Version": "1.0.6666.26742",
      "Key": "processing_items:1.0.6666.26742",
      "Description": "Blank Project",
      "Published": "2018-10-11T16:45:28.6265116Z",
      "IsLatestVersion": true,
      "OldVersion": null,
      "ReleaseNotes": null,
      "Authors": "madalina.boboc",
      "Id": "processing_items"
    }
  ]
}

	

  



			

			
Deleting a Library


			

			

				
Important!
				

				
Please note that only host administrators can delete libraries.


				

			

			

  

    

    

      DELETE
      

        https://platform.uipath.com/odata/Libraries('BlankLibraryProj')
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    

    
200 OK

	

  



			

		

	

	

		

		

	


Suggest Edits
Jobs Requests
 



	

		

			
Requesting Jobs Started By a Specific Robot


According to the Robot Id


As you can see in the example below, we requested the top 3 jobs, but only 1 was returned as only one job was found that was ran on the Robot with the 749 Id.


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Jobs?$top=3&$filter=Robot/Id eq 749
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Jobs",
    "@odata.count": 13,
    "value": [
        {
            "Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
            "StartTime": "2018-01-15T18:18:02.79Z",
            "EndTime": "2018-01-15T18:18:47.587Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
            "Info": "Job completed",
            "CreationTime": "2018-01-15T18:18:01.623Z",
            "StartingScheduleId": null,
            "Id": 125161
        },
        {
            "Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
            "StartTime": "2018-03-02T17:25:35.17Z",
            "EndTime": "2018-03-02T17:25:46.62Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
            "Info": "Job completed",
            "CreationTime": "2018-03-02T17:25:34.087Z",
            "StartingScheduleId": null,
            "Id": 127283
        },
        {
            "Key": "e29e472d-5d51-4369-9c15-af867e6dd580",
            "StartTime": "2018-03-05T18:27:27.123Z",
            "EndTime": "2018-03-05T18:27:38.593Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "ad498d35-326c-4c6c-89d0-16fb73abd0c8",
            "Info": "Execution error : System.ArgumentException: The sheet does not exist\r\n   at UiPath.Excel.WorkbookApplication.SetSheet(String sheetName, Boolean createNew)\r\n   at UiPath.Excel.Activities.ExcelInteropActivity`1.BeginExecute(AsyncCodeActivityContext context, AsyncCallback callback, Object state)\r\n   at System.Activities.AsyncCodeActivity.InternalExecute(ActivityInstance instance, ActivityExecutor executor, BookmarkManager bookmarkManager)\r\n   at System.Activities.ActivityInstance.Execute(ActivityExecutor executor, BookmarkManager bookmarkManager)\r\n   at System.Activities.Runtime.ActivityExecutor.ExecuteActivityWorkItem.ExecuteBody(ActivityExecutor executor, BookmarkManager bookmarkManager, Location resultLocation)",
            "CreationTime": "2018-03-05T18:27:25.793Z",
            "StartingScheduleId": null,
            "Id": 127416
        }
    ]
}

	

  



			

			
According to the Robot Name


This call requests all top 10 jobs that were executed by a Robot with the "DocBot" name, but only 1 was returned as only one job was found. 


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Jobs?$top=10&$filter=Robot/Name eq 'DocBot'
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Jobs",
    "@odata.count": 1,
    "value": [
        {
            "Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
            "StartTime": "2018-01-15T18:18:02.79Z",
            "EndTime": "2018-01-15T18:18:47.587Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
            "Info": "Job completed",
            "CreationTime": "2018-01-15T18:18:01.623Z",
            "StartingScheduleId": null,
            "Id": 125161
        }
    ]
}

	

  



			

			
According to a Specific Robot Id, with a Specific State


The following example looks for the first 10 jobs that were processed by a Robot with the 749 Id and are in the Successful state. As you can see, only two results were returned.


			

			

  

    

    

      GET
      

        	https://platform.uipath.com/odata/Jobs?$top=10&$filter=Robot/Id eq 749 and State eq 'Successful'
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Jobs",
    "@odata.count": 2,
    "value": [
        {
            "Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
            "StartTime": "2018-01-15T18:18:02.79Z",
            "EndTime": "2018-01-15T18:18:47.587Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
            "Info": "Job completed",
            "CreationTime": "2018-01-15T18:18:01.623Z",
            "StartingScheduleId": null,
            "Id": 125161
        },
        {
            "Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
            "StartTime": "2018-03-02T17:25:35.17Z",
            "EndTime": "2018-03-02T17:25:46.62Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
            "Info": "Job completed",
            "CreationTime": "2018-03-02T17:25:34.087Z",
            "StartingScheduleId": null,
            "Id": 127283
        }
    ]
}

	

  



			

			
According to Start Date and Robot Id


The following query searches for the top 10 jobs that were executed by a Robot with the 749 Id, starting with the 22nd of September 2017, 09:59:22.837. 


			

			

  

    

    

      GET
      

        	 https://platform.uipath.com/odata/Jobs?$top=10&$filter=Robot/Id eq 749 and StartTime gt 2017-09-22T09:59:22.837Z
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Jobs",
    "@odata.count": 2,
    "value": [
        {
            "Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
            "StartTime": "2018-01-15T18:18:02.79Z",
            "EndTime": "2018-01-15T18:18:47.587Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
            "Info": "Job completed",
            "CreationTime": "2018-01-15T18:18:01.623Z",
            "StartingScheduleId": null,
            "Id": 125161
        },
        {
            "Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
            "StartTime": "2018-03-02T17:25:35.17Z",
            "EndTime": "2018-03-02T17:25:46.62Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
            "Info": "Job completed",
            "CreationTime": "2018-03-02T17:25:34.087Z",
            "StartingScheduleId": null,
            "Id": 127283
        }
    ]
}

	

  



			

			
According to Robot Id and End Date


The example below enables you to look for the first 10 jobs that were executed by the Robot with the 759 Id and finished running after the 22nd of February 2018, 10:00:00.837. Since only three jobs matched all these parameters, only those were returned in the Response section. 


			

			

  

    

    

      GET
      

        	 https://platform.uipath.com/odata/Jobs?$top=10&$filter=Robot/Id eq 759 and EndTime lt 2018-02-22T10:00:00.837Z
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Jobs",
    "@odata.count": 3,
    "value": [
        {
            "Key": "45383b6c-a547-49e1-be5c-f3bb6d78982c",
            "StartTime": "2018-01-15T18:17:14.693Z",
            "EndTime": "2018-01-15T18:17:14.693Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "9eda64eb-3ab8-46e8-833d-fe944a4eb25e",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:17:13.59Z",
            "StartingScheduleId": null,
            "Id": 125160
        },
        {
            "Key": "4b018719-36cb-43a1-8096-202641ccee62",
            "StartTime": "2018-01-15T18:19:03.177Z",
            "EndTime": "2018-01-15T18:19:03.177Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "7a60ce9d-a5a6-4e9f-b908-ab5819b016c2",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:19:02.37Z",
            "StartingScheduleId": null,
            "Id": 125162
        },
        {
            "Key": "4420820e-7b0a-49a3-a172-ddcc1d88ace9",
            "StartTime": "2018-01-15T18:20:07.93Z",
            "EndTime": "2018-01-15T18:20:22.68Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "843d9f41-ae7b-4a28-bd32-d57006f90a2f",
            "Info": "Job completed",
            "CreationTime": "2018-01-15T18:20:06.733Z",
            "StartingScheduleId": null,
            "Id": 125163
        }
    ]
}

	

  



			

			
Starting a Job


The following request enables you to start the execution of the indicated process (through the ReleaseKey parameter), on all the available Robots that are in the associated environment. 


			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
  "startInfo": {
    "ReleaseKey": "795cbab2-8008-4a54-b1cb-f9ff1ece139e",
    "Strategy": "All",
    "RobotIds": [],
    "NoOfRobots": 0
  }
}

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Jobs",
  "value": [
    {
      "Key": "31ade17f-5a35-4250-beea-43922dc2a20d",
      "StartTime": null,
      "EndTime": null,
      "State": "Pending",
      "Source": "Manual",
      "BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
      "Info": null,
      "CreationTime": "2018-03-19T19:01:58.6806126Z",
      "StartingScheduleId": null,
      "Id": 128209
    },
    {
      "Key": "c4caf051-9db6-486d-8078-231f9dec1a4c",
      "StartTime": null,
      "EndTime": null,
      "State": "Pending",
      "Source": "Manual",
      "BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
      "Info": null,
      "CreationTime": "2018-03-19T19:01:58.7610094Z",
      "StartingScheduleId": null,
      "Id": 128210
    },
    {
      "Key": "969552ba-cfe5-4e87-adde-c85a358ae96f",
      "StartTime": null,
      "EndTime": null,
      "State": "Pending",
      "Source": "Manual",
      "BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
      "Info": null,
      "CreationTime": "2018-03-19T19:01:58.8212679Z",
      "StartingScheduleId": null,
      "Id": 128211
    }
  ]
}

	

  



			

			
Starting a Job with Custom Values for Input Parameters


The following POST request to the /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs endpoint enables you to add custom values for input parameters while also starting a job on a specific Robot.


			

			

				
Important!
				

				
Please note that a maximum of 10.000 characters is accepted for the entire length of the JSON representation of input parameters, including argument names, all the escaped characters, spaces, brackets, and arguments values.


If you provide values for integer input parameters when making start job API calls which are also valid ASCII values, please note that they are changed. For example, 0065 becomes 53.


				

			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
	"startInfo": {
		"ReleaseKey": "429cf1cc-283c-424f-a935-43f72c2ca719",
		"RobotIds": [121],
		"JobsCount": 0,
		"Strategy": "Specific",
		"InputArguments": "{\"age\":33,\"trueOrFalse\":false,\"stringNew\":\"testing\"}"
	}
}

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://uipath-alpha.azurewebsites.net/odata/$metadata#Jobs",
    "value": [
        {
            "Key": "0fbdbecb-3677-4c33-a491-a1f7ed4ff886",
            "StartTime": null,
            "EndTime": null,
            "State": "Pending",
            "Source": "Manual",
            "SourceType": "Manual",
            "BatchExecutionKey": "e188f409-c504-47b7-b2cf-30b8fe423f87",
            "Info": null,
            "CreationTime": "2018-08-27T16:41:00.4773869Z",
            "StartingScheduleId": null,
            "ReleaseName": "input_output_test_DocEnv",
            "Type": "Unattended",
            "InputArguments": "{\"age\":33,\"trueOrFalse\":false,\"stringNew\":\"testing\"}",
            "OutputArguments": null,
            "Id": 21767
        }
    ]
}

	

  



			

			
Retrieving Jobs that were Executed by an Indicated Environment


The following example enables us to get the first two jobs that were executed by Robots that are part of the environment with the 312 Id and expand the process information. 


			

			

  

    

    

      GET
      

        http://platform.uipath.com/odata/Jobs?$top=2&$expand=Release&$filter=Release/EnvironmentId eq 312
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Jobs",
    "@odata.count": 26,
    "value": [
        {
            "Key": "d3780aac-1e80-49b0-bfd3-c8ec6a3939db",
            "StartTime": "2018-01-15T18:03:42.51Z",
            "EndTime": "2018-01-15T18:03:44.353Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "c08beec5-243c-4e08-854d-7c100cd35214",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:03:41.56Z",
            "StartingScheduleId": null,
            "Id": 125153,
            "Release": {
                "Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
                "ProcessKey": "Release_Project",
                "ProcessVersion": "",
                "IsLatestVersion": false,
                "IsProcessDeleted": false,
                "Description": "rockerii",
                "Name": "Release_Project_doc_env",
                "EnvironmentId": 312,
                "EnvironmentName": null,
                "Id": 440
            }
        },
        {
            "Key": "93b0bfc1-cb80-4594-bb3e-9f35f3efc828",
            "StartTime": "2018-01-15T18:05:42.393Z",
            "EndTime": "2018-01-15T18:05:42.393Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "2f894a2b-7ba1-4eee-b399-c67894a9b3ec",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:05:41.093Z",
            "StartingScheduleId": null,
            "Id": 125154,
            "Release": {
                "Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
                "ProcessKey": "Release_Project",
                "ProcessVersion": "",
                "IsLatestVersion": false,
                "IsProcessDeleted": false,
                "Description": "rockerii",
                "Name": "Release_Project_doc_env",
                "EnvironmentId": 312,
                "EnvironmentName": null,
                "Id": 440
            }
        }
    ]
}

	

  



			

			
Retrieving Faulted Jobs According to Errors


The call below helps you display the first 2 jobs that failed with the `Logon failure: unknown user name or bad password' error, and expands the Robot and process details. You can use this query for any kind of error that is displayed in the Job Details window.


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Jobs?$filter=(CreationTime gt 2017-01-01T00:00:00.000Z and State eq '4' and indexof(Info,'Logon failure: unknown user name or bad password') ne -1)&$expand=Robot,Release&$top=2
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Jobs",
  "@odata.count": 5,
  "value": [
    {
      "Key": "d3780aac-1e80-49b0-bfd3-c8ec6a3939db",
      "StartTime": "2018-01-15T18:03:42.51Z",
      "EndTime": "2018-01-15T18:03:44.353Z",
      "State": "Faulted",
      "Source": "Manual",
      "BatchExecutionKey": "c08beec5-243c-4e08-854d-7c100cd35214",
      "Info": "Logon failure: unknown user name or bad password",
      "CreationTime": "2018-01-15T18:03:41.56Z",
      "StartingScheduleId": null,
      "Id": 125153,
      "Robot": {
        "LicenseKey": null,
        "MachineName": "DESKTOP-PMFQGCB",
        "Name": "RoboDrulea",
        "Username": "ALEX",
        "Description": null,
        "Type": "Unattended",
        "Password": null,
        "RobotEnvironments": "",
        "Id": 758,
        "ExecutionSettings": null
      },
      "Release": {
        "Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
        "ProcessKey": "Release_Project",
        "ProcessVersion": "",
        "IsLatestVersion": false,
        "IsProcessDeleted": false,
        "Description": null,
        "Name": "Release_Project_doc_env",
        "EnvironmentId": 312,
        "EnvironmentName": null,
        "Id": 440
      }
    },
    {
      "Key": "93b0bfc1-cb80-4594-bb3e-9f35f3efc828",
      "StartTime": "2018-01-15T18:05:42.393Z",
      "EndTime": "2018-01-15T18:05:42.393Z",
      "State": "Faulted",
      "Source": "Manual",
      "BatchExecutionKey": "2f894a2b-7ba1-4eee-b399-c67894a9b3ec",
      "Info": "Logon failure: unknown user name or bad password",
      "CreationTime": "2018-01-15T18:05:41.093Z",
      "StartingScheduleId": null,
      "Id": 125154,
      "Robot": {
        "LicenseKey": null,
        "MachineName": "DESKTOP-PMFQGCB",
        "Name": "RoboDrulea",
        "Username": "ALEX",
        "Description": null,
        "Type": "Unattended",
        "Password": null,
        "RobotEnvironments": "",
        "Id": 758,
        "ExecutionSettings": null
      },
      "Release": {
        "Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
        "ProcessKey": "Release_Project",
        "ProcessVersion": "",
        "IsLatestVersion": false,
        "IsProcessDeleted": false,
        "Description": null,
        "Name": "Release_Project_doc_env",
        "EnvironmentId": 312,
        "EnvironmentName": null,
        "Id": 440
      }
    }
  ]
}

	

  



			

			
Stopping Multiple Jobs


The request below enables us to forcefully stop (kill) two jobs. 


			

			

				
Note:
				

				
The strategy parameter can be populated with the following values:


    

  • SoftStop or 1
  • Kill or 2.


				

			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Jobs/UiPath.Server.Configuration.OData.StopJobs
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{ 
	"jobIds": [141888, 141889], 
	"strategy": "Kill"
}

	

  

   

  

    
Response

    

    
200 OK

	

  



			

		

	

	

		

		

	


Suggest Edits
Schedules Requests
 



	

		

			
Starting a Schedule with Dynamic Robot Allocation


The following request enables you to create a schedule named ApiTest, on the GMT Standard Time time zone, which is triggered every 5 months, on Sundays. The "StartStrategy": 15 represents the number of times the job is going to be executed dynamically - on any Robot from the associated environment that is available. 


			

			

				
Important!
				

				
It is possible to create a schedule from the API which has both specific Robots and dynamic allocation parameters. However, please note that the ExecutorRobots parameter is ignored when the dynamic allocation one is used (StartStrategy).


				

			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/ProcessSchedules
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
	"Name": "ApiTest",
	"ReleaseId": 75,
	"ReleaseName": "BlankProcess_DocEnv",
	"StartProcessCron": "0 0 0 ? 1/5 SUN *",
	"StartProcessCronDetails": "{\"type\":4,\"minutely\":{},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[{\"id\":\"SUN\",\"weekly\":\"Sunday\",\"monthly\":\"Sunday\"}],\"atMinute\":0,\"atHour\":0,\"frequencyInMonths\":\"5\"},\"advancedCronExpression\":\"\"}",
	"StartStrategy": 15,
	"ExecutorRobots": [],
	"StopProcessExpression": "",
	"StopStrategy": null,
	"TimeZoneId": "GMT Standard Time"
}

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
	"@odata.context": "https://platform.uipath.com/odata/$metadata#ProcessSchedules/$entity",
	"Enabled": true,
	"Name": "ApiTest",
	"ReleaseId": 75,
	"ReleaseKey": "00000000-0000-0000-0000-000000000000",
	"ReleaseName": null,
	"PackageName": null,
	"EnvironmentName": null,
	"EnvironmentId": "0",
	"StartProcessCron": "0 0 0 ? 1/5 SUN *",
	"StartProcessCronDetails": "{\"type\":4,\"minutely\":{},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[{\"id\":\"SUN\",\"weekly\":\"Sunday\",\"monthly\":\"Sunday\"}],\"atMinute\":0,\"atHour\":0,\"frequencyInMonths\":\"5\"},\"advancedCronExpression\":\"\"}",
	"StartProcessCronSummary": null,
	"StartProcessNextOccurrence": null,
	"StartStrategy": 15,
	"StopProcessExpression": "",
	"StopStrategy": null,
	"ExternalJobKey": "8cda4b35-e835-445b-b477-1ea0961d62e5",
	"TimeZoneId": "GMT Standard Time",
	"TimeZoneIana": "Europe/London",
	"UseCalendar": false,
	"StopProcessDate": null,
	"InputArguments": "{}",
	"Id": 43
}

	

  



			

			
Starting a Schedule with Input Parameters Values


The following POST request to the /odata/ProcessSchedules endpoint allows you to create an enabled schedule with the "API_schedule_test" name on the process with the 55 Id, while also adding custom values for some of the processes' parameters. The schedule starts every five minutes on all available Robots and does not take into account non-working days.


			

			

				
Note:
				

				
A maximum of 10.000 characters is accepted for the entire length of the JSON representation of input parameters, including argument names, all the escaped characters, spaces, brackets, and arguments values.


				

			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/ProcessSchedules
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
      "Enabled": true,
      "Name": "API_schedule_test",
      "ReleaseId": 55,
      "ReleaseKey": "429cf1cc-283c-424f-a935-43f72c2ca719",
      "ReleaseName": "input_output_test_DocEnv",
      "PackageName": "input_output_test",
      "EnvironmentName": "DocEnv",
      "EnvironmentId": "7",
      "StartProcessCron": "0 0/5 * 1/1 * ? *",
      "StartProcessCronDetails": "{\"type\":0,\"minutely\":{\"atMinute\":5},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
      "StartProcessCronSummary": "Every 5 minutes",
      "StartProcessNextOccurrence": null,
      "StartStrategy": 0,
      "StopProcessExpression": "",
      "StopStrategy": null,
      "ExternalJobKey": "af486c19-c797-48cd-b586-cfb7a12110a2",
      "TimeZoneId": "Morocco Standard Time",
      "TimeZoneIana": "Africa/Casablanca",
      "UseCalendar": false,
      "StopProcessDate": null,
      "InputArguments": "{\"arrayStrings\":[\"test\",\"test\"],\"age\":666,\"trueOrFalse\":false,\"dateNow\":\"2012-04-23T18:25:43.511Z\",\"stringNew\":\"stringTest\",\"DoubleTest\":7.555555}",
      "Id": 37
    }

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://uipath-alpha.azurewebsites.net/odata/$metadata#ProcessSchedules/$entity",
    "Enabled": true,
    "Name": "API_schedule_test",
    "ReleaseId": 55,
    "ReleaseKey": "00000000-0000-0000-0000-000000000000",
    "ReleaseName": null,
    "PackageName": null,
    "EnvironmentName": null,
    "EnvironmentId": "0",
    "StartProcessCron": "0 0/5 * 1/1 * ? *",
    "StartProcessCronDetails": "{\"type\":0,\"minutely\":{\"atMinute\":5},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
    "StartProcessCronSummary": "Every 5 minutes",
    "StartProcessNextOccurrence": null,
    "StartStrategy": 0,
    "StopProcessExpression": "",
    "StopStrategy": null,
    "ExternalJobKey": "7ecbff8d-832d-41e1-a3ed-aee0957caffe",
    "TimeZoneId": "Morocco Standard Time",
    "TimeZoneIana": "Africa/Casablanca",
    "UseCalendar": false,
    "StopProcessDate": null,
    "InputArguments": "{\"arrayStrings\":[\"test\",\"test\"],\"age\":666,\"trueOrFalse\":false,\"dateNow\":\"2012-04-23T18:25:43.511Z\",\"stringNew\":\"stringTest\",\"DoubleTest\":7.555555,\"inOutTry\":\"2012-04-23T18:25:43.511Z\"}",
    "Id": 37
}

	

  



			

		

	

	

		

		

	


Suggest Edits
Transaction Requests
 



	

		

			

				
Important!
				

				
Queue items can only be processed by Robots. For example, making a POST request to the /odata/Queues/UiPathODataSvc.StartTransaction endpoint requires information which is only available to the Robot.


				

			

			
Retrieving Transactions According to Their Status and Robot Id


The example below queries the Orchestrator database for the first 10 queue items with the In Progress status that were processed by the Robot with the 749 Id. Lastly, the Robot information is expanded. Please note that the Response was truncated. 


			

			

  

    

    

      GET
      

        	https://platform.uipath.com//odata/QueueItems?$top=10&$expand=Robot&$filter=Status eq 'InProgress' and Robot/Id eq 749
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#QueueItems",
    "@odata.count": 1752,
    "value": [
        {
            "QueueDefinitionId": 188,
            "OutputData": null,
            "Status": "InProgress",
            "ReviewStatus": "None",
            "ReviewerUserId": null,
            "Key": "1c632cc1-44ab-4624-bace-6fbb5fd1c0cd",
            "Reference": "ActivityDescription",
            "ProcessingExceptionType": null,
            "DueDate": null,
            "Priority": "High",
            "DeferDate": null,
            "StartProcessing": "2018-03-07T15:05:05.113Z",
            "EndProcessing": null,
            "SecondsInPreviousAttempts": 0,
            "AncestorId": null,
            "RetryNumber": 0,
            "SpecificData": "{\"DynamicProperties\":{\"Description\":\"Checks if Stop was triggered in UiPath Orchestrator.\"}}",
            "CreationTime": "2018-03-05T18:39:16.06Z",
            "Progress": null,
            "RowVersion": "AAAAAABC3aA=",
            "Id": 1048065,
            "ProcessingException": null,
            "SpecificContent": {
                "Description": "Checks if Stop was triggered in UiPath Orchestrator."
            },
            "Output": null,
            "Robot": {
                "LicenseKey": null,
                "MachineName": "MBOBOC",
                "Name": "DocBot",
                "Username": "UIPATH\\MADALINA.BOBOC",
                "Description": null,
                "Type": "NonProduction",
                "Password": null,
                "RobotEnvironments": "",
                "Id": 749,
                "ExecutionSettings": null
            }
        },
        {
            "QueueDefinitionId": 188,
            "OutputData": null,
            "Status": "InProgress",
            "ReviewStatus": "None",
            "ReviewerUserId": null,
            "Key": "7dfa834b-8398-476e-bd18-b0fa51d4ddf6",
            "Reference": "ActivityDescription",
            "ProcessingExceptionType": null,
            "DueDate": null,
            "Priority": "High",
            "DeferDate": null,
            "StartProcessing": "2018-03-07T15:05:04.503Z",
            "EndProcessing": null,
            "SecondsInPreviousAttempts": 0,
            "AncestorId": null,
            "RetryNumber": 0,
            "SpecificData": "{\"DynamicProperties\":{\"Description\":\"Sets the status of a transaction item to Failed or Successful.\"}}",
            "CreationTime": "2018-03-05T18:39:15.627Z",
            "Progress": null,
            "RowVersion": "AAAAAABC3Z8=",
            "Id": 1048064,
            "ProcessingException": null,
            "SpecificContent": {
                "Description": "Sets the status of a transaction item to Failed or Successful."
            },
            "Output": null,
            "Robot": {
                "LicenseKey": null,
                "MachineName": "MBOBOC",
                "Name": "DocBot",
                "Username": "UIPATH\\MADALINA.BOBOC",
                "Description": null,
                "Type": "NonProduction",
                "Password": null,
                "RobotEnvironments": "",
                "Id": 749,
                "ExecutionSettings": null
            }
        }
    ]
}

	

  



			

			
Viewing the History of an Item


The following call enables you to view all the actions that a specific queue item went through. 


			

			

  

    

    

      GET
      

        	https://platform.uipath.com/odata/QueueItemEvents/UiPath.Server.Configuration.OData.GetQueueItemEventsHistory(queueItemId=1050203)?$orderby=Timestamp&$top=10
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#QueueItemEvents",
    "@odata.count": 5,
    "value": [
        {
            "QueueItemId": 1050203,
            "Timestamp": "2018-03-07T16:02:59.09Z",
            "Action": "Create",
            "Data": null,
            "UserId": 910,
            "UserName": "DocBot",
            "Status": "New",
            "ReviewStatus": "None",
            "ReviewerUserId": null,
            "ReviewerUserName": null,
            "Id": 18276
        },
        {
            "QueueItemId": 1050203,
            "Timestamp": "2018-03-07T18:15:04.46Z",
            "Action": "Status",
            "Data": null,
            "UserId": 910,
            "UserName": "DocBot",
            "Status": "InProgress",
            "ReviewStatus": "None",
            "ReviewerUserId": null,
            "ReviewerUserName": null,
            "Id": 20333
        },
        {
            "QueueItemId": 1050203,
            "Timestamp": "2018-03-07T18:15:05.07Z",
            "Action": "Edit",
            "Data": null,
            "UserId": 910,
            "UserName": "DocBot",
            "Status": "InProgress",
            "ReviewStatus": "None",
            "ReviewerUserId": null,
            "ReviewerUserName": null,
            "Id": 20334
        },
        {
            "QueueItemId": 1050203,
            "Timestamp": "2018-03-07T18:15:05.507Z",
            "Action": "Edit",
            "Data": null,
            "UserId": 910,
            "UserName": "DocBot",
            "Status": "Failed",
            "ReviewStatus": "None",
            "ReviewerUserId": null,
            "ReviewerUserName": null,
            "Id": 20335
        },
        {
            "QueueItemId": 1050203,
            "Timestamp": "2018-03-08T10:47:40.463Z",
            "Action": "Edit",
            "Data": null,
            "UserId": 583,
            "UserName": "admin",
            "Status": "Failed",
            "ReviewStatus": "None",
            "ReviewerUserId": 583,
            "ReviewerUserName": "admin",
            "Id": 21240
        }
    ]
}

	

  



			

			
Retrieving Comments for a Specific Item


The example below displays all the comments of the queue item with the 1050204 Id, in ascending order of creation. 


			

			

  

    

    

      GET
      

        	https://platform.uipath.com/odata/QueueItemComments/UiPath.Server.Configuration.OData.GetQueueItemCommentsHistory(queueItemId=1050204)?$orderby=CreationTime%20desc
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#QueueItemComments",
    "@odata.count": 2,
    "value": [
        {
            "Text": "needs review asap",
            "QueueItemId": 1050204,
            "CreationTime": "2018-03-08T13:41:49.167Z",
            "UserId": 583,
            "UserName": "admin",
            "Id": 320
        },
        {
            "Text": "fixed. excel hiccup.",
            "QueueItemId": 1050204,
            "CreationTime": "2018-03-08T13:46:48.613Z",
            "UserId": 901,
            "UserName": "dragomirmir",
            "Id": 321
        }
    ]
}

	

  



			

			
Retrieving the Average Execution Time for a Specific Queue


The following request enables you to see the average execution time of items in an indicated queue. 


			

			

				
Note:
				

				
This type of request can only be filtered according to the queue name or description, and not queue id.


				

			

			

  

    

    

      GET
      

        	http://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveQueuesProcessingStatus?$filter=QueueDefinitionName eq 'DocQueue'
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Collection(UiPath.Core.Model.Queues.QueueProcessingStatus)",
    "@odata.count": 1,
    "value": [
        {
            "ItemsToProcess": 682,
            "ItemsInProgress": 0,
            "QueueDefinitionId": 188,
            "QueueDefinitionName": "DocQueue",
            "QueueDefinitionDescription": null,
            "QueueDefinitionAcceptAutomaticallyRetry": true,
            "QueueDefinitionMaxNumberOfRetries": 5,
            "QueueDefinitionEnforceUniqueReference": false,
            "ProcessingMeanTime": 2.15,
            "SuccessfulTransactionsNo": 0,
            "ApplicationExceptionsNo": 0,
            "BusinessExceptionsNo": 883,
            "SuccessfulTransactionsProcessingTime": 0,
            "ApplicationExceptionsProcessingTime": 0,
            "BusinessExceptionsProcessingTime": 2.15,
            "TotalNumberOfTransactions": 883,
            "LastProcessed": "2018-03-07T18:20:29.3833333Z"
        }
    ]
}

	

  



			

			
Changing the Reviewer of a Queue Item


The following example enables you to change the reviewer of the failed transaction item with the 1050200 Id. 


			

			

				
Important!
				

				
The value of the RowVersion parameter changes each time an update is made to a queue item. To retrieve this information, perform a GET call on the /odata/QueueItems() endpoint, such as https://platform.uipath.com/odata/QueueItems(1050200).


				

			

			

  

    

    

      POST
      

        	https://platform.uipath.com/odata/QueueItems/UiPathODataSvc.SetItemReviewer
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
	"queueItems": [{
		"Id": 1050200, 
		"RowVersion":"AAAAAABDIK8="
	}], 
	"userId": 583
}

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#UiPath.Application.Dto.BulkOperationResponseDto_1OfInt64",
    "Success": true,
    "Message": null,
    "FailedItems": []
}

	

  



			

			
Retrieving Queue Items with an Indicated Review Status


This example enables you to extract the first two queue items that have a Revision status set to In Review. 


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/QueueItems?$filter=ReviewStatus eq 'InReview'&$top=2
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#QueueItems",
    "@odata.count": 3,
    "value": [
        {
            "QueueDefinitionId": 188,
            "OutputData": null,
            "Status": "Failed",
            "ReviewStatus": "InReview",
            "ReviewerUserId": 583,
            "Key": "e4760d27-a76d-4469-b7e6-fbda2f732b10",
            "Reference": "ActivityDescription",
            "ProcessingExceptionType": "BusinessException",
            "DueDate": null,
            "Priority": "High",
            "DeferDate": null,
            "StartProcessing": "2018-03-07T18:14:56.633Z",
            "EndProcessing": "2018-03-07T18:14:58.723Z",
            "SecondsInPreviousAttempts": 2,
            "AncestorId": null,
            "RetryNumber": 0,
            "SpecificData": "{\"DynamicProperties\":{\"Description\":\"Gets a specified credential by using a provided AssetName, and returns a username and a secure password.\"}}",
            "CreationTime": "2018-03-07T16:02:57.547Z",
            "Progress": null,
            "RowVersion": "AAAAAABDFiU=",
            "Id": 1050199,
            "ProcessingException": {
                "Reason": "because I say so",
                "Details": null,
                "Type": "BusinessException",
                "AssociatedImageFilePath": null,
                "CreationTime": "2018-03-07T18:14:58.723Z"
            },
            "SpecificContent": {
                "Description": "Gets a specified credential by using a provided AssetName, and returns a username and a secure password."
            },
            "Output": null
        },
        {
            "QueueDefinitionId": 188,
            "OutputData": null,
            "Status": "Failed",
            "ReviewStatus": "InReview",
            "ReviewerUserId": 583,
            "Key": "e90e8067-50fc-407a-9678-eede311f815a",
            "Reference": "ActivityDescription",
            "ProcessingExceptionType": "BusinessException",
            "DueDate": null,
            "Priority": "High",
            "DeferDate": null,
            "StartProcessing": "2018-03-07T18:14:54.85Z",
            "EndProcessing": "2018-03-07T18:14:57.103Z",
            "SecondsInPreviousAttempts": 2,
            "AncestorId": null,
            "RetryNumber": 0,
            "SpecificData": "{\"DynamicProperties\":{\"Description\":\"Gets a specified asset by using a provided AssetName. If the asset is not global, it must be assigned to the local robot in order to be retrieved.\"}}",
            "CreationTime": "2018-03-07T16:02:57.287Z",
            "Progress": null,
            "RowVersion": "AAAAAABDFiY=",
            "Id": 1050198,
            "ProcessingException": {
                "Reason": "because I say so",
                "Details": null,
                "Type": "BusinessException",
                "AssociatedImageFilePath": null,
                "CreationTime": "2018-03-07T18:14:57.103Z"
            },
            "SpecificContent": {
                "Description": "Gets a specified asset by using a provided AssetName. If the asset is not global, it must be assigned to the local robot in order to be retrieved."
            },
            "Output": null
        }
    ]
}

	

  



			

			
Adding a Queue Item


The example below enables us to add an item to the "DocQueue" queue, with a high priority, defer and due dates, and two arguments with values. All items added like this have the New status, just like the Add Queue Item activity. 


Please note that the SpecificContent parameter should be populated only with primitive values.


			

			

				
Important!
				

				
Special characters cannot be escaped in the body of POST requests. To use special characters you need to first declare the parameter you use them in as string, using the following format "Parameter@odata.type": "#String". For a better understanding, please see how the Specific Content parameter was populated in the example below.


				

			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Queues/UiPathODataSvc.AddQueueItem
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
	"itemData": {
		"Priority": "High",
		"DeferDate": "2018-03-21T13:42:27.654Z",
		"DueDate": "2018-03-25T13:42:27.654Z",
		"Name": "DocQueue",
		"SpecificContent": {
			"Email@odata.type": "#String",
			"Email": "obrian@uipath.com", 
			"Name@odata.type": "#String",
			"Name": "O'Brian"
		}
	}
}

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#queueItem/$entity",
    "QueueDefinitionId": 188,
    "OutputData": null,
    "Status": "New",
    "ReviewStatus": "None",
    "ReviewerUserId": null,
    "Key": "e9cb2205-0232-4b99-9556-52dc2e686663",
    "Reference": null,
    "ProcessingExceptionType": null,
    "DueDate": "2018-03-25T13:42:27.654Z",
    "Priority": "High",
    "DeferDate": "2018-03-21T13:42:27.654Z",
    "StartProcessing": null,
    "EndProcessing": null,
    "SecondsInPreviousAttempts": 0,
    "AncestorId": null,
    "RetryNumber": 0,
    "SpecificData": "{\"DynamicProperties\":{\"Email\":\"obrian@uipath.com\",\"Name\":\"O'brian\"}}",
    "CreationTime": "2018-03-21T15:31:27.2699068Z",
    "Progress": null,
    "RowVersion": "AAAAAABDGLk=",
    "Id": 1050947,
    "ProcessingException": null,
    "SpecificContent": {
        "Email": "obrian@uipath.com",
        "Name": "O'Brian"
    },
    "Output": null
}}

	

  



			

			
Adding Multiple Queue Items


The examples below enables us to add multiple items at the same time to the "DocTest" queue, using the odata/Queues/UiPathODataSvc.BulkAddQueueItems endpoint. The items have a high priority, unique references, defer and due dates. Once added, they all have the New status. 


The first example is successful, while the latter fails because the references we are trying to add are not unique.


There are two upload strategies one can use when adding multiple queue items:


    

  • AllOrNothing - Adds queue items only if an error is not encountered. Otherwise, it does not insert anything and returns the row where the error occurred. 
  • ProcessAllIndependently - Adds all your items and returns a list of all those that failed.


			

			

				
Note:
				

				
Failed requests return 200 OK, as the failed items are returned in the body of the response, as you can see in the second example.
The only requests that do not return 200 OK are those in which the input parameters are incorrect.


				

			

			
Successful request:


			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Queues/UiPathODataSvc.BulkAddQueueItems
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
	"queueName": "DocTest",
	"commitType": "AllOrNothing",
	"queueItems": [{
			"Name": "q1",
			"Priority": "High",
			"SpecificContent": {},
			"DeferDate": "2019-03-14T12:20:13.290Z",
			"DueDate": "2019-03-14T12:20:13.290Z",
			"Reference": "ref1"
		},
		{
			"Name": "q2",
			"Priority": "High",
			"SpecificContent": {},
			"DeferDate": "2019-03-14T12:20:13.290Z",
			"DueDate": "2019-03-14T12:20:13.290Z",
			"Reference": "ref2"
		},
		{
			"Name": "q3",
			"Priority": "High",
			"SpecificContent": {},
			"DeferDate": "2019-03-14T12:20:13.290Z",
			"DueDate": "2019-03-14T12:20:13.290Z",
			"Reference": "ref3"
		}
	]
}

	

  

   

  

    
Response

    
200 OK

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#UiPath.Application.Dto.BulkOperationResponseDto_1OfFailedQueueItemDto",
  "Success": true,
  "Message": null,
  "FailedItems": []
}

	

  



			

			
Failed request:


			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Queues/UiPathODataSvc.BulkAddQueueItems
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
	"queueName": "DocTest",
	"commitType": "AllOrNothing",
	"queueItems": [{
			"Name": "q1",
			"Priority": "High",
			"SpecificContent": {},
			"DeferDate": "2019-03-14T12:20:13.290Z",
			"DueDate": "2019-03-14T12:20:13.290Z"
		},
		{
			"Name": "q2",
			"Priority": "High",
			"SpecificContent": {},
			"DeferDate": "2019-03-14T12:20:13.290Z",
			"DueDate": "2019-03-14T12:20:13.290Z"
		},
		{
			"Name": "q3",
			"Priority": "High",
			"SpecificContent": {},
			"DeferDate": "2019-03-14T12:20:13.290Z",
			"DueDate": "2019-03-14T12:20:13.290Z"
		}
	]
}

	

  

   

  

    
Response

    
200 OK

    
{
	"@odata.context": "https://platform.uipath.com/odata/$metadata#UiPath.Application.Dto.BulkOperationResponseDto_1OfFailedQueueItemDto",
	"Success": false,
	"Message": "Some items have not been inserted.",
	"FailedItems": [{
		"Ordinal": 1,
		"ErrorCode": "TransactionReferenceRequired",
		"ErrorMessage": "Error creating Transaction. Reference is required for Unique Reference Queues."
	}]
}

	

  



			

		

	

	

		

		

	


Suggest Edits
Assets Requests
 



	

		

			

				
Note:
				

				
Global and Per Robot text assets support up to 1.000.000 characters.


				

			

			
Retrieving a Specific Asset


The call below enables you to display all the available information for the asset with the "DocAPITest"  name and 455 Id. 


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId='455',assetName='DocAPITest')
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
    "Name": "DocAPITest",
    "ValueType": "Text",
    "StringValue": "An asset added through an API call",
    "BoolValue": false,
    "IntValue": 0,
    "CredentialUsername": "",
    "CredentialPassword": ""
}

	

  



			

			
Retrieving Per Robot Assets


To perform a GET request to the /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId() endpoint, you need to provide the robotId and assetName in the URL. Please note that only the username is returned for Per Robot credential assets, as you can see in the example below. 


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId(robotId=193,assetName='Testing')
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
  "Name": "Testing",
  "ValueType": "Credential",
  "StringValue": "",
  "BoolValue": false,
  "IntValue": 0,
  "CredentialUsername": "DocBot",
  "CredentialPassword": ""
}

	

  



			

			
Adding an Asset


The following example enables you to create a new global asset, of type text.


			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Assets
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
    "Name": "DocAPITest",
    "ValueScope": "Global",
    "ValueType": "Text", 
    "StringValue": "An asset added through an API call"
}

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Assets/$entity",
    "Name": "DocAPITest",
    "CanBeDeleted": true,
    "ValueScope": "Global",
    "ValueType": "Text",
    "Value": "An asset added through an API call",
    "StringValue": "An asset added through an API call",
    "BoolValue": false,
    "IntValue": 0,
    "CredentialUsername": "",
    "CredentialPassword": "",
    "Id": 455,
    "KeyValueList": []
}

	

  



			

		

	

	

		

		

	


Suggest Edits
Settings Requests
 



	

		

			
Retrieving Service Settings Used by the Robot


The following request enables you to display all the service settings used by the Robot. 


			

			

				
Important!
				

				
Please note that you need to include the Robot license key when making this request, as a header. The header's name must be X-ROBOT-LICENSE, as you can see in the example below.


				

			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Settings/UiPath.Server.Configuration.OData.GetServicesSettings()
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#System.Collections.Generic.Dictionary_2OfString_String",
    "Keys": [
        "ConfigurationUrl",
        "DeploymentUrl",
        "MonitoringUrl",
        "NotificationHubUrl",
        "LoggingUrl",
        "QueuesSvcUrl",
        "NuGet.Packages.ApiKey",
        "NuGetServiceApiKey",
        "ActivitiesFeed"
    ],
    "Values": [
        "https://platform.uipath.com",
        "https://platform.uipath.com/nuget/feed/documentation",
        "https://platform.uipath.com",
        "https://platform.uipath.com/signalr/hubs",
        "https://platform.uipath.com",
        "https://platform.uipath.com",
        "ec5b1111-5eb9-4264-a545-d5ed85c6301a",
        "ec5b1111-5eb9-4264-a545-d5ed85c6301a",
        "https://platform.uipath.com/nuget/activities"
    ]
}

	

  



			

			
Retrieving the Robot Execution Settings


The example below enables you to retrieve the Robot runtime settings. 


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Settings/UiPath.Server.Configuration.OData.GetExecutionSettingsConfiguration(scope=1)
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#UiPath.Core.Settings.ExecutionSettingsConfiguration",
  "Scope": "Global",
  "Configuration": [
    {
      "Key": "TracingLevel",
      "DisplayName": "Logging Level",
      "ValueType": "MultipleChoice",
      "DefaultValue": "Information",
      "PossibleValues": [
        "Verbose",
        "Trace",
        "Information",
        "Warning",
        "Error",
        "Critical",
        "Off"
      ]
    },
    {
      "Key": "LoginToConsole",
      "DisplayName": "Login To Console",
      "ValueType": "Boolean",
      "DefaultValue": "false",
      "PossibleValues": []
    },
    {
      "Key": "ResolutionWidth",
      "DisplayName": "Resolution Width",
      "ValueType": "Integer",
      "DefaultValue": "0",
      "PossibleValues": []
    },
    {
      "Key": "ResolutionHeight",
      "DisplayName": "Resolution Height",
      "ValueType": "Integer",
      "DefaultValue": "0",
      "PossibleValues": []
    },
    {
      "Key": "ResolutionDepth",
      "DisplayName": "Resolution Depth",
      "ValueType": "Integer",
      "DefaultValue": "0",
      "PossibleValues": []
    }
  ]
}

	

  



			

			
Setting the Number of Hours an Attended Robot Can Run Offline


The request below enables you to change the number of hours for which an Attended Robot retains its licenses in an offline environment to 24 hours. 


Please note that this setting is applied when you first connect the Robot to Orchestrator, or after the UiPath Robot service is restarted. If you are running the Community version, you need to restart the tray for the change to take effect. 


			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Settings/UiPath.Server.Configuration.OData.UpdateBulk
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
	"settings": [{
		"Name@odata.type": "#String",
		"Name": "AttendedRobot.RunDisconnectedHours",
		"Value": "24"
	}]
}

	

  

   

  

    
Response

    

    
200 OK

	

  



			

		

	

	

		

		

	


Suggest Edits
Users Requests
 



	

		

			
Updating Your Password


			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Users/UiPath.Server.Configuration.OData.UpdatePassword
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
  "TenancyName": "Documentation",
  "Username": "DocTest",
  "CurrentPassword": "YourCurrentPassword123$",
  "NewPassword": "ANew567*Password"
}

	

  

   

  

    
Response

    

    
200 OK

	

  



			

			
Deleting a User


			

			

  

    

    

      DELETE
      

        https://platform.uipath.com/odata/Users(446)
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    

    
204 No Content

	

  



			

			
Changing the Language


The following example enables you to change the language for the user with the 749 Id to Japanese.


			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Users(749)/UiPath.Server.Configuration.OData.ChangeUserCulture
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
	"culture": "ja"
}

	

  

   

  

    
Response

    

    
200 OK

	

  



			

		

	

	

		

		

	


Suggest Edits
Roles Requests
 



	

		

			
Retrieving Info about a Specific Role According to Its Id


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Roles(259)
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Roles/$entity",
    "Name": "TestRole",
    "DisplayName": "TestRole",
    "Groups": null,
    "IsStatic": false,
    "IsEditable": true,
    "Id": 259
}

	

  



			

		

	

	

		

		

	


Suggest Edits
Permissions Requests
 



	

		

			
The following request enables you to display all the permissions of the user you are currently authenticated with. Please note that only the permissions you are granted are returned.


You have the possibility to disable permissions completely from the user interface and API using the Auth.DisabledPermissions parameter in web.config. More details here.


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Permissions
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
	"@odata.context": "https://platform.uipath.com/odata/$metadata#Permissions",
	"@odata.count": 3,
	"value": [{
			"Name": "Machines",
			"IsGranted": true,
			"RoleId": 8
		},
		{
			"Name": "License",
			"IsGranted": true,
			"RoleId": 8
		},
		{
			"Name": "Settings",
			"IsGranted": true,
			"RoleId": 8
		}

	]
}

	

  



			

		

	

	

		

		

	


Suggest Edits
License Requests
 



	

		

			
Retrieving All Attended Robots with a Named User License


The following call to the odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='robotType') endpoint enables you to retrieve all the Attended Robots that are licensed with a named user license. 


			

			

				
Note:
				

				
This request returns a maximum of 1,000 entries.


				

			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='Attended')
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#NamedUserLicenses",
  "@odata.count": 1,
  "value": [
    {
      "UserName": "uipath\\documentation",
      "Key": "uipath\\documentation",
      "LastLoginDate": "2018-09-19T10:44:45.757Z",
      "MachinesCount": 1,
      "IsLicensed": false,
      "ActiveRobotId": null,
      "MachineNames": [
        "MINDAGOMIR"
      ],
      "ActiveMachineNames": []
    }
  ]
}

	

  



			

			
Enabling or Disabling a Machine


The following example disables the Documentation machine so that the Robots connected so it do not consume NonProduction/Unattended licenses. 


You can also enable a machine with a request to the /odata/LicensesRuntime('Key')/UiPath.Server.Configuration.OData.ToggleEnabled endpoint, by setting the enabled parameter to true. 


			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/LicensesRuntime('Documentation')/UiPath.Server.Configuration.OData.ToggleEnabled
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
	"key": "Documentation",
	"robotType": "Unattended",
	"enabled": false
}

	

  

   

  

    
Response

    

    
200 OK

	

  



			

		

	

	

		

		

	


Suggest Edits
Tenants Requests
 



	

		

			

				
Important!
				

				
Only host administrators can make tenant requests.
Additionally, the AdminEmailAddress, AdminName, and AdminSurname parameters are returned as null.


				

			

			
Retrieving Active Tenants


The request below enables you to retrieve all the tenants that are enabled. Please note that the response example has been truncated. 


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Tenants?$filter=IsActive eq true
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
	"@odata.context": "https://platform.uipath.com/odata/$metadata#Tenants",
	"@odata.count": 125,
	"value": [{
			"Name": "mynewtenant",
			"AdminEmailAddress": null,
			"AdminName": null,
			"AdminSurname": null,
			"AdminPassword": null,
			"LastLoginTime": "2017-12-04T16:20:58.65Z",
			"IsActive": true,
			"Id": 93,
			"License": null
		},
    {...},
		{
			"Name": "testing_orche",
			"AdminEmailAddress": null,
			"AdminName": null,
			"AdminSurname": null,
			"AdminPassword": null,
			"LastLoginTime": "2018-01-16T03:40:43.073Z",
			"IsActive": true,
			"Id": 100,
			"License": null
		}
	]
}

	

  



			

			
Retrieving a Tenant According to Its Id


The following example enables you to view the details of the tenant with the 99 Id. 


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Tenants(99)
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Tenants/$entity",
  "Name": "Documentation",
  "AdminEmailAddress": null,
  "AdminName": null,
  "AdminSurname": null,
  "AdminPassword": null,
  "LastLoginTime": "2018-11-26T11:28:03.56Z",
  "IsActive": true,
  "Id": 99,
  "License": {
    "HostLicenseId": null,
    "CreationTime": "2018-01-12T11:49:48.177Z",
    "Code": "1234567890",
    "Id": 99,
    "Allowed": {
      "Unattended": 99,
      "Attended": 99,
      "NonProduction": 99,
      "Development": 99
    }
  }
}

	

  



			

			
Disabling a Tenant


			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Tenants/UiPath.Server.Configuration.OData.SetActive
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
	"tenantIds": [375],
	"active": false
}

	

  

   

  

    
Response

    
200 OK

    

	

  



			

			
Disabling a Feature


This request disables the Monitoring feature for a tenant with the Id of 4 .
To enable the feature, make a request to the /odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk endpoint, by setting the Monitoring.Enabled parameter to true.


			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Features/UiPath.Server.Configuration.OData.UpdateFeaturesBulk
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
	"Name": "Monitoring.Enabled",
	"TenantId": [4]
	"Value": False
}

	

  

   

  

    
Response

    
200 OK

    

	

  



			

		

	

	

		

		

	


Suggest Edits
Webhooks Requests
 



	

		

			
Retrieving Webhooks


According to Their URL


The following example enables you to get all the webhooks that send information to the http://documentation.azurewebsites.net/webhook/documentation URL. 


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Webhooks?$filter=Url eq 'http://documentation.azurewebsites.net/webhook/documentation'
      

    

  





  

  

    
Request

    

    
Authorization: Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE
x-uipath-organizationunitid: 47

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
	"@odata.context": "https://platform.uipath.com/odata/$metadata#Webhooks",
	"@odata.count": 1,
	"value": [{
		"Url": "http://documentation.azurewebsites.net/webhook/documentation",
		"Enabled": true,
		"Secret": "1234567890",
		"SubscribeToAllEvents": false,
		"AllowInsecureSsl": false,
		"Id": 4,
		"Events": [{
				"EventType": "job.started"
			},
			{
				"EventType": "process.created"
			},
			{
				"EventType": "process.deleted"
			},
			{
				"EventType": "process.updated"
			},
			{
				"EventType": "queue.created"
			}
		]
	}]
}

	

  



			

			
According to an Id


The following request enables you to retrieve information about a specific webhook, according to its Id. 


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Webhooks(10)
      

    

  





  

  

    
Request

    

    
Authorization: Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE
x-uipath-organizationunitid: 47

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Webhooks/$entity",
  "Url": "https://orchestrator.uipath.com",
  "Enabled": false,
  "Secret": "1234567890",
  "SubscribeToAllEvents": true,
  "AllowInsecureSsl": false,
  "Id": 10,
  "Events": []
}

	

  



			

			
Retrieving All Available Event Types


The example below enables you to retrieve all the event types that one can subscribe to in Orchestrator.


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Webhooks/UiPath.Server.Configuration.OData.GetEventTypes()
      

    

  





  

  

    
Request

    

    
Authorization: Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE
x-uipath-organizationunitid: 47

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Collection(UiPath.Application.Dto.Webhooks.WebhookEventTypeDto)",
    "value": [
        {
            "Name": "process.created",
            "Group": "process"
        },
        {
            "Name": "process.updated",
            "Group": "process"
        },
        {
            "Name": "process.deleted",
            "Group": "process"
        },
        {
            "Name": "schedule.failed",
            "Group": "schedule"
        },
        {
            "Name": "robot.status",
            "Group": "robot"
        },
        {
            "Name": "job.started",
            "Group": "job"
        },
        {
            "Name": "job.completed",
            "Group": "job"
        },
        {
            "Name": "job.faulted",
            "Group": "job"
        },
        {
            "Name": "job.stopped",
            "Group": "job"
        },
        {
            "Name": "job.created",
            "Group": "job"
        },
        {
            "Name": "queue.created",
            "Group": "queue"
        },
        {
            "Name": "queue.updated",
            "Group": "queue"
        },
        {
            "Name": "queue.deleted",
            "Group": "queue"
        },
        {
            "Name": "queueItem.added",
            "Group": "queueItem"
        },
        {
            "Name": "queueItem.transactionStarted",
            "Group": "queueItem"
        },
        {
            "Name": "queueItem.transactionFailed",
            "Group": "queueItem"
        },
        {
            "Name": "queueItem.transactionCompleted",
            "Group": "queueItem"
        },
        {
            "Name": "queueItem.transactionAbandoned",
            "Group": "queueItem"
        },
        {
            "Name": "robot.created",
            "Group": "robot"
        },
        {
            "Name": "robot.updated",
            "Group": "robot"
        },
        {
            "Name": "robot.deleted",
            "Group": "robot"
        }
    ]
}

	

  



			

			
Editing a Webhook


The example below changes the Url, Enabled state, Secret, AllowInsecureSsl, and the Events the webhook with the 10 Id is subscribed to. 


			

			

  

    

    

      PUT
      

        https://platform.uipath.com/odata/Webhooks(10)
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
	"Url": "https://orchestrator.uipath.com/reference",
	"Enabled": false,
	"Secret": "This is a new secret.",
	"AllowInsecureSsl": true,
	"Events": [{
			"EventType": "process.created"
		},
		{
			"EventType": "queue.created"
		},
		{
			"EventType": "robot.deleted"
		}
	]
}

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/odata/$metadata#Webhooks/$entity",
    "Url": "https://orchestrator.uipath.com/reference",
    "Enabled": false,
    "Secret": "This is a new secret.",
    "SubscribeToAllEvents": false,
    "AllowInsecureSsl": true,
    "Id": 10,
    "Events": [
        {
            "EventType": "process.created"
        },
        {
            "EventType": "queue.created"
        },
        {
            "EventType": "robot.deleted"
        }
    ]
}

	

  



			

			
Testing the Webhook Target URL


The following request enables you to test the target URL, and, if successful, it returns a ping type of event, its Id, TenantId, OrganizationUnitId, and UserId.


			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Webhooks(11)/UiPath.Server.Configuration.OData.Ping
      

    

  





  

  

    
Request

    

    
Authorization: Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE
x-uipath-organizationunitid: 47

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#UiPath.Webhooks.Dto.PingEventDto",
  "Type": "ping",
  "EventId": "c3319a2d83c44b2f989bdd7eba1f0297",
  "Timestamp": "2018-11-19T14:32:47.6024779Z",
  "TenantId": 57,
  "OrganizationUnitId": null,
  "UserId": 583
}

	

  



			

		

	

	

		

		

	


Suggest Edits
Folders Requests
 



	

		

			
Assigning a User to a Folder with a Specified Role


			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Folders/UiPath.Server.Configuration.OData.AssignUsers
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
  "assignments": {
    "UserIds": [58571],
    "RolesPerFolder": [
      {
        "FolderId": 14091,
        "RoleIds": [25]
      }
    ]
  }
}
}

	

  

   

  

    
Response

    

    
204 No Content

	

  



			

			
Getting All the Users in a Folder and Their Roles


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key=14089,includeInherited=true)?$expand=UserEntity%2CRoles
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#UserRoles",
  "@odata.count": 2,
  "value": [
    {
      "Id": 52454,
      "UserEntity": {
        "UserName": "admin",
        "IsInherited": true,
        "Id": 52454
      },
      "Roles": [
        {
          "Name": "Administrator",
          "Origin": "Assigned",
          "Id": 13
        },
        {
          "Name": "Test",
          "Origin": "Assigned",
          "Id": 25
        }
      ]
    },
    {
      "Id": 58571,
      "UserEntity": {
        "UserName": "Petrix",
        "IsInherited": false,
        "Id": 58571
      },
      "Roles": [
        {
          "Name": "Test",
          "Origin": "Assigned",
          "Id": 25
        }
      ]
    }
  ]
}

	

  



			

		

	

	

		

		

	


Suggest Edits
Calendars Requests
 



	

		

			
Retrieving Calendars According to Their Name


The following GET request to the /odata/Calendars endpoint retrieves a specific calendar based on its Name. 


			

			

  

    

    

      GET
      

        https://platform.uipath.com/odata/Calendars?$filter=Name%20eq%20'BankHoliday'
      

    

  





  

  

    
Request

    
Authorization

    
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Calendars",
  "value": [
    {
      "TimeZoneId": null,
      "ExcludedDates": [],
      "Name": "BankHoliday",
      "Id": 18845
    }
  ]
}
  ]
}

	

  



			

			
Creating a Calendar


The following POST request to the /odata/Calendars endpoint enables you to create a new calendar with an excluded date. 


			

			

				
Note:
				

				
The Id parameter is automatically generated. The TimeZoneId parameter is populated with the tenant's timezone.


				

			

			

  

    

    

      POST
      

        https://platform.uipath.com/odata/Calendars
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
  "Name": "VacationCal",
  "TimeZoneId": "string",
  "ExcludedDates": [
    "2019-11-12T14:31:44.778Z"
  ]
}

	

  

   

  

    
Response

    
201 OK

    
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Calendars/$entity",
  "TimeZoneId": "GTB Standard Time",
  "ExcludedDates": [
    "2019-11-12T00:00:00Z"
  ],
  "Name": "VacationCal",
  "Id": 32718
}

	

  



			

		

	

	

		

		

	


Suggest Edits
Consuming Cloud API
Public Preview


 



	

		

			
The recently announced UiPath Cloud Platform has a new mechanism for consuming APIs. All clients that used to connect to Orchestrator CE via API, or using PowerShell and other scripting tools, need to be updated in order to connect to the UiPath Cloud Platform.


			

			

				
Important:
				

				
On-premises Orchestrator or Orchestrator installed in your private cloud have not been changed. You can continue to use your API integrations, PowerShell or other scripting tools as before when connecting to these Orchestrators.


				

			

			
Follow these instructions to consume our Cloud API.


Getting Token to Use in Your API Calls


Generating Code Challenge and Code Verifier


    

  1. In a web browser window, go to https://repl.it/languages/nodejs.
  2. Paste the following code in the index.js file:


			

			

				
				

						
						
						
function base64URLEncode(str) {
  return str.toString('base64')
    .replace(/\+/g, '-')
    .replace(/\//g, '_')
    .replace(/=/g, '');
}
 
function sha256(buffer) {
  return crypto.createHash('sha256').update(buffer).digest();
}
 
console.log("Generating challenge and Verifier");
var cryptoResult = crypto.randomBytes(32);
var verifier = base64URLEncode(cryptoResult);
var challenge = base64URLEncode(sha256(verifier));
console.log("Code challenge: " + challenge)
console.log("Code verifier: " + verifier);

				

			

			
    

  1. Click Run on the top of the page. The output should look like this:


Generating challenge and Verifier
Code challenge: 6FmSWYSNC1I-7fC6oTIEGz-FirleVDkAVjxkkbYNzc4
Code verifier: IwqVfyjRULvl5Yz9S8InPTVqZTlfJn5MysOOOZrXDKs


    

  1. Save the codes. 


Getting Authorization Code


    

  1. Copy the following URL in a text editor, such as Notepad:
    https://account.uipath.com/authorize?response_type=code&nonce=b0f368cbc59c6b99ccc8e9b66a30b4a6&state=47441df4d0f0a89da08d43b6dfdc4be2&code_challenge=[Code Challenge]&code_challenge_method=S256&scope=openid+profile+offline_access+email  &audience=https%3A%2F%2Forchestrator.cloud.uipath.com&client_id=5v7PmPJL6FOGu6RB8I1Y4adLBhIwovQN&redirect_uri=https%3A%2F%2Faccount.uipath.com%2Fmobile
  2. Replace [Code challenge] with your Code challenge generated in step 3 of the previous section.
  3. Copy the updated URL.
  4. Open a web browser window.
  5. Paste the updated URL into the address bar, and press Enter. You are redirected to a UiPath Login page.
  6. Login using your credentials.
  7. The browser's Text window shows OK, with the URL in the following format:
    https://account.uipath.com/mobile?code=[Authorization code]&state=47441df4d0f0a89da08d43b6dfdc4be2
  8. Copy this [Authorization code] for later use.


Getting Refresh Token


    

  1. In any API testing tool, perform a POST request to the https://account.uipath.com/oauth/token URL. In the body of the request, replace [Authorization code] and [Code verifier] with the values received in the two procedures above. The request and response should look as in the following example:


			

			

  

    

    

      POST
      

        	https://account.uipath.com/oauth/token
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
    "grant_type": "authorization_code",
    "code": "[Authorization code]",
    "redirect_uri": "https://account.uipath.com/mobile",
    "code_verifier": "[Code verifier]",
    "client_id": "5v7PmPJL6FOGu6RB8I1Y4adLBhIwovQN"
}

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "access_token": "[access token]",
  "refresh_token": "[refresh token]",
  "id_token": "[id token]",
  "scope": "openid profile email offline_access",
  "expires_in": 86400,
  "token_type": "Bearer"
}

	

  



			

			
    

  1. Copy the [refresh_token] from the body of the response for later use. 


Generating Access Token and ID Token Using the Refresh Token


			

			

				
Important!
				

				
The [access_token] required for making API calls is valid for 24 hours. You have to regenerate [access_token] and [id_token] using your [refresh_token], otherwise you receive 401 status code.


				

			

			
    

  1. In any API testing tool, perform a POST request to the https://account.uipath.com/oauth/token URL. In the body of the request, replace [refresh_token] with the refresh_token value received in the procedure above. The request and response should look as in the following example:


			

			

  

    

    

      POST
      

        	https://account.uipath.com/oauth/token
      

    

  





  

  

    
Request

    
Content-Type: application/json

    
{
    "grant_type": "refresh_token",
    "client_id": "5v7PmPJL6FOGu6RB8I1Y4adLBhIwovQN",
    "refresh_token": "[refresh token]"
}

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "access_token": "[access token]",
  "id_token": "[id token]",
  "scope": "openid profile email offline_access",
  "expires_in": 86400,
  "token_type": "Bearer"
}

	

  



			

			
    

  1. Copy [access_token] and [id_token] for later use.


Discovering UiPath Account and Service Instance Identifiers


Getting Account Logical Name


    

  1. In any API testing tool, perform a GET request to the https://platform.uipath.com/cloudrpa/api/getAccountsForUser URL. You need to use Authorization header with your Bearer Token, pasting the [id_token]value received in the procedure above. The request and response should look as in the following example:


			

			

  

    

    

      GET
      

        	https://platform.uipath.com/cloudrpa/api/getAccountsForUser
      

    

  





  

  

    
Request

    
Authorization: Bearer [id_token]

    
 
    

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
  "userEmail": "[user_email]",
    "accounts": [
        {
            "accountName": "[account_name]",
            "accountLogicalName": "[account_logical_name]"
        }
    ]
}

	

  



			

			
    

  1. Copy [account_logical_name] for later use.


Getting Service Instance Logical Name


    

  1. Copy the following URL into API testing tool, to perform a GET request: https://platform.uipath.com/cloudrpa/api/account/[account_logical_name]/getAllServiceInstances
  2. Replace the [account_logical_name] with the value obtained in the procedure above.
  3. You need to use Authorization header with your Bearer Token, pasting the [id_token] value received in the procedure above. 


The request and response should look as in the following example:


			

			

  

    

    

      GET
      

        	https://platform.uipath.com/cloudrpa/api/account/[account_logical_name]/getAllServiceInstances
      

    

  





  

  

    
Request

    
Authorization: Bearer [id_token]

    
 
    

	

  

   

  

    
Response

    
Content-Type: application/json

    
[
    {
        "serviceInstanceName": "[service_instance_name]",
        "serviceInstanceLogicalName": "[service_instance_logical_name]",
        "serviceType": "ORCHESTRATOR",
        "serviceUrl": "[service_url]"
    }
]


	

  



			

			
    

  1. Copy [service_instance_logical_name] for later use.


Making Orchestrator API Calls


    

  1. Copy the following URL into any API testing tool to perform a GET request: https://platform.uipath.com/[account_logical_name]/[service_instance_logical_name]/odata/Settings/UiPath.Server.Configuration.OData.GetLicense
  2. Replace the [account_logical_name] and [service_instance_logical_name] with your values received in the previous procedures.
  3. You need to use Authorization header with your Bearer Token, pasting the [access_token] value received in the procedure above - not the previously used [id_token]. 
  4. You also need to use Authorization header X-UIPATH-TenantName, with the [service_instance_logical_name] value.


After sending the request, you should get a response back from Orchestrator with the license information for this service_instance.


The request and response should look as in the following example:


			

			

  

    

    

      GET
      

        	https://platform.uipath.com/[account_logical_name]/[ service_instance_logical_name]/odata/Settings/UiPath.Server.Configuration.OData.GetLicense
      

    

  





  

  

    
Request

    
Headers

    
Authorization: Bearer [access_token]
X-UIPATH-TenantName: [service_instance_logical_name]
 

	

  

   

  

    
Response

    
Content-Type: application/json

    
{
    "@odata.context": "https://platform.uipath.com/[account_logical_name]/[ service_instance_logical_name]/odata/$metadata#UiPath.Application.Dto.License.LicenseDto",
    "HostLicenseId": null,
    "Id": 0,
    "ExpireDate": 1591877557,
    "AttendedConcurrent": false,
    "DevelopmentConcurrent": false,
    "IsRegistered": false,
    "IsExpired": false,
    "CreationTime": "0001-01-01T00:00:00Z",
    "Code": null,
    "Allowed": {
        "Unattended": 0,
        "Attended": 0,
        "NonProduction": 0,
        "Development": 2
    },
    "Used": {
        "Unattended": 0,
        "Attended": 0,
        "NonProduction": 0,
        "Development": 1
    }
}

	

  



			

			

				
Important!
				

				
All Orchestrator API calls subsequent to the initial authorization have to contain the following headers:


    

  • Authorization: Bearer [access_token] 
  • X-UIPATH-TenantName: [service_instance_logical_name]