Introduction

Overview

This is an OData version 4.0 standard compliant REST API that exposes entities and their relationships using well defined access, navigation and modification rules.

The UiPath Orchestrator API Guide is meant to help you easily access and manage all resources available in the Orchestrator web interface.

Note: All examples have been built using the https://platform.uipath.com Orchestrator address. Please use your own Orchestrator address when building requests.

Version

API Name
UiPath Orchestrator
API Version

2016.2

OData Protocol Version
4.0

Authentication

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 60 minutes. You can change the expiry time, by modifying the value of the Auth.Cookie.Expire parameter, in the Web.config file

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": "AKsxHNKxBDUxKJWImK-i3MJlbfABTuO58JEg_0PHDikj8i9j2itauuVIpDuMn1MiIOfUyyx1Lf1bP4SPW3mYaB8NL22RkAKDTwB79gM1IFAYGnbxLLF_DqBxKfOiDKy5egGMSDyFQQdVUaw-IfQOzrBPHtZzO46UqVNreeALueWffj7ce8_XsTVbbgIW11QKa97kxjoSSM5NnpZdbp73GdlZm0-hOCkDdEBd-_855_Vtsfsv_DhXA5RpTaELLSoDEmlxvseffmAZ3Qv7TudFT7nVbuiqjQqiVOLx5MGHUw5TiyXoXUAwMhfsOROigL2Bmk_X7B892_c30LWEeEtpyV_Yj9YlQBPQHdQOWseRbajAI1IsGyi1gbANbGu-Z11844k0p10MevF5iZO_gguE5K2EJ5oICtJce7yu3QIxrplx8H_ijY-g8bp2XHs0RY5erMepA2McZUa-fQDETLBiticLLE7lJHBHS9VWYlYIrepg3N1IeuZA12HiTuD1LhqdE08DCw",
  "targetUrl": null,
  "success": true,
  "error": null,
  "unAuthorizedRequest": false,
  "__abp": true
}
  1. Copy to the Clipboard the token from the HTTP response, from the "result" parameter. 
  2. The token must be used in all future requests, in the following format: 

                Authorization: Bearer xxxxxxxxxxx

xxxxxxxxxxx - represents the token copied at step 2 

Access

Following API endpoint and resources are exposed to be accessible with appropriate authorization.

Service Level Documents

Top Level Resources

Indirectly Accessible Resources

ReleaseVersionDto
Accessible through parent Resource i.e. ReleaseDto
https://platform.uipath.com/odata/<SPECIFY_PARENT_RESOURCE(KEY)>/ReleaseVersionDto
AssetRobotValueDto
Accessible through parent Resource i.e. AssetDto
https://platform.uipath.com/odata/<SPECIFY_PARENT_RESOURCE(KEY)>/AssetRobotValueDto
ProcessingExceptionDto
Accessible through parent Resource i.e. QueueItemDto
https://platform.uipath.com/odata/<SPECIFY_PARENT_RESOURCE(KEY)>/ProcessingExceptionDto
UserRoleDto
Accessible through parent Resource i.e. UserDto
https://platform.uipath.com/odata/<SPECIFY_PARENT_RESOURCE(KEY)>/UserRoleDto
RobotExecutorDto
Accessible through parent Resource i.e. ProcessScheduleDto
https://platform.uipath.com/odata/<SPECIFY_PARENT_RESOURCE(KEY)>/RobotExecutorDto

Error Codes

Standard HTTP status codes are used for HTTP communication level error information. Further, OData Protocol level and application level error information is sent in the message-body. Application level error information is provided with a well defined structure. An example error response in JSON format is as below:

Sample Error Response

HTTP/1.1 404 Not Found
{
  "error": {
    "code": "",
    "message": "No HTTP resource was found that matches the request URI 'https://platform.uipath.com/odata/ProcessSchedules'.",
    "innererror": {
      "message": "No routing convention was found to select an action for the OData path with template '~/entityset'.",
      "type": "",
      "stacktrace": ""
    }
  }
}

Entities

SettingsDto

Used to store various predefined application configurations like time zone or account e-mail information. Supported methods: Get and Put.

SettingsDto Properties

name type nullable Description
Name Edm.String false The name of a specific setting (eg. Abp.Net.Mail.DefaultFromAddress).
Value Edm.String The value assigned to a specific setting (eg. admin@mydomain.com).
Scope Abp.Configuration.SettingScopes The scope of a specific setting. Possible values: Application, Tenant or User.
Id ๐Ÿ”‘ Edm.String false The database unique identifier.

SettingsDto Representation

{
  "Name": "",
  "Value": "",
  "Scope": "Application",
  "Id": ""
}

SettingsDto Methods & Examples


GET
https://platform.uipath.com/odata/Settings?$filter=Name eq 'Abp.Timing.TimeZone'

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Settings",
  "@odata.count": 1,
  "value": [
    {
      "Name": "Abp.Timing.TimeZone",
      "Value": "UTC",
      "Scope": null,
      "Id": "Abp.Timing.TimeZone"
    }
  ]
}

PUT
https://platform.uipath.com/odata/Settings('Abp.Net.Mail.Smtp.Domain')

Request

Content-Type: application/json
{
    "Name": "Abp.Net.Mail.Smtp.Domain", 
    "Value": "gmail.com", 
    "Scope": null
}

Response

Content-Type: application/json
HTTP 200 OK

RobotDto

A Robot is an execution host that runs processes built in UiPath Studio. Supported methods: Get, Post, Put and Delete.

RobotDto Properties

name type nullable Description
LicenseKey Edm.String false The key is automatically generated from the server for the Robot machine. For the robot to work, the same key must exist on both the robot and Orchestrator. All robots on a machine must have the same license key in order to register correctly.
MachineName Edm.String false The name of the machine a Robot is hosted on.
Name Edm.String false A custom name for the robot.
Username Edm.String The machine username. If the user is under a domain, you are required to also specify it in a DOMAIN\username format. Note: You must use short domain names, such as desktop\administrator and NOT desktop.local/administrator.
Description Edm.String Used to add additional information about a robot in order to better identify it.
Type UiPath.Core.Enums.RobotType false The Robot type. Possible values: DevTest, FrontOffice or BackOffice.
Password Edm.String The Windows password associated with the machine username.
RobotEnvironments Edm.String The comma separated textual representation of environment names the robot is part of.
Id ๐Ÿ”‘ Edm.Int64 false The database unique identifier.

RobotDto Relations

name Entity Type Type Description
Environments EnvironmentDto Collection(UiPath.Application.Dto.EnvironmentDto) The collection of environments the robot is part of.

RobotDto Representation

{
  "LicenseKey": "",
  "MachineName": "",
  "Name": "",
  "Username": "",
  "Description": "",
  "Type": "DevTest",
  "Password": "",
  "RobotEnvironments": "",
  "Id": ""
}

RobotDto Methods & Examples


GET
https://platform.uipath.com/odata/Robots?$filter=Name eq 'Documentation 2'

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Robots",
  "@odata.count": 1,
  "value": [
    {
      "LicenseKey": "89fe329c-94c6-4449-83ba-4624e93d609f",
      "MachineName": "DESKTOP-E47LTUF",
      "Name": "Documentation 2",
      "Username": "win10vm2",
      "Description": null,
      "Type": "DevTest",
      "Password": null,
      "RobotEnvironments": "doc_env,yellow",
      "Id": 130
    }
  ]
POST
https://platform.uipath.com/odata/Robots

Request

Content-Type: application/json
{
    "LicenseKey":"9cbacb47-a470-4226-83e3-39fddfd7ee0d",
    "MachineName":"DESKTOP-E47LTUF",
    "Username":"Documentation_API_test",
    "Type":"DevTest",
    "Password":"",
    "Name":"API_test"
}

Response

Content-Type: application/json
HTTP 200 OK

SessionDto

Stores information about the last status reported to Orchestrator by a registered Robot. Supported method: Get.

SessionDto Properties

name type nullable Description
State UiPath.Core.Enums.RobotState false The value of the last reported status. Possible values: Available, Busy, Disconnected or Unknown.
ReportingTime Edm.DateTimeOffset false The date and time when the last heartbeat came.
Info Edm.String May store additional information about the robot state.
Id ๐Ÿ”‘ Edm.Int64 false The database unique identifier.

SessionDto Relations

name Entity Type Type Description
Robot RobotDto UiPath.Application.Dto.RobotDto The Robot for which the information is stored.
Job JobDto UiPath.Application.Dto.JobDto The Job that is executed by the robot.

SessionDto Representation

{
  "State": "Available",
  "ReportingTime": "2017-02-21T11:49:11Z",
  "Info": "",
  "Id": ""
}

SessionDto Methods & Examples

GET
https://platform.uipath.com/odata/Sessions?$top=1&$filter=State eq UiPath.Core.Enums.RobotState%27Disconnected%27

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Sessions",
  "@odata.count": 46,
  "value": [
    {
      "State": "Disconnected",
      "ReportingTime": "2016-10-28T10:31:07.177Z",
      "Info": null,
      "Id": 15
    }
  ]
}

EnvironmentDto

A grouping of Robots. Supported methods: Get, Post and Delete.

EnvironmentDto Properties

name type nullable Description
Name Edm.String false A custom name for the environment.
Description Edm.String Used to add aditional information about an environment in order to beter identify it.
Type UiPath.Core.Enums.EnvironmentType false The environment type specifies how it should be used. Possible values: Dev, Test or Prod.
Id ๐Ÿ”‘ Edm.Int64 false The database unique identifier.

EnvironmentDto Relations

nameEntity TypeTypeDescription
RobotsSimpleRobotDtoCollection(UiPath.Application.Dto.SimpleRobotDto)The collection of robots associated with the current environment.

EnvironmentDto Representation

{
  "Name": "",
  "Description": "",
  "Type": "Dev",
  "Id": ""
}

EnvironmentDto Methods & Examples

GET
https://platform.uipath.com/odata/Environments?$top=1&$filter=Type eq UiPath.Core.Enums.EnvironmentType%27Test%27

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Environments",
  "@odata.count": 7,
  "value": [
    {
      "Name": "altest",
      "Description": "te",
      "Type": "Test",
      "Id": 4
    }
  ]
}
POST
https://platform.uipath.com/odata/Environments

Request

Content-Type: application/json
{
  "Name": "API_Documentation_Test",
  "Description": "API_TEST",
  "Type": "Dev"
}

Response

Content-Type: application/json
HTTP/1.1 200 OK

DELETE
https://platform.uipath.com/odata/Environments(47)

Request

Content-Type: application/json

Response

Content-Type: application/json
HTTP/1.1 200 OK

ProcessScheduleDto

Defines the schedule of a process that can be executed at regular intervals, on selected Robots, all of them or a specified number of Robots. Supported methods: Get, Post, Put and Delete.

ProcessScheduleDto Properties

name type nullable Description
EnabledEdm.BooleanfalseSpecifies if the schedule is active or not.
ReleaseIdEdm.Int64falseThe Id of the release associated with the schedule.
ReleaseKeyEdm.StringThe unique key of the release associated with the schedule.
ReleaseNameEdm.StringThe name of the release associated with the schedule.
PackageNameEdm.StringThe name of the process to be triggered with the schedule.
EnvironmentNameEdm.StringThe name of the environment associated with the schedule.
EnvironmentIdEdm.StringThe Id of the environment associated with the schedule.
StartProcessCronEdm.StringThe start cron expression of the schedule.
StartProcessCronDetailsEdm.StringVarious details that can be associated to the time period expression of the schedule.
StartProcessCronSummaryEdm.StringHuman readable form of cron expression of the schedule.
StartProcessNextOccurrenceEdm.DateTimeOffsetThe date and time when the associated process will be run next.
StartStrategyEdm.Int32falseStates which robots from the environment are runned by the schedule. Possible values: -1 - all robots; 0 - specific robots; n (n>=1) - a n number of random robots from the environment.
StopProcessExpressionEdm.StringThe cron expression after which a running process will be stopped.
StopStrategyUiPath.Core.Enums.StopStrategyThe way a running process is stopped. Possible values: SoftStop or Kill.
ExternalJobKeyEdm.StringThe unique identifier of the external job associated with the jobs generated by this schedule. A key is generated for each group of jobs triggered by this schedule.
Id ๐Ÿ”‘Edm.Int64The database unique identifier.

ProcessScheduleDto Relations

nameEntity TypeTypeDescription
ExecutorRobotsRobotExecutorDtoCollection(UiPath.Application.Dto.Robots.RobotExecutorDto)The collection of specific robots selected to be targeted by the current schedule. This collection must be empty if the start strategy is not 0 (specific robots).

ProcessScheduleDto Representation

{
  "Enabled": false,
  "ReleaseId": "",
  "ReleaseKey": "",
  "ReleaseName": "",
  "PackageName": "",
  "EnvironmentName": "",
  "EnvironmentId": "",
  "StartProcessCron": "",
  "StartProcessCronDetails": "",
  "StartProcessCronSummary": "",
  "StartProcessNextOccurrence": "2017-02-21T11:49:11Z",
  "StartStrategy": 0,
  "StopProcessExpression": "",
  "StopStrategy": "SoftStop",
  "ExternalJobKey": "",
  "Id": ""
}

ProcessScheduleDto Methods & Examples


GET
https://platform.uipath.com/odata/ProcessSchedules?$top=1&$filter=startswith(ReleaseName, 'Dan') eq true

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#ProcessSchedules",
  "@odata.count": 5,
  "value": [
    {
      "Enabled": false,
      "ReleaseId": 101,
      "ReleaseKey": "36dce01a-0bba-41c8-9b52-6528ba317f44",
      "ReleaseName": "DanBProcEmpty_danb_env1",
      "PackageName": "DanBProcEmpty",
      "EnvironmentName": "danb_env1",
      "EnvironmentId": "60",
      "StartProcessCron": "0/10 0/1 * 1/1 * ? *",
      "StartProcessCronDetails": "{\"type\":5,\"minutely\":{},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"0/10 0/1 * 1/1 * ? *\"}",
      "StartProcessCronSummary": "Every 10 seconds",
      "StartProcessNextOccurrence": null,
      "StartStrategy": 0,
      "StopProcessExpression": "",
      "StopStrategy": "Kill",
      "ExternalJobKey": "cc3e1fa4-2fa2-4e42-b961-c18c02690ebb",
      "Id": 55
    }
  ]
}
POST
https://platform.uipath.com/odata/ProcessSchedules

