postman.uipath.rocks
Open in
urlscan Pro
54.145.55.5
Public Scan
URL:
https://postman.uipath.rocks/
Submission: On September 16 via automatic, source certstream-suspicious — Scanned from DE
Submission: On September 16 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
Public
Documentation Settings
Environment
No Environment
Layout
Double Column
Language
cURL
UIPATH CONNECTOR GUIDE
* Introduction
Document Scope
Getting Started
Authentication
Folders
Start Job
Queue Items
Assets
Robots
UiPath Connector Guide
WHAT IS THIS ABOUT:
The UiPath Orchestrator API is used by third-party platforms to build
connectors/adapters. Common use cases of connectors are to start jobs in UiPath
Orchestrator or create queue items which can be processes by robots. This guide
describes the different UiPath Orchestrator APIs that can be used to build these
connectors.
WHY BUILD A CONNECTOR:
Connectors give you the flexibility to stay connected to your UiPath resources
from outside of the UiPath products. So, if you want to invoke or retrieve
information about a UiPath Orchestrator resource from within your application
(e.g. start a process, add a Queue item, etc.), then a connector is the ideal
integration to build. This allows you to seamlessly integrate robots into your
local software ecosystem.
For example, your application is an issue management system and you want a robot
to run a specific business process after a user or system event (e.g., a new
ticket is created). By integrating with the Orchestrator API via a connector,
you have the ability to send requests that instruct a robot to run the business
process that typically follows the event (e.g., escalate ticket based on its
category, content, etc.).
AUTHORIZATIONOAuth 2.0
Access Token
<access-token>
Document Scope
The focus of this page is to provide you an up to date documentation and the
abiltiy to learn and understand UiPath APIs as quick as possible.
This is a collection of what we think are the most useful API calls for UiPath
Orchestrator.
Please submit any feedback and your suggestions for further supported use cases
here: integrations@uipath.com.
The full Open API specification for the UiPath Orchestrator can be found in your
local orchestrator instance:
https://cloud.uipath.com/{yourOrgId}/{tenantId}/orchestrator_/swagger/index.html
Here you can find a public hosted Open API spec for the latest version.
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
Supported Versions
ORCHESTRATOR VERSIONS
* Latest on premise Orchestrator Release (21.04)
* Long Term Support (LTS) on premise Orchestrator Release (19.10)
* Automation Cloud (current)
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
Getting Started
HOW DOES IT WORK:
Click on the right upper corner of this page Run in Postman and import this
collection into your Postman workspace.
Once imported you will need an environment in Postman. Here is how you can
create a Postman environment. Use the following variables and start making
calls.
For Cloud Orchestrator:
Variable Value oAuthClientId get from external apps configuration
oAuthClientSecret get from external apps configuration cloudUrl
https://cloud.uipath.com cloudTenant your cloud tenant name cloudOrg your cloud
organization ID onPremUrl your onPrem URL token [will be set when performing
authentication]
There are additional variables configured on Collection level. They will be used
for chaining calls in order to support functional use cases like Start Process.
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
Authentication
When sending API calls to the Orchestrator, you need to be authenticated by a
valid Bearer token.
With the following Authenticate methods you can retrieve this token. The token
has to be added for subsequent calls as Bearer token in the HTTP Header:
Authorization property.
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
External Apps (oAuth 2.0 )
Refer to Managing External Applications in order to manage access to your
Orchestrator.
You will need to configure following parameters in your app in order to
successfully authenticate:
View More
Name Value oAuth Version 2.0 Add Auth data to Request Header Header Prefix
Bearer Grant Type Authorization Code Callback URL Depends where you run your
app. Ask your admin for assistance. Postman Callback URL Desktop
https://oauth.pstmn.io/v1/callback Postman Callback URL Browser
https://oauth.pstmn.io/v1/browser-callback Auth URL
https://cloud.uipath.com/identity_/connect/authorize Access Token URL
https://cloud.uipath.com/identity_/connect/token Client ID Get from external
apps section in your automation cloud instance Client Secret Get from external
apps section in your automation cloud instance Scope OR.Jobs OR.Queues OR.Tasks
OR.Folders OR.Machines OR.Robots OR.Execution State Not mandatory Client
Authentication Send as Basic Auth Header
In tools like Postman the oAuth routine is performed implicit when doing a call
to the Orchestrator API. In this example we are using GET Folders as resource.
Please find configuration details in this Postman collection which has oAuth
configured on the oAuth 2.0 folder and will be inhereted by any subsequent API
call.
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
GET
GET Folders
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/orchestrator_/odata/folders?$Filter=DisplayName
eq 'UnattendedProcesses'
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
PARAMS
$Filter
DisplayName eq 'UnattendedProcesses'
Example Request
GET Folders
curl --location -g --request GET '{{url}}/orchestrator_/odata/folders?$Filter=DisplayName%20eq%20%27UnattendedProcesses%27'
Example Response
200 OK
Body
Header(25)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenat/orchestrator_/odata/$metadata#Folders",
"@odata.count": 1,
"value": [
{
"Key": "0d521387-6fb2-4055-a22c-62b7225565b4",
"DisplayName": "UnattendedProcesses",
"FullyQualifiedName": "UnattendedProcesses",
"FullyQualifiedNameOrderable": "UnattendedProcesses",
"Description": null,
"ProvisionType": "Automatic",
OnPremises
Refer to Authenticating with Orchestrator page page for more details
authenticating to on premise Orchestrator including an example.
Property Description OrchestratorURL The base URL of your on premise
Orchestrator instance. TenantName The tenant you want to connect to. Username
The user to be used for authentication. Password The user password.
POST
Authenticate (OnPrem)
{{onPremUrl}}/api/Account/Authenticate
BODYraw
{
"password": "{{onPremPass}}",
"usernameOrEmailAddress": "{{onPremUser}}",
"tenancyName": "{{onPremTenant}}"
}
Example Request
Authenticate (OnPrem)
curl --location -g --request POST '{{onPremUrl}}/api/Account/Authenticate' \
--data-raw '{
"password": "{{onPremPass}}",
"usernameOrEmailAddress": "{{onPremUser}}",
"tenancyName": "{{onPremTenant}}"
}'
Example Response
200 OK
Body
Header(18)
{
"result": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjVENzg4QTgyMEE4QzAzMkJBNzg1Mjk4QjNBMTlEMkNGMEQyODI2ODYiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJYWGlLZ2dxTUF5dW5oU21MT2huU3p3MG9Kb1kifQ.eyJuYmYiOjE2MTc5NzQ1NjYsImV4cCI6MTYxNzk3ODQ2NiwiaXNzIjoiaHR0cHM6Ly9wdGFvcmNoMjAxMC1pcy5henVyZXdlYnNpdGVzLm5ldC9pZGVudGl0eSIsImF1ZCI6Ik9yY2hlc3RyYXRvckFwaVVzZXJBY2Nlc3MiLCJjbGllbnRfaWQiOiI0ZDdmMmJmMi05MDkzLTQ5NTktOWQ1Mi1iNGE2NjBmMTQ4NWYiLCJzdWIiOiJkNGFiODFlNi00NjU5LTRjMjUtOGFjNy0wYTQ4MGFhZTE3ZjAiLCJhdXRoX3RpbWUiOjE2MTc5NzQ4NjYsImlkcCI6ImxvY2FsIiwiQXNwTmV0LklkZW50aXR5LlNlY3VyaXR5U3RhbXAiOiJTWFoyTUFJV0wzSUxBNUtLWVZBM1pWWFdURERKRVU2WCIsInBydF9pZCI6IjNkZDg0NGQwLWZjY2YtMGUyZC04ZTE4LWMyZTNiMzExYTBhZiIsImhvc3QiOiJGYWxzZSIsImZpcnN0X25hbWUiOiJDb2RlIFNjaWVuY2UiLCJsYXN0X25hbWUiOiJRQSIsInBydF9hZG0iOiJGYWxzZSIsInByZWZlcnJlZF91c2VybmFtZSI6ImNvZGVzY2llbmNlcWEiLCJuYW1lIjoiY29kZXNjaWVuY2VxYSIsInNjb3BlIjpbImVtYWlsIiwib3BlbmlkIiwicHJvZmlsZSIsInRlbmFudCIsIk9yY2hlc3RyYXRvckFwaVVzZXJBY2Nlc3MiXSwiYW1yIjpbInB3ZCJdfQ.rQfDqz83R5qujADvcEBhSKREDCrW_L3LwCeRDlSf1NIpIykyCjTdprPp7QgbOmB5FRf7H1778ZY3pkPY4C_EH60lTqraNKe66E09vTpRPlASQoWrbUprNSxkVd7KLTQ16QUthelVsml_D39uSCBfhiUJR0N4Bpr9GF5IVsGOuRgwQtXiw4Gi-7hlWBX5qhnj3GO29uVO5oiSJJtKlMTqWO8iIZloURFdVxYUpXuywH6nEmeUFdIvOsUcFKjPOkpUW2SdIPqWjy7yTplAXoXny1yKBfPbEkwtivvOrzRz6fz6rPQO8qNTKcAf28oeO2iLYWRN7u4AIKLgPdpkbXjwgrrVXgY3Duvw6yjBsC2Yt9Iu6DJMXq2ereBA9E_PgiMTv7D3NbKcyqLUNmTScVfWBM92qMw9UzKh1_fl5qjN3DtfdRWek8AJowxkgDskNScemdkemXAS2cGSgFc7JxEsxmZWa8CSxuSuVw9XSsFc37GaZo3t2XusJR8P55frEzcycfnxfDOJfp8iFmaMY9slUiAXX1Y4lo6_LJBBld1_y_AxRzHBskvsNc5WZwFCfrMM27NjFATfrODToECkWq-S3s-rI6h-mjQZECta4PG9cDYK5cyPB6yYp9VY2FqMg4znUIphyQIVRgHUsC2cGSo-UGZdCrgX5J4za5b3ze9OoAY",
"targetUrl": null,
"success": true,
"error": null,
"unAuthorizedRequest": false,
"__abp": true
}
API Access Key
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
PLEASE NOTE:
API Access key feature will be deprecated with version 21.10. It is not
recommended to use it anymore and please consider to migrate your projects to
oAuth2.0 / External Apps feature.
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
Refer to Consuming Cloud API page for details on authenticating to Automation
Cloud including an example.
The parameters for the authentication request can be obtained as follows:
1) Login to your Automation Cloud account.
2) Navigate to Admin > Tenants. The Tenants page is displayed with a list of all
existing tenants.
3) Expand the desired tenant to display the available services.
4) Click API Access icon on the right for the Orchestrator service in the
tenant. The API Access window is displayed with the following service-specific
information:
Property Description AccountLogicalName You account specific unique URL
identifier. TenantName The display name of the tenant. ClientId Specific to the
Orchestrator application itself, is the same for all users and tenants on a
specific platform. UserKey Allows you to generate unique login keys to be used
with APIs or with 3rd party applications in order to log in and perform actions
on your behalf. This was previously known as your refresh token.
POST
Authenticate (Access Key)
https://account.uipath.com/oauth/token
FOR CLOUD ORCHESTRATOR USERS
The first step is to send Orchestrator your Client ID and User Key so it knows
who is making these calls. Orchestrator will return a token that authenticates
all subsequent actions.
HTTP Header: Authorization: Bearer {token}
Read how to get your Client ID and User Key here.
HEADERS
Content-Type
application/json
BODYraw
{
"grant_type": "refresh_token",
"client_id": "{{clientId}}",
"refresh_token": "{{userKey}}"
}
Example Request
Authenticate (Access Key)
curl --location --request POST 'https://account.uipath.com/oauth/token' \
--header 'Content-Type: application/json' \
--data-raw '{
"grant_type": "refresh_token",
"client_id": "{{clientId}}",
"refresh_token": "{{userKey}}"
}'
Example Response
200 OK
Body
Header(24)
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI3IkpXVCIsImtpZCI6IlJUTkVOMEl5T1RWQk1UZEVRVEEzUlRZNE16UkJPVU00UVRRM016TXlSalUzUmpnMk4wSTBPQSJ9.eyJodHRwczovL3VpcGF0aC9lbWFpbCI6InJvYmVydC23YWduZXJAdWlwYXRoLmNvbSIsImh0dHBzOi8vdWlwYXRoL2VtYWlsX3ZlcmlmaWVkIjp0cnVlLCJpc3MiOiJodHRwczovL2FjY291bnQudWlwYXRoLmNvbS8iLCJzdWIiOiJhdXRoMHw1ZmZkNzhkOGNhNzk3NzAwN2JmZWEyMjYiLCJhdWQiOlsiaHR0cHM6Ly9vcmNoZXN0cmF0b3IuY2xvdWQudWlwYXRoLmNvbSIsImh0dHBzOi8vdWlwYXRoLmV1LmF1dGgwLmNvbS91c2VyaW5mbyJdLCJpYXQiOjE2MTcxOTUxODgsImV4cCI6MTYxNzI4MTU4OCwiYXpwIjoiOERFdjFBTU5YY3pXM3k0VTE1TEwzallmNjJqSzkzbjUiLCJzY29wZSI6Im1wZW5pZCBwcm9maWxlIGVtYWlsIG9mZmxpbmVfYWNjZXNzIn0.HyycgYbs9f6EXyDRZm8w-d0A82bZqBoH594ZN-ZHujMuuoLgRF1cIq8jiAGI83P2nT4hclbVxFWiw8huPqYlu7ps9uXiiV7uKFHY2cbdEyRND1-MRYqL4HyilImyJFuIREwYyl1NHshKWZ1GYepIkX6plKTT2zAXEOZ68hfb22loSQld0uGi6X9eV6sCiSV8RCLF0qMp9Pi6SzQxx3OwYJXZJWnhTlRGWUbvvBw7E0s7nJKPMKFyqiMQUu8fXYdl_zKPlEFhf-MnOo5EqRwxDMu89kDf8H1KbRan5fNmYbyQLnplWaib9ctyITFsqKyexnzKN-tyHGEQioJ79p4bNc",
"id_token": "eyJhbGxiOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI3IlJUTkVOMEl2T1RWQk1UZEVRVEEzUlRZNE16UkJXVU00UVRRM016TXlSalUzUmpnMk4wSTBPQSJ9.eyJodHRwczovL2Nsb3VkcnBhL3VzZXJpbmZvIjp7ImZpcnN0TmFtZSI6IlJvYmVydCIsImxhc3ROYW1lIjoiV2FnbmVyIiwibWFya2V0aW5nQ29uZGl0aW9uQWNjZXB0ZWQiOiJ0cnVlIiwidXNlcl9zaWdudXBfbGFuZ3VhZ2UiOiJkZSIsInRlcm1zQW5kQ29uZGl0aW9uc0IyQ0FjY2VwdGVkIjoidHJ1ZSIsIndlbGNvbWVFbWFpbFN0YXR1cyI6IlDFTkRJTkcifSwiaHR0cHM6Ly9jbG91ZHJwYS9jb25uZWN0aW9uIjoiVXNlcm5hbWUtUGFzc3dvcmQtQXV0aGVudGljYXRpb24iLCJuaWNrbmFtZSI6InJvYmVydC53YWduZXIiLCJuYW1lIjoicm9iZXJ0LndhZ25lckB1aXBhdGguY29tIiwicGljdHVyZSI1Imh0dHBzOi8vcy5ncmF2YXRhci5jb20vYXZhdGFyLzc5ZWI3OTM1ZDBjZDczYzZlNWVmMThiNTM5Y2JmY2M0P3M9NDgwJnI9cGcmZD1odHRwcyUzQSUyRiUyRmNkbi5hdXRoMC5jb20lMkZhdmF0YXJzJTJGcm8ucG5nIiwidXBkYXRlZF9hdCI6IjIwMjEtMDMtMzFUMTI6MjA6MTYuOTM2WiIsImVtYWlsIjoicm9iZXJ0LndhZ25lckB1aXBhdGguY29tIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImlzcyI6Imh0dHBzOi8vYWNjb3VudC51aXBhdGguY29tLyIsInN1YiI6ImF1dGgwfDVmZmQ3OGQ4Y2E3OTc3MDA3YmZlYTIyNiIsImF1ZCI6IjhERXYxQU1OWGN6VzN5NFUxNUxMM2pZZjYyaks5M241IiwiaWF0IjoxNjE3MTk1MTg4LCJleHAiOjE2MTcyMzExODh9.F4GrdXgZyPHrK9WQGVjIQx2nPx6tibbZK-SRRIhM85sCAy3F6FDF9ip_dWxR3t9XSVAa-kCrapzOitTnDgW_USCKTt_9ICZOOvq1UTvuXx0uFCjxYM78x3dZPpyE_LUNaBtlEc7c67xrgbPswA6fdyueehsEzJVdt_c9CQSBOflq8vRrElmr5Sk7qsf3RNYQ1u5vG12S-jtjJCnJKBxijK69SPENRVoiFxSBTneS28m53knMbTkhx48a4aTmuhl4QeLlWrFqzfJ7x8iE1TrNXCyaF5mr57s1wXlLA08y8jwHTxy0bQ0EYCYowtFr0iGnNKTZaRcuiCOp4K5wpi2VsZ",
"scope": "openid profile email offline_access",
"expires_in": 86400,
"token_type": "Bearer"
}
Folders
A folder is a storage area that helps organizations keep their projects separate
and maintain fine-grained control over their automations. There are two kinds of
folders - Classic and Modern. Folders are described in detail here.
From a connector perspective, if folders are being used in the Orchestrator
tenant, then some API calls that consume resources from a folder will require
the folder name be passed in as a header. If a folder is not specified, then the
API call is assumed to be for the classic folder named Default (which always
exists), and the call will fail if the required automations/resources are not
available in that folder. If a API expects a folder to be specified and one is
not specified, then the call will fail with the HTTP Error Code 400 as follows:
"{ "message": "An organization unit is required for this action.", "errorCode":
1101, "resourceIds": null }"
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
Validation and Type
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
PLEASE NOTE
Classic folders will be deprecated in the near future and should not be
activated anymore in newer installations. Learn more about folders.
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
It is recommended that the connector validate the entered Fully Qualified Name
of the folder before making subsequent calls. This can be done with the Get
Folders API. If there is no folder by that name, then the call will return 0
items, and the error can be flagged to the user. The Id of the folder should
also be stored as it will be needed in some API calls.
Depending on the type of the folder (Classic or Modern), the configuration of
certain API calls like Start Job will change (this is because the resources are
managed differently as explained in the respective API section later in the
document). So, it is necessary to know the type of the folder to enable proper
configuration of those API calls. The folder type is indicated by the
ProvisionType of the folder in the Get Folders API response. Modern folders are
Automatic, whereas classic folders are Manual.
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
GET
GET Folders
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/orchestrator_/odata/folders
It is recommended that the user should specify the Fully Qualified Name of the
folder. Once specified, it can be passed in the header X-UIPATH-FolderPath for
API calls that need the header.
From a connector perspective, if folders are being used in the Orchestrator
tenant, then some API calls that consume resources from a folder will require
the folder name be passed in as a header. If a folder is not specified, then the
API call is assumed to be for the modern folder named Shared (which always
exists), and the call will fail if the required automations/resources are not
available in that folder. If a API expects a folder to be specified and one is
not specified, then the call will fail with the HTTP Error Code 400 as follows:
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
PARAMS
$Filter
FullyQualifiedName eq 'ClassicFolder'
Example Request
GET Folders
curl --location -g --request GET '{{url}}/orchestrator_/odata/folders'
Example Response
200 OK
Body
Header(25)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenat/orchestrator_/odata/$metadata#Folders",
"@odata.count": 1,
"value": [
{
"Key": "db4528cc-7a3d-44f0-9df9-781fc07e9d8d",
"DisplayName": "Shared",
"FullyQualifiedName": "Shared",
"FullyQualifiedNameOrderable": "Shared",
"Description": null,
"ProvisionType": "Automatic",
Start Job
A job represents the execution of a process on UiPath Robot. You cannot launch a
job from Orchestrator on attended robots, you can only launch them on Unattended
robots.
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
Classic Folder
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
PLEASE NOTE:
Classic Folders feature will be deprecated with version 21.10. It is not
recommended to use them anymore and please consider to migrate your projects to
Modern Folders.
Here you can find more details on how to migrate from Classic to Modern folders.
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
In classic folders, jobs are started in an Environment and can be submitted to
specific robots.
View More
Property Description Type Source Environment The environment in which to start
the job. Dynamic List Get Environments API. The Name is displayed to the user
and the Id is needed for subsequent calls. Process The process to start. Dynamic
Dependent List Get Releases For Environment API to retrieve Releases for the
Environment selected above. The ProcessKey is displayed to the user and the Key
will need to be stored to be passed into the start job request. Strategy The
strategy to apply to the job. Static List All, JobsCount, Specific. JobsCount
The number of jobs to start, only if Strategy = JobsCount. Integer (value 1 or
more) RobotIds The list of robots to start the job on, only if Strategy =
Specific Dynamic Dependent List. Get Robots for Environment API for the
Environment selected above. The Name can be displayed to the user, and the Id is
passed into the start job request. Priority The priority to apply to the job.
(20.10+) Static List Low, Normal, High. Reference A string reference for the
submitted job(s). (20.10+) Text InputArguments Job Parameters that will be
passed in to the job. A JSON object as a string. Text The schema/list of
parameters is available in the response of the Get Releases API call.
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
GET
Get Folder
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Folders?$Filter=DisplayName eq
'ClassicFolder'
When executing GET Folders you will receive a list of folders including their
IDs. You will need a specific folder ID for the following steps in order to find
the right processes to be executed.
The folder ID will be handed over as X-UIPATH-OrganizationUnitId for instance
when searching for Release or StartingJobs in subsequent steps.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
Content-Type
application/json
PARAMS
$Filter
DisplayName eq 'ClassicFolder'
Example Request
Get Folder by Name
curl --location -g --request GET '{{url}}/odata/Folders?$Filter=DisplayName%20eq%20%27UnattendedProcesses%27' \
--header 'Content-Type: application/json' \
--header 'X-UIPATH-TenantName: {{tenantName}}'
Example Response
200 OK
Body
Header(25)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Folders",
"@odata.count": 1,
"value": [
{
"Key": "0d521387-6fb2-4055-a22c-62b7225565b4",
"DisplayName": "UnattendedProcesses",
"FullyQualifiedName": "UnattendedProcesses",
"FullyQualifiedNameOrderable": "UnattendedProcesses",
"Description": null,
"ProvisionType": "Automatic",
GET
Get Environments
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Environments?$Filter=Name eq
'Demo'
When executing GET Folders you will receive a list of folders including their
IDs. You will need a specific folder ID for the following steps in order to find
the right processes to be executed.
The folder ID will be handed over as X-UIPATH-OrganizationUnitId for instance
when searching for Release or StartingJobs in subsequent steps.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
Content-Type
application/json
X-UIPATH-OrganizationUnitId
PARAMS
$Filter
Name eq 'Demo'
Example Request
Get Environments
curl --location -g --request GET '{{cloudUrl}}/odata/Environments?$Filter=Name%20eq%20%27Demo%27' \
--header 'Content-Type: application/json' \
--header 'X-UIPATH-OrganizationUnitId;'
Example Response
200 OK
Body
Header(25)
View More
{
"@odata.context": "https://cloud.uipath.com/myOrg/myTenant/orchestrator_/odata/$metadata#Environments",
"@odata.count": 1,
"value": [
{
"Name": "Demo",
"Description": null,
"Type": "Dev",
"Id": 9285
}
]
GET
Get Releases by Name
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Releases?$filter=EnvironmentId
eq
The ReleaseKey is the Key property in the response, which will be needed during
the Start Job API call. The ProcessKey can be displayed to the user.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
X-UIPATH-OrganizationUnitId
PARAMS
$filter
EnvironmentId eq
Example Request
Get Releases by Name Copy
curl --location -g --request GET '{{url}}/odata/Releases?$filter=Name%20eq%20%27Add%20a%20pet%20to%20pet%20store%20by%20queue%20item%27' \
--header 'X-UIPATH-TenantName: {{tenantName}}' \
--header 'X-UIPATH-OrganizationUnitId;'
Example Response
200 OK
Body
Header(25)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Releases",
"@odata.count": 1,
"value": [
{
"Key": "6f459380-1b98-4f33-9682-6f8a7457490f",
"ProcessKey": "PetStore_AddPet_byQueueItem",
"ProcessVersion": "1.0.13",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": "Gets a queue item and adds a pet with item name",
GET
Gets robots
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Robots
This is needed only for Strategy = Specific. The user should be able to select
one ore more robots. Note that jobs can only be started on Unattended,
NonProductions, or Development robots.
The Id is passed into the Start Job API, the Name can be displayed to the user.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
X-UIPATH-OrganizationUnitId
Folder/OrganizationUnit Id
Example Request
Gets robots
curl --location -g --request GET '{{url}}/odata/Robots' \
--header 'X-UIPATH-OrganizationUnitId;'
Example Response
200 OK
Body
Header(25)
View More
{
"@odata.context": "https://cloud.uipath.com/myOrg/myTenant/orchestrator_/odata/$metadata#Robots",
"@odata.count": 1,
"value": [
{
"LicenseKey": null,
"MachineName": "SomeMachine",
"MachineId": 101763,
"Name": "myRobot",
"Username": "joe.doe@uipath.com",
"ExternalName": null,
POST
Start Process
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
Content-Type
application/json
X-UIPATH-OrganizationUnitId
X-UIPATH-TenantName
{{tenant}}
BODYraw
{
"startInfo": {
"ReleaseKey": "",
"Strategy": "Specific",
"RobotIds": [],
"Source": "Manual",
"JobPriority": "Normal",
"InputArguments": "{}"
}
}
Start Process Strategy=Specific
Example Request
View More
curl --location -g --request POST '{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs' \
--header 'Content-Type: application/json' \
--header 'X-UIPATH-OrganizationUnitId;' \
--data-raw '{
"startInfo": {
"ReleaseKey": "c5714fae-e785-4ff8-9854-e7d3212fef70",
"Strategy": "Specific",
"RobotIds": [151, 152],
"Source": "Manual",
"JobPriority": "Normal",
"InputArguments": "{'\''AccountId'\'':'\''0014J00000CgDXEQA3'\'','\''Id'\'':'\''0064J000009CJFYQA4'\'','\''Name'\'':'\''Demo Wednesday'\''}"
Example Response
201 Created
Body
Header(23)
View More
{
"@odata.context": "https://cloud.uipath.com/myOrg/myTenant/orchestrator_/odata/$metadata#Jobs",
"value": [
{
"Key": "4d7ea00a-996b-4a7d-961b-9068d9a519b3",
"StartTime": null,
"EndTime": null,
"State": "Pending",
"JobPriority": "Normal",
"Source": "Manual",
"SourceType": "Manual",
Modern Folder
In modern folders, the concept of environment does not exist, and a job can be
optionally submitted to one user or it will be allocated to a available user.
##Configuration
View More
Property Description Type Source Process The process to start. Dynamic Dependent
List Get Releases for Folder API to retrieve Releases for the modern folder. The
ProcessKey is displayed to the user and the Key will need to be stored to be
passed into the start job request. ModernJobsCount The number of jobs to start.
Integer (value 1 or more) User Optional user to whom to submit the job. Dynamic
Dependent List. Get Robots From Folder API for the modern. The Username can be
displayed to the user, and the Id is passed into the start job request.
JobPriority The priority to apply to the job. (20.10+) Static List Low, Normal,
High. RuntimeType The runtime type to consume for the job. Applicable only when
Machine Session is selected. Static List NonProduction, Unattended, Development
Machine The machine on which to execute the job. Dynamic Dependent List. Get
Machine Session Runtimes By Folder to retrieve the list of available sessions.
Reference A string reference for the submitted job(s). (20.10+) Text
InputArguments Job Parameters that will be passed in to the job. A JSON object
as a string. Text The schema/list of parameters is available in the response of
the Get Releases API call. Strategy The strategy to apply to the job. Need not
be shown the user, always ModernJobsCount. Text ModernJobsCount
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
GET
Get Folder by Name
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Folders?$Filter=DisplayName eq
'UnattendedProcesses'
When executing GET Folders you will receive a list of folders including their
IDs. You will need a specific folder ID for the following steps in order to find
the right processes to be executed.
The folder ID will be handed over as X-UIPATH-OrganizationUnitId for instance
when searching for Release or StartingJobs in subsequent steps.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
Content-Type
application/json
PARAMS
$Filter
DisplayName eq 'UnattendedProcesses'
Example Request
Get Folder by Name
curl --location -g --request GET '{{url}}/odata/Folders?$Filter=DisplayName%20eq%20%27myTestFolder%27' \
--header 'Content-Type: application/json' \
--header 'X-UIPATH-TenantName: {{tenantName}}'
Example Response
200 OK
Body
Header(25)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Folders",
"@odata.count": 1,
"value": [
{
"Key": "0d521387-6fb2-4055-a22c-62b7225565b4",
"DisplayName": "myTestFolder",
"FullyQualifiedName": "myTestFolder",
"FullyQualifiedNameOrderable": "myTestFolder",
"Description": null,
"ProvisionType": "Automatic",
GET
Get Releases by Name
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Releases?$filter=Name eq 'Add a
pet to pet store by queue item'
So you've created a Process in UiPath Studio and published it to Orchestrator.
Here's where you specify that process, by name, in order to start it remotely.
Within the URL, simply replace the string in the filter parameter with the name
of your process and this call will return the ReleaseKey that you will need in
step 3 to start the process.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
X-UIPATH-OrganizationUnitId
PARAMS
$filter
Name eq 'Add a pet to pet store by queue item'
Example Request
Get Releases by Name Copy
curl --location -g --request GET '{{url}}/odata/Releases?$filter=Name%20eq%20%27Add%20a%20pet%20to%20pet%20store%20by%20queue%20item%27' \
--header 'X-UIPATH-TenantName: {{tenantName}}' \
--header 'X-UIPATH-OrganizationUnitId;'
Example Response
200 OK
Body
Header(25)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Releases",
"@odata.count": 1,
"value": [
{
"Key": "6f459380-1b98-4f33-9682-6f8a7457490f",
"ProcessKey": "PetStore_AddPet_byQueueItem",
"ProcessVersion": "1.0.13",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": "Gets a queue item and adds a pet with item name",
POST
Start Process
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
Within Orchestrator, a Process that is running or has been run is called a Job.
To start a Job you need to hand over at least the following request body input
parameters:
1. ReleaseKey: The ID you get in the previous step GET Releases by name. The
Orchestator needs this key to run a specific version of a process.
2. Strategy: For modern folders we recommend to make use of ModernJobsCount.
3. JobsCount: How often the job will be executed.
4. InputArguments: If your job has input parameters, they can be sent as a JSON
string in the InputArguments field. If it does not, this field will be
ignored. See how input arguments are handed over in the next example.
Find more details on how to start of job here.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
Content-Type
application/json
X-UIPATH-OrganizationUnitId
BODYraw
{
"startInfo": {
"ReleaseKey": "",
"Strategy": "ModernJobsCount",
"JobsCount": 1,
"InputArguments": "{}"
}
}
Example Request
Start Process
View More
curl --location -g --request POST '{{cloudUrl}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs' \
--header 'Content-Type: application/json' \
--header 'X-UIPATH-TenantName: {{tenantName}}' \
--header 'X-UIPATH-OrganizationUnitId;' \
--data-raw '{
"startInfo": {
"ReleaseKey": "",
"Strategy": "ModernJobsCount",
"JobsCount": 1,
"InputArguments": "{}"
}
Example Response
201 Created
Body
Header(23)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Jobs",
"value": [
{
"Key": "b07ac1db-13d6-46b7-baf5-51a97ef20946",
"StartTime": null,
"EndTime": null,
"State": "Pending",
"JobPriority": "Normal",
"Source": "Manual",
"SourceType": "Manual",
Input Parameters
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
Simple Key Vale Input Parameters
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
GET
Get Folder by Name
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Folders?$Filter=DisplayName eq
'UnattendedProcesses'
When executing GET Folders you will receive a list of folders including their
IDs. You will need a specific folder ID for the following steps in order to find
the right processes to be executed.
The folder ID will be handed over as X-UIPATH-OrganizationUnitId for instance
when searching for Release or StartingJobs in subsequent steps.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
Content-Type
application/json
PARAMS
$Filter
DisplayName eq 'UnattendedProcesses'
Example Request
Get Folder by Name
curl --location -g --request GET '{{url}}/odata/Folders?$Filter=DisplayName%20eq%20%27UnattendedProcesses%27' \
--header 'Content-Type: application/json' \
--header 'X-UIPATH-TenantName: {{tenantName}}'
Example Response
200 OK
Body
Header(25)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Folders",
"@odata.count": 1,
"value": [
{
"Key": "0d521387-6fb2-4055-a22c-62b7225565b4",
"DisplayName": "UnattendedProcesses",
"FullyQualifiedName": "UnattendedProcesses",
"FullyQualifiedNameOrderable": "UnattendedProcesses",
"Description": null,
"ProvisionType": "Automatic",
GET
Get Releases by Name
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Releases?$filter=ProcessKey eq
'PetStore_UpdatePet'
So you've created a Process in UiPath Studio and published it to Orchestrator.
Here's where you specify that process, by name, in order to start it remotely.
Within the URL, simply replace the string in the filter parameter with the name
of your process and this call will return the ReleaseKey that you will need in
step 3 to start the process.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
X-UIPATH-OrganizationUnitId
PARAMS
$filter
ProcessKey eq 'PetStore_UpdatePet'
Example Request
Get Releases by Name Copy
curl --location -g --request GET '{{url}}/odata/Releases?$filter=Name%20eq%20%27Add%20a%20pet%20to%20pet%20store%20by%20queue%20item%27' \
--header 'X-UIPATH-TenantName: {{tenantName}}' \
--header 'X-UIPATH-OrganizationUnitId;'
Example Response
200 OK
Body
Header(25)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Releases",
"@odata.count": 1,
"value": [
{
"Key": "6f459380-1b98-4f33-9682-6f8a7457490f",
"ProcessKey": "PetStore_AddPet_byQueueItem",
"ProcessVersion": "1.0.13",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": "Gets a queue item and adds a pet with item name",
POST
Start Process
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
Within Orchestrator, a Process that is running or has been run is called a Job.
To start a Job you need to hand over at least the following request body input
parameters:
1. ReleaseKey: The ID you get in the previous step GET Releases by name. The
Orchestator needs this key to run a specific version of a process.
2. Strategy: For modern folders we recommend to make use of ModernJobsCount.
3. JobsCount: How often the job will be executed.
4. InputArguments: If your job has input parameters, they can be sent as a JSON
string in the InputArguments field. If it does not, this field will be
ignored. See how input arguments are handed over in the next example.
Find more details on how to start of job here.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
Content-Type
application/json
X-UIPATH-TenantName
{{tenantName}}
X-UIPATH-OrganizationUnitId
BODYraw
{
"startInfo": {
"ReleaseKey": "",
"Strategy": "ModernJobsCount",
"JobsCount": 1,
"InputArguments": "{\"status\":\"Sold\"}"
}
}
Example Request
Start Process
View More
curl --location -g --request POST '{{url}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs' \
--header 'Content-Type: application/json' \
--header 'X-UIPATH-TenantName: {{tenantName}}' \
--header 'X-UIPATH-OrganizationUnitId;' \
--data-raw '{
"startInfo": {
"ReleaseKey": "",
"Strategy": "ModernJobsCount",
"JobsCount": 1,
"InputArguments": "{\"status\":\"Sold\"}"
}
Example Response
201 Created
Body
Header(23)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Jobs",
"value": [
{
"Key": "b07ac1db-13d6-46b7-baf5-51a97ef20946",
"StartTime": null,
"EndTime": null,
"State": "Pending",
"JobPriority": "Normal",
"Source": "Manual",
"SourceType": "Manual",
Data Table Input Parameters
--------------------------------------------------------------------------------
This example is currently under construction
--------------------------------------------------------------------------------
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
GET
Get Folder by Name
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Folders?$Filter=DisplayName eq
'UnattendedProcesses'
When executing GET Folders you will receive a list of folders including their
IDs. You will need a specific folder ID for the following steps in order to find
the right processes to be executed.
The folder ID will be handed over as X-UIPATH-OrganizationUnitId for instance
when searching for Release or StartingJobs in subsequent steps.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
Content-Type
application/json
PARAMS
$Filter
DisplayName eq 'UnattendedProcesses'
Example Request
Get Folder by Name
curl --location -g --request GET '{{url}}/odata/Folders?$Filter=DisplayName%20eq%20%27UnattendedProcesses%27' \
--header 'Content-Type: application/json' \
--header 'X-UIPATH-TenantName: {{tenantName}}'
Example Response
200 OK
Body
Header(25)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Folders",
"@odata.count": 1,
"value": [
{
"Key": "0d521387-6fb2-4055-a22c-62b7225565b4",
"DisplayName": "UnattendedProcesses",
"FullyQualifiedName": "UnattendedProcesses",
"FullyQualifiedNameOrderable": "UnattendedProcesses",
"Description": null,
"ProvisionType": "Automatic",
GET
Get Releases by Name
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Releases?$filter=ProcessKey eq
'CreateTableauSAPorder'
So you've created a Process in UiPath Studio and published it to Orchestrator.
Here's where you specify that process, by name, in order to start it remotely.
Within the URL, simply replace the string in the filter parameter with the name
of your process and this call will return the ReleaseKey that you will need in
step 3 to start the process.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
X-UIPATH-OrganizationUnitId
PARAMS
$filter
ProcessKey eq 'CreateTableauSAPorder'
Example Request
Get Releases by Name Copy
curl --location -g --request GET '{{url}}/odata/Releases?$filter=Name%20eq%20%27Add%20a%20pet%20to%20pet%20store%20by%20queue%20item%27' \
--header 'X-UIPATH-TenantName: {{tenantName}}' \
--header 'X-UIPATH-OrganizationUnitId;'
Example Response
200 OK
Body
Header(25)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Releases",
"@odata.count": 1,
"value": [
{
"Key": "6f459380-1b98-4f33-9682-6f8a7457490f",
"ProcessKey": "PetStore_AddPet_byQueueItem",
"ProcessVersion": "1.0.13",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": "Gets a queue item and adds a pet with item name",
POST
Start Process
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
Within Orchestrator, a Process that is running or has been run is called a Job.
To start a Job you need to hand over at least the following request body input
parameters:
1. ReleaseKey: The ID you get in the previous step GET Releases by name. The
Orchestator needs this key to run a specific version of a process.
2. Strategy: For modern folders we recommend to make use of ModernJobsCount.
3. JobsCount: How often the job will be executed.
4. InputArguments: If your job has input parameters, they can be sent as a JSON
string in the InputArguments field. If it does not, this field will be
ignored. See how input arguments are handed over in the next example.
Find more details on how to start of job here.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
Content-Type
application/json
X-UIPATH-TenantName
{{tenantName}}
X-UIPATH-OrganizationUnitId
BODYraw
{
"startInfo": {
"ReleaseKey": "",
"Strategy": "ModernJobsCount",
"JobsCount": 1,
"InputArguments": "{\"InventoryData\":[{\"Product ID\":\"FUR-FU-10002874\",\"Measure Names\":\"Sales Forecast\",\"Measure Values\":\"$96\"},{\"Product ID\":\"FUR-FU-10002874\",\"Measure Names\":\"Quantity\",\"Measure Values\":\"2\"}]}"
}
}
Example Request
Start Process
View More
curl --location -g --request POST '{{url}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs' \
--header 'Content-Type: application/json' \
--header 'X-UIPATH-TenantName: {{tenantName}}' \
--header 'X-UIPATH-OrganizationUnitId;' \
--data-raw '{
"startInfo": {
"ReleaseKey": "",
"Strategy": "ModernJobsCount",
"JobsCount": 1,
"InputArguments": "{\"InventoryData\":[{\"Product ID\":\"FUR-FU-10002874\",\"Measure Names\":\"Sales Forecast\",\"Measure Values\":\"$96\"},{\"Product ID\":\"FUR-FU-10002874\",\"Measure Names\":\"Quantity\",\"Measure Values\":\"2\"}]}"
}
Example Response
201 Created
Body
Header(23)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Jobs",
"value": [
{
"Key": "b07ac1db-13d6-46b7-baf5-51a97ef20946",
"StartTime": null,
"EndTime": null,
"State": "Pending",
"JobPriority": "Normal",
"Source": "Manual",
"SourceType": "Manual",
Process Status
Once a process is started it will change its status. You might want to wait
until a process status is changing to 'successful'.
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
GET
Get Process Status
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/orchestrator_/odata/Jobs?$Filter=State
eq 'Successful' AND ReleaseName eq 'Add a pet to pet store by queue
item'&$orderby=EndTime DESC
You can use oData query options to filter for a specific "ReleaseName" and
"Status".
For example, you could use following query parameters for the latest
successfully run process.
$Filter=State eq 'Successful' AND ReleaseName eq 'Add a pet to pet store by
queue item'&$orderby=EndTime DESC
Find more details at oData Basic Tutorial
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
Content-Type
application/json
X-UIPATH-TenantName
{{tenantName}}
X-UIPATH-OrganizationUnitId
PARAMS
$Filter
State eq 'Successful' AND ReleaseName eq 'Add a pet to pet store by queue item'
$orderby
EndTime DESC
$count
Example Request
Get Process Status
curl --location -g --request GET '{{url}}/orchestrator_/odata/Jobs?$Filter=State%20eq%20%27Successful%27%20AND%20ReleaseName%20eq%20%27Add%20a%20pet%20to%20pet%20store%20by%20queue%20item%27&$orderby=EndTime%20DESC' \
--header 'Content-Type: application/json' \
--header 'X-UIPATH-TenantName: {{tenantName}}' \
--header 'X-UIPATH-OrganizationUnitId;'
Example Response
200 OK
Body
Header(25)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Jobs",
"@odata.count": 401,
"value": [
{
"Key": "b07ac1db-13d6-46b7-baf5-51a97ef20946",
"StartTime": "2021-03-31T12:54:16.587Z",
"EndTime": "2021-03-31T12:54:20.153Z",
"State": "Successful",
"JobPriority": "Normal",
"Source": "Manual",
Queue Items
Queue items can store multiple types of data, such as invoice information or
customer details. This information can be processed in other systems - SAP or
Salesforce, for instance.
The data stored in, and output from, Queue items is free form by default.
Learn more about queues and transactions.
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
POST
Add Queue Item
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Queues/UiPathODataSvc.AddQueueItem
#Configuration
View More
Property Description Type Source Queue The name of the queue to which to submit
the queue item. Dynamic List Get Queue Definitions API. The Name is displayed to
the user and is also passed in the subsequent call. Priority The priority to
apply to the queue item. Static List Low, Normal, High. DeferDate The earliest
date and time at which the item is available for processing. If empty the item
can be processed as soon as possible. DateTime DueDate The latest date and time
at which the item should be processed. If empty the item can be processed at any
given time. DateTime RiskSlaDate The RiskSla date at time which is considered as
risk zone for the item to be processed. DateTime Reference A string reference
for the queue item. Text SpecificContent Data that will be passed in to the job.
JSON Object
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
X-UIPATH-OrganizationUnitId
Folder/OrganizationUnit Id
Content-Type
application/json
PARAMS
$expand
Indicates the related entities to be represented inline. The maximum depth is 2.
$select
Limits the properties returned in the result.
BODYraw
View More
{
"itemData": {
"DeferDate": "2021-03-11T14:19:56.4407392Z",
"DueDate": "2021-03-11T15:19:56.4407392Z",
"Priority": "Normal",
"Name": "UnattendedQueue",
"SpecificContent": {
"Name@odata.type": "#String",
"Name": "Testymonika2000",
"Age": 43,
"Status": false
Example Request
Add Queue Item
View More
curl --location -g --request POST '{{url}}/odata/Queues/UiPathODataSvc.AddQueueItem' \
--header 'X-UIPATH-OrganizationUnitId;' \
--header 'Content-Type: application/json' \
--data-raw '{
"itemData": {
"DeferDate": "2021-03-11T14:19:56.4407392Z",
"DueDate": "2021-03-11T15:19:56.4407392Z",
"Priority": "Normal",
"Name": "UnattendedQueue",
"SpecificContent": {
"Name@odata.type": "#String",
Example Response
201 Created
Body
Header(24)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#QueueItems/$entity",
"QueueDefinitionId": 28211,
"OutputData": null,
"AnalyticsData": null,
"Status": "New",
"ReviewStatus": "None",
"ReviewerUserId": null,
"Key": "883749b2-70cd-4beb-b0a7-4fd260d26635",
"Reference": "Petstore",
"ProcessingExceptionType": null,
GET
Get Queue Item by ID
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/QueueItems()
OAuth required scopes: OR.Queues or OR.Queues.Read.
Required permissions: Queues.View and Transactions.View.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
X-UIPATH-OrganizationUnitId
Folder/OrganizationUnit Id
PARAMS
$expand
Indicates the related entities to be represented inline. The maximum depth is 2.
$select
Limits the properties returned in the result.
Example Request
Get Queue Item by ID
curl --location -g --request GET '{{url}}/odata/QueueItems()' \
--header 'X-UIPATH-OrganizationUnitId;'
Example Response
200 OK
Body
Header(25)
View More
{
"@odata.context": "https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#QueueItems/$entity",
"QueueDefinitionId": 28211,
"OutputData": null,
"AnalyticsData": null,
"Status": "New",
"ReviewStatus": "None",
"ReviewerUserId": null,
"Key": "883749b2-70cd-4beb-b0a7-4fd260d26635",
"Reference": "Petstore",
"ProcessingExceptionType": null,
Assets
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
POST
Assets - Create
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Assets
Create a new Asset
ValueScope: Global or PerRobot
ValueType: Text, Bool, Integer, or Credential
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
Content-Type
application/json
X-UIPATH-OrganizationUnitId
BODYraw
{
"Name": "Caesar2",
"ValueScope": "Global",
"ValueType": "Text",
"StringValue": "Et tu Asset 2"
}
Example Request
Assets - Create
curl --location -g --request POST '{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Assets' \
--header 'Content-Type: application/json' \
--data-raw '{
"Name": "Caesar",
"ValueScope": "Global",
"ValueType": "Text",
"StringValue": "Et tu Asset 2"
}'
Example Response
201 Created
Body
Header(15)
View More
{
"@odata.context": "https://cloud.uipath.com/Org/Tenant/orchestrator_/odata/$metadata#Assets/$entity",
"Name": "Caesar",
"CanBeDeleted": true,
"ValueScope": "Global",
"ValueType": "Text",
"Value": "Et tu Asset 2",
"StringValue": "Et tu Asset 2",
"BoolValue": false,
"IntValue": 0,
"CredentialUsername": "",
GET
Assets - Get all
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Assets
Get all Assets. Use query params to narrow the response group.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
X-UIPATH-TenantName
{{cloudTenant}}
X-UIPATH-OrganizationUnitId
Example Request
Assets - Get all
curl --location -g --request GET '{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Assets' \
--header 'X-UIPATH-TenantName: {{tenantName}}' \
--header 'X-UIPATH-OrganizationUnitId;'
Example Response
200 OK
Body
Header(16)
View More
{
"@odata.context": "https://cloud.uipath.com/Org/Tenant/orchestrator_/odata/$metadata#Assets/$entity",
"@odata.count": 15,
"value": [
{
"Name": "Asset 2",
"CanBeDeleted": true,
"ValueScope": "Global",
"ValueType": "Text",
"Value": "I would not, Cassius, yet I love him well.",
"StringValue": "I would not, Cassius, yet I love him well.",
GET
Assets - Get by name
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Assets?$filter=Name eq 'Caesar'
Get a single Asset with the name specified in the $filter param.
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
Content-Type
application/json
X-UIPATH-OrganizationUnitId
PARAMS
$filter
Name eq 'Caesar'
$Count
1
Example Request
Assets - Get by Name
curl --location -g --request GET '{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Assets?$filter=Name%20eq%20%27Caesar%27'
Example Response
200 OK
Body
Header(16)
View More
{
"@odata.context": "https://cloud.uipath.com/Org/Tenant/orchestrator_/odata/$metadata#Assets",
"@odata.count": 1,
"value": [
{
"Name": "Caesar",
"CanBeDeleted": true,
"ValueScope": "Global",
"ValueType": "Text",
"Value": "Et tu Asset 2",
"StringValue": "Et tu Asset 2",
PUT
Assets - Edit
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Assets(38364)
Change any characteristic of an Asset--name, scope, type, value...
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
Content-Type
application/json
X-UIPATH-OrganizationUnitId
BODYraw
{
"Name": "Caesar",
"ValueScope": "Global",
"ValueType": "Text",
"StringValue": "Et tu Asset 3",
"Id":
}
Example Request
Assets - Edit
View More
curl --location -g --request PUT '{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Assets(38364)' \
--header 'Content-Type: application/json' \
--data-raw '{
"Name": "Caesar",
"ValueScope": "Global",
"ValueType": "Text",
"StringValue": "Et tu Asset 2",
"Id": 38364
}'
Example Response
200 OK
Body
Header(12)
No response body
This request doesn't return a response body
Robots
AUTHORIZATIONOAuth 2.0
This folder is using OAuth 2.0 from collectionUiPath Connector Guide
GET
Robots - Get all
{{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Robots
AUTHORIZATIONOAuth 2.0
This request is using OAuth 2.0 from collectionUiPath Connector Guide
HEADERS
Content-Type
application/json
X-UIPATH-TenantName
{{cloudTenant}}
X-UIPATH-OrganizationUnitId
Example Request
Robots - Get all
curl --location -g --request GET '{{url}}/odata/Robots' \
--header 'Content-Type: application/json'
Example Response
200 OK
Body
Header(16)
View More
{
"@odata.context": "https://platform.uipath.com/odata/$metadata#Robots",
"@odata.count": 2,
"value": [
{
"LicenseKey": null,
"MachineName": "AnotherFakeOne",
"MachineId": 20967,
"Name": "Cassius",
"Username": "cassius",
"Description": "A dev bot for testing",