orchestrator
2022.4
false
- Getting Started
- Swagger Definition
- Orchestrator APIs
- Alerts Requests
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Processes Requests
- Queue Items Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
Processes Requests
Orchestrator API Guide
Last updated Jun 22, 2024
Processes Requests
GET
{OrchestratorURL}/odata/Releases?$filter=%20Name%20eq%20'all_activities_DocEnv'
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Releases",
"@odata.count": 1,
"value": [
{
"Key": "01b7cf62-98e0-4a69-9a65-be7514643229",
"ProcessKey": "all_activities",
"ProcessVersion": "1.0.6666.26728",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "all_activities_DocEnv",
"EnvironmentId": 7,
"EnvironmentName": "DocEnv",
"InputArguments": null,
"Id": 6,
"Arguments": null
}
]
}
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Releases",
"@odata.count": 1,
"value": [
{
"Key": "01b7cf62-98e0-4a69-9a65-be7514643229",
"ProcessKey": "all_activities",
"ProcessVersion": "1.0.6666.26728",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "all_activities_DocEnv",
"EnvironmentId": 7,
"EnvironmentName": "DocEnv",
"InputArguments": null,
"Id": 6,
"Arguments": null
}
]
}
The following PATCH request to the
/odata/Releases(Id)
endpoint enables you to add or change the values of specific input parameters, at process level. If you want to add these
values when starting a job, please see the Job Requests topic.
Note: Please note that a maximum of 10,000 characters is accepted for the entire length of the JSON representation of input parameters,
including argument names, all the escaped characters, spaces, brackets, and arguments values.
PATCH
{OrchestratorURL}/odata/Releases(55)
{
"Arguments": {
"Input": "{\"age\":27,\"trueOrFalse\":false,\"stringNew\":\"testing\"}"
}
}
{
"Arguments": {
"Input": "{\"age\":27,\"trueOrFalse\":false,\"stringNew\":\"testing\"}"
}
}