UiPath Orchestrator Guide

 
Suggest Edits

Authenticates the user based on user name and password

Authenticates the user based on user name and password.

 
posthttps://platform.uipath.com/api/Account/Authenticate
curl --request POST \
  --url https://platform.uipath.com/api/Account/Authenticate
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/api/Account/Authenticate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/api/Account/Authenticate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/api/Account/Authenticate");

xhr.send(data);
import requests

url = "https://platform.uipath.com/api/Account/Authenticate"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

TenancyName
string
UsernameOrEmailAddress
string
required
Password
string
required

Response

Successful authentication

Resultobject
TargetUrlstring
Successboolean
Errorobject
Error.Codeinteger
Error.Messagestring
Error.Detailsstring
Error.ValidationErrorsarray
UnAuthorizedRequestboolean
__abpboolean
Suggest Edits

Authenticates the user based on user name and password

Authenticates the user based on user name and password.

 
posthttps://platform.uipath.com/api/Account
curl --request POST \
  --url https://platform.uipath.com/api/Account
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/api/Account' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/api/Account")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/api/Account");

xhr.send(data);
import requests

url = "https://platform.uipath.com/api/Account"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

TenancyName
string
UsernameOrEmailAddress
string
required
Password
string
required

Response

Successful authentication

Resultobject
TargetUrlstring
Successboolean
Errorobject
Error.Codeinteger
Error.Messagestring
Error.Detailsstring
Error.ValidationErrorsarray
UnAuthorizedRequestboolean
__abpboolean
Suggest Edits

Inserts a log entry with a specified message in JSON format.

Example of jMessage parameter.

 {
     "message": "TTT execution started",
     "level": "Information",
     "timeStamp": "2017-01-18T14:46:07.4152893+02:00",
     "windowsIdentity": "DESKTOP-1L50L0P\\WindowsUser",
     "agentSessionId": "00000000-0000-0000-0000-000000000000",
     "processName": "TTT",
     "fileName": "Main",
     "jobId": "8066c309-cef8-4b47-9163-b273fc14cc43"
 }
 
posthttps://platform.uipath.com/api/logs
curl --request POST \
  --url https://platform.uipath.com/api/logs
var request = require("request");