Request

Content-Type: application/json
{
	"Enabled":true,
	"ReleaseId":67,
	"ReleaseName":"test_doc_env",
	"StartProcessCron":"0 0/1 * 1/1 * ? *",
	"StartProcessCronDetails":"{\"type\":0,\"minutely\":{\"atMinute\":1},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
	"StartStrategy":-1,
	"ExecutorRobots":[],
	"StopProcessExpression":"",
	"StopStrategy":"Kill"
}

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#ProcessSchedules/$entity",
  "Enabled": true,
  "ReleaseId": 67,
  "ReleaseKey": null,
  "ReleaseName": "test_doc_env",
  "PackageName": null,
  "EnvironmentName": null,
  "EnvironmentId": null,
  "StartProcessCron": "0 0/1 * 1/1 * ? *",
  "StartProcessCronDetails": "{\"type\":0,\"minutely\":{\"atMinute\":1},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[]},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
  "StartProcessCronSummary": "Every minute",
  "StartProcessNextOccurrence": null,
  "StartStrategy": -1,
  "StopProcessExpression": "",
  "StopStrategy": "Kill",
  "ExternalJobKey": null,
  "Id": 0
}
PUT
https://platform.uipath.com/odata/ProcessSchedules(81)

Request

Content-Type: application/json
{
   "Id": 81,
   "Enabled": false,
   "ReleaseId": 68,
   "ReleaseKey": "8746b2e4-f25f-4dc8-b7a5-e703b77a863a",
   "ReleaseName": "Test_Queue_doc_env",
   "PackageName": "Test_Queue",
   "EnvironmentName": "doc_env",
   "EnvironmentId": "8",
   "StartProcessCron": "0 0 5 ? * MON *",
   "StartProcessCronDetails": "{\"type\":3,\"minutely\":{},\"hourly\":{},\"daily\":{},\"weekly\":{\"weekdays\":[{\"text\":\"Monday\",\"id\":\"MON\"}],\"atMinute\":0,\"atHour\":5},\"monthly\":{\"weekdays\":[]},\"advancedCronExpression\":\"\"}",
   "StartProcessCronSummary": "At 05:00 AM, only on Sunday, every 5 months",
   "StartProcessNextOccurrence": null,
   "StartStrategy": -1,
   "ExecutorRobots": [],
   "StopProcessExpression": "",
   "StopStrategy": "Kill",
   "ExternalJobKey": "122bb08f-bb3e-4406-b22a-de5130067a81"
}

Response

Content-Type: application/json
HTTP 200 OK

DELETE
https://platform.uipath.com/odata/ProcessSchedules(80)

Request

Content-Type: application/json

Response

Content-Type: application/json
HTTP 204  No Content

ProcessDto

A process is a project defined in UiPath Studio and published to Orchestrator from UiPath Studio or manually. Supported methods: Get and Delete.

ProcessDto Properties

nametypeDescriptionnullable
TitleEdm.StringThe custom name of the process.
VersionEdm.StringThe current version of the given process.
KeyEdm.StringThe unique identifier for the process.
DescriptionEdm.StringUsed to add aditional information about a process in order to better identify it.
PublishedEdm.DateTimeOffsetThe date and time when process was published or uploaded.false
IsLatestVersionEdm.BooleanSpecifies whether the current version is the latest of the given process.false
OldVersionEdm.StringSpecifies the last version before the current one.
IsActiveEdm.BooleanSpecifies if the process is still active.false
Id ๐Ÿ”‘Edm.StringThe database unique identifier.false

ProcessDto Representation

{
  "Title": "",
  "Version": "",
  "Key": "",
  "Description": "",
  "Published": "2017-02-21T11:49:11Z",
  "IsLatestVersion": false,
  "OldVersion": "",
  "IsActive": false,
  "Id": ""
}

ProcessDto Methods & Examples

GET
https://platform.uipath.com/odata/Processes?$top=1&$filter=contains(Title,'logging')

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Processes",
  "@odata.count": 5,
  "value": [
    {
      "Title": "1JustLogging",
      "Version": "1.0.6164.27873",
      "Key": "1JustLogging:1.0.6164.27873",
      "Description": "Blank Project",
      "Published": "2016-11-16T13:29:08.2297962Z",
      "IsLatestVersion": true,
      "OldVersion": null,
      "IsActive": false,
      "Id": "1JustLogging"
    }
  ]
}
DELETE
https://platform.uipath.com/odata/Processes('Test_Queue')

Request

Content-Type: application/json

Response

Content-Type: application/json
HTTP 200 OK

LogDto

Logs generated by Robots and execution reports. Can be stored in ElasticSearch and/or to a local SQL database. Supported methods: Get.

Note: Requests to this entity have to be made to the https://platform.uipath.com/odata/RobotLogs URL.

LogDto Properties

nametypenullableDescription
LevelUiPath.Core.Enums.LogLevelfalseDefines the log severity. Possible values: Trace, Debug, Info, Warn, Error or Fatal.
WindowsIdentityEdm.StringThe name of the user that performed the action that was logged.
ProcessNameEdm.StringThe name of the process.
TimeStampEdm.DateTimeOffsetfalseThe exact date and time the action was performed.
MessageEdm.StringThe log message. This can also be a message logged through the Log Message activity in UiPath Studio.
JobKeyEdm.GuidThe key of the job running the process that generated the log, if any.
RawMessageEdm.StringA JSON format message containing all the above fields.
Id ๐Ÿ”‘Edm.Int64falseThe database unique identifier.

LogDto Representation

{
  "Level": "Trace",
  "WindowsIdentity": "",
  "ProcessName": "",
  "TimeStamp": "2017-02-21T11:49:11Z",
  "Message": "",
  "JobKey": "",
  "RawMessage": "",
  "Id": ""
}

LogDto Methods & Examples


GET
https://platform.uipath.com/odata/RobotLogs?$top=1&$filter=Level eq UiPath.Core.Enums.LogLevel%27Fatal%27

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#RobotLogs",
  "@odata.count": 4,
  "value": [
    {
      "Level": "Fatal",
      "WindowsIdentity": "SPARKY\\uipathadmin",
      "ProcessName": "Open_and_Type_Notepad_TeoEnv",
      "TimeStamp": "2017-01-22T09:59:24.173Z",
      "Message": "This is a Fatal log",
      "JobKey": "25899540-535d-4226-a7d1-aac96716c35d",
      "RawMessage": "{\r\n  \"message\": \"This is a Fatal log\",\r\n  \"level\": \"Critical\",\r\n  \"timeStamp\": \"2017-01-22T09:59:24.1739865+00:00\",\r\n  \"windowsIdentity\": \"SPARKY\\\\uipathadmin\",\r\n  \"agentSessionId\": \"00000000-0000-0000-0000-000000000000\",\r\n  \"processName\": \"Open_and_Type_Notepad_TeoEnv\",\r\n  \"fileName\": \"Main\",\r\n  \"jobId\": \"25899540-535d-4226-a7d1-aac96716c35d\"\r\n}",
      "Id": 51881
    }
  ]
}

JobDto

Represents a scheduled or manual execution of a process on a robot. Supported method: Get.

JobDto Properties

nametypenullableDescription
KeyEdm.GuidfalseThe unique job identifier.
StartTimeEdm.DateTimeOffsetThe date and time when the job execution started or null if the job hasn't started yet.
EndTimeEdm.DateTimeOffsetThe date and time when the job execution ended or null if the job hasn't ended yet.
StateUiPath.Core.Enums.JobStatefalseThe state in which the job is. Possible values: Pending, Running, Canceling, Terminating, Faulted, Successful or Canceled.
SourceUiPath.Core.Enums.JobSourcefalseThe Source of the job. Possible values: Manual or Schedule.
BatchExecutionKeyEdm.GuidfalseThe unique identifier grouping multiple jobs. It is usually generated when the job is created by a schedule.
InfoEdm.StringAdditional information about the current job.
CreationTimeEdm.DateTimeOffsetfalseThe date and time when the job was created.
Id ๐Ÿ”‘Edm.Int64falseThe database unique identifier.

JobDto Relations

nameEntity TypeTypeDescription
RobotSimpleRobotDtoUiPath.Application.Dto.SimpleRobotDtoThe robot associated with the current job.
ReleaseSimpleReleaseDtoUiPath.Application.Dto.SimpleReleaseDtoThe release associated with the current job.

JobDto Representation

{
  "Key": "",
  "StartTime": "2017-02-15T15:39:43Z",
  "EndTime": "2017-02-15T15:39:43Z",
  "State": "Pending",
  "Source": "Manual",
  "BatchExecutionKey": "",
  "Info": "",
  "CreationTime": "2017-02-15T15:39:43Z",
  "Id": ""
}

JobDto Methods & Examples


GET
https://platform.uipath.com/odata/Jobs?$top=2&$filter=StartTime ge 2017-02-13T10:49:25Z

Request

Accept: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Jobs",
  "@odata.count": 50,
  "value": [
    {
      "Key": "5e6828d0-e3e1-42b9-92a2-8273a30f2b93",
      "StartTime": "2017-02-13T13:20:01.003Z",
      "EndTime": "2017-02-13T13:20:04.923Z",
      "State": "Successful",
      "Source": "Schedule",
      "BatchExecutionKey": "7ce6c1b0-9d9f-4d97-a6d5-eacf38361ca8",
      "Info": "Job completed",
      "CreationTime": "2017-02-13T13:20:00.143Z",
      "Id": 25832
    },
    {
      "Key": "0181fdef-7c81-4f2b-894b-1fb6ecda0fc0",
      "StartTime": "2017-02-13T13:20:03.88Z",
      "EndTime": "2017-02-13T13:20:01.503Z",
      "State": "Faulted",
      "Source": "Schedule",
      "BatchExecutionKey": "7ce6c1b0-9d9f-4d97-a6d5-eacf38361ca8",
      "Info": "Executor start process failed, reason System.Runtime.InteropServices.COMException (0x800700AA): The requested resource is in use. (Exception from HRESULT: 0x800700AA)\r\n   at UiPath.UiSystemClass.OpenInteractiveWindowsSession(String bstrUser, String bstrPassword, UiOpenSessionFlags nFlags, String bstrApplication, String bstrAppArguments, Int32 nDelayMs, Int32 userToken, UiGenericOptions options)\r\n   at UiPath.Core.Setup.OpenInteractiveWindowsSession(String username, String password, OpenSessionFlags flags, String application, String arguments, Int32 userToken, Int32 preferredWidth, Int32 preferredHeight, Int32 preferredDepth) in C:\\Projects\\Studio\\Core\\UiPath.Core\\Setup.cs:line 87\r\n   at UiPath.Service.Impl.Executor.StartProcessInSession(Guid executorInstanceId, String username, String password, OpenSessionInfo sessionInfo, IntPtr userToken) in C:\\Projects\\Studio\\Robot\\UiPath.Service\\Impl\\Executor.cs:line 401\r\n   at UiPath.Service.Impl.Executor.<>c__DisplayClass13_0.<<Start>b__0>d.MoveNext() in C:\\Projects\\Studio\\Robot\\UiPath.Service\\Impl\\Executor.cs:line 145",
      "CreationTime": "2017-02-13T13:20:00.317Z",
      "Id": 25833
    }
  ]
}

AuditLogDto

Stores audit information about any action performed in Orchestrator. Supported method: Get.

AuditLogDto Properties

nametypeDescriptionnullable
ServiceNameEdm.StringThe name of the Orchestrator service that performed a given action in the system.
MethodNameEdm.StringThe name of the service method that performed a given action in the system.
ParametersEdm.StringJSON representation of the method parameters and their values for the given action.
ExecutionTimeEdm.DateTimeOffsetThe date and time when the action was performed.false
Id ๐Ÿ”‘Edm.Int64The database unique identifier.false

AuditLogDto Representation

{
  "ServiceName": "",
  "MethodName": "",
  "Parameters": "",
  "ExecutionTime": "2017-02-21T11:49:11Z",
  "Id": ""
}

AuditLogDto Methods & Examples


GET
https://platform.uipath.com/odata/AuditLogs?$top=1&$filter=ExecutionTime ge 2017-02-13T11:04:02Z

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#AuditLogs",
  "@odata.count": 47,
  "value": [
    {
      "ServiceName": "UiPath.Application.Services.EnvironmentsService",
      "MethodName": "CreateAsync",
      "Parameters": "{\"user\":\"admin\",\"nameProperty\":\"Name\",\"data\":{\"dto\":{\"name\":\"asd1\",\"description\":null,\"robots\":null,\"type\":\"Dev\",\"id\":0}}}",
      "ExecutionTime": "2017-02-13T13:16:10.47Z",
      "Id": 805
    }
  ]
}

SimpleRobotDto

Entity derived from RobotDto. It shares all the properties of the base entity except the navigation properties. Supported methods: None.

SimpleRobotDto Properties

N/A

SimpleRobotDto Representation

{
  "LicenseKey": "",
  "MachineName": "",
  "Name": "",
  "Username": "",
  "Description": "",
  "Type": "DevTest",
  "Password": "",
  "RobotEnvironments": "",
  "Id": ""
}

SimpleReleaseDto

Entity derived from ReleaseDto. It shares all the properties of the base entity except the navigation properties. Supported methods: None.

SimpleReleaseDto Properties

N/A

SimpleReleaseDto Representation

{
  "Key": "",
  "ProcessKey": "",
  "ProcessVersion": "",
  "IsLatestVersion": false,
  "IsProcessDeleted": false,
  "Description": "",
  "Name": "",
  "EnvironmentId": "",
  "EnvironmentName": "",
  "Id": ""
}

ReleaseDto

