UiPath
App · 20 actions
Read Orchestrator resources, start and stop jobs, and manage queue transactions.
Actions
| Action | What it does |
|---|---|
| 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. |
| Get asset | Get one asset in a folder by its ID, returning its name, type and value. |
| 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. |
| Get machine | Get one machine in a folder by its ID, returning its name, type and runtime slots. |
| Get queue | Get one queue in a folder by its ID, returning its name, description and retry settings. |
| Get queue item | Get one queue item in a folder by its ID, returning its status, priority, reference, content, output and processing times. |
| Get release | Get one process (release) in a folder by its ID, returning its name, key, package version and input arguments. |
| Get robot | Get one robot in a folder by its ID, returning its name, type, username and machine. |
| List assets | List the assets (shared values such as settings and credentials) in a folder, returning each one's name, type and value. |
| List folders | List the Orchestrator folders you can see, returning each folder's ID, name and path. |
| List jobs | List the jobs in an Orchestrator folder, returning each job's process, robot, state and start and end times. |
| List machines | List the machines available in a folder, returning each one's name, type and runtime slots. |
| List queue items | List the items in a folder's queues, returning each item's queue, status, priority, reference and content. |
| List queues | List the queues in a folder, returning each queue's name, ID and retry settings. |
| List releases | List the processes (releases) published to a folder, returning each one's name, key and package version. |
| List robots | List the robots in a folder, returning each one's name, type, username and machine. |
| List users | List the users in the Orchestrator tenant, returning each user's name, username, email address and type. |
| Set transaction status | Mark a queue item that is being processed as successful or failed by its ID, optionally saving output values with it. |
| Start job | Start one job of a process in a folder, picked by its release key, optionally passing input arguments. |
| 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). |
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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Queue name
queue_nametextRequired - Queue name.
- Priority
prioritytextRequired - Priority.One of:
Low,Normal,High. - Specific content
specific_contentobject - Specific content.
- Reference
referencetext - Reference.
- Due date
due_datedate and time - Due date.
- Defer date
defer_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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Asset ID
asset_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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Job ID
job_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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Machine ID
machine_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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Queue ID
queue_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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Queue item ID
queue_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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Release ID
release_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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Robot ID
robot_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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Top
topnumber - Top.From 1 to 1000.
- Skip
skipnumber - 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
- Top
topnumber - Top.From 1 to 1000.
- Skip
skipnumber - 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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Top
topnumber - Top.From 1 to 1000.
- Skip
skipnumber - 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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Top
topnumber - Top.From 1 to 1000.
- Skip
skipnumber - 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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Top
topnumber - Top.From 1 to 1000.
- Skip
skipnumber - 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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Top
topnumber - Top.From 1 to 1000.
- Skip
skipnumber - 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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Top
topnumber - Top.From 1 to 1000.
- Skip
skipnumber - 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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Top
topnumber - Top.From 1 to 1000.
- Skip
skipnumber - 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
- Top
topnumber - Top.From 1 to 1000.
- Skip
skipnumber - 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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Queue item ID
queue_item_idnumberRequired - Queue item ID.At least 1.
- Successful
successfultrue/falseRequired - Successful.
- Output
outputobject - 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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Release key
release_keytextRequired - Release key.
- Input arguments
input_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
- Folder
folder_idnumberRequired - Folder.At least 1.
- Job ID
job_idnumberRequired - Job ID.At least 1.
- Strategy
strategytextRequired - Strategy.One of:
SoftStop,Kill.
Outputs
dataobject- Response.
Example output
{
"data": {}
}