var options = { method: 'POST', url: 'https://platform.uipath.com/api/logs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/api/logs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/api/logs");

xhr.send(data);
import requests

url = "https://platform.uipath.com/api/logs"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Response

Successfully inserts a log message. Although it's a post, there's no need for an object to be returned

jMessage is null or an Exception is thrown during insert

Suggest Edits

Inserts a log entry with a specified message in JSON format.

Example of jMessage parameter.

 {
     "message": "TTT execution started",
     "level": "Information",
     "timeStamp": "2017-01-18T14:46:07.4152893+02:00",
     "windowsIdentity": "DESKTOP-1L50L0P\\WindowsUser",
     "agentSessionId": "00000000-0000-0000-0000-000000000000",
     "processName": "TTT",
     "fileName": "Main",
     "jobId": "8066c309-cef8-4b47-9163-b273fc14cc43"
 }
 
posthttps://platform.uipath.com/api/Logs/Post
curl --request POST \
  --url https://platform.uipath.com/api/Logs/Post
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/api/Logs/Post' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/api/Logs/Post")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/api/Logs/Post");

xhr.send(data);
import requests

url = "https://platform.uipath.com/api/Logs/Post"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Response

Successfully inserts a log message. Although it's a post, there's no need for an object to be returned

jMessage is null or an Exception is thrown during insert

Suggest Edits

Inserts a collection of log entries, each in a specific JSON format.

Example of log entry:
{
"message": "TTT execution started",
"level": "Information",
"timeStamp": "2017-01-18T14:46:07.4152893+02:00",
"windowsIdentity": "DESKTOP-1L50L0P\WindowsUser",
"agentSessionId": "00000000-0000-0000-0000-000000000000",
"processName": "TTT",
"fileName": "Main",
"jobId": "8066c309-cef8-4b47-9163-b273fc14cc43"
}

 
posthttps://platform.uipath.com/api/Logs/SubmitLogs
curl --request POST \
  --url https://platform.uipath.com/api/Logs/SubmitLogs
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/api/Logs/SubmitLogs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/api/Logs/SubmitLogs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/api/Logs/SubmitLogs");

xhr.send(data);
import requests

url = "https://platform.uipath.com/api/Logs/SubmitLogs"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Response

Successfully inserts the log entries

logs is null or an Exception is thrown during insert

Suggest Edits

RobotsService

 
Suggest Edits

Post to the server a collection of heartbeats messages generated by the robots from a machine

Every 30 seconds the UiPath service running on a robot machine posts a collection of heartbeat messages (one for each robot hosted on the machine).
The response is a collection of commands specific to all robots defined on that machine, including the ones that were added in the meanwhile.

 
posthttps://platform.uipath.com/api/RobotsService/SubmitHeartbeat
curl --request POST \
  --url https://platform.uipath.com/api/RobotsService/SubmitHeartbeat
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/api/RobotsService/SubmitHeartbeat' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/api/RobotsService/SubmitHeartbeat")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/api/RobotsService/SubmitHeartbeat");

xhr.send(data);
import requests

url = "https://platform.uipath.com/api/RobotsService/SubmitHeartbeat"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Response

hbts is null or empty or an Exception is thrown during insert

Suggest Edits

Post to the server a heartbeat collection with jobs information

 
posthttps://platform.uipath.com/api/RobotsService/SubmitJobState
curl --request POST \
  --url https://platform.uipath.com/api/RobotsService/SubmitJobState
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/api/RobotsService/SubmitJobState' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/api/RobotsService/SubmitJobState")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/api/RobotsService/SubmitJobState");

xhr.send(data);
import requests

url = "https://platform.uipath.com/api/RobotsService/SubmitJobState"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Response

Job state was updated successfully. No object returned so 200 instead of 201

Suggest Edits

Gets from the server all the processes associated with a robot

Gets from the server all the processes associated with a robot

 
gethttps://platform.uipath.com/api/RobotsService/GetAssociatedProcesses
curl --request GET \
  --url 'https://platform.uipath.com/api/RobotsService/GetAssociatedProcesses?robotKey=robotKey'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/api/RobotsService/GetAssociatedProcesses',
  qs: { robotKey: 'robotKey' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/api/RobotsService/GetAssociatedProcesses?robotKey=robotKey")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/api/RobotsService/GetAssociatedProcesses?robotKey=robotKey");

xhr.send(data);
import requests

url = "https://platform.uipath.com/api/RobotsService/GetAssociatedProcesses"

querystring = {"robotKey":"robotKey"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

robotKey
string
required

The unique key identifying the robot.

Response

Returns the processes collection.

robotKey is null or empty or an Exception is thrown during retrieval

Suggest Edits

Gets from the server all robots associated with a machine and having the specified licence key

Gets from the server all robots associated with a machine and having the specified licence key.

 
gethttps://platform.uipath.com/api/RobotsService/GetRobotMappings
curl --request GET \
  --url 'https://platform.uipath.com/api/RobotsService/GetRobotMappings?licenseKey=licenseKey&machineName=machineName'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/api/RobotsService/GetRobotMappings',
  qs: 
   { licenseKey: 'licenseKey',
     machineName: 'machineName' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/api/RobotsService/GetRobotMappings?licenseKey=licenseKey&machineName=machineName")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/api/RobotsService/GetRobotMappings?licenseKey=licenseKey&machineName=machineName");

xhr.send(data);
import requests

url = "https://platform.uipath.com/api/RobotsService/GetRobotMappings"

querystring = {"licenseKey":"licenseKey","machineName":"machineName"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

licenseKey
string
required

The license key that the returned robots must have.

machineName
string
required

The name of the machine that the returned robots must be associated with

Response

No robots meet the criteria or an Exception is thrown during retrieval

Suggest Edits

Called by RobotSvc to connect the robots on the machine it is running on to Orchestrator (under automatic deployment).

This is the initial handshake between the robot service and Orchestrator, the equivalent of configuring the connection
info from Robot tray (manual deployment). It is supported only for authorized machines, i.e. the robot machine is part of the
same AD as Orchestrator. To enforce this, the request must contain the machine identity. The robots must be already provisioned
in Orchestrator before this step, otherwise RobotSvc will continue to call this method until they are.

 
gethttps://platform.uipath.com/api/RobotsService/GetConnectionData
curl --request GET \
  --url 'https://platform.uipath.com/api/RobotsService/GetConnectionData?tenantId=tenantId'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/api/RobotsService/GetConnectionData',
  qs: { tenantId: 'tenantId' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/api/RobotsService/GetConnectionData?tenantId=tenantId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/api/RobotsService/GetConnectionData?tenantId=tenantId");

xhr.send(data);
import requests

url = "https://platform.uipath.com/api/RobotsService/GetConnectionData"

querystring = {"tenantId":"tenantId"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

tenantId
int32
required

The tenant under which already defined robots are searched for.

Response

LicenseKeystring
OrchestratorUrlstring

Calling machine is not part of the same AD

Suggest Edits

Gets from the server all the processes associated with a robot

Gets from the server all the processes associated with a robot

 
gethttps://platform.uipath.com/api/RobotsService
curl --request GET \
  --url 'https://platform.uipath.com/api/RobotsService?robotKey=robotKey'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/api/RobotsService',
  qs: { robotKey: 'robotKey' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/api/RobotsService?robotKey=robotKey")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/api/RobotsService?robotKey=robotKey");

xhr.send(data);
import requests

url = "https://platform.uipath.com/api/RobotsService"

querystring = {"robotKey":"robotKey"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

robotKey
string
required

The unique key identifying the robot.

Response

Returns the processes collection.

robotKey is null or empty or an Exception is thrown during retrieval

Suggest Edits

Gets the total number of various entities registered in Orchestrator

Returns the name and the total number of entities registered in Orchestrator for a set of entities.
All the counted entity types can be seen in the result below.

 [
       {
         "title": "Processes",
         "count": 1
       },
       {
         "title": "Assets",
         "count": 0
       },
       {
         "title": "Queues",
         "count": 0
       },
       {
         "title": "Schedules",
         "count": 0
       }
 ]
 
gethttps://platform.uipath.com/api/Stats/GetCountStats
curl --request GET \
  --url https://platform.uipath.com/api/Stats/GetCountStats
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/api/Stats/GetCountStats' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/api/Stats/GetCountStats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/api/Stats/GetCountStats");

xhr.send(data);
import requests

url = "https://platform.uipath.com/api/Stats/GetCountStats"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Response

Successful

Suggest Edits

Gets the total number of robots aggregated by Robot State

Returns the total number of Available, Busy, Disconnected and Unresponsive robots respectively.
Example of returned result:

[
      {
        "title": "Available",
        "count": 1
      },
      {
        "title": "Busy",
        "count": 0
      },
      {
        "title": "Disconnected",
        "count": 1
      },
      {
        "title": "Unresponsive",
        "count": 0
      }
]
 
gethttps://platform.uipath.com/api/Stats/GetSessionsStats
curl --request GET \
  --url https://platform.uipath.com/api/Stats/GetSessionsStats
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/api/Stats/GetSessionsStats' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/api/Stats/GetSessionsStats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/api/Stats/GetSessionsStats");

xhr.send(data);
import requests

url = "https://platform.uipath.com/api/Stats/GetSessionsStats"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Response

Suggest Edits

Gets the total number of jobs aggregated by Job State

Returns the total number of Successful, Faulted and Canceled jobs respectively.
Example of returned result:

[
      {
        "title": "Successful",
        "count": 0
      },
      {
        "title": "Faulted",
        "count": 0
      },
      {
        "title": "Canceled",
        "count": 0
      }
]
 
gethttps://platform.uipath.com/api/Stats/GetJobsStats
curl --request GET \
  --url https://platform.uipath.com/api/Stats/GetJobsStats
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/api/Stats/GetJobsStats' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/api/Stats/GetJobsStats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/api/Stats/GetJobsStats");

xhr.send(data);
import requests

url = "https://platform.uipath.com/api/Stats/GetJobsStats"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Response

Suggest Edits

Gets alerts.

 
gethttps://platform.uipath.com/odata/Alerts
curl --request GET \
  --url https://platform.uipath.com/odata/Alerts
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/Alerts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Alerts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/Alerts");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Alerts"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

$expand
string

Expands related entities inline.

$filter
string

Filters the results, based on a Boolean condition.

$select
string

Selects which properties to include in the response.

$orderby
string

Sorts the results.

$top
int32

Returns only the first n results.

$skip
int32

Skips the first n results.

$count
boolean

Includes a count of the matching results in the response.

Response

@odata.contextstring
valuearray
Suggest Edits

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

 
gethttps://platform.uipath.com/odata/Alerts/UiPath.Server.Configuration.OData.GetUnreadCount()
curl --request GET \
  --url 'https://platform.uipath.com/odata/Alerts/UiPath.Server.Configuration.OData.GetUnreadCount()'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/Alerts/UiPath.Server.Configuration.OData.GetUnreadCount()' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Alerts/UiPath.Server.Configuration.OData.GetUnreadCount()")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/Alerts/UiPath.Server.Configuration.OData.GetUnreadCount()");

xhr.send(data);
import requests

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

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Response

@odata.contextstring
valueinteger
Suggest Edits

Marks alerts as read and returns the remaining number of unread notifications.

 
posthttps://platform.uipath.com/odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead
curl --request POST \
  --url https://platform.uipath.com/odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

ids
array of strings
required

Response

@odata.contextstring
valueinteger
Suggest Edits

Get Assets

 
gethttps://platform.uipath.com/odata/Assets
curl --request GET \
  --url https://platform.uipath.com/odata/Assets
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/Assets' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Assets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/Assets");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Assets"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

$expand
string

Expands related entities inline.

$filter
string

Filters the results, based on a Boolean condition.

$select
string

Selects which properties to include in the response.

$orderby
string

Sorts the results.

$top
int32

Returns only the first n results.

$skip
int32

Skips the first n results.

$count
boolean

Includes a count of the matching results in the response.

Response

@odata.contextstring
valuearray
Suggest Edits

Creates an asset

 
posthttps://platform.uipath.com/odata/Assets
curl --request POST \
  --url https://platform.uipath.com/odata/Assets
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/Assets' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Assets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/Assets");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Assets"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

Name
string
required

A custom name for the asset.

CanBeDeleted
boolean

States if an assets can be deleted. The default value of this property is true.

ValueScope
string
required

Defines the scope of the asset.

ValueType
string

Defines the type of value stored by the asset.

Value
string

The textual representation of the asset value, irrespective of value type.

StringValue
string

The value of the asset when the value type is Text. Empty when the value type is not Text.

BoolValue
boolean

The value of the asset when the value type is Bool. False when the value type is not Bool.

IntValue
int32

The value of the asset when the value type is Integer. 0 when the value type is not Integer.

CredentialUsername
string

The user name when the value type is Credential. Empty when the value type is not Credential.

CredentialPassword
string

The password when the value type is Credential. Empty when the value type is not Credential.

KeyValueList
array of objects

A collection of key value pairs when the type is KeyValueList. Empty when the value type is not KeyValueList.

RobotValues
array of objects

The collection of asset values per robot. Empty if the asset type is Global.

Id
int64

Response

Successfully created the asset

Namestring

A custom name for the asset.

CanBeDeletedboolean

States if an assets can be deleted. The default value of this property is true.

ValueScopestring

Defines the scope of the asset.

ValueTypestring

Defines the type of value stored by the asset.

Valuestring

The textual representation of the asset value, irrespective of value type.

StringValuestring

The value of the asset when the value type is Text. Empty when the value type is not Text.

BoolValueboolean

The value of the asset when the value type is Bool. False when the value type is not Bool.

IntValueinteger

The value of the asset when the value type is Integer. 0 when the value type is not Integer.

CredentialUsernamestring

The user name when the value type is Credential. Empty when the value type is not Credential.

CredentialPasswordstring

The password when the value type is Credential. Empty when the value type is not Credential.

KeyValueListarray

A collection of key value pairs when the type is KeyValueList. Empty when the value type is not KeyValueList.

RobotValuesarray

The collection of asset values per robot. Empty if the asset type is Global.

Idinteger
Suggest Edits

Edit an asset

 
puthttps://platform.uipath.com/odata/Assets(Id)
curl --request PUT \
  --url 'https://platform.uipath.com/odata/Assets(Id)'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://platform.uipath.com/odata/Assets(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Assets(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://platform.uipath.com/odata/Assets(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Assets(Id)"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Body Params

Name
string
required

A custom name for the asset.

CanBeDeleted
boolean

States if an assets can be deleted. The default value of this property is true.

ValueScope
string
required

Defines the scope of the asset.

ValueType
string

Defines the type of value stored by the asset.

Value
string

The textual representation of the asset value, irrespective of value type.

StringValue
string

The value of the asset when the value type is Text. Empty when the value type is not Text.

BoolValue
boolean

The value of the asset when the value type is Bool. False when the value type is not Bool.

IntValue
int32

The value of the asset when the value type is Integer. 0 when the value type is not Integer.

CredentialUsername
string

The user name when the value type is Credential. Empty when the value type is not Credential.

CredentialPassword
string

The password when the value type is Credential. Empty when the value type is not Credential.

KeyValueList
array of objects

A collection of key value pairs when the type is KeyValueList. Empty when the value type is not KeyValueList.

RobotValues
array of objects

The collection of asset values per robot. Empty if the asset type is Global.

Id
int64

Response

Successfully updated

Suggest Edits

Delete an asset

 
deletehttps://platform.uipath.com/odata/Assets(Id)
curl --request DELETE \
  --url 'https://platform.uipath.com/odata/Assets(Id)'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://platform.uipath.com/odata/Assets(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Assets(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://platform.uipath.com/odata/Assets(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Assets(Id)"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Headers

If-Match
string

If-Match header

Response

Successfully deleted the asset

Suggest Edits

Returns the named asset associated to the given robot Id.

 
gethttps://platform.uipath.com/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId='robotId',assetName='assetName')
curl --request GET \
  --url 'https://platform.uipath.com/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId=%27robotId%27,assetName=%27assetName%27)'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId=%27robotId%27,assetName=%27assetName%27)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId=%27robotId%27,assetName=%27assetName%27)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId=%27robotId%27,assetName=%27assetName%27)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId=%27robotId%27,assetName=%27assetName%27)"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

robotId
string
required

The Id of the robot for which the asset is being fetched.

assetName
string
required

The name of the asset being fetched.

Response

Successful

Namestring

The asset name.

ValueTypestring

Defines the type of value stored by the asset.

StringValuestring

The value of the asset when the value type is Text. Empty when the value type is not Text.

BoolValueboolean

The value of the asset when the value type is Bool. False when the value type is not Bool.

IntValueinteger

The value of the asset when the value type is Integer. 0 when the value type is not Integer.

CredentialUsernamestring

The user name when the value type is Credential. Empty when the value type is not Credential.

CredentialPasswordstring

The password when the value type is Credential. Empty when the value type is not Credential.

Suggest Edits

AuditLogs

 
Suggest Edits

Gets Audit logs.

 
gethttps://platform.uipath.com/odata/AuditLogs
curl --request GET \
  --url https://platform.uipath.com/odata/AuditLogs
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/AuditLogs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/AuditLogs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/AuditLogs");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/AuditLogs"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

$expand
string

Expands related entities inline.

$filter
string

Filters the results, based on a Boolean condition.

$select
string

Selects which properties to include in the response.

$orderby
string

Sorts the results.

$top
int32

Returns only the first n results.

$skip
int32

Skips the first n results.

$count
boolean

Includes a count of the matching results in the response.

Response

Successful

@odata.contextstring
valuearray
Suggest Edits

Environments

 
Suggest Edits

Gets Environments.

 
gethttps://platform.uipath.com/odata/Environments
curl --request GET \
  --url https://platform.uipath.com/odata/Environments
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/Environments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Environments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/Environments");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Environments"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

$expand
string

Expands related entities inline.

$filter
string

Filters the results, based on a Boolean condition.

$select
string

Selects which properties to include in the response.

$orderby
string

Sorts the results.

$top
int32

Returns only the first n results.

$skip
int32

Skips the first n results.

$count
boolean

Includes a count of the matching results in the response.

Response

Successful

@odata.contextstring
valuearray
Suggest Edits

Posts new environment.

 
posthttps://platform.uipath.com/odata/Environments
curl --request POST \
  --url https://platform.uipath.com/odata/Environments
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/Environments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Environments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/Environments");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Environments"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

Name
string
required

A custom name for the environment.

Description
string

Used to add additional information about an environment in order to better identify it.

Robots
array of objects

The collection of robots associated with the current environment.

Type
string
required

The environment type specifies how it should be used.

Id
int64

Response

Created

Namestring

A custom name for the environment.

Descriptionstring

Used to add additional information about an environment in order to better identify it.

Robotsarray

The collection of robots associated with the current environment.

Typestring

The environment type specifies how it should be used.

Idinteger
Suggest Edits

Gets a single environment.

 
gethttps://platform.uipath.com/odata/Environments(Id)
curl --request GET \
  --url 'https://platform.uipath.com/odata/Environments(Id)'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/Environments(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Environments(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/Environments(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Environments(Id)"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Query Params

$expand
string

Expands related entities inline.

$select
string

Selects which properties to include in the response.

Response

Successful

Namestring

A custom name for the environment.

Descriptionstring

Used to add additional information about an environment in order to better identify it.

Robotsarray

The collection of robots associated with the current environment.

Typestring

The environment type specifies how it should be used.

Idinteger
Suggest Edits

Updates an environment.

 
puthttps://platform.uipath.com/odata/Environments(Id)
curl --request PUT \
  --url 'https://platform.uipath.com/odata/Environments(Id)'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://platform.uipath.com/odata/Environments(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Environments(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://platform.uipath.com/odata/Environments(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Environments(Id)"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Body Params

Name
string
required

A custom name for the environment.

Description
string

Used to add additional information about an environment in order to better identify it.

Robots
array of objects

The collection of robots associated with the current environment.

Type
string
required

The environment type specifies how it should be used.

Id
int64

Response

Updated

Suggest Edits

Deletes an environment.

 
deletehttps://platform.uipath.com/odata/Environments(Id)
curl --request DELETE \
  --url 'https://platform.uipath.com/odata/Environments(Id)'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://platform.uipath.com/odata/Environments(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Environments(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://platform.uipath.com/odata/Environments(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Environments(Id)"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Headers

If-Match
string

If-Match header

Response

Deleted

Suggest Edits

Returns a collection of robots associated to an environment based on environment Id. Allows odata query options.

 
gethttps://platform.uipath.com/odata/Environments/UiPath.Server.Configuration.OData.GetRobotsForEnvironment(key=key)
curl --request GET \
  --url 'https://platform.uipath.com/odata/Environments/UiPath.Server.Configuration.OData.GetRobotsForEnvironment(key=key)'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/Environments/UiPath.Server.Configuration.OData.GetRobotsForEnvironment(key=key)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Environments/UiPath.Server.Configuration.OData.GetRobotsForEnvironment(key=key)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/Environments/UiPath.Server.Configuration.OData.GetRobotsForEnvironment(key=key)");

xhr.send(data);
import requests

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

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

key
int64
required

The Id of the environment for which the robots are fetched.

Response

Successful

@odata.contextstring
valuearray
Suggest Edits

Associates a robot with the given environment.

 
posthttps://platform.uipath.com/odata/Environments(Id)/UiPath.Server.Configuration.OData.AddRobot
curl --request POST \
  --url 'https://platform.uipath.com/odata/Environments(Id)/UiPath.Server.Configuration.OData.AddRobot'
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/Environments(Id)/UiPath.Server.Configuration.OData.AddRobot' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Environments(Id)/UiPath.Server.Configuration.OData.AddRobot")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/Environments(Id)/UiPath.Server.Configuration.OData.AddRobot");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Environments(Id)/UiPath.Server.Configuration.OData.AddRobot"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Body Params

robotId
string

Response

Nothing returned

Suggest Edits

Dissociates a robot from the given environment.

 
posthttps://platform.uipath.com/odata/Environments(Id)/UiPath.Server.Configuration.OData.RemoveRobot
curl --request POST \
  --url 'https://platform.uipath.com/odata/Environments(Id)/UiPath.Server.Configuration.OData.RemoveRobot'
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/Environments(Id)/UiPath.Server.Configuration.OData.RemoveRobot' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Environments(Id)/UiPath.Server.Configuration.OData.RemoveRobot")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/Environments(Id)/UiPath.Server.Configuration.OData.RemoveRobot");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Environments(Id)/UiPath.Server.Configuration.OData.RemoveRobot"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Body Params

robotId
string

Response

Deleted

Suggest Edits

Gets Jobs.

 
gethttps://platform.uipath.com/odata/Jobs
curl --request GET \
  --url https://platform.uipath.com/odata/Jobs
var request = require("request");

var options = { method: 'GET', url: 'https://platform.uipath.com/odata/Jobs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/Jobs");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Jobs"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

$expand
string

Expands related entities inline.

$filter
string

Filters the results, based on a Boolean condition.

$select
string

Selects which properties to include in the response.

$orderby
string

Sorts the results.

$top
int32

Returns only the first n results.

$skip
int32

Skips the first n results.

$count
boolean

Includes a count of the matching results in the response.

Response

@odata.contextstring
valuearray
Suggest Edits

Post a new entity to EntitySet Jobs

 
posthttps://platform.uipath.com/odata/Jobs
curl --request POST \
  --url https://platform.uipath.com/odata/Jobs
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/Jobs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/Jobs");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Jobs"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

Key
uuid

The unique job identifier.

StartTime
date-time

The date and time when the job execution started or null if the job hasn't started yet.

EndTime
date-time

The date and time when the job execution ended or null if the job hasn't ended yet.

State
string

The state in which the job is.

Robot
object

The robot associated with the current job.

Robot.LicenseKey
string
required

The key is automatically generated from the server for the Robot machine.

<para />For the robot to work, the same key must exist on both the robot and Orchestrator.

<para />All robots on a machine must have the same license key in order to register correctly.

Robot.MachineName
string
required

The name of the machine a Robot is hosted on.

Robot.Name
string
required

A custom name for the robot.

Robot.Username
string

The machine username. If the user is under a domain, you are required to also specify it in a DOMAIN\username format.

<para />Note: You must use short domain names, such as desktop\administrator and NOT desktop.local/administrator.

Robot.Description
string

Used to add additional information about a robot in order to better identify it.

Robot.Type
string
required

The Robot type.

Robot.Password
string

The Windows password associated with the machine username.

Robot.Environments
array of objects

The collection of environments the robot is part of.

Robot.RobotEnvironments
string

The comma separated textual representation of environment names the robot is part of.

Robot.Id
int64
Release
object

The release associated with the current job.

Release.Key
string

A unique identifier associated to each release.

Release.ProcessKey
string
required

The unique identifier of the process associated with the release.

Release.ProcessVersion
string
required

The version of the process associated with the release.

Release.IsLatestVersion
boolean

States whether the version of process associated with the release is latest or not.

Release.IsProcessDeleted
boolean

States whether the process associated with the release is deleted or not.

Release.Description
string

Used to add additional information about a release in order to better identify it.

Release.Name
string
required

A custom name of the release. The default name format is ProcessName_EnvironmentName.

Release.EnvironmentId
int64
required

The Id of the environment associated with the release.

Release.EnvironmentName
string

The name of the environment associated with the release.

Release.Environment
object

The environment associated with the release.

Release.Environment.Name
string
required

A custom name for the environment.

Release.Environment.Description
string

Used to add additional information about an environment in order to better identify it.

Release.Environment.Robots
array of objects

The collection of robots associated with the current environment.

Release.Environment.Type
string
required

The environment type specifies how it should be used.

Release.Environment.Id
int64
Release.CurrentVersion
object

The release version associated with the current release.

Release.CurrentVersion.ReleaseId
int64
required

The Id of the parent release.

Release.CurrentVersion.VersionNumber
string
required

The version of process associated with the release.

Release.CurrentVersion.CreationTime
date-time

The date and time when the version was associated with the release.

Release.CurrentVersion.Id
int64
Release.ReleaseVersions
array of objects

The collection of release versions that current release had over time.

Release.Id
int64
Source
string

The Source of the job.

BatchExecutionKey
uuid

The unique identifier grouping multiple jobs. It is usually generated when the job is created by a schedule.

Info
string

Additional information about the current job.

CreationTime
date-time

The date and time when the job was created.

StartingScheduleId
int64

The Id of the schedule that started the job, or null if the job was started by the user.

Id
int64

Response

No Content

Suggest Edits

Gets a single job.

 
gethttps://platform.uipath.com/odata/Jobs(Id)
curl --request GET \
  --url 'https://platform.uipath.com/odata/Jobs(Id)'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/Jobs(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Jobs(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/Jobs(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Jobs(Id)"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Query Params

$expand
string

Expands related entities inline.

$select
string

Selects which properties to include in the response.

Response

Keystring

The unique job identifier.

StartTimestring

The date and time when the job execution started or null if the job hasn't started yet.

EndTimestring

The date and time when the job execution ended or null if the job hasn't ended yet.

Statestring

The state in which the job is.

Robotobject

The robot associated with the current job.

Robot.LicenseKeystring

The key is automatically generated from the server for the Robot machine.

<para />For the robot to work, the same key must exist on both the robot and Orchestrator.

<para />All robots on a machine must have the same license key in order to register correctly.

Robot.MachineNamestring

The name of the machine a Robot is hosted on.

Robot.Namestring

A custom name for the robot.

Robot.Usernamestring

The machine username. If the user is under a domain, you are required to also specify it in a DOMAIN\username format.

<para />Note: You must use short domain names, such as desktop\administrator and NOT desktop.local/administrator.

Robot.Descriptionstring

Used to add additional information about a robot in order to better identify it.

Robot.Typestring

The Robot type.

Robot.Passwordstring

The Windows password associated with the machine username.

Robot.Environmentsarray

The collection of environments the robot is part of.

Robot.RobotEnvironmentsstring

The comma separated textual representation of environment names the robot is part of.

Robot.Idinteger
Releaseobject

The release associated with the current job.

Release.Keystring

A unique identifier associated to each release.

Release.ProcessKeystring

The unique identifier of the process associated with the release.

Release.ProcessVersionstring

The version of the process associated with the release.

Release.IsLatestVersionboolean

States whether the version of process associated with the release is latest or not.

Release.IsProcessDeletedboolean

States whether the process associated with the release is deleted or not.

Release.Descriptionstring

Used to add additional information about a release in order to better identify it.

Release.Namestring

A custom name of the release. The default name format is ProcessName_EnvironmentName.

Release.EnvironmentIdinteger

The Id of the environment associated with the release.

Release.EnvironmentNamestring

The name of the environment associated with the release.

Release.Environmentobject

The environment associated with the release.

Release.Environment.Namestring

A custom name for the environment.

Release.Environment.Descriptionstring

Used to add additional information about an environment in order to better identify it.

Release.Environment.Robotsarray

The collection of robots associated with the current environment.

Release.Environment.Typestring

The environment type specifies how it should be used.

Release.Environment.Idinteger
Release.CurrentVersionobject

The release version associated with the current release.

Release.CurrentVersion.ReleaseIdinteger

The Id of the parent release.

Release.CurrentVersion.VersionNumberstring

The version of process associated with the release.

Release.CurrentVersion.CreationTimestring

The date and time when the version was associated with the release.

Release.CurrentVersion.Idinteger
Release.ReleaseVersionsarray

The collection of release versions that current release had over time.

Release.Idinteger
Sourcestring

The Source of the job.

BatchExecutionKeystring

The unique identifier grouping multiple jobs. It is usually generated when the job is created by a schedule.

Infostring

Additional information about the current job.

CreationTimestring

The date and time when the job was created.

StartingScheduleIdinteger

The Id of the schedule that started the job, or null if the job was started by the user.

Idinteger
Suggest Edits

Replace entity in EntitySet Jobs

 
puthttps://platform.uipath.com/odata/Jobs(Id)
curl --request PUT \
  --url 'https://platform.uipath.com/odata/Jobs(Id)'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://platform.uipath.com/odata/Jobs(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Jobs(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://platform.uipath.com/odata/Jobs(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Jobs(Id)"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Body Params

Key
uuid

The unique job identifier.

StartTime
date-time

The date and time when the job execution started or null if the job hasn't started yet.

EndTime
date-time

The date and time when the job execution ended or null if the job hasn't ended yet.

State
string

The state in which the job is.

Robot
object

The robot associated with the current job.

Robot.LicenseKey
string
required

The key is automatically generated from the server for the Robot machine.

<para />For the robot to work, the same key must exist on both the robot and Orchestrator.

<para />All robots on a machine must have the same license key in order to register correctly.

Robot.MachineName
string
required

The name of the machine a Robot is hosted on.

Robot.Name
string
required

A custom name for the robot.

Robot.Username
string

The machine username. If the user is under a domain, you are required to also specify it in a DOMAIN\username format.

<para />Note: You must use short domain names, such as desktop\administrator and NOT desktop.local/administrator.

Robot.Description
string

Used to add additional information about a robot in order to better identify it.

Robot.Type
string
required

The Robot type.

Robot.Password
string

The Windows password associated with the machine username.

Robot.Environments
array of objects

The collection of environments the robot is part of.

Robot.RobotEnvironments
string

The comma separated textual representation of environment names the robot is part of.

Robot.Id
int64
Release
object

The release associated with the current job.

Release.Key
string

A unique identifier associated to each release.

Release.ProcessKey
string
required

The unique identifier of the process associated with the release.

Release.ProcessVersion
string
required

The version of the process associated with the release.

Release.IsLatestVersion
boolean

States whether the version of process associated with the release is latest or not.

Release.IsProcessDeleted
boolean

States whether the process associated with the release is deleted or not.

Release.Description
string

Used to add additional information about a release in order to better identify it.

Release.Name
string
required

A custom name of the release. The default name format is ProcessName_EnvironmentName.

Release.EnvironmentId
int64
required

The Id of the environment associated with the release.

Release.EnvironmentName
string

The name of the environment associated with the release.

Release.Environment
object

The environment associated with the release.

Release.Environment.Name
string
required

A custom name for the environment.

Release.Environment.Description
string

Used to add additional information about an environment in order to better identify it.

Release.Environment.Robots
array of objects

The collection of robots associated with the current environment.

Release.Environment.Type
string
required

The environment type specifies how it should be used.

Release.Environment.Id
int64
Release.CurrentVersion
object

The release version associated with the current release.

Release.CurrentVersion.ReleaseId
int64
required

The Id of the parent release.

Release.CurrentVersion.VersionNumber
string
required

The version of process associated with the release.

Release.CurrentVersion.CreationTime
date-time

The date and time when the version was associated with the release.

Release.CurrentVersion.Id
int64
Release.ReleaseVersions
array of objects

The collection of release versions that current release had over time.

Release.Id
int64
Source
string

The Source of the job.

BatchExecutionKey
uuid

The unique identifier grouping multiple jobs. It is usually generated when the job is created by a schedule.

Info
string

Additional information about the current job.

CreationTime
date-time

The date and time when the job was created.

StartingScheduleId
int64

The Id of the schedule that started the job, or null if the job was started by the user.

Id
int64

Response

No Content

Suggest Edits

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.

 
posthttps://platform.uipath.com/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
curl --request POST \
  --url https://platform.uipath.com/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs");

xhr.send(data);
import requests

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

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

startInfo
object

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

startInfo.ReleaseKey
string
required

The unique key of the release associated with the process.

startInfo.Strategy
string

States which robots from the environment are being run by the process.

startInfo.RobotIds
array of integers

The 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).

startInfo.NoOfRobots
int32

The 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).

startInfo.Source
string

The Source of the job starting the current process.

Response

Created

@odata.contextstring
valuearray
Suggest Edits

Cancels or terminates the specified job.

 
posthttps://platform.uipath.com/odata/Jobs(Id)/UiPath.Server.Configuration.OData.StopJob
curl --request POST \
  --url 'https://platform.uipath.com/odata/Jobs(Id)/UiPath.Server.Configuration.OData.StopJob'
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/Jobs(Id)/UiPath.Server.Configuration.OData.StopJob' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Jobs(Id)/UiPath.Server.Configuration.OData.StopJob")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/Jobs(Id)/UiPath.Server.Configuration.OData.StopJob");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Jobs(Id)/UiPath.Server.Configuration.OData.StopJob"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Body Params

strategy
string
required

Response

Suggest Edits

Permissions

 
Suggest Edits

Gets permissions.

 
gethttps://platform.uipath.com/odata/Permissions
curl --request GET \
  --url https://platform.uipath.com/odata/Permissions
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/Permissions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Permissions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/Permissions");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Permissions"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

$expand
string

Expands related entities inline.

$filter
string

Filters the results, based on a Boolean condition.

$select
string

Selects which properties to include in the response.

$orderby
string

Sorts the results.

$top
int32

Returns only the first n results.

$skip
int32

Skips the first n results.

$count
boolean

Includes a count of the matching results in the response.

Response

@odata.contextstring
valuearray
Suggest Edits

Processes

 
Suggest Edits

Gets the processes.

 
gethttps://platform.uipath.com/odata/Processes
curl --request GET \
  --url https://platform.uipath.com/odata/Processes
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/Processes' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Processes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/Processes");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Processes"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

$expand
string

Expands related entities inline.

$filter
string

Filters the results, based on a Boolean condition.

$select
string

Selects which properties to include in the response.

$orderby
string

Sorts the results.

$top
int32

Returns only the first n results.

$skip
int32

Skips the first n results.

$count
boolean

Includes a count of the matching results in the response.

Response

@odata.contextstring
valuearray
Suggest Edits

Deletes a package.

 
deletehttps://platform.uipath.com/odata/Processes('Id')
curl --request DELETE \
  --url 'https://platform.uipath.com/odata/Processes(%27Id%27)'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://platform.uipath.com/odata/Processes(%27Id%27)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Processes(%27Id%27)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://platform.uipath.com/odata/Processes(%27Id%27)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Processes(%27Id%27)"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
string
required

key: Id

Headers

If-Match
string

If-Match header

Response

Package deleted

Deleted

Suggest Edits

Returns a collection of all available versions of a given process. Allows odata query options.

 
gethttps://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='processId')
curl --request GET \
  --url 'https://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId=%27processId%27)'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId=%27processId%27)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId=%27processId%27)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId=%27processId%27)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId=%27processId%27)"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

processId
string
required

The Id of the process for which the versions are fetched.

Response

@odata.contextstring
valuearray
Suggest Edits

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.

 
posthttps://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.UploadPackage
curl --request POST \
  --url https://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.UploadPackage
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.UploadPackage' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.UploadPackage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.UploadPackage");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/Processes/UiPath.Server.Configuration.OData.UploadPackage"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Form Data

file
file
required

Response

Suggest Edits

ProcessSchedules

 
Suggest Edits

Gets the process schedules.

 
gethttps://platform.uipath.com/odata/ProcessSchedules
curl --request GET \
  --url https://platform.uipath.com/odata/ProcessSchedules
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/ProcessSchedules' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/ProcessSchedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/ProcessSchedules");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/ProcessSchedules"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

$expand
string

Expands related entities inline.

$filter
string

Filters the results, based on a Boolean condition.

$select
string

Selects which properties to include in the response.

$orderby
string

Sorts the results.

$top
int32

Returns only the first n results.

$skip
int32

Skips the first n results.

$count
boolean

Includes a count of the matching results in the response.

Response

@odata.contextstring
valuearray
Suggest Edits

Creates a new process schedule.

 
posthttps://platform.uipath.com/odata/ProcessSchedules
curl --request POST \
  --url https://platform.uipath.com/odata/ProcessSchedules
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/ProcessSchedules' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/ProcessSchedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/ProcessSchedules");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/ProcessSchedules"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

Enabled
boolean

Specifies if the schedule is active or not.

Name
string
required

The name of the schedule.

ReleaseId
int64

The Id of the process associated with the schedule.

ReleaseKey
string

The unique key of the process associated with the schedule.

ReleaseName
string

The name of the process associated with the schedule.

PackageName
string

The name of the package to be triggered with the schedule.

EnvironmentName
string

The name of the environment associated with the schedule.

EnvironmentId
string

The Id of the environment associated with the schedule.

StartProcessCron
string

The start cron expression of the schedule.

StartProcessCronDetails
string

Various details that can be associated to the time period expression of the schedule.

StartProcessCronSummary
string

Human readable form of cron expression of the schedule.

StartProcessNextOccurrence
date-time

The date and time when the associated process will be run next.

StartStrategy
int32

States which robots from the environment are being run by the schedule.

ExecutorRobots
array of objects

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).

StopProcessExpression
string

The cron expression after which a running process will be stopped.

StopStrategy
string

The way a running process is stopped.

ExternalJobKey
string

The 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.

TimeZoneId
string

The timezone under which the schedule will run.

Id
int64

Response

Created

Enabledboolean

Specifies if the schedule is active or not.

Namestring

The name of the schedule.

ReleaseIdinteger

The Id of the process associated with the schedule.

ReleaseKeystring

The unique key of the process associated with the schedule.

ReleaseNamestring

The name of the process associated with the schedule.

PackageNamestring

The name of the package to be triggered with the schedule.

EnvironmentNamestring

The name of the environment associated with the schedule.

EnvironmentIdstring

The Id of the environment associated with the schedule.

StartProcessCronstring

The start cron expression of the schedule.

StartProcessCronDetailsstring

Various details that can be associated to the time period expression of the schedule.

StartProcessCronSummarystring

Human readable form of cron expression of the schedule.

StartProcessNextOccurrencestring

The date and time when the associated process will be run next.

StartStrategyinteger

States which robots from the environment are being run by the schedule.

ExecutorRobotsarray

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).

StopProcessExpressionstring

The cron expression after which a running process will be stopped.

StopStrategystring

The way a running process is stopped.

ExternalJobKeystring

The 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.

TimeZoneIdstring

The timezone under which the schedule will run.

Idinteger
Suggest Edits

Gets a single process schedule based on its key.

 
gethttps://platform.uipath.com/odata/ProcessSchedules(Id)
curl --request GET \
  --url 'https://platform.uipath.com/odata/ProcessSchedules(Id)'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/ProcessSchedules(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/ProcessSchedules(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/ProcessSchedules(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/ProcessSchedules(Id)"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Query Params

$expand
string

Expands related entities inline.

$select
string

Selects which properties to include in the response.

Response

Enabledboolean

Specifies if the schedule is active or not.

Namestring

The name of the schedule.

ReleaseIdinteger

The Id of the process associated with the schedule.

ReleaseKeystring

The unique key of the process associated with the schedule.

ReleaseNamestring

The name of the process associated with the schedule.

PackageNamestring

The name of the package to be triggered with the schedule.

EnvironmentNamestring

The name of the environment associated with the schedule.

EnvironmentIdstring

The Id of the environment associated with the schedule.

StartProcessCronstring

The start cron expression of the schedule.

StartProcessCronDetailsstring

Various details that can be associated to the time period expression of the schedule.

StartProcessCronSummarystring

Human readable form of cron expression of the schedule.

StartProcessNextOccurrencestring

The date and time when the associated process will be run next.

StartStrategyinteger

States which robots from the environment are being run by the schedule.

ExecutorRobotsarray

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).

StopProcessExpressionstring

The cron expression after which a running process will be stopped.

StopStrategystring

The way a running process is stopped.

ExternalJobKeystring

The 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.

TimeZoneIdstring

The timezone under which the schedule will run.

Idinteger
Suggest Edits

Edits a process schedule.

 
puthttps://platform.uipath.com/odata/ProcessSchedules(Id)
curl --request PUT \
  --url 'https://platform.uipath.com/odata/ProcessSchedules(Id)'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://platform.uipath.com/odata/ProcessSchedules(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/ProcessSchedules(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://platform.uipath.com/odata/ProcessSchedules(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/ProcessSchedules(Id)"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Body Params

Enabled
boolean

Specifies if the schedule is active or not.

Name
string
required

The name of the schedule.

ReleaseId
int64

The Id of the process associated with the schedule.

ReleaseKey
string

The unique key of the process associated with the schedule.

ReleaseName
string

The name of the process associated with the schedule.

PackageName
string

The name of the package to be triggered with the schedule.

EnvironmentName
string

The name of the environment associated with the schedule.

EnvironmentId
string

The Id of the environment associated with the schedule.

StartProcessCron
string

The start cron expression of the schedule.

StartProcessCronDetails
string

Various details that can be associated to the time period expression of the schedule.

StartProcessCronSummary
string

Human readable form of cron expression of the schedule.

StartProcessNextOccurrence
date-time

The date and time when the associated process will be run next.

StartStrategy
int32

States which robots from the environment are being run by the schedule.

ExecutorRobots
array of objects

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).

StopProcessExpression
string

The cron expression after which a running process will be stopped.

StopStrategy
string

The way a running process is stopped.

ExternalJobKey
string

The 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.

TimeZoneId
string

The timezone under which the schedule will run.

Id
int64

Response

Enabledboolean

Specifies if the schedule is active or not.

Namestring

The name of the schedule.

ReleaseIdinteger

The Id of the process associated with the schedule.

ReleaseKeystring

The unique key of the process associated with the schedule.

ReleaseNamestring

The name of the process associated with the schedule.

PackageNamestring

The name of the package to be triggered with the schedule.

EnvironmentNamestring

The name of the environment associated with the schedule.

EnvironmentIdstring

The Id of the environment associated with the schedule.

StartProcessCronstring

The start cron expression of the schedule.

StartProcessCronDetailsstring

Various details that can be associated to the time period expression of the schedule.

StartProcessCronSummarystring

Human readable form of cron expression of the schedule.

StartProcessNextOccurrencestring

The date and time when the associated process will be run next.

StartStrategyinteger

States which robots from the environment are being run by the schedule.

ExecutorRobotsarray

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).

StopProcessExpressionstring

The cron expression after which a running process will be stopped.

StopStrategystring

The way a running process is stopped.

ExternalJobKeystring

The 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.

TimeZoneIdstring

The timezone under which the schedule will run.

Idinteger

Successful put

Enabledboolean

Specifies if the schedule is active or not.

Namestring

The name of the schedule.

ReleaseIdinteger

The Id of the process associated with the schedule.

ReleaseKeystring

The unique key of the process associated with the schedule.

ReleaseNamestring

The name of the process associated with the schedule.

PackageNamestring

The name of the package to be triggered with the schedule.

EnvironmentNamestring

The name of the environment associated with the schedule.

EnvironmentIdstring

The Id of the environment associated with the schedule.

StartProcessCronstring

The start cron expression of the schedule.

StartProcessCronDetailsstring

Various details that can be associated to the time period expression of the schedule.

StartProcessCronSummarystring

Human readable form of cron expression of the schedule.

StartProcessNextOccurrencestring

The date and time when the associated process will be run next.

StartStrategyinteger

States which robots from the environment are being run by the schedule.

ExecutorRobotsarray

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).

