UiPath

App · 20 actions

Read Orchestrator resources, start and stop jobs, and manage queue transactions.

Actions

ActionWhat it does
Add queue itemAdd an item to a queue by the queue's name, with a priority and optional content, reference, due date and defer date.
Get assetGet one asset in a folder by its ID, returning its name, type and value.
Get jobGet one job in a folder by its ID, returning its process, robot, state, start and end times, and any output or error.
Get machineGet one machine in a folder by its ID, returning its name, type and runtime slots.
Get queueGet one queue in a folder by its ID, returning its name, description and retry settings.
Get queue itemGet one queue item in a folder by its ID, returning its status, priority, reference, content, output and processing times.
Get releaseGet one process (release) in a folder by its ID, returning its name, key, package version and input arguments.
Get robotGet one robot in a folder by its ID, returning its name, type, username and machine.
List assetsList the assets (shared values such as settings and credentials) in a folder, returning each one's name, type and value.
List foldersList the Orchestrator folders you can see, returning each folder's ID, name and path.
List jobsList the jobs in an Orchestrator folder, returning each job's process, robot, state and start and end times.
List machinesList the machines available in a folder, returning each one's name, type and runtime slots.
List queue itemsList the items in a folder's queues, returning each item's queue, status, priority, reference and content.
List queuesList the queues in a folder, returning each queue's name, ID and retry settings.
List releasesList the processes (releases) published to a folder, returning each one's name, key and package version.
List robotsList the robots in a folder, returning each one's name, type, username and machine.
List usersList the users in the Orchestrator tenant, returning each user's name, username, email address and type.
Set transaction statusMark a queue item that is being processed as successful or failed by its ID, optionally saving output values with it.
Start jobStart one job of a process in a folder, picked by its release key, optionally passing input arguments.
Stop jobStop a running job in a folder by its ID, either asking it to finish gracefully (soft stop) or ending it at once (kill).

Add queue item

Add an item to a queue by the queue's name, with a priority and optional content, reference, due date and defer date. Returns the new queue item with its ID.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Queue namequeue_nametextRequired
Queue name.
PriorityprioritytextRequired
Priority.One of: Low, Normal, High.
Specific contentspecific_contentobject
Specific content.
Referencereferencetext
Reference.
Due datedue_datedate and time
Due date.
Defer datedefer_datedate and time
Defer date.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get asset

Get one asset in a folder by its ID, returning its name, type and value.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Asset IDasset_idnumberRequired
Asset ID.At least 1.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get job

Get one job in a folder by its ID, returning its process, robot, state, start and end times, and any output or error.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Job IDjob_idnumberRequired
Job ID.At least 1.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get machine

Get one machine in a folder by its ID, returning its name, type and runtime slots.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Machine IDmachine_idnumberRequired
Machine ID.At least 1.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get queue

Get one queue in a folder by its ID, returning its name, description and retry settings.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Queue IDqueue_idnumberRequired
Queue ID.At least 1.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get queue item

Get one queue item in a folder by its ID, returning its status, priority, reference, content, output and processing times.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Queue item IDqueue_item_idnumberRequired
Queue item ID.At least 1.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get release

Get one process (release) in a folder by its ID, returning its name, key, package version and input arguments.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Release IDrelease_idnumberRequired
Release ID.At least 1.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get robot

Get one robot in a folder by its ID, returning its name, type, username and machine.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Robot IDrobot_idnumberRequired
Robot ID.At least 1.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List assets

List the assets (shared values such as settings and credentials) in a folder, returning each one's name, type and value. Returns one page; use top and skip for the next page.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Toptopnumber
Top.From 1 to 1000.
Skipskipnumber
Skip.At least 0.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "value": []
  }
}

List folders

List the Orchestrator folders you can see, returning each folder's ID, name and path. Returns one page; use top and skip for the next page.

Inputs

Toptopnumber
Top.From 1 to 1000.
Skipskipnumber
Skip.At least 0.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "value": []
  }
}

List jobs

List the jobs in an Orchestrator folder, returning each job's process, robot, state and start and end times. Returns one page; use top and skip for the next page.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Toptopnumber
Top.From 1 to 1000.
Skipskipnumber
Skip.At least 0.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "value": []
  }
}

List machines

List the machines available in a folder, returning each one's name, type and runtime slots. Returns one page; use top and skip for the next page.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Toptopnumber
Top.From 1 to 1000.
Skipskipnumber
Skip.At least 0.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "value": []
  }
}

List queue items

List the items in a folder's queues, returning each item's queue, status, priority, reference and content. Returns one page; use top and skip for the next page.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Toptopnumber
Top.From 1 to 1000.
Skipskipnumber
Skip.At least 0.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "value": []
  }
}

List queues

List the queues in a folder, returning each queue's name, ID and retry settings. Returns one page; use top and skip for the next page.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Toptopnumber
Top.From 1 to 1000.
Skipskipnumber
Skip.At least 0.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "value": []
  }
}

List releases

List the processes (releases) published to a folder, returning each one's name, key and package version. Returns one page; use top and skip for the next page.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Toptopnumber
Top.From 1 to 1000.
Skipskipnumber
Skip.At least 0.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "value": []
  }
}

List robots

List the robots in a folder, returning each one's name, type, username and machine. Returns one page; use top and skip for the next page.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Toptopnumber
Top.From 1 to 1000.
Skipskipnumber
Skip.At least 0.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "value": []
  }
}

List users

List the users in the Orchestrator tenant, returning each user's name, username, email address and type. Returns one page; use top and skip for the next page.

Inputs

Toptopnumber
Top.From 1 to 1000.
Skipskipnumber
Skip.At least 0.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "value": []
  }
}

Set transaction status

Mark a queue item that is being processed as successful or failed by its ID, optionally saving output values with it.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Queue item IDqueue_item_idnumberRequired
Queue item ID.At least 1.
Successfulsuccessfultrue/falseRequired
Successful.
Outputoutputobject
Output.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Start job

Start one job of a process in a folder, picked by its release key, optionally passing input arguments. Returns the new job with its ID and state.

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Release keyrelease_keytextRequired
Release key.
Input argumentsinput_argumentsobject
Input arguments.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "value": []
  }
}

Stop job

Stop a running job in a folder by its ID, either asking it to finish gracefully (soft stop) or ending it at once (kill).

Inputs

Folderfolder_idnumberRequired
Folder.At least 1.
Job IDjob_idnumberRequired
Job ID.At least 1.
StrategystrategytextRequired
Strategy.One of: SoftStop, Kill.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

On this page