A release enables the assignment of a process to an environment. Supported methods: Get, Post, Put and Delete.

ReleaseDto Properties

nametypeDescriptionnullable
KeyEdm.StringA unique identifier associated to each release.
ProcessKeyEdm.StringThe unique identifier of the process associated with the release.false
ProcessVersionEdm.StringThe version of the process associated with the release.false
IsLatestVersionEdm.BooleanStates whether the version of process associated with the release is latest or not.false
IsProcessDeletedEdm.BooleanStates whether the process associated with the release is deleted or not.false
DescriptionEdm.StringUsed to add aditional information about a release in order to better identify it.
NameEdm.StringA custom name of the release. The default name format is ProcessName_EnvironmentName.false
EnvironmentIdEdm.Int64The Id of the environment associated with the release.false
EnvironmentNameEdm.StringThe name of the environment associated with the release.
Id ๐Ÿ”‘Edm.Int64The database unique identifier.false

ReleaseDto Relations

nameEntity TypeTypeDescription
EnvironmentEnvironmentDtoUiPath.Application.Dto.EnvironmentDtoThe environment associated with the release.
CurrentVersionReleaseVersionDtoUiPath.Application.Dto.Releases.ReleaseVersionDtoThe release version associated with the current release.
ReleaseVersionsReleaseVersionDtoCollection(UiPath.Application.Dto.Releases.ReleaseVersionDto)The collection of release versions that current release had over time.

ReleaseDto Representation

{
  "Key": "",
  "ProcessKey": "",
  "ProcessVersion": "",
  "IsLatestVersion": false,
  "IsProcessDeleted": false,
  "Description": "",
  "Name": "",
  "EnvironmentId": "",
  "EnvironmentName": "",
  "Id": ""
}

ReleaseDto Methods & Examples


GET
https://platform.uipath.com/odata/Releases?$top=2&$filter=Environment/Name eq 'doc_env'

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Releases",
  "@odata.count": 9,
  "value": [
    {
      "Key": "5db1dde4-fbde-4901-855c-3226385d3155",
      "ProcessKey": "1OCR_SmokeTest",
      "ProcessVersion": "1.0.6127.20108",
      "IsLatestVersion": false,
      "IsProcessDeleted": false,
      "Description": null,
      "Name": "1OCR_SmokeTest_doc_env",
      "EnvironmentId": 8,
      "EnvironmentName": "doc_env",
      "Id": 80
    },
    {
      "Key": "4cf8acf6-d925-47e8-9ea9-f220accf9ea5",
      "ProcessKey": "assets_tests",
      "ProcessVersion": "1.0.6163.9481",
      "IsLatestVersion": false,
      "IsProcessDeleted": false,
      "Description": "",
      "Name": "assets_tests_doc_env",
      "EnvironmentId": 8,
      "EnvironmentName": "doc_env",
      "Id": 69
    }
  ]
}

POST
https://platform.uipath.com/odata/Releases

Request

Content-Type: application/json
{
      "ProcessKey": "Delay50",
      "ProcessVersion": "1.0.5954.36530",
      "IsLatestVersion": true,
      "IsProcessDeleted": false,
      "Description": "API_test",
      "Name": "Delay50_doc_env",
      "EnvironmentId": 8,
      "EnvironmentName": "doc_env"
  }

Response

Content-Type: application/json
HTTP 200 OK

PUT
https://platform.uipath.com/odata/Releases(67)

Request

Content-Type: application/json
{
  "Key": "9dd04f43-d8fd-4816-ab22-485ee9e7ee92",
  "ProcessKey": "test",
  "ProcessVersion": "1.0.6166.22709",
  "Description": null,
  "Name": "test_doc_env",
  "EnvironmentId": 8,
  "EnvironmentName": "doc_env",
  "Id": 67
}

Response

Content-Type: application/json
HTTP 200 OK 

DELETE
https://platform.uipath.com/odata/Releases(67)

Request

Content-Type: application/json

Response

Content-Type: application/json
HTTP 200 OK

ReleaseVersionDto

Stores data about a version of the various versions of the process associated with a certain release. If a certain version is associated on and off with a release a new ReleaseVersion object is created for each association. Supported methods: None.

ReleaseVersionDto Properties

nametypenullableDescription
ReleaseIdEdm.Int64falseThe Id of the parent release.
VersionNumberEdm.StringfalseThe version of process associated with the release.
CreationTimeEdm.DateTimeOffsetfalseThe date and time when the version was associated with the release.
Id ๐Ÿ”‘Edm.Int64falseThe database unique identifier.

ReleaseVersionDto Representation

{
  "ReleaseId": "",
  "VersionNumber": "",
  "CreationTime": "2017-02-21T11:49:11Z",
  "Id": ""
}

AssetDto

Stores specific data so that Robots can easily have access to it. Supported methods: Get, Post, Put and Delete.

AssetDto Properties

nametypenullableDescription
NameEdm.StringfalseA custom name for the asset.
CanBeDeletedEdm.BooleanfalseStates if an assets can be deleted. The default value of this property is true.
ValueScopeUiPath.Core.Model.Assets.AssetValueScopefalseDefines the scope of the asset. Possible values: Global, PerRobot.
ValueTypeUiPath.Core.Model.Assets.AssetValueTypefalseDefines the type of value stored by the asset. Possible values: DBConnectionString, HttpConnectionString, Text, Bool, Integer or Credential.
ValueEdm.StringThe textual representation of the asset value, irrespective of value type.
StringValueEdm.StringThe value of the asset when the value type is Text. Empty when the value type is not Text.
BoolValueEdm.BooleanfalseThe value of the asset when the value type is Bool. False when the value type is not Bool.
IntValueEdm.Int32falseThe value of the asset when the value type is Integer. 0 when the value type is not Integer.
CredentialUsernameEdm.StringThe user name when the value type is Credential. Empty when the value type is not Credential
CredentialPasswordEdm.StringThe password when the value type is Credential. Empty when the value type is not Credential
KeyValueListCollection(UiPath.Core.Model.Assets.CustomKeyValuePair)A collection of key value pairs when the type is KeyValueList. Empty when the value type is not KeyValueList.
Id ๐Ÿ”‘Edm.Int64falseThe database unique identifier.

AssetDto Relations

nameEntity TypeTypeDescription
RobotValuesAssetRobotValueDtoCollection(UiPath.Application.Dto.Assets.AssetRobotValueDto)The collection of asset values per robot. Empty if the asset type is Global.

AssetDto Representation

{
  "Name": "",
  "CanBeDeleted": false,
  "ValueScope": "Global",
  "ValueType": "DBConnectionString",
  "Value": "",
  "StringValue": "",
  "BoolValue": false,
  "IntValue": 0,
  "CredentialUsername": "",
  "CredentialPassword": "",
  "KeyValueList": [
    {
      "Key": "",
      "Value": ""
    }
  ],
  "Id": ""
}

AssetDto Methods & Examples


GET
https://platform.uipath.com/odata/Assets?$filter=Name eq 'QueueName'

Note: This method can be filtered only according to the asset name.

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Assets",
  "@odata.count": 1,
  "value": [
    {
      "Name": "QueueName",
      "CanBeDeleted": true,
      "ValueScope": "PerRobot",
      "ValueType": "Text",
      "Value": "[Value per robot]",
      "StringValue": null,
      "BoolValue": false,
      "IntValue": 0,
      "CredentialUsername": null,
      "CredentialPassword": null,
      "Id": 3,
      "KeyValueList": []
    }
  ]
}

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

Request

Content-Type: application/json
{
  "Name": "API_Test",
  "CanBeDeleted": false,
  "ValueScope": "Global",
  "ValueType": "Text",
  "Value": "API_test",
  "StringValue": "API_test",
  "BoolValue": false
}

Response

Content-Type: application/json
HTTP 200 OK

PUT
https://platform.uipath.com/odata/Assets(79)

Request

Content-Type: application/json
{
    "Id":79,
    "Name":"API_Test",
    "Value":"API_test_part8",
    "ValueType":"Text",
    "ValueScope":"Global",
    "CanBeDeleted":true,
    "StringValue":"API_test_part99999",
    "RobotValues":[]
}

Response

Content-Type: application/json
HTTP 200 OK

DELETE
https://platform.uipath.com/odata/Assets(80)

Request

Content-Type: application/json

Response

Content-Type: application/json
HTTP 204 No Content

AssetRobotValueDto

Stores the value of an asset associated with a robot as well as the robot association data. Supported methods: None.

AssetRobotValueDto Properties

nametypenullableDescription
RobotIdEdm.Int64falseThe Id of the robot with which the asset is associated.
RobotNameEdm.StringThe name of the robot with which the asset is associated.
KeyTrailEdm.StringMasked value of the robot key.
ValueTypeUiPath.Core.Model.Assets.AssetValueTypefalseDefines the type of value stored by the asset. Possible values: DBConnectionString, HttpConnectionString, Text, Bool, Integer or Credential.
StringValueEdm.StringThe value of the asset when the value type is Text. Empty when the value type is not Text.
BoolValueEdm.BooleanfalseThe value of the asset when the value type is Bool. False when the value type is not Bool.
IntValueEdm.Int32falseThe value of the asset when the value type is Integer. 0 when the value type is not Integer.
ValueEdm.StringThe textual representation of the asset value, irrespective of value type.
CredentialUsernameEdm.StringThe user name when the value type is Credential. Empty when the value type is not Credential
CredentialPasswordEdm.StringThe password when the value type is Credential. Empty when the value type is not Credential
KeyValueListCollection(UiPath.Core.Model.Assets.CustomKeyValuePair)A collection of key value pairs when the type is KeyValueList. Empty when the value type is not KeyValueList.
Id ๐Ÿ”‘Edm.Int64falseThe database unique identifier.

AssetRobotValueDto Representation

{
  "RobotId": "",
  "RobotName": "",
  "KeyTrail": "",
  "ValueType": "DBConnectionString",
  "StringValue": "",
  "BoolValue": false,
  "IntValue": 0,
  "Value": "",
  "CredentialUsername": "",
  "CredentialPassword": "",
  "KeyValueList": [
    {
      "Key": "",
      "Value": ""
    }
  ],
  "Id": ""
}

QueueDefinitionDto

The definition of a work queue. A work queue contains work items that are processed by Robots. Supported methods: Get, Post, Put and Delete.

QueueDefinitionDto Properties

nametypeDescriptionnullable
NameEdm.StringA custom name for the queue.
DescriptionEdm.StringUsed to add aditional information about a queue in order to better identify it.
MaxNumberOfRetriesEdm.Int32An integer value representing the number of times an item of this queue can be retried if its processing fails with application exception and auto retry is on.false
AcceptAutomaticallyRetryEdm.BooleanStates whether a robot should retry to process an item if, after processing, it failed with application exception.false
ArchiveItemsEdm.BooleanStates whether the items of the queue should be archived after processing.false
CreationTimeEdm.DateTimeOffsetThe date and time when the queue was created.false
Id ๐Ÿ”‘Edm.Int64The database unique identifier.false

QueueDefinitionDto Representation

{
  "Name": "",
  "Description": "",
  "MaxNumberOfRetries": 0,
  "AcceptAutomaticallyRetry": false,
  "ArchiveItems": false,
  "CreationTime": "2017-02-21T11:49:11Z",
  "Id": ""
}

QueueDefinitionDto Methods & Examples


GET
https://platform.uipath.com/odata/QueueDefinitions?$filter=MaxNumberOfRetries eq 2

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#QueueDefinitions",
  "@odata.count": 2,
  "value": [
    {
      "Name": "AlexVQueue",
      "Description": null,
      "MaxNumberOfRetries": 2,
      "AcceptAutomaticallyRetry": true,
      "ArchiveItems": true,
      "CreationTime": "2016-10-27T15:47:02.43Z",
      "Id": 2
    },
    {
      "Name": "myFirstQueue",
      "Description": null,
      "MaxNumberOfRetries": 2,
      "AcceptAutomaticallyRetry": true,
      "ArchiveItems": true,
      "CreationTime": "2017-01-16T11:49:47.79Z",
      "Id": 32
    }
  ]
}

POST
https://platform.uipath.com/odata/QueueDefinitions

Request

Content-Type: application/json
 {
      "Name": "APItestQueue",
      "Description": null,
      "MaxNumberOfRetries": 5,
      "AcceptAutomaticallyRetry": true,
      "ArchiveItems": true
    }

Response

Content-Type: application/json
HTTP 200 OK

PUT
https://platform.uipath.com/odata/QueueDefinitions(32)

Request

Content-Type: application/json
{
    "Name": "myFirstQueue_APItest",
    "Description": "API test to change name, description, # of retries and archiveitems.",
    "MaxNumberOfRetries": 9,
    "AcceptAutomaticallyRetry": true,
    "ArchiveItems": false,
    "CreationTime": "2017-01-16T11:49:47.79Z",
    "Id": 32
}

Response

Content-Type: application/json
HTTP 200 OK

DELETE
https://platform.uipath.com/odata/QueueDefinitions(42)

Request

Content-Type: application/json

Response

Content-Type: application/json
HTTP 204 OK

QueueItemDto

Defines a piece of data that can be processed by a Robot and the information associated with its processing status. Queue items are grouped in queues. Supported methods: Get and Delete.

QueueItemDto Properties