StopProcessExpressionstring

The cron expression after which a running process will be stopped.

StopStrategystring

The way a running process is stopped.

ExternalJobKeystring

The 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.

TimeZoneIdstring

The timezone under which the schedule will run.

Idinteger
Suggest Edits

Deletes a process schedule.

 
deletehttps://platform.uipath.com/odata/ProcessSchedules(Id)
curl --request DELETE \
  --url 'https://platform.uipath.com/odata/ProcessSchedules(Id)'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://platform.uipath.com/odata/ProcessSchedules(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/ProcessSchedules(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://platform.uipath.com/odata/ProcessSchedules(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/ProcessSchedules(Id)"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Headers

If-Match
string

If-Match header

Response

Deleted

Suggest Edits

Enables/disables a group of schedules.

 
posthttps://platform.uipath.com/odata/ProcessSchedules/UiPath.Server.Configuration.OData.SetEnabled
curl --request POST \
  --url https://platform.uipath.com/odata/ProcessSchedules/UiPath.Server.Configuration.OData.SetEnabled
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/ProcessSchedules/UiPath.Server.Configuration.OData.SetEnabled' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/ProcessSchedules/UiPath.Server.Configuration.OData.SetEnabled")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/ProcessSchedules/UiPath.Server.Configuration.OData.SetEnabled");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/ProcessSchedules/UiPath.Server.Configuration.OData.SetEnabled"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

