- Erste Schritte
- Authentication
- Swagger-Definition
- Orchestrator-APIs
- Warnungsanforderungen
- Anfragen zu Assets
- Kalenderanforderungen
- Umgebungsabfragen
- Ordneranforderungen
- Anforderungen für generische Aufgaben
- Jobanfragen
- Bibliotheksabfragen
- Lizenzabfragen
- Paketanfragen
- Berechtigungsabfragen
- Anforderungen für persönliche Arbeitsbereiche
- Prozessabfragen
- Anforderungen von Warteschlangenelementen
- Queue retention policy requests
- Roboteranfragen
- Rollenanfragen
- Zeitplanabfragen
- Anfragen zu Einstellungen
- Anforderungen für Speicher-Buckets
- Aufgabenanforderungen
- Aufgabenkataloganforderungen
- Aufgabenformularanforderungen
- Mandantenabfragen
- Transaktionsanfragen
- Benutzerabfragen
- Webhook-Abfragen
- Plattformverwaltungs-APIs

Anleitung für die Orchestrator-API
Umgebungsabfragen
Ab Version 2018.3 wurde das Konzept des Umgebungstyps abgeschafft und wird nicht mehr in der Bedienoberfläche angezeigt. Sie können jedoch beruhigt sein, dass die Rückwärtskompatibilität erhalten bleibt, da diese Option nicht aus der Orchestrator-API entfernt wurde. Bitte beachten Sie jedoch, dass alle in der Bedienoberfläche neu erstellten Umgebungen zum Typ Dev. gehören.
Rufen Sie die Umgebungen ab, mit denen ein Paket verknüpft ist
Mit dem folgenden Abruf können Sie nur die Umgebungen anzeigen, die dem Paket „add_queue_items“ zugeordnet sind.
Abrufen
https://{yourDomain}/odata/Releases?$filter=ProcessKey eq 'add_queue_items'&$select=EnvironmentName
Anforderungsheader
| Schlüssel | Wert |
|---|---|
| Autorisierung | Inhaber |
Antwortcode
200 OK
Antworttext
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Releases(EnvironmentName)",
"@odata.count": 2,
"value": [
{
"EnvironmentName": "clean_env"
},
{
"EnvironmentName": "doc_env"
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Releases(EnvironmentName)",
"@odata.count": 2,
"value": [
{
"EnvironmentName": "clean_env"
},
{
"EnvironmentName": "doc_env"
}
]
}
Alle Prozesse gemäß einer angegebenen Umgebung abrufen
Im folgenden Beispiel rufen Sie alle Prozesse ab, die mit der Umgebung „doc_env“ verknüpft sind.
Abrufen
https://{yourDomain}/odata/Releases?$filter=EnvironmentName eq 'doc_env'
Anforderungsheader
| Schlüssel | Wert |
|---|---|
| Autorisierung | Inhaber |
Antwortcode
200 OK
Antworttext
{
"@odata.context": "https://{yourDomain}/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": "https://{yourDomain}/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
}
]
}