nametypenullableDescription
QueueDefinitionIdEdm.Int64falseThe Id of the parent queue.
QueueDefinitionNameEdm.StringThe name of the parent queue.
ProcessingExceptionIdEdm.Int64The Id of the processing exception, if any.
SpecificContentUiPath.Core.Model.Queues.QueueItemSpecificContentA collection of key value pairs containing custom data configured in the Add Queue Item activity, in UiPath Studio.
OutputUiPath.Core.Model.Queues.QueueItemOutputA collection of key value pairs containing custom data resulted after successful processing.
OutputDataEdm.StringA JSON representaion of the output data generated by the item's processing.
StatusUiPath.Core.Model.Queues.ProcessingStatusfalseThe processing state of the item. Possible values: New, InProgress, Failed, Successful, Abandoned or Retried.
ReviewStatusUiPath.Core.Model.Queues.Enums.ReviewStatusfalseThe review state of the item - applicable only for failed items. Possible values: None, InReview, Verified or Retried.
KeyEdm.GuidfalseThe unique identifier of a queue item.
ExceptionTypeUiPath.Core.Model.Queues.Enums.ProcessingExceptionTypeThe processing exception type, if any. Possible values: ApplicationException or BusinessException.
DueDateEdm.DateTimeOffsetThe latest date and time at which the item should be processed. If empty the item can be processed at any given time.
PriorityUiPath.Core.Model.Queues.PriorityfalseSets the processing importance for a given item. Possible values: High, Normal or Low.
DeferDateEdm.DateTimeOffsetThe earliest date and time at which the item is available for processing. If empty the item can be processed as soon as possible.
StartProcessingEdm.DateTimeOffsetThe date and time at which the item processing started. This is null if the item was not processed.
EndProcessingEdm.DateTimeOffsetThe date and time at which the item processing ended. This is null if the item was not processed.
SecondsInPreviousAttemptsEdm.Int32falseThe number of seconds that the last failed processing lasted.
AncestorIdEdm.Int64The Id of an ancestor item connected to the current item.
RetryNumberEdm.Int32falseThe number of times this work item has been processed. This can be higher than 0 only if MaxRetried number is set and the item was never processed Succesfully or with BusinessException.
SpecificDataEdm.StringA JSON representation of the specific content.
CreationTimeEdm.DateTimeOffsetfalseThe date and time when the item was created.
Id ๐Ÿ”‘Edm.Int64falseThe database unique identifier.

QueueItemDto Relations

nameEntity TypeTypeDescription
ProcessingExceptionProcessingExceptionDtoUiPath.Application.Dto.Queues.ProcessingExceptionDtoThe processing exception. If the item has not been processed or has been processed succesfully it will be null.
RobotRobotDtoUiPath.Application.Dto.RobotDtoThe robot that has processed the item, if any.

QueueItemDto Representation

{
  "QueueDefinitionId": "",
  "QueueDefinitionName": "",
  "ProcessingExceptionId": "",
  "SpecificContent": null,
  "Output": null,
  "OutputData": "",
  "Status": "New",
  "ReviewStatus": "None",
  "Key": "",
  "ExceptionType": "ApplicationException",
  "DueDate": "2017-02-21T11:49:11Z",
  "Priority": "High",
  "DeferDate": "2017-02-21T11:49:11Z",
  "StartProcessing": "2017-02-21T11:49:11Z",
  "EndProcessing": "2017-02-21T11:49:11Z",
  "SecondsInPreviousAttempts": 0,
  "AncestorId": "",
  "RetryNumber": 0,
  "SpecificData": "",
  "CreationTime": "2017-02-21T11:49:11Z",
  "Id": ""
}

QueueItemDto Methods & Examples


GET
https://platform.uipath.com/odata/QueueItems?$top=2&$filter=Robot/Description eq 'doc_tests' and Status eq UiPath.Core.Model.Queues.ProcessingStatus%27Failed%27

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#QueueItems",
  "@odata.count": 169,
  "value": [
    {
      "QueueDefinitionId": 32,
      "QueueDefinitionName": "myFirstQueue_APItest",
      "ProcessingExceptionId": 389,
      "OutputData": null,
      "Status": "Failed",
      "ReviewStatus": "None",
      "Key": "1323fbce-3899-466f-bdec-1a2eaf90e66d",
      "ExceptionType": "BusinessException",
      "DueDate": null,
      "Priority": "Normal",
      "DeferDate": null,
      "StartProcessing": "2017-01-20T15:09:28.777Z",
      "EndProcessing": "2017-01-20T15:09:29.873Z",
      "SecondsInPreviousAttempts": 1,
      "AncestorId": null,
      "RetryNumber": 0,
      "SpecificData": "{\"DynamicProperties\":{\"totalValue\":423}}",
      "CreationTime": "2017-01-20T14:55:10.4Z",
      "Id": 782971,
      "SpecificContent": {
        "totalValue": 423
      },
      "Output": null
    }
  ]
}

DELETE
https://platform.uipath.com/odata/QueueItems(782971)

Request

Content-Type: application/json

Response

Content-Type: application/json
HTTP 204 No Content

QueueProcessingRecordDto

Stores aggregated report information about the processing status of all the items from a given queue in a specific time period. Supported methods: None.

QueueProcessingRecordDto Properties

nametypenullableDescription
QueueDefinitionIdEdm.Int64falseThe Id of the queue for which the report is done.
ProcessingTimeEdm.DateTimeOffsetfalseThe date and time when the report is computed.
ReportTypeUiPath.Core.Model.Queues.ReportingUnitfalseThe aggregation period used in the report. Possible values: Minute, Hour or Day.
NumberOfApplicationExceptionsEdm.Int32falseThe total number of application exceptions thrown while processing queue items in the given time period.
NumberOfBusinessExceptionsEdm.Int32falseThe total number of business exceptions thrown while processing queue items in the given time period.
NumberOfSuccessfulTransactionsEdm.Int32falseThe total number of successfully processed queue items in the given time period.
NumberOfRetriedItemsEdm.Int32falseThe total number of processing retries occured in the given time period.
ApplicationExceptionsProcessingTimeEdm.Int32falseThe total number of seconds spent processing queue items that failed with application exception in the given time period.
BusinessExceptionsProcessingTimeEdm.Int32falseThe total number of seconds spent processing queue items that failed with business exception in the given time period.
SuccessfulTransactionsProcessingTimeEdm.Int32falseThe total number of seconds spent processing successful queue items in the given time period.
TotalNumberOfTransactionsEdm.Int32falseThe total number of item processing transactions, both failed and successful.
TenantIdEdm.Int32falseThe Id of the queue tenant.
Id ๐Ÿ”‘Edm.Int64falseThe database unique identifier.

QueueProcessingRecordDto Relations

nameEntity TypeTypeDescription
UiQueueMetadataQueueDefinitionDtoUiPath.Application.Dto.Queues.QueueDefinitionDtoThe queue for which the report is done.

QueueProcessingRecordDto Representation

{
  "QueueDefinitionId": "",
  "ProcessingTime": "2017-02-21T11:49:11Z",
  "ReportType": "Minute",
  "NumberOfApplicationExceptions": 0,
  "NumberOfBusinessExceptions": 0,
  "NumberOfSuccessfulTransactions": 0,
  "NumberOfRetriedItems": 0,
  "ApplicationExceptionsProcessingTime": 0,
  "BusinessExceptionsProcessingTime": 0,
  "SuccessfulTransactionsProcessingTime": 0,
  "TotalNumberOfTransactions": 0,
  "TenantId": 0,
  "Id": ""
}

ProcessingExceptionDto

Stores information about exceptions thrown while processing failed queue items. Supported methods: None.

ProcessingExceptionDto Properties

nametypeDescriptionnullable
ReasonEdm.StringThe reason the processing failed.
DetailsEdm.StringStores additional details about the exception.
TypeUiPath.Core.Model.Queues.Enums.ProcessingExceptionTypeThe processing exception type, if any. Possible values: ApplicationException or BusinessException.false
AssociatedImageFilePathEdm.StringA path on the robot running computer to an image file that stores relevant information about the exception - eg. a system print screen.
Id ๐Ÿ”‘Edm.Int64The database unique identifier.false

ProcessingExceptionDto Representation

{
  "Reason": "",
  "Details": "",
  "Type": "ApplicationException",
  "AssociatedImageFilePath": "",
  "Id": ""
}

RoleDto

A role acts as a grouping of permissions. Roles are associated with users to provide application authorization. Supported methods: Get, Post, Put and Delete.

RoleDto Properties

nametypeDescriptionnullable
NameEdm.StringA custom name for the role.
DisplayNameEdm.StringAn alternative name used for UI display.
GroupsEdm.StringAllows groupping multiple roles together.
IsStaticEdm.BooleanStates whether the group is defined by the application and cannot be deleted or modified or it is user defined and can be deleted or modified.false
Id ๐Ÿ”‘Edm.Int32The database unique identifier.false

RoleDto Relations

nameEntity TypeTypeDescription
PermissionsPermissionDtoCollection(UiPath.Application.Dto.Permissions.PermissionDto)The collection of application permissions associated with the role.

RoleDto Representation

{
  "Name": "",
  "DisplayName": "",
  "Groups": "",
  "IsStatic": false,
  "Id": 0,
"Permissions":[] }

RoleDto Methods & Examples


GET
https://platform.uipath.com/odata/Roles?$filter=Name eq 'admin'

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Roles",
  "@odata.count": 11,
  "value": [
    {
      "Name": "admin",
      "DisplayName": "admin",
      "Groups": null,
      "IsStatic": false,
      "Id": 15
    },
    {
      "Name": "Administrator",
      "DisplayName": "Administrator",
      "Groups": null,
      "IsStatic": true,
      "Id": 6
    }
  ]
}

POST
https://platform.uipath.com/odata/Roles

Request

Content-Type: application/json
{
    "Name": "API_test",
    "DisplayName": "API_test",
    "Groups": null,
    "IsStatic": false,
    "Permissions":[]
}

Response

Content-Type: application/json
HTTP 200 OK

PUT
https://platform.uipath.com/odata/Roles(92)

Request

Content-Type: application/json
  {
    "Name": "API_test",
    "DisplayName": "API_test",
    "Groups": null,
    "IsStatic": false,
    "Id": 92,
    "Permissions":
      [	
    	{
      	"Name":"Settings.View",
      	"IsGranted":true
        },
    	{
      	"Name":"Alerts.View",
      	"IsGranted":true
    	}
      ]
    }

Response

Content-Type: application/json
HTTP 200 OK

DELETE
https://platform.uipath.com/odata/Roles(91)

Request

Content-Type: application/json

Response

Content-Type: application/json
HTTP 200 OK

UserRoleDto

Stores information about the association between a user and a role. Supported methods: None.

UserRoleDto Properties

nametypenullableDescription
UserIdEdm.Int64falseThe Id of the associated user.
RoleIdEdm.Int32falseThe Id of the associated role.
Id ๐Ÿ”‘Edm.Int64falseThe database unique identifier.

UserRoleDto Representation

{
  "UserId": "",
  "RoleId": 0,
  "Id": ""
}

PermissionDto

Stores information about an application permission and role association, and returns the entire list of permissions. Supported method: Get.

PermissionDto Properties

nametypeDescriptionnullable
NameEdm.StringThe name of the application permission.
IsGrantedEdm.BooleanStates if a user associated with the role will be allowed or denied to perform the actions governed by the permission.false
RoleIdEdm.Int32The Id of the role associated with the permission.false
Id ๐Ÿ”‘Edm.Int64The database unique identifier.false

PermissionDto Representation

{
  "Name": "",
  "IsGranted": false,
  "RoleId": 0,
  "Id": ""
}

PermissionDto Methods & Examples


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

Request

Content-Type: application/json

Response

Note: This response has been truncated, due to its size.

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Permissions",
  "@odata.count": 75,
  "value": [
    {
      "Name": "Settings",
      "IsGranted": false,
      "RoleId": 0,
      "Id": 0
    },
    {
      "Name": "Robots",
      "IsGranted": false,
      "RoleId": 0,
      "Id": 0
    },
    {
      "Name": "Processes",
      "IsGranted": false,
      "RoleId": 0,
      "Id": 0
    },
    {
      "Name": "Packages",
      "IsGranted": false,
      "RoleId": 0,
      "Id": 0
    }
  ]
}

UserDto

Stores information about assigned role(s) and email settings, and enables a person or a Robot to login to Orchestrator. Supported methods: Get, Post, Put, Delete.

UserDto Properties

nametypeDescriptionnullable
NameEdm.StringThe name of the person for which the user is created.
SurnameEdm.StringThe surname of the person for which the user is created.
UserNameEdm.StringThe name used to login to Orchestrator.
FullNameEdm.StringThe full name of the person constructed with the format Surname Name.
EmailAddressEdm.StringThe e-mail address associated with the user.
IsEmailConfirmedEdm.BooleanStates if the email address is valid or not.false
LastLoginTimeEdm.DateTimeOffsetThe date and time when the user last logged in, or null if the user never logged in.
IsActiveEdm.BooleanStates if the user is active or not. An inactive user cannot login to Orchestratorfalse
CreationTimeEdm.DateTimeOffsetThe date and time when the user was created.false
AuthenticationSourceEdm.StringThe source which authenticated this user.
PasswordEdm.StringThe password used during application login.
RolesListCollection(Edm.String)The collection of role names associated with the user.
LoginProvidersCollection(Edm.String)The collection of entities that can authenticate the user.
TenancyNameEdm.StringThe name of the tenant owning the user.
TypeUiPath.Core.Enums.UserTypeThe user type. Possible values: User or Robot.false
Id ๐Ÿ”‘Edm.Int64The database unique identifier.false

UserDto Relations

nameEntity TypeTypeDescription
UserRolesUserRoleDtoCollection(UiPath.Application.Dto.Roles.UserRoleDto)The collection of roles associated with the user.

UserDto Representation

{
  "Name": "",
  "Surname": "",
  "UserName": "",
  "FullName": "",
  "EmailAddress": "",
  "IsEmailConfirmed": false,
  "LastLoginTime": "2017-02-21T11:49:11Z",
  "IsActive": false,
  "CreationTime": "2017-02-21T11:49:11Z",
  "AuthenticationSource": "",
  "Password": "",
  "RolesList": [
    ""
  ],
  "LoginProviders": [
    ""
  ],
  "TenancyName": "",
  "Type": "User",
  "Id": ""
}

UserDto Methods & Examples