scheduleIds
array of integers
required
enabled
boolean
required

Response

Suggest Edits

QueueDefinitions

 
Suggest Edits

Gets the list of queue definitions.

 
gethttps://platform.uipath.com/odata/QueueDefinitions
curl --request GET \
  --url https://platform.uipath.com/odata/QueueDefinitions
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/QueueDefinitions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueDefinitions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/QueueDefinitions");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueDefinitions"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

$expand
string

Expands related entities inline.

$filter
string

Filters the results, based on a Boolean condition.

$select
string

Selects which properties to include in the response.

$orderby
string

Sorts the results.

$top
int32

Returns only the first n results.

$skip
int32

Skips the first n results.

$count
boolean

Includes a count of the matching results in the response.

Response

@odata.contextstring
valuearray
Suggest Edits

Creates a new queue.

 
posthttps://platform.uipath.com/odata/QueueDefinitions
curl --request POST \
  --url https://platform.uipath.com/odata/QueueDefinitions
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/QueueDefinitions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueDefinitions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/QueueDefinitions");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueDefinitions"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

Name
string

A custom name for the queue.

Description
string

Used to add additional information about a queue in order to better identify it.

MaxNumberOfRetries
int32

An 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.

AcceptAutomaticallyRetry
boolean

States whether a robot should retry to process an item if, after processing, it failed with application exception.

