orchestrator
2022.4
false
- Getting Started
- Authentication
- 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
- Platform Management APIs
Environments Requests
Orchestrator API Guide
Last updated Jun 18, 2024
Environments Requests
Note: Starting with v2018.3, the concept of environment type has been removed and is no longer displayed in the user interface.
Rest assured, backward compatibility is still maintained as this option was not removed from the Orchestrator API. However,
please note that all new environments created in the user interface are of type Dev.
The following call helps you display only the environments assigned to the "add_queue_items" package.
GET
{OrchestratorURL}/odata/Releases?$filter=ProcessKey eq 'add_queue_items'&$select=EnvironmentName
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Releases(EnvironmentName)",
"@odata.count": 2,
"value": [
{
"EnvironmentName": "clean_env"
},
{
"EnvironmentName": "doc_env"
}
]
}
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Releases(EnvironmentName)",
"@odata.count": 2,
"value": [
{
"EnvironmentName": "clean_env"
},
{
"EnvironmentName": "doc_env"
}
]
}
The following example lets you retrieve all the processes that are associated with the "doc_env" environment.
GET
{OrchestratorURL}/odata/Releases?$filter=EnvironmentName eq 'doc_env'
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Releases",
"@odata.count": 5,
"value": [
{
"Key": "663119a9-cd88-4345-ad9a-e91e96c97eb2",
"ProcessKey": "add_queue_items",
"ProcessVersion": "1.0.6586.22741",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "add_queue_items_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 422
},
{
"Key": "57fb1bd5-f8fd-40b4-be7b-4a18f34fe293",
"ProcessKey": "DataScraping",
"ProcessVersion": "1.0.6586.22750",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "DataScraping_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 421
},
{
"Key": "cabdbd2e-0c92-4abe-9266-ac053d660bbc",
"ProcessKey": "in_progress_items",
"ProcessVersion": "1.0.6640.35909",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "in_progress_items_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 598
},
{
"Key": "795cbab2-8008-4a54-b1cb-f9ff1ece139e",
"ProcessKey": "new_activities_tests",
"ProcessVersion": "1.0.6586.22737",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "new_activities_tests_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 423
},
{
"Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
"ProcessKey": "Release_Project",
"ProcessVersion": "1.0.6589.35468",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": "rockerii",
"Name": "Release_Project_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 440
}
]
}
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Releases",
"@odata.count": 5,
"value": [
{
"Key": "663119a9-cd88-4345-ad9a-e91e96c97eb2",
"ProcessKey": "add_queue_items",
"ProcessVersion": "1.0.6586.22741",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "add_queue_items_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 422
},
{
"Key": "57fb1bd5-f8fd-40b4-be7b-4a18f34fe293",
"ProcessKey": "DataScraping",
"ProcessVersion": "1.0.6586.22750",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "DataScraping_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 421
},
{
"Key": "cabdbd2e-0c92-4abe-9266-ac053d660bbc",
"ProcessKey": "in_progress_items",
"ProcessVersion": "1.0.6640.35909",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "in_progress_items_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 598
},
{
"Key": "795cbab2-8008-4a54-b1cb-f9ff1ece139e",
"ProcessKey": "new_activities_tests",
"ProcessVersion": "1.0.6586.22737",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": null,
"Name": "new_activities_tests_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 423
},
{
"Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
"ProcessKey": "Release_Project",
"ProcessVersion": "1.0.6589.35468",
"IsLatestVersion": false,
"IsProcessDeleted": false,
"Description": "rockerii",
"Name": "Release_Project_doc_env",
"EnvironmentId": 312,
"EnvironmentName": "doc_env",
"Id": 440
}
]
}