GET
https://platform.uipath.com/odata/Users?$top=1&$filter=contains(UserName,'doc') and Type eq UiPath.Core.Enums.UserType%27Robot%27

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Users",
  "@odata.count": 2,
  "value": [
    {
      "Name": "",
      "Surname": "",
      "UserName": "Documentation1",
      "FullName": null,
      "EmailAddress": "",
      "IsEmailConfirmed": true,
      "LastLoginTime": "2017-02-23T12:01:17.31Z",
      "IsActive": true,
      "CreationTime": "2016-10-31T16:15:38.387Z",
      "AuthenticationSource": null,
      "Password": null,
      "RolesList": [
        "Robot"
      ],
      "LoginProviders": [],
      "TenancyName": null,
      "Type": "Robot",
      "Id": 26
    }
  ]
}

POST
https://platform.uipath.com/odata/Users

Request

Content-Type: application/json
{
      "Name": "Test",
      "Surname": "API",
      "UserName": "API_Test",
      "FullName": null,
      "EmailAddress": "api@test.com",
      "IsEmailConfirmed": true,
      "IsActive": true,
      "AuthenticationSource": null,
      "Password": null,
      "RolesList": [
        "Administrator"
      ],
      "LoginProviders": [],
      "TenancyName": null,
      "Type": "User"
    }

Response

Content-Type: application/json
HTTP 200 OK

PUT
https://platform.uipath.com/odata/Users(193)

Request

Content-Type: application/json
   {
      "Id": 193,
      "Name": "Test",
      "Surname": "API",
      "UserName": "API_Test",
      "FullName": null,
      "EmailAddress": "api@test.com",
      "IsEmailConfirmed": true,
      "IsActive": true,
      "AuthenticationSource": null,
      "Password": null,
      "LastLoginTime":null,
      "CreationTime":"2017-02-23T15:11:46.847Z",
      "RolesList": [
        "API_test", "Administrator"
      ],
      "LoginProviders": [],
      "TenancyName": null,
      "Type": "User"
    }

Response

Content-Type: application/json
HTTP 200 OK

DELETE
https://platform.uipath.com/odata/Users(193)

Request

Content-Type: application/json

Response

Content-Type: application/json
HTTP 200 OK

AlertDto

Stores notification data used to inform the users about specific application events. Supported method: Get.

AlertDto Properties

nametypeDescriptionnullable
NotificationNameEdm.StringThe name of a specific type of notification, eg. Robot.StatusChanged.NotResponding.
DataEdm.StringStores data about the context in which the event occured, in JSON format.
EntityTypeNameEdm.StringThe fully qualified type name of the allert, eg. UiPath.Core.Alerts.Model.RobotStatusNotification, UiPath.Core, Version=2016.2.6220.18686, Culture=neutral, PublicKeyToken=null.
SeverityAbp.Notifications.NotificationSeverityThe severity level of the alert. Possible values: Info, Success, Warn, Error or Fatal.false
CreationTimeEdm.DateTimeOffsetThe date and time when the alert was generated.false
StateAbp.Notifications.UserNotificationStateDefines if a specified notification has been read or not.false
UserNotificationIdEdm.GuidThe database unique identifier for the alert notification sent to the current user.false
Id ๐Ÿ”‘Edm.GuidThe database unique identifier.false

AlertDto Representation

{
  "NotificationName": "",
  "Data": "",
  "EntityTypeName": "",
  "Severity": "Info",
  "CreationTime": "2017-02-21T11:49:11Z",
  "State": "Unread",
  "UserNotificationId": "",
  "Id": ""
}

AlertDto Methods & Examples


GET
https://platform.uipath.com/odata/Alerts?$top=2&$filter=CreationTime ge 2017-02-16T15:50:59Z and Severity eq Abp.Notifications.NotificationSeverity%27Fatal%27

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Alerts",
  "@odata.count": 443,
  "value": [
    {
      "NotificationName": "Robot.StatusChanged.Offline",
      "Data": "{\"RobotId\":182,\"RobotName\":\"DanbR_virtual\",\"State\":2,\"NotResponding\":false,\"Message\":\"#robot DanbR_virtual  disconnected\",\"ReportingTime\":\"2017-02-21T09:50:32.0949683Z\",\"Type\":\"UiPath.Core.Alerts.Model.RobotStatusNotification\",\"Properties\":{}}",
      "EntityTypeName": "UiPath.Core.Model.UiRobot",
      "Severity": "Fatal",
      "CreationTime": "2017-02-21T09:50:35.017Z",
      "State": "Unread",
      "UserNotificationId": "4ddd1370-4e90-4504-81fc-1a41a7b50392",
      "Id": "78c4db48-bcd8-475f-8749-00e378384a85"
    },
    {
      "NotificationName": "Robot.StatusChanged.Offline",
      "Data": "{\"RobotId\":178,\"RobotName\":\"danb_r2\",\"State\":2,\"NotResponding\":false,\"Message\":\"#robot danb_r2  disconnected\",\"ReportingTime\":\"2017-02-20T15:59:07.1231017Z\",\"Type\":\"UiPath.Core.Alerts.Model.RobotStatusNotification\",\"Properties\":{}}",
      "EntityTypeName": "UiPath.Core.Model.UiRobot",
      "Severity": "Fatal",
      "CreationTime": "2017-02-20T15:59:11.763Z",
      "State": "Unread",
      "UserNotificationId": "e486fa09-41bb-43f3-9f9a-5783462046be",
      "Id": "7cf63db7-bb8c-46c3-957e-01774ca62844"
    }
  ]
}

RobotExecutorDto

Stores information about a Robot on which a process will be executed. Supported methods: None.

RobotExecutorDto Properties

nametypeDescriptionnullable
MachineNameEdm.StringThe name of the machine on which the robot runs the job.
NameEdm.StringThe name of the robot that runs the job.
DescriptionEdm.StringThe description of the robot that runs the job.
Id ๐Ÿ”‘Edm.Int64The database unique identifier.false

RobotExecutorDto Representation

{
  "MachineName": "",
  "Name": "",
  "Description": "",
  "Id": ""
}

Complex Types

StartProcessDto

The Start Process transfers information from the client to the server during JobsController.StartJobs custom action. Supported methods: None.

StartProcessDto Properties

nametypenullableDescription
ReleaseKeyEdm.StringfalseThe unique key of the release associated with the process.
StrategyUiPath.Core.Enums.StartStrategyfalseStates which robots from the environment are runned by the process. Possible values: All, Specific or RobotCount.
RobotIdsCollection(Edm.Int64)falseThe collection of ids of specific robots selected to be run by the current process. This collection must be empty only if the start strategy is not 1 (Specific).
NoOfRobotsEdm.Int32falseThe number of robots selected to be run by the current process. This number must be greater than 0 only if the start strategy is not 2 (RobotCount).
SourceUiPath.Core.Enums.JobSourcefalseThe Source of the job starting the current process. Possible values: Manual or Schedule.

RobotAssetDto

A robot asset stores the information of a per robot asset for a specific robot, without specifying the robot. Supported methods: None.

RobotAssetDto Properties

>
nametypenullableDescription
NameEdm.StringfalseThe asset name.
ValueTypeUiPath.Core.Model.Assets.AssetValueTypeDefines the type of value stored by the asset. Possible values: DBConnectionString, HttpConnectionString, Text, Bool, Integer or Credential.
StringValueEdm.StringThe value of the asset when the value type is Text. Empty when the value type is not Text.
BoolValueEdm.BooleanThe value of the asset when the value type is Bool. False when the value type is not Bool.
IntValueEdm.Int32The value of the asset when the value type is Integer. 0 when the value type is not Integer.
CredentialUsernameEdm.StringThe user name when the value type is Credential. Empty when the value type is not Credential
CredentialPasswordEdm.StringThe password when the value type is Credential. Empty when the value type is not Credential

TransactionDataDto

Stores data sent when processing of an existing or a new item starts. Supported methods: None.

TransactionDataDto Properties

nametypeDescriptionnullable
NameEdm.StringThe name of the queue in which to search for the next item or in which to insert the item before marking it as InProgress and sending it to the robot.
RobotIdentifierEdm.GuidThe unique key identifying the robot that sent the request.false
SpecificContentUiPath.Core.Model.Queues.QueueItemSpecificContentIf not null a new item will be added to the queue with this content before being moved to InProgress state and returned to the robot for processing. If null the next available item in the list will be moved to InProgress state and returned to the robot for processing.
DeferDateEdm.DateTimeOffsetThe earliest date and time at which the item is available for processing. If empty the item can be processed as soon as possible.
DueDateEdm.DateTimeOffsetThe latest date and time at which the item should be processed. If empty the item can be processed at any given time.

QueueItemDataDto

Defines the work item content. Supported methods: None.

QueueItemDataDto Properties

nametypeDescriptionnullable
NameEdm.StringThe name of the queue into which the item will be added.
PriorityUiPath.Core.Model.Queues.PrioritySets the processing importance for a given item. Possible values: High, Normal or Low.false
SpecificContentUiPath.Core.Model.Queues.QueueItemSpecificContentA collection of key value pairs containing custom data configured in the Add Queue Item activity, in UiPath Studio.
DeferDateEdm.DateTimeOffsetThe earliest date and time at which the item is available for processing. If empty the item can be processed as soon as possible.
DueDateEdm.DateTimeOffsetThe latest date and time at which the item should be processed. If empty the item can be processed at any given time.

TransactionResultDto

Stores data sent when processing an item ended. Supported methods: None.

TransactionResultDto Properties

nametypenullableDescription
IsSuccessfulEdm.BooleanfalseStates if the processing was successful or not.
DeferDateEdm.DateTimeOffsetThe earliest date and time at which the item is available for processing. If empty the item can be processed as soon as possible.
DueDateEdm.DateTimeOffsetThe latest date and time at which the item should be processed. If empty the item can be processed at any given time.
OutputUiPath.Core.Model.Queues.QueueItemOutputA collection of key value pairs containing custom data resulted after successful processing.

QueueItemSpecificContent

A collection of key value pairs containing custom data associated to a queue item. Supported methods: None.

QueueItemSpecificContent Properties

N/A

QueueProcessingStatus

Stores aggregated report information about the processing status of all the items from a given queue. Supported methods: None.

QueueProcessingStatus Properties

nametypenullableDescription
ItemsToProcessEdm.Int32falseThe total number of items in the queue with the status New.
QueueDefinitionIdEdm.Int64falseThe Id of the queue for which the report is done.
QueueDefinitionNameEdm.StringThe name of the queue for which the report is done.
QueueDefinitionDescriptionEdm.StringThe description of the queue for which the report is done.
QueueDefinitionAcceptAutomaticallyRetryEdm.BooleanfalseStates whether the queue accepts automatic item retry or not.
QueueDefinitionMaxNumberOfRetriesEdm.Int32falseThe maximum number of retries allowed for any item of the queue.
ProcessingMeanTimeEdm.SinglefalseThe average time spent processing a successful item.
SuccessfulTransactionsNoEdm.Int32falseThe total number of successfully processed items.
ApplicationExceptionsNoEdm.Int32falseThe total number of application exceptions thrown while processing queue items.
BusinessExceptionsNoEdm.Int32falseThe total number of business exceptions thrown while processing queue items.
SuccessfulTransactionsProcessingTimeEdm.Int32falseThe total number of seconds spent processing successful queue items.
ApplicationExceptionsProcessingTimeEdm.Int32falseThe total number of seconds spent processing queue items that failed with application exception.
BusinessExceptionsProcessingTimeEdm.Int32falseThe total number of seconds spent processing queue items that failed with business exception.
TotalNumberOfTransactionsEdm.Int32falseThe total number of item processing transactions, both failed and successful.
LastProcessedEdm.DateTimeOffsetThe date and time of the last item processing.

QueueItemOutput

A collection of key value pairs containing custom data resulted after successful processing. Supported methods: None.

QueueItemOutput Properties

N/A

UserPermissionsCollection

Stores information about all the permissions a user is associated with in Orchestrator. Supported methods: None.

UserPermissionsCollection Properties

nametypenullableDescription
UserIdEdm.Int64falseThe Id of the user associated with the permissions.
PermissionsCollection(Edm.String)The collection of names of the permissions the user is associated with.

CustomKeyValuePair

Stores a custom pair of key and value for assets with type KeyValueList. Supported methods: None.

CustomKeyValuePair Properties

nametypeDescription
KeyEdm.StringA piece of text representing the key.
ValueEdm.StringA piece of text representing the value.

Enumerated Types

ProcessingStatus

Defines the processing state of a given queue item. Supported methods: None.

ProcessingStatus Members

Name Value Description
New 0 The state of a newly added item.
InProgress 1 The state of an item that is being processed now.
Failed 2 The state of an item whose processing ended in failure.
Successful 3 The state of an item whose processing ended in success.
Abandoned 4 The state of an item whose processing was stoped before succeeding or failing.
Retried 5 The state of an item that was processed at least twice.

Priority

Defines the processing importance of a given queue item. Supported methods: None.

Priority Members

Name Value Description
High 0 Items with this priority are processed before any item with other priorities if other ordering settings (like DueDate or DeferDate) are similar.
Normal 1 Items with this priority are processed before any item with Low priority but after any item with High priority if other ordering settings (like DueDate or DeferDate) are similar./td>
Low 2 Items with this priority are processed after any item with other priorities if other ordering settings (like DueDate or DeferDate) are similar.

ReportingUnit

The aggregation period used when computing a processing report. Supported methods: None.

ReportingUnit Members

Name Value Description
Minute 0 The aggregation period for a report is one minute.
Hour 1 The aggregation period for a report is one hour.
Day 2 The aggregation period for a report is one day.
All -1

AssetValueScope

Defines the visibility level of an asset. Supported methods: None.

AssetValueScope Members

Name Value Description
Global 0 If an asset has Global scope, it is visible to all robots.
PerRobot 1 If an asset has PerRobot scope, it will be visible only to certain robots, to which it was associated and may have different values for each robot.

AssetValueType

Defines what type of value is stored by an asset. Supported methods: None.

AssetValueType Members

Name Value Description
DBConnectionString 0 Defines an asset that stores a database connection string.
HttpConnectionString 1 Defines an asset that stores an HTTP connection string.
Text 2 Defines an asset that stores a text value.
Bool 3 Defines an asset that stores a boolean value.
Integer 4 Defines an asset that stores a numerical value.
Credential 5 Defines an asset that stores a username and password.
WindowsCredential 6 Defines an asset that stores a Windows username and password.
KeyValueList 7 Defines an asset that stores a collection of key value pairs.