EnforceUniqueReference
boolean

States whether Item Reference field should be unique per Queue. Deleted and retried items are not checked against this rule.

CreationTime
date-time

The date and time when the queue was created.

Id
int64

Response

Created

Namestring

A custom name for the queue.

Descriptionstring

Used to add additional information about a queue in order to better identify it.

MaxNumberOfRetriesinteger

An 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.

AcceptAutomaticallyRetryboolean

States whether a robot should retry to process an item if, after processing, it failed with application exception.

EnforceUniqueReferenceboolean

States whether Item Reference field should be unique per Queue. Deleted and retried items are not checked against this rule.

CreationTimestring

The date and time when the queue was created.

Idinteger
Suggest Edits

Edits a queue.

 
puthttps://platform.uipath.com/odata/QueueDefinitions(Id)
curl --request PUT \
  --url 'https://platform.uipath.com/odata/QueueDefinitions(Id)'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://platform.uipath.com/odata/QueueDefinitions(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueDefinitions(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://platform.uipath.com/odata/QueueDefinitions(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueDefinitions(Id)"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Body Params

Name
string

A custom name for the queue.

Description
string

Used to add additional information about a queue in order to better identify it.

MaxNumberOfRetries
int32

An 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.

AcceptAutomaticallyRetry
boolean