StopStrategy

Provides information about how a job should be stopped. Supported methods: None.

StopStrategy Members

Name Value Description
SoftStop 1 The soft stop strategy will stop a job when the process is finished or after the first Should Stop activity with a True value is executed.
Kill 2 The kill strategy will stop a job immediately.

RobotType

Defines categories of robots based on their usage. Supported methods: None.

RobotType Members

Name Value Description
DevTest 0 Defines a robot created during development for testing purposes.
FrontOffice 1 Defines a robot that works side by side with the human agents and assists them to complete the process.
BackOffice 2 Defines a robot that works in an unattended manner, independent of any human interaction.

EnvironmentType

Defines categories of environments based on their usage. Supported methods: None.

EnvironmentType Members

Name Value Description
Dev 0 Defines an environment used for development purposes.
Test 1 Defines an environment used for testing purposes.
Prod 2 Defines an environment used in production.

RobotState

Defines the Robot availability state. Supported methods: None.

RobotState Members

Name Value Description
Available 0 Defines an functioning robot that is free to be used.
Busy 1 Defines a robot that is running a process.
Disconnected 2 Defines a robot that is disconnected from Orchestrator.
Unknown 3 Defines a robot that is in an Unknown state.

JobState

Defines the state of a job. Supported methods: None.

JobState Members

Name Value Description
Pending 0 A pending job is queued for a robot if the robot is busy or disconnected.
Running 1 A running job is a job that is currently processed by a robot.
Canceling 2 A cancelling job is a job triggered to cancel as soon as the process considers it safe to stop. This is usually achieved by using "ShouldStop" activity when implementing the process.
Terminating 3 A terminating job is a job triggered to forcefully stop. This may take up to a couple of seconds and the process is killed. Safe stopping is not guaranteed.
Faulted 4 A faulted stop has failed to start or the associated workflow threw an unhandled error during execution.
Successful 5 A successful job is a job that finished processing without any exceptions.
Canceled 6 A canceled job is a job stopped before it finished executing without throwing any errors.

JobSource

A job source stores data about how a job was created. Supported methods: None.

JobSource Members

Name Value Description
Manual 0 A job created manually.
Schedule 1 A job created automatically based on a schedule.

LogLevel

Defines the log severity. Supported methods: None.

LogLevel Members

Name Value Description
Trace 0 The most detailed information.
Debug 1 Detailed information on the flow through the system.
Info 2 Important runtime events like startup or shutdown. The vast majority of log entries.
Warn 3 Runtime situations that are undesirable or unexpected, but not necessarily wrong.
Error 4 Runtime errors or unexpected conditions.
Fatal 5 Severe errors that cause premature termination.

StartStrategy

Defines how robots from the environment associated to a schedule are selected to run jobs. Supported methods: None.

StartStrategy Members

Name Value Description
All 0 All robots from the environment are eligible to run jobs.
Specific 1 Only a specific list of robots from the environment are eligible to run jobs.
RobotCount 2 Any number of robots from the environment are eligible to run jobs, available robots having priority.

UserType

Defines how a user was created and how it is supposed to be used. Supported methods: None.

UserType Members

Name Value Description
User 0 A user of this type is supposed to be used by a human.
Robot 1 A user of this type is automatically created when adding a robot, is associated with Robot role and it is used by a robot when communicating with Orchestrator.

SettingScopes

Defines settings levels. More details here. Supported methods: None.

SettingScopes Members

Name Value Description
Application 1 An application scoped setting is used for user/tenant independed settings.
Tenant 2 If the application is multi-tenant, tenant-specific settings can be defined.
User 4 A user scoped setting stores/gets value of the setting specific to each user.

ProcessingExceptionType

Defines categories for the exception thrown when item processing fails. Supported method: None.

ProcessingExceptionType Members

Name Value Description
ApplicationException 0 This type of exception should be thrown when the process fails due to an application error.

ReviewStatus

Defines the possible review states of a queue item that failed with application exception. Supported methods: None.

ReviewStatus Members

Name Value Description
None 0 Default state applicable to all type of items.
InReview 1 An item in this state has failed with application exception and has been marked by a user as in the process of being reviewed.
Verified 2 An item in this state has failed with application exception and has been marked by a user as verified and can no longer be retried. In order to be retried an item has to be manually marked for retry.
Retried 3 An item in this state has failed with application exception and has been marked for retry.

NotificationSeverity

Defines the notification severity leve. More details here. Supported methods: None. UnderlyingType="Edm.Byte"

NotificationSeverity Members

Name Value Description
Info 0 Info severity notifications are the least severe.
Success 1 Success severity notifications inform about successful actions occurred in the application.
Warn 2 Warn severity notifications inform about runtime situations that are undesirable or unexpected, but not necessarily wrong.
Error 3 Error severity notifications inform about runtime errors or unexpected conditions.
Fatal 4 Fatal Severity notifications inform about severe errors that can cause premature termination.

UserNotificationState

Defines if a specified notification has been read or not. Supported methods: None.

UserNotificationState Members

Name Value Description
Unread 0 The specified notification has not been marked as read.
Read 1 The specified notification has been marked as read.

Actions

AddRobot

Associates a Robot with the given environment. HTTP method: Post.

AddRobot Properties

nametypeunicodeDescription
bindingParameterUiPath.Application.Dto.EnvironmentDto
robotIdEdm.StringfalseThe associated robot Id.

AddRobot Methods & Examples


POST
https://platform.uipath.com/odata/Environments(1)/UiPath.Server.Configuration.OData.AddRobot

Request

Content-Type: application/json
{
    "robotId": "198"
}

Response

Content-Type: application/json
HTTP 204 No Content

RemoveRobot

Dissociates a Robot from the given environment. HTTP method: Post.

RemoveRobot Properties

nametypeunicodeDescription
bindingParameterUiPath.Application.Dto.EnvironmentDto
robotIdEdm.StringfalseThe dissociated robot Id.

RemoveRobot Methods & Examples


POST
https://platform.uipath.com/odata/Environments(47)/UiPath.Server.Configuration.OData.RemoveRobot

Request

Content-Type: application/json
{
    "robotId": "130"
}

Response

Content-Type: application/json
HTTP 204 No Content

UpdateToSpecificPackageVersion

Updates the package version for the given release. HTTP method: Post.

UpdateToSpecificPackageVersion Properties

nametypeunicodeDescription
bindingParameterUiPath.Application.Dto.Releases.ReleaseDto
packageVersionEdm.StringfalseThe new package version.
ReturnTypeEdm.Int64

UpdateToSpecificPackageVersion Methods & Examples


POST
https://platform.uipath.com/odata/Releases(64)/UiPath.Server.Configuration.OData.UpdateToSpecificPackageVersion

Request

Content-Type: application/json
{
    "packageVersion": "1.0.6151.32465"
}

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Edm.Int64",
  "value": 64
}

UpdateToLatestPackageVersion

Updates the package version for the given release to the latest available. HTTP method: Post.

UpdateToLatestPackageVersion Properties

nametypeDescription
bindingParameterUiPath.Application.Dto.Releases.ReleaseDto
ReturnTypeEdm.Int64

UpdateToLatestPackageVersion Methods & Examples


POST
https://platform.uipath.com/odata/Releases(107)/UiPath.Server.Configuration.OData.UpdateToLatestPackageVersion

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Edm.Int64",
  "value": 107
}

RollbackToPreviousReleaseVersion

Reverts the package verions for the given release to the last version it had before the current one. HTTP method: Post.

RollbackToPreviousReleaseVersion Properties

nametypeDescription
bindingParameterUiPath.Application.Dto.Releases.ReleaseDto
ReturnTypeEdm.Int64

RollbackToPreviousReleaseVersion Methods & Examples


POST
https://platform.uipath.com/odata/Releases(78)/UiPath.Server.Configuration.OData.RollbackToPreviousReleaseVersion

Request

Content-Type: application/json

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Edm.Int64",
  "value": 78
}

SetEnabled

Enables/disables a group of schedules. HTTP method: Post.

SetEnabled Properties

nametypenullableDescription
bindingParameterCollection(UiPath.Application.Dto.ProcessScheduleDto)
scheduleIdsCollection(Edm.Int64)falseThe collection of ids of the affected schedules.
enabledEdm.BooleanfalseIf true the schedules will be enabled, if false the schedules will be disabled.
ReturnTypeEdm.Boolean

SetEnabled Methods & Examples


POST
https://platform.uipath.com/odata/ProcessSchedules/UiPath.Server.Configuration.OData.SetEnabled

Request

Content-Type: application/json
{
    "scheduleIds": [81,82], 
    "enabled": true
}

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Edm.Boolean",
  "value": true
}

UploadPackage

Uploads a new package or a new version of an existing package. The content of the package is sent as a .nupkg file embedded in the HTTP request. HTTP method: Post.

UploadPackage Properties

nametypeDescription
bindingParameterCollection(UiPath.Application.Dto.ProcessDto)

UploadPackage Methods & Examples


POST
https://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.UploadPackage()

Request

Content-Type: multipart/form-data
--MultipartBoundry
Content-Disposition: form-data; name="file"; filename="test_debugging.1.0.6264.33733.nupkg"
Content-Type: application/octet-stream --MultipartBoundry--

Response

Content-Type: multipart/form-data
HTTP 200 OK

UpdateUncompletedItems

Changes the status of all InProgress queue items to Abandoned, after a specified amount of time. HTTP method: Post. 

Note: By default, the amount of time after which you can perform this action is 24 hours. To change it, modify the value of the inProgressMaxNumberOfMinutes parameter, from the web.config file. 

UpdateUncompletedItems Properties

nametypeDescription
bindingParameterCollection(UiPath.Application.Dto.Queues.QueueItemDto)

UpdateUncompletedItems Methods & Examples


POST
https://platform.uipath.com/odata/Queues/UiPath.Server.Configuration.OData.UpdateUncompletedItems()

Request

Content-Type: application/json

Response

Content-Type: application/json
HTTP 200 OK

StartJobs

Adds a new job and sets it in Pending state for each Robot based on the input parameters and notifies the respective Robots about the pending job. HTTP method: Post.

StartJobs Properties

nametypeDescription
bindingParameterCollection(UiPath.Application.Dto.JobDto)
startInfoUiPath.Application.Dto.StartProcessDtoThe information required to register the new jobs.

StartJobs Methods & Examples


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

Request

Content-Type: application/json
{
  "startInfo": {
    "ReleaseKey": "9e16e6a6-f99a-4d2d-b454-93ae02a69ebc",
    "RobotIds": [
      36, 130
    ],
    "NoOfRobots": 0,
    "Strategy": "Specific"
  }
}

Response

Content-Type: application/json
HTTP 200 OK

StopJob

Cancels or terminates the specified job. Supported methods: Post.

StopJob Properties

nametypenullableDescription
bindingParameterUiPath.Application.Dto.JobDto
strategyUiPath.Core.Enums.StopStrategyfalseStates whether a job should be soft stopped or killed immediatly.

StopJob Methods & Examples


POST
https://platform.uipath.com/odata/Jobs(25893)/UiPath.Server.Configuration.OData.StopJob

Request

Content-Type: application/json
{
   "strategy": "2"
}

Response

Content-Type: application/json
HTTP 200 OK

ToggleRole

Associates/dissociates the given user with/from a role based on toggle parameter. HTTP method: Post.

ToggleRole Properties

nametypeunicodeDescriptionnullable
bindingParameterUiPath.Core.Users.Dto.UserDto
roleEdm.StringfalseThe name of the role to be associated/dissociated.
toggleEdm.BooleanStates whether to associate or to dissociate the role with/from the user.false

ToggleRole Methods & Examples


POST
https://platform.uipath.com/odata/Users(191)/UiPath.Server.Configuration.OData.ToggleRole

Request

Content-Type: application/json
{
    "role": "API_test", 
    "toggle": true
}

Response

Content-Type: application/json
HTTP 200 OK

ImportUsers

Imports from AD all users from the given group and associates them with given roles. HTTP method: Post.

ImportUsers Properties

nametypeunicodeDescription
bindingParameterCollection(UiPath.Core.Users.Dto.UserDto)
groupEdm.StringfalseThe name of the AD group who's users are to be imported.
rolesListCollection(Edm.String)falseThe collection of roles the imported users will be associated with.

ImportUsers Methods & Examples


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

Request

Content-Type: application/json
{
   "group": "UiPathadministrator",
   "rolesList": [
      "Administrator"
   ]
}

Response

Content-Type: application/json
HTTP 200 OK

MarkAsRead

Marks alerts as read and returns the remaining number of unread notifications. HTTP method: Post.

MarkAsRead Properties

nametypenullableDescription
bindingParameterCollection(UiPath.Application.Dto.Alerts.AlertDto)
idsCollection(Edm.Guid)falseCollection containing the unique identifiers of the notifications that will be marked as read.
ReturnTypeEdm.Int64

MarkAsRead Methods & Examples


POST
https://platform.uipath.com/odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead

Request

Content-Type: application/json
{
   "ids": [
      "1c347808-b3c5-4237-831b-00290c650b53",
      "d2244eb3-b027-4289-b4c9-004824be736e"
   ]
}

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Edm.Int64",
  "value": 2346
}

RetryQueueItem

Moves the given queue items in Retried state. HTTP method: Post.

RetryQueueItem Properties

nametypenullableDescription
bindingParameterCollection(UiPath.Application.Dto.Queues.QueueItemDto)
idsCollection(Edm.Int64)falseThe collection of ids of queue items to be moved in Retried state.

RetryQueueItem Methods & Examples


POST
https://platform.uipath.com/odata/QueueItems/UiPathODataSvc.RetryQueueItem()

Request

Content-Type: application/json
{
   "ids": [
      784429,
      784424
   ]
}

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Edm.Int32",
  "value": 2
}

SetItemReviewStatus

Updates the review status of the specified queue items to an indicated state. HTTP method: Post.