States whether a robot should retry to process an item if, after processing, it failed with application exception.

EnforceUniqueReference
boolean

States whether Item Reference field should be unique per Queue. Deleted and retried items are not checked against this rule.

CreationTime
date-time

The date and time when the queue was created.

Id
int64

Response

Namestring

A custom name for the queue.

Descriptionstring

Used to add additional information about a queue in order to better identify it.

MaxNumberOfRetriesinteger

An 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.

AcceptAutomaticallyRetryboolean

States whether a robot should retry to process an item if, after processing, it failed with application exception.

EnforceUniqueReferenceboolean

States whether Item Reference field should be unique per Queue. Deleted and retried items are not checked against this rule.

CreationTimestring

The date and time when the queue was created.

Idinteger
Suggest Edits

Deletes a queue based on its key.

 
deletehttps://platform.uipath.com/odata/QueueDefinitions(Id)
curl --request DELETE \
  --url 'https://platform.uipath.com/odata/QueueDefinitions(Id)'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://platform.uipath.com/odata/QueueDefinitions(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueDefinitions(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://platform.uipath.com/odata/QueueDefinitions(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueDefinitions(Id)"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Headers

If-Match
string

If-Match header

Response

Deleted

Suggest Edits

Returns an Excel file containing all the items in the given queue.

 
gethttps://platform.uipath.com/odata/QueueDefinitions(Id)/UiPathODataSvc.Reports()
curl --request GET \
  --url 'https://platform.uipath.com/odata/QueueDefinitions(Id)/UiPathODataSvc.Reports()'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/QueueDefinitions(Id)/UiPathODataSvc.Reports()' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueDefinitions(Id)/UiPathODataSvc.Reports()")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/QueueDefinitions(Id)/UiPathODataSvc.Reports()");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueDefinitions(Id)/UiPathODataSvc.Reports()"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Response

Suggest Edits

QueueItemComments

 
Suggest Edits

Gets the QueueItemComments.

 
gethttps://platform.uipath.com/odata/QueueItemComments
curl --request GET \
  --url https://platform.uipath.com/odata/QueueItemComments
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/QueueItemComments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItemComments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/QueueItemComments");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItemComments"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

$expand
string

Expands related entities inline.

$filter
string

Filters the results, based on a Boolean condition.

$select
string

Selects which properties to include in the response.

$orderby
string

Sorts the results.

$top
int32

Returns only the first n results.

$skip
int32

Skips the first n results.

$count
boolean

Includes a count of the matching results in the response.

Response

@odata.contextstring
valuearray
Suggest Edits

Creates a QueueItemComment.

 
posthttps://platform.uipath.com/odata/QueueItemComments
curl --request POST \
  --url https://platform.uipath.com/odata/QueueItemComments
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/QueueItemComments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItemComments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/QueueItemComments");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItemComments"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

Text
string
required

The comment body.

QueueItemId
int64

The Id of a Queue Item that the current item is connected to.

CreationTime
date-time

The date and time when the comment was created.

UserId
int64

The id of the User that authored the comment.

UserName
string

The name of the User that authored the comment.

Id
int64

Response

Textstring

The comment body.

QueueItemIdinteger

The Id of a Queue Item that the current item is connected to.

CreationTimestring

The date and time when the comment was created.

UserIdinteger

The id of the User that authored the comment.

UserNamestring

The name of the User that authored the comment.

Idinteger
Suggest Edits

Gets a QueueItemComment by Id.

 
gethttps://platform.uipath.com/odata/QueueItemComments(Id)
curl --request GET \
  --url 'https://platform.uipath.com/odata/QueueItemComments(Id)'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/QueueItemComments(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItemComments(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/QueueItemComments(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItemComments(Id)"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Query Params

$expand
string

Expands related entities inline.

$select
string

Selects which properties to include in the response.

Response

Textstring

The comment body.

QueueItemIdinteger

The Id of a Queue Item that the current item is connected to.

CreationTimestring

The date and time when the comment was created.

UserIdinteger

The id of the User that authored the comment.

UserNamestring

The name of the User that authored the comment.

Idinteger
Suggest Edits

Replace entity in EntitySet QueueItemComments

 
puthttps://platform.uipath.com/odata/QueueItemComments(Id)
curl --request PUT \
  --url 'https://platform.uipath.com/odata/QueueItemComments(Id)'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://platform.uipath.com/odata/QueueItemComments(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItemComments(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://platform.uipath.com/odata/QueueItemComments(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItemComments(Id)"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Body Params

Text
string
required

The comment body.

QueueItemId
int64

The Id of a Queue Item that the current item is connected to.

CreationTime
date-time

The date and time when the comment was created.

UserId
int64

The id of the User that authored the comment.

UserName
string

The name of the User that authored the comment.

Id
int64

Response

OK

Suggest Edits

Deletes a QueueItemComment.

 
deletehttps://platform.uipath.com/odata/QueueItemComments(Id)
curl --request DELETE \
  --url 'https://platform.uipath.com/odata/QueueItemComments(Id)'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://platform.uipath.com/odata/QueueItemComments(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItemComments(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://platform.uipath.com/odata/QueueItemComments(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItemComments(Id)"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Headers

If-Match
string

If-Match header

Response

Suggest Edits

Returns a collection of Queue Item Comments associated to a Queue Item and all its related Queue Items. A Queue Item is related to another if it was created as a retry of a failed Queue Item. They also share the same Key.

 
gethttps://platform.uipath.com/odata/QueueItemComments/UiPath.Server.Configuration.OData.GetQueueItemCommentsHistory(queueItemId=queueItemId)
curl --request GET \
  --url 'https://platform.uipath.com/odata/QueueItemComments/UiPath.Server.Configuration.OData.GetQueueItemCommentsHistory(queueItemId=queueItemId)'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/QueueItemComments/UiPath.Server.Configuration.OData.GetQueueItemCommentsHistory(queueItemId=queueItemId)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItemComments/UiPath.Server.Configuration.OData.GetQueueItemCommentsHistory(queueItemId=queueItemId)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/QueueItemComments/UiPath.Server.Configuration.OData.GetQueueItemCommentsHistory(queueItemId=queueItemId)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItemComments/UiPath.Server.Configuration.OData.GetQueueItemCommentsHistory(queueItemId=queueItemId)"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

queueItemId
int64
required

The Id of the Queue Item for which the comment history is requested.

Response

@odata.contextstring
valuearray
Suggest Edits

QueueItems

 
Suggest Edits

Gets a collection of queue items.

 
gethttps://platform.uipath.com/odata/QueueItems
curl --request GET \
  --url https://platform.uipath.com/odata/QueueItems
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/QueueItems' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItems")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/QueueItems");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItems"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

$expand
string

Expands related entities inline.

$filter
string

Filters the results, based on a Boolean condition.

$select
string

Selects which properties to include in the response.

$orderby
string

Sorts the results.

$top
int32

Returns only the first n results.

$skip
int32

Skips the first n results.

$count
boolean

Includes a count of the matching results in the response.

Response

@odata.contextstring
valuearray
Suggest Edits

Post a new entity to EntitySet QueueItems

 
posthttps://platform.uipath.com/odata/QueueItems
curl --request POST \
  --url https://platform.uipath.com/odata/QueueItems
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/QueueItems' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItems")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/QueueItems");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItems"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

Name
string

A custom name for the queue.

Description
string

Used to add additional information about a queue in order to better identify it.

MaxNumberOfRetries
int32

An 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.

AcceptAutomaticallyRetry
boolean

States whether a robot should retry to process an item if, after processing, it failed with application exception.

EnforceUniqueReference
boolean

States whether Item Reference field should be unique per Queue. Deleted and retried items are not checked against this rule.

CreationTime
date-time

The date and time when the queue was created.

Id
int64

Response

OK

Suggest Edits

Gets a queue item by Id.

 
gethttps://platform.uipath.com/odata/QueueItems(Id)
curl --request GET \
  --url 'https://platform.uipath.com/odata/QueueItems(Id)'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/QueueItems(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItems(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/QueueItems(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItems(Id)"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Query Params

$expand
string

Expands related entities inline.

$select
string

Selects which properties to include in the response.

Response

QueueDefinitionIdinteger

The Id of the parent queue.

ProcessingExceptionIdinteger

The Id of the processing exception, if any.

ProcessingExceptionobject

Stores the actual processing exception, if any.

ProcessingException.Reasonstring

The reason the processing failed.

ProcessingException.Detailsstring

Stores additional details about the exception.

ProcessingException.Typestring

The processing exception type, if any.

ProcessingException.AssociatedImageFilePathstring

A path on the robot running computer to an image file that stores relevant information about the exception - e.g. a system print screen.

ProcessingException.Idinteger
SpecificContentobject

A collection of key value pairs containing custom data configured in the Add Queue Item activity, in UiPath Studio.

SpecificContent.DynamicPropertiesobject
Outputobject

A collection of key value pairs containing custom data resulted after successful processing.

Output.DynamicPropertiesobject
OutputDatastring

A JSON representation of the output data generated by the item's processing.

Statusstring

The processing state of the item.

ReviewStatusstring

The review state of the item - applicable only for failed items.

Keystring

The unique identifier of a queue item.

Referencestring

An optional, user-specified value for queue item identification.

ProcessingExceptionTypestring

The processing exception. If the item has not been processed or has been processed successfully it will be null.

DueDatestring

The latest date and time at which the item should be processed. If empty the item can be processed at any given time.

Prioritystring

Sets the processing importance for a given item.

Robotobject

The robot that has processed the item, if any.

Robot.LicenseKeystring

The key is automatically generated from the server for the Robot machine.

<para />For the robot to work, the same key must exist on both the robot and Orchestrator.

<para />All robots on a machine must have the same license key in order to register correctly.

Robot.MachineNamestring

The name of the machine a Robot is hosted on.

Robot.Namestring

A custom name for the robot.

Robot.Usernamestring

The machine username. If the user is under a domain, you are required to also specify it in a DOMAIN\username format.

<para />Note: You must use short domain names, such as desktop\administrator and NOT desktop.local/administrator.

Robot.Descriptionstring

Used to add additional information about a robot in order to better identify it.

Robot.Typestring

The Robot type.

Robot.Passwordstring

The Windows password associated with the machine username.

Robot.Environmentsarray

The collection of environments the robot is part of.

Robot.RobotEnvironmentsstring

The comma separated textual representation of environment names the robot is part of.

Robot.Idinteger
DeferDatestring

The earliest date and time at which the item is available for processing. If empty the item can be processed as soon as possible.

StartProcessingstring

The date and time at which the item processing started. This is null if the item was not processed.

EndProcessingstring

The date and time at which the item processing ended. This is null if the item was not processed.

SecondsInPreviousAttemptsinteger

The number of seconds that the last failed processing lasted.

AncestorIdinteger

The Id of an ancestor item connected to the current item.

RetryNumberinteger

The number of times this work item has been processed.

<para />This can be higher than 0 only if MaxRetried number is set and the item processing failed at least once with ApplicationException.

SpecificDatastring

A JSON representation of the specific content.

CreationTimestring

The date and time when the item was created.

Progressstring

String field which is used to keep track of the business flow progress.

RowVersionstring

Identifier used for optimistic concurrency, so Orchestrator can figure whether data is out of date or not.

Idinteger
Suggest Edits

Replace entity in EntitySet QueueItems

 
puthttps://platform.uipath.com/odata/QueueItems(Id)
curl --request PUT \
  --url 'https://platform.uipath.com/odata/QueueItems(Id)'
var request = require("request");

var options = { method: 'PUT',
  url: 'https://platform.uipath.com/odata/QueueItems(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItems(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://platform.uipath.com/odata/QueueItems(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItems(Id)"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Body Params

Name
string

A custom name for the queue.

Description
string

Used to add additional information about a queue in order to better identify it.

MaxNumberOfRetries
int32

An 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.

AcceptAutomaticallyRetry
boolean

States whether a robot should retry to process an item if, after processing, it failed with application exception.

EnforceUniqueReference
boolean

States whether Item Reference field should be unique per Queue. Deleted and retried items are not checked against this rule.

CreationTime
date-time

The date and time when the queue was created.

Id
int64

Response

OK

Suggest Edits

Deletes a queue item by Id.

 
deletehttps://platform.uipath.com/odata/QueueItems(Id)
curl --request DELETE \
  --url 'https://platform.uipath.com/odata/QueueItems(Id)'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://platform.uipath.com/odata/QueueItems(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItems(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://platform.uipath.com/odata/QueueItems(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItems(Id)"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Headers

If-Match
string

If-Match header

Response

Suggest Edits

Update entity in EntitySet QueueItems

 
patchhttps://platform.uipath.com/odata/QueueItems(Id)
curl --request PATCH \
  --url 'https://platform.uipath.com/odata/QueueItems(Id)'
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://platform.uipath.com/odata/QueueItems(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItems(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://platform.uipath.com/odata/QueueItems(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItems(Id)"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Body Params

Name
string

A custom name for the queue.

Description
string

Used to add additional information about a queue in order to better identify it.

MaxNumberOfRetries
int32

An 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.

AcceptAutomaticallyRetry
boolean

States whether a robot should retry to process an item if, after processing, it failed with application exception.

EnforceUniqueReference
boolean

States whether Item Reference field should be unique per Queue. Deleted and retried items are not checked against this rule.

CreationTime
date-time

The date and time when the queue was created.

Id
int64

Response

OK

Suggest Edits

Returns data about the processing history of the given queue item. Allows odata query options.

 
gethttps://platform.uipath.com/odata/QueueItems(Id)/UiPathODataSvc.GetItemProcessingHistory()
curl --request GET \
  --url 'https://platform.uipath.com/odata/QueueItems(Id)/UiPathODataSvc.GetItemProcessingHistory()'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/QueueItems(Id)/UiPathODataSvc.GetItemProcessingHistory()' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItems(Id)/UiPathODataSvc.GetItemProcessingHistory()")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/QueueItems(Id)/UiPathODataSvc.GetItemProcessingHistory()");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItems(Id)/UiPathODataSvc.GetItemProcessingHistory()"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Response

@odata.contextstring
valuearray
Suggest Edits

Updates the review status of the specified queue items to an indicated state.

 
posthttps://platform.uipath.com/odata/QueueItems/UiPathODataSvc.SetItemReviewStatus
curl --request POST \
  --url https://platform.uipath.com/odata/QueueItems/UiPathODataSvc.SetItemReviewStatus
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/QueueItems/UiPathODataSvc.SetItemReviewStatus' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItems/UiPathODataSvc.SetItemReviewStatus")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/QueueItems/UiPathODataSvc.SetItemReviewStatus");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItems/UiPathODataSvc.SetItemReviewStatus"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

status
string
queueItems
array of objects

Response

Successboolean
Messagestring
FailedItemsarray
Suggest Edits

Sets the given queue items' status to Deleted.

 
posthttps://platform.uipath.com/odata/QueueItems/UiPathODataSvc.DeleteBulk
curl --request POST \
  --url https://platform.uipath.com/odata/QueueItems/UiPathODataSvc.DeleteBulk
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/QueueItems/UiPathODataSvc.DeleteBulk' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItems/UiPathODataSvc.DeleteBulk")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/QueueItems/UiPathODataSvc.DeleteBulk");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItems/UiPathODataSvc.DeleteBulk"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

queueItems
array of objects

Response

Successboolean
Messagestring
FailedItemsarray
Suggest Edits

Updates the progress field of a queue item with the status 'In Progress'.

 
posthttps://platform.uipath.com/odata/QueueItems(Id)/UiPathODataSvc.SetTransactionProgress
curl --request POST \
  --url 'https://platform.uipath.com/odata/QueueItems(Id)/UiPathODataSvc.SetTransactionProgress'
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/QueueItems(Id)/UiPathODataSvc.SetTransactionProgress' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueItems(Id)/UiPathODataSvc.SetTransactionProgress")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/QueueItems(Id)/UiPathODataSvc.SetTransactionProgress");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueItems(Id)/UiPathODataSvc.SetTransactionProgress"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Body Params

progress
string

Response

Suggest Edits

QueueProcessingRecords

 
Suggest Edits

Returns the EntitySet QueueProcessingRecords

 
gethttps://platform.uipath.com/odata/QueueProcessingRecords
curl --request GET \
  --url https://platform.uipath.com/odata/QueueProcessingRecords
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/QueueProcessingRecords' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueProcessingRecords")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/QueueProcessingRecords");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueProcessingRecords"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Query Params

$expand
string

Expands related entities inline.

$filter
string

Filters the results, based on a Boolean condition.

$select
string

Selects which properties to include in the response.

$orderby
string

Sorts the results.

$top
int32

Returns only the first n results.

$skip
int32

Skips the first n results.

$count
boolean

Includes a count of the matching results in the response.

Response

OK

Suggest Edits

Post a new entity to EntitySet QueueProcessingRecords

 
posthttps://platform.uipath.com/odata/QueueProcessingRecords
curl --request POST \
  --url https://platform.uipath.com/odata/QueueProcessingRecords
var request = require("request");

var options = { method: 'POST',
  url: 'https://platform.uipath.com/odata/QueueProcessingRecords' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueProcessingRecords")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://platform.uipath.com/odata/QueueProcessingRecords");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueProcessingRecords"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Body Params

QueueDefinitionId
int64

The Id of the queue for which the report is done.

UiQueueMetadata
object

The queue for which the report is done.

UiQueueMetadata.Name
string

A custom name for the queue.

UiQueueMetadata.Description
string

Used to add additional information about a queue in order to better identify it.

UiQueueMetadata.MaxNumberOfRetries
int32

An 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.

UiQueueMetadata.AcceptAutomaticallyRetry
boolean

States whether a robot should retry to process an item if, after processing, it failed with application exception.

UiQueueMetadata.EnforceUniqueReference
boolean

States whether Item Reference field should be unique per Queue. Deleted and retried items are not checked against this rule.

UiQueueMetadata.CreationTime
date-time

The date and time when the queue was created.

UiQueueMetadata.Id
int64
ProcessingTime
date-time

The date and time when the report is computed.

ReportType
string

The aggregation period used in the report.

NumberOfRemainingTransactions
int32

The number of unprocessed (new) items.

NumberOfInProgressTransactions
int32

The number of items in progress.

NumberOfApplicationExceptions
int32

The total number of application exceptions thrown while processing queue items in the given time period.

NumberOfBusinessExceptions
int32

The total number of business exceptions thrown while processing queue items in the given time period.

NumberOfSuccessfulTransactions
int32

The total number of successfully processed queue items in the given time period.

NumberOfRetriedItems
int32

The total number of processing retries occurred in the given time period.

ApplicationExceptionsProcessingTime
decimal

The total number of seconds spent processing queue items that failed with application exception in the given time period.

BusinessExceptionsProcessingTime
decimal

The total number of seconds spent processing queue items that failed with business exception in the given time period.

SuccessfulTransactionsProcessingTime
decimal

The total number of seconds spent processing successful queue items in the given time period.

TotalNumberOfTransactions
int32

The total number of item processing transactions, both failed and successful.

TenantId
int32

The Id of the queue tenant.

Id
int64

Response

OK

Suggest Edits

Returns the entity with the key from QueueProcessingRecords

 
gethttps://platform.uipath.com/odata/QueueProcessingRecords(Id)
curl --request GET \
  --url 'https://platform.uipath.com/odata/QueueProcessingRecords(Id)'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/QueueProcessingRecords(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueProcessingRecords(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/QueueProcessingRecords(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueProcessingRecords(Id)"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Query Params

$expand
string

Expands related entities inline.

$select
string

Selects which properties to include in the response.

Response

OK

Suggest Edits

Delete entity in EntitySet QueueProcessingRecords

 
deletehttps://platform.uipath.com/odata/QueueProcessingRecords(Id)
curl --request DELETE \
  --url 'https://platform.uipath.com/odata/QueueProcessingRecords(Id)'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://platform.uipath.com/odata/QueueProcessingRecords(Id)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueProcessingRecords(Id)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://platform.uipath.com/odata/QueueProcessingRecords(Id)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueProcessingRecords(Id)"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

Id
int64
required

key: Id

Headers

If-Match
string

If-Match header

Response

OK

Suggest Edits

Returns the computed processing status for a given queue in the last specified days.

 
gethttps://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveLastDaysProcessingRecords(daysNo=daysNo,queueDefinitionId=queueDefinitionId)
curl --request GET \
  --url 'https://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveLastDaysProcessingRecords(daysNo=daysNo,queueDefinitionId=queueDefinitionId)'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveLastDaysProcessingRecords(daysNo=daysNo,queueDefinitionId=queueDefinitionId)' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveLastDaysProcessingRecords(daysNo=daysNo,queueDefinitionId=queueDefinitionId)")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveLastDaysProcessingRecords(daysNo=daysNo,queueDefinitionId=queueDefinitionId)");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveLastDaysProcessingRecords(daysNo=daysNo,queueDefinitionId=queueDefinitionId)"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

No response examples available

Path Params

daysNo
int32
required

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
int64
required

The Id of the queue for which the report is computed.

Response

@odata.contextstring
valuearray
Suggest Edits

Returns the processing status for all queues. Allows odata query options.

 
gethttps://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveQueuesProcessingStatus()
curl --request GET \
  --url 'https://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveQueuesProcessingStatus()'
var request = require("request");

var options = { method: 'GET',
  url: 'https://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveQueuesProcessingStatus()' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveQueuesProcessingStatus()")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveQueuesProcessingStatus()");

xhr.send(data);
import requests

url = "https://platform.uipath.com/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveQueuesProcessingStatus()"

response = requests.