SetItemReviewStatus Properties

nametypeunicodeDescriptionnullable
bindingParameterCollection(UiPath.Application.Dto.Queues.QueueItemDto)
statusEdm.StringfalseThe new value for the review status.
idsCollection(Edm.Int64)The collection of ids of queue items for which the state is set.false

SetItemReviewStatus Methods & Examples


POST
https://platform.uipath.com/odata/QueueItems/UiPathODataSvc.SetItemReviewStatus()

Request

Content-Type: application/json
{
   "status": "InReview",
   "ids": [
      784423
   ]
}

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Edm.Int32",
  "value": 1
}

StartTransaction

Adds a new queue item if the specific content is not null and then returns the new item or returns the next item in the queue to be processed. It also sets the state to InProgress for the returned item. HTTP method: Post.

StartTransaction Properties

nametypeDescription
bindingParameterCollection(UiPath.Application.Dto.Queues.QueueItemDto)
transactionDataUiPath.Application.Dto.Queues.TransactionDataDtoStores information necessary to start a new transaction - queue name, robot Id and specific content. If specific content is not null a new item will be added to the queue. If the specific content is null the next item from the queue will be returned.
ReturnTypeUiPath.Application.Dto.Queues.QueueItemDto

StartTransaction Methods & Examples


POST
https://platform.uipath.com/odata/Queues/UiPathODataSvc.StartTransaction()

Request

Content-Type: application/json
{
   "transactionData": {
      "Name": "myFirstQueue_APItest",
      "RobotIdentifier": "89fe329c-94c6-4449-83ba-4624e93d609f",
      "SpecificContent": {
         "totalValue": 666
      },
      "DeferDate": null,
      "DueDate": null
   }
}

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Queues/$entity",
  "QueueDefinitionId": 32,
  "QueueDefinitionName": null,
  "ProcessingExceptionId": null,
  "OutputData": null,
  "Status": "InProgress",
  "ReviewStatus": "None",
  "Key": "c685fc50-cc19-4ff1-b213-c9d9bf895399",
  "ExceptionType": null,
  "DueDate": null,
  "Priority": "High",
  "DeferDate": null,
  "StartProcessing": "2017-03-02T14:09:28.1673204Z",
  "EndProcessing": null,
  "SecondsInPreviousAttempts": 0,
  "AncestorId": null,
  "RetryNumber": 0,
  "SpecificData": "{\"DynamicProperties\":{\"totalValue\":666}}",
  "CreationTime": "2017-03-02T14:09:28.1516945Z",
  "Id": 784731,
  "SpecificContent": {
    "totalValue": 666
  },
  "Output": null
}

AddQueueItem

Adds a new item to a queue based on input parameters. HTTP method: Post.

AddQueueItem Properties

nametypeDescription
bindingParameterCollection(UiPath.Application.Dto.Queues.QueueItemDto)
itemDataUiPath.Application.Dto.Queues.QueueItemDataDtoInformation about the newly added item - queue name, content, priority, due date or defer date.

AddQueueItem Methods & Examples


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

Request

Content-Type: application/json
{
   "itemData": {
      "Name": "myFirstQueue_APItest",
      "Priority": "Low",
      "SpecificContent": {
         "totalValue": 1234567890
      },
      "DeferDate": null,
      "DueDate": null
   }
}

Response

Content-Type: application/json
HTTP 200 OK

SetTransactionResult

Updates the given queue item based on Robot processing outcome. HTTP method: Post.

SetTransactionResult Properties

nametypeDescription
bindingParameterUiPath.Application.Dto.Queues.QueueItemDto
transactionResultUiPath.Application.Dto.Queues.TransactionResultDtoInformation resulted after the current queue item has been processed by a robot.

SetTransactionResult Methods & Examples


POST
https://platform.uipath.com/odata/Queues(782975)/UiPathODataSvc.SetTransactionResult()

Request

Content-Type: application/json
{
   "transactionResult": {
      "IsSuccessful": true,
      "DeferDate": null,
      "DueDate": null,
      "Output": {
         "APItest": 50
      }
   }
   }
}

Response

Content-Type: application/json
HTTP 200 OK

Functions

GetServicesSettings

Returns a collection of key value pairs representing all service settings used by a robot. A valid robot licence key (X-ROBOT-LICENSE format) is required in the request headers. Supported methods: Get.

GetServicesSettings Properties

name type Description
bindingParameter Collection(UiPath.Application.Dto.SettingsDto)
ReturnType System.Collections.Generic.Dictionary_2OfString_String

GetServicesSettings Methods & Examples

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

Request

Content-Type: application/json

			

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",
    "apiKey",
    "NuGetServiceApiKey"
  ],
  "Values": [
    "https://platform.uipath.com",
    "https://www.myget.org/F/orchestrator_platform/",
    "https://platform.uipath.com",
    "https://platform.uipath.com/signalr/hubs",
    "https://platform.uipath.com",
    "https://platform.uipath.com",
    "eb5b1110-5eb0-4274-a54f-b5ed85c6301a",
    "eb5b1110-5eb0-4274-a54f-b5ed85c6301a"
  ]
}

GetWebSettings

Returns a collection of key value pairs representing settings used by the Orchestrator web client. Supported methods: Get.

GetWebSettings Properties

name type Description
bindingParameter Collection(UiPath.Application.Dto.SettingsDto)
ReturnType System.Collections.Generic.Dictionary_2OfString_String

GetWebSettings Methods & Examples

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

Request

Content-Type: application/json

			

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#System.Collections.Generic.Dictionary_2OfString_String",
  "Keys": [
    "Abp.Timing.TimeZone",
    "MonitoringUrl",
    "NotificationHubUrl",
    "LoggingUrl",
    "QueuesSvcUrl",
    "Timezone.Iana",
    "WindowsAuth.Enabled"
  ],
  "Values": [
    "UTC",
    "https://platform.uipath.com",
    "https://platform.uipath.com/signalr/hubs",
    "https://platform.uipath.com",
    "https://platform.uipath.com",
    "Etc/UTC",
    "False"
  ]
}

GetRobotsForEnvironment

Returns a collection of all Robots registered to Orchestrator, starting with the ones associated with a specified environment, using the key=environment id format. Allows odata query options. Supported methods: Get.

GetRobotsForEnvironment Properties

name type nullable Description
bindingParameter Collection(UiPath.Application.Dto.EnvironmentDto)
key Edm.Int64 false The Id of the environment for which the robots are fetched.
ReturnType Collection(UiPath.Application.Dto.RobotDto)

GetRobotsForEnvironment Methods & Examples

GET
https://platform.uipath.com/odata/Environments/UiPath.Server.Configuration.OData.GetRobotsForEnvironment(key=8)

Request

Content-Type: application/json

			

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Robots",
  "@odata.count": 68,
  "value": [
    {
      "LicenseKey": "89fe329c-94c6-4449-83ba-4624e93d609f",
      "MachineName": "DESKTOP-E47LTUF",
      "Name": "Documentation 1",
      "Username": "win10vm",
      "Description": "doc_tests",
      "Type": "DevTest",
      "Password": null,
      "RobotEnvironments": "doc_env",
      "Id": 36
    },
    {
      "LicenseKey": "89fe329c-94c6-4449-83ba-4624e93d609f",
      "MachineName": "DESKTOP-E47LTUF",
      "Name": "Documentation 2",
      "Username": "win10vm2",
      "Description": null,
      "Type": "DevTest",
      "Password": null,
      "RobotEnvironments": "doc_env,Hell,yellow",
      "Id": 130
    },
    {
      "LicenseKey": "02ad8005-c6e6-4033-8635-238a1d9f328b",
      "MachineName": "ANDRADEVSERVER",
      "Name": "a_mrk_r2",
      "Username": "deskover\\serveradmin",
      "Description": null,
      "Type": "DevTest",
      "Password": null,
      "RobotEnvironments": "a_mrk_env,a_invoke_env",
      "Id": 7
    }
  ]
}

GetRobotAsset

Returns the named asset associated to the given robot Id. Supported methods: Get.

GetRobotAsset Properties

name type unicode Description
bindingParameter Collection(UiPath.Application.Dto.Assets.AssetDto)
robotId Edm.String false The Id of the robot for which the asset is being fetched. To obtain this Id, make a GET request to a URL similar to http://platform.uipath.com/api/RobotsService/GetRobotMappings?licenseKey='89fe329c-94c6-4449-83ba-4624e93d609f'&machineName='DESKTOP-E47LTUF'.
assetName Edm.String false The name of the asset being fetched.
ReturnType UiPath.Application.Dto.Assets.RobotAssetDto

GetRobotAsset Methods & Examples

GET
https://platform.uipath.com/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId='c696a0ad-5e2f-47de-938f-fa6558fa08f7', assetName='APItest')

Request

Content-Type: application/json

			

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#UiPath.Application.Dto.Assets.RobotAssetDto",
  "Name": "APItest",
  "ValueType": "Text",
  "StringValue": "API_test_documentation",
  "BoolValue": false,
  "IntValue": 0,
  "CredentialUsername": "",
  "CredentialPassword": ""
}

GetProcessVersions

Returns a collection of all available versions of a given process. Allows odata query options. Supported methods: Get.

GetProcessVersions Properties

name type Unicode Description
bindingParameter Collection(UiPath.Application.Dto.ProcessDto)
processId Edm.String false The Id of the process for which the versions are fetched.
ReturnType Collection(UiPath.Application.Dto.ProcessDto)

GetProcessVersions Methods & Examples

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

Request

Content-Type: application/json

			

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Processes",
  "@odata.count": 5,
  "value": [
    {
      "Title": "Documentation",
      "Version": "1.0.6148.18675",
      "Key": "Documentation:1.0.6148.18675",
      "Description": "Blank Project",
      "Published": "2016-10-31T17:22:30.0143265Z",
      "IsLatestVersion": false,
      "OldVersion": null,
      "IsActive": false,
      "Id": "Documentation"
    },
    {
      "Title": "Documentation",
      "Version": "1.0.6149.3446",
      "Key": "Documentation:1.0.6149.3446",
      "Description": "Blank Project",
      "Published": "2016-11-01T08:54:51.8564953Z",
      "IsLatestVersion": false,
      "OldVersion": null,
      "IsActive": false,
      "Id": "Documentation"
    },
    {
      "Title": "Documentation",
      "Version": "1.0.6150.11412",
      "Key": "Documentation:1.0.6150.11412",
      "Description": "Blank Project",
      "Published": "2016-11-02T13:20:25.3724635Z",
      "IsLatestVersion": false,
      "OldVersion": null,
      "IsActive": false,
      "Id": "Documentation"
    },
    {
      "Title": "Documentation",
      "Version": "1.0.6225.14662",
      "Key": "Documentation:1.0.6225.14662",
      "Description": "Blank Project",
      "Published": "2017-01-16T16:08:44.3337219Z",
      "IsLatestVersion": false,
      "OldVersion": null,
      "IsActive": false,
      "Id": "Documentation"
    },
    {
      "Title": "Documentation",
      "Version": "1.0.6243.17476",
      "Key": "Documentation:1.0.6243.17476",
      "Description": "Blank Project",
      "Published": "2017-02-03T17:42:34.3989426Z",
      "IsLatestVersion": true,
      "OldVersion": null,
      "IsActive": false,
      "Id": "Documentation"
    }
  ]
}

GetProcessInfo

Returns a collection of all processes registered in Orchestrator. Supported methods: Get.

GetProcessInfo Properties

name type Description
bindingParameter Collection(UiPath.Application.Dto.ProcessDto)
ReturnType Collection(UiPath.Application.Dto.ProcessDto)

GetProcessInfo Methods & Examples

GET
https://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.GetProcessInfo()

Request

Content-Type: application/json

			

Response

Note: This response has been truncated, due to its size.

Content-Type: application/json
{
  "@odata.context": "https://orchestratorv2nlb.deskover.local/odata/$metadata#Processes",
  "value": [
  {
      "Title": null,
      "Version": "1.0.6271.96",
      "Key": "1Log:1.0.6271.96",
      "Description": "Blank Project",
      "Published": "2017-03-03T08:03:13.5667994Z",
      "IsLatestVersion": true,
      "OldVersion": null,
      "IsActive": false,
      "Id": "1Log"
    },
    {
      "Title": null,
      "Version": "1.0.6228.28114",
      "Key": "2:1.0.6228.28114",
      "Description": "Blank Project",
      "Published": "2017-02-16T12:37:36.6857605Z",
      "IsLatestVersion": true,
      "OldVersion": null,
      "IsActive": false,
      "Id": "2"
    },
    {
      "Title": null,
      "Version": "1.0.6228.28126",
      "Key": "3:1.0.6228.28126",
      "Description": "Blank Project",
      "Published": "2017-02-16T12:37:43.0109824Z",
      "IsLatestVersion": true,
      "OldVersion": null,
      "IsActive": false,
      "Id": "3"
    }
  ]
}

Reports

Returns an Excel file containing filtered robot logs. Supports odata query options. Supported methods: Get.

Reports Properties

name type Description
bindingParameter Collection(UiPath.Application.Dto.LogDto)
ReturnType Edm.Binary

Reports Methods & Examples

GET
https://platform.uipath.com/odata/RobotLogs/UiPath.Server.Configuration.OData.Reports()?$top=2&$filter=Level eq UiPath.Core.Enums.LogLevel%27Fatal%27

Request

Content-Type: application/json

			

Response

Content-Type: application/json
Time,Level,Process,User,Message
1/22/2017 10:00:45 AM,Fatal,Open_and_Type_Notepad_TeoEnv,TEODOR\teodo,This is a Fatal log
1/22/2017 9:59:24 AM,Fatal,Open_and_Type_Notepad_TeoEnv,TEODOR\teodo,This is a Fatal log
1/22/2017 9:59:24 AM,Fatal,Open_and_Type_Notepad_TeoEnv,EVE\uipathadmin,This is a Fatal log
1/22/2017 9:59:24 AM,Fatal,Open_and_Type_Notepad_TeoEnv,SPARKY\uipathadmin,This is a Fatal log

GetCurrentPermissions

Returns a user permission collection containing data about the current user and all the permissions it has. Supported methods: Get.

GetCurrentPermissions Properties

name type Description
bindingParameter Collection(UiPath.Core.Users.Dto.UserDto)
ReturnType UiPath.Application.Dto.Permissions.UserPermissionsCollection

GetCurrentPermissions Methods & Examples

GET
https://platform.uipath.com/odata/Users/UiPath.Server.Configuration.OData.GetCurrentPermissions()

Request

Content-Type: application/json

			

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#UiPath.Application.Dto.Permissions.UserPermissionsCollection",
  "UserId": 77,
  "Permissions": [
    "Settings",
    "Robots",
    "Processes",
    "Packages",
    "Assets",
    "Environments",
    "Queues",
    "Transactions",
    "Jobs",
    "Schedules",
    "Logs",
    "Roles",
    "Users",
    "Audit",
    "Alerts",
    "Settings.View",
    "Settings.Edit",
    "Settings.Create",
    "Settings.Delete",
    "Robots.View",
    "Robots.Edit",
    "Robots.Create",
    "Robots.Delete",
    "Processes.View",
    "Processes.Edit",
    "Processes.Create",
    "Processes.Delete",
    "Packages.View",
    "Packages.Edit",
    "Packages.Create",
    "Packages.Delete",
    "Assets.View",
    "Assets.Edit",
    "Assets.Create",
    "Assets.Delete",
    "Environments.View",
    "Environments.Edit",
    "Environments.Create",
    "Environments.Delete",
    "Queues.View",
    "Queues.Edit",
    "Queues.Create",
    "Queues.Delete",
    "Transactions.View",
    "Transactions.Edit",
    "Transactions.Create",
    "Transactions.Delete",
    "Jobs.View",
    "Jobs.Edit",
    "Jobs.Create",
    "Jobs.Delete",
    "Schedules.View",
    "Schedules.Edit",
    "Schedules.Create",
    "Schedules.Delete",
    "Logs.View",
    "Logs.Edit",
    "Logs.Create",
    "Logs.Delete",
    "Roles.View",
    "Roles.Edit",
    "Roles.Create",
    "Roles.Delete",
    "Users.View",
    "Users.Edit",
    "Users.Create",
    "Users.Delete",
    "Audit.View",
    "Audit.Edit",
    "Audit.Create",
    "Audit.Delete",
    "Alerts.View",
    "Alerts.Edit",
    "Alerts.Create",
    "Alerts.Delete"
  ]
}

GetCurrentUser

Returns details about the user currently logged into Orchestrator. Supported methods: Get.

GetCurrentUser Properties

name type Description
bindingParameter Collection(UiPath.Core.Users.Dto.UserDto)
ReturnType UiPath.Core.Users.Dto.UserDto

GetCurrentUser Methods & Examples

GET
https://platform.uipath.com/odata/Users/UiPath.Server.Configuration.OData.GetCurrentUser()

Request

Content-Type: application/json

			

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Users/$entity",
  "Name": "Docu'",
  "Surname": "Dr.",
  "UserName": "Documentation",
  "FullName": null,
  "EmailAddress": "",
  "IsEmailConfirmed": true,
  "LastLoginTime": "2017-03-04T19:45:59.737Z",
  "IsActive": true,
  "CreationTime": "2016-11-14T12:08:20.76Z",
  "AuthenticationSource": null,
  "Password": null,
  "RolesList": [],
  "LoginProviders": [],
  "TenancyName": "Default",
  "Type": "User",
  "Id": 77
}

GetAlertsStats

Returns the total number of notifications aggregated by alert name in the last specified days. Supported methods: Get.

GetAlertsStats Properties

name type nullable Description
bindingParameter Collection(UiPath.Application.Dto.Alerts.AlertDto)
daysNo Edm.Int32 false The number of days to go back from the present moment when calculating the report. If it is 0 the report will be computed for the last hour.
ReturnType System.Collections.Generic.Dictionary_2OfString_Int32

GetAlertsStats Methods & Examples

GET
https://platform.uipath.com/odata/Alerts/UiPath.Server.Configuration.OData.GetAlertsStats(daysNo=2)

Request

Content-Type: application/json

			

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#System.Collections.Generic.Dictionary_2OfString_Int32",
  "Keys": [
    "Process.JobExecution.Faulted",
    "Process.JobExecution.Started",
    "Process.JobExecution.Succeeded",
    "Robot.StatusChanged.Available",
    "Robot.StatusChanged.NotResponding",
    "Robot.StatusChanged.Offline"
  ],
  "Values": [
    1446,
    2027,
    10,
    102,
    97,
    102
  ]
}

GetUnreadCount

Returns the total number of alerts, per tenant, that haven't been read by the current user. Supported methods: Get.

GetUnreadCount Properties

name type Description
bindingParameter Collection(UiPath.Application.Dto.Alerts.AlertDto)
ReturnType UiPath.Core.Users.Dto.UserDto

GetUnreadCount Methods & Examples

GET
https://platform.uipath.com/odata/Alerts/UiPath.Server.Configuration.OData.GetUnreadCount()

Request

Content-Type: application/json

			

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Edm.Int64",
  "value": 5110
}

Reports

Returns an Excel file containing all the items in the given queue. Supports odata query options. Supported methods: Get.

Note: The URL request must contain the QueueDefinitionId odata query option, along with the queue definition id in the resource path.

Reports Properties

name type Description
bindingParameter UiPath.Application.Dto.Queues.QueueDefinitionDto
ReturnType Collection(UiPath.Application.Dto.Queues.QueueItemDto)

Reports Methods & Examples

GET
https://platform.uipath.com/odata/QueueDefinitions(2)/UiPathODataSvc.Reports()?$filter=QueueDefinitionId eq 2 and Status eq 'New'

Request

Content-Type: application/json

			

Response

Content-Type: application/json
Status,ReviewStatus,Key,ExceptionType,Deadline,Priority,Robot,Postpone,StartProcessing,EndProcessing,SecondsInPreviousAttempts,RetryNumber,SpecificData
New,None,7422e984-f9ea-42a1-a669-c262edaf12ff,,,Normal,,,,,0,0,"{""DynamicProperties"":{""Argument1"":""Test"",""UniqueNumber"":5}}"
New,None,7d2c8f8c-26ed-442b-84ca-71a6c7954d24,,,Normal,,,,,0,0,"{""DynamicProperties"":{""Argument1"":""Test"",""UniqueNumber"":5}}"
New,None,89888d1d-c1d9-4b1c-95b5-eebe17cfddcc,,,Normal,,,,,0,0,"{""DynamicProperties"":{""Argument1"":""Test""}}"
New,None,8e2c2da2-88de-4160-8d5d-dddaa4afdc0e,,,Normal,,,,,0,0,"{""DynamicProperties"":{""Argument1"":""Test""}}"

GetItemProcessingHistory

Returns data about the processing history of the given queue item. Supports odata query options. Supported methods: Get.

GetItemProcessingHistory Properties

name type Description
bindingParameter UiPath.Application.Dto.Queues.QueueItemDto
ReturnType Collection(UiPath.Application.Dto.Queues.QueueItemDto)

GetItemProcessingHistory Methods & Examples

GET
https://platform.uipath.com/odata/QueueItems(784729)/UiPathODataSvc.GetItemProcessingHistory()

Request

Content-Type: application/json

			

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Queues",
  "value": [
    {
      "QueueDefinitionId": 44,
      "QueueDefinitionName": null,
      "ProcessingExceptionId": null,
      "OutputData": null,
      "Status": "New",
      "ReviewStatus": "None",
      "Key": "4a0b057f-4bcf-46aa-be98-c6bb7cbe9099",
      "ExceptionType": null,
      "DueDate": null,
      "Priority": "Normal",
      "DeferDate": null,
      "StartProcessing": null,
      "EndProcessing": null,
      "SecondsInPreviousAttempts": 1,
      "AncestorId": 784424,
      "RetryNumber": 1,
      "SpecificData": "{\"DynamicProperties\":{\"FirstName\":\"Lavinia\",\"LastName\":\"Cojocaru\",\"Age\":12,\"CashIn\":33,\"CashOut\":33,\"Index\":4}}",
      "CreationTime": "2017-03-02T13:11:51.907Z",
      "Id": 784729,
      "SpecificContent": {
        "FirstName": "Lavinia",
        "LastName": "Cojocaru",
        "Age": 12,
        "CashIn": 33,
        "CashOut": 33,
        "Index": 4
      },
      "Output": null
    },
    {
      "QueueDefinitionId": 44,
      "QueueDefinitionName": null,
      "ProcessingExceptionId": 400,
      "OutputData": null,
      "Status": "Failed",
      "ReviewStatus": "Retried",
      "Key": "4a0b057f-4bcf-46aa-be98-c6bb7cbe9099",
      "ExceptionType": "ApplicationException",
      "DueDate": null,
      "Priority": "Normal",
      "DeferDate": null,
      "StartProcessing": "2017-02-23T16:27:28.283Z",
      "EndProcessing": "2017-02-23T16:27:30.08Z",
      "SecondsInPreviousAttempts": 1,
      "AncestorId": null,
      "RetryNumber": 0,
      "SpecificData": "{\"DynamicProperties\":{\"FirstName\":\"Lavinia\",\"LastName\":\"Cojocaru\",\"Age\":12,\"CashIn\":33,\"CashOut\":33,\"Index\":4}}",
      "CreationTime": "2017-02-23T16:26:56.413Z",
      "Id": 784424,
      "SpecificContent": {
        "FirstName": "Lavinia",
        "LastName": "Cojocaru",
        "Age": 12,
        "CashIn": 33,
        "CashOut": 33,
        "Index": 4
      },
      "Output": null
    }
  ]
}

RetrieveLastDaysProcessingRecords

Returns the computed processing status for a given queue in the last specified days. Supported methods: Get.

RetrieveLastDaysProcessingRecords Properties

name type nullable Description
bindingParameter Collection(UiPath.Application.Dto.Queues.QueueProcessingRecordDto)
daysNo Edm.Int32 false The number of days to go back from the present moment when calculating the report. If it is 0 the report will be computed for the last hour.
queueDefinitionId Edm.Int64 false The Id of the queue for which the report is computed.
ReturnType Collection(UiPath.Application.Dto.Queues.QueueProcessingRecordDto)

RetrieveLastDaysProcessingRecords Methods & Examples

GET
https://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveLastDaysProcessingRecords(daysNo=0, queueDefinitionId=32)

Request

Content-Type: application/json

			

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#QueueProcessingRecords",
  "value": [
    {
      "QueueDefinitionId": 32,
      "ProcessingTime": "2017-03-04T21:04:00Z",
      "ReportType": "Minute",
      "NumberOfApplicationExceptions": 0,
      "NumberOfBusinessExceptions": 0,
      "NumberOfSuccessfulTransactions": 0,
      "NumberOfRetriedItems": 0,
      "ApplicationExceptionsProcessingTime": 0,
      "BusinessExceptionsProcessingTime": 0,
      "SuccessfulTransactionsProcessingTime": 0,
      "TotalNumberOfTransactions": 0,
      "TenantId": 1,
      "Id": 191137919
    },
    {
      "QueueDefinitionId": 32,
      "ProcessingTime": "2017-03-04T21:02:00Z",
      "ReportType": "Minute",
      "NumberOfApplicationExceptions": 0,
      "NumberOfBusinessExceptions": 0,
      "NumberOfSuccessfulTransactions": 0,
      "NumberOfRetriedItems": 0,
      "ApplicationExceptionsProcessingTime": 0,
      "BusinessExceptionsProcessingTime": 0,
      "SuccessfulTransactionsProcessingTime": 0,
      "TotalNumberOfTransactions": 0,
      "TenantId": 1,
      "Id": 191137841
    }
  ]
}

RetrieveQueuesProcessingStatus

Returns the processing status for all queues. Allows odata query options. Supported methods: Get.

RetrieveQueuesProcessingStatus Properties

name type Description
bindingParameter Collection(UiPath.Application.Dto.Queues.QueueProcessingRecordDto)
ReturnType Collection(UiPath.Core.Model.Queues.QueueProcessingStatus)

RetrieveQueuesProcessingStatus Methods & Examples

GET
https://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveQueuesProcessingStatus()?$filter=QueueDefinitionId eq 2

Request

Content-Type: application/json

			

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/odata/$metadata#Collection(UiPath.Core.Model.Queues.QueueProcessingStatus)",
  "@odata.count": 2,
  "value": [
    {
      "ItemsToProcess": 0,
      "QueueDefinitionId": 31,
      "QueueDefinitionName": "AlexVQueue2",
      "QueueDefinitionDescription": null,
      "QueueDefinitionAcceptAutomaticallyRetry": true,
      "QueueDefinitionMaxNumberOfRetries": 0,
      "ProcessingMeanTime": 0,
      "SuccessfulTransactionsNo": 0,
      "ApplicationExceptionsNo": 0,
      "BusinessExceptionsNo": 0,
      "SuccessfulTransactionsProcessingTime": 0,
      "ApplicationExceptionsProcessingTime": 0,
      "BusinessExceptionsProcessingTime": 0,
      "TotalNumberOfTransactions": 0,
      "LastProcessed": null
    },
    {
      "ItemsToProcess": 0,
      "QueueDefinitionId": 6,
      "QueueDefinitionName": "test2",
      "QueueDefinitionDescription": null,
      "QueueDefinitionAcceptAutomaticallyRetry": false,
      "QueueDefinitionMaxNumberOfRetries": 0,
      "ProcessingMeanTime": 0,
      "SuccessfulTransactionsNo": 0,
      "ApplicationExceptionsNo": 0,
      "BusinessExceptionsNo": 0,
      "SuccessfulTransactionsProcessingTime": 0,
      "ApplicationExceptionsProcessingTime": 0,
      "BusinessExceptionsProcessingTime": 0,
      "TotalNumberOfTransactions": 0,
      "LastProcessed": null
    }
  ]
}