orchestrator
2021.10
false
- Erste Schritte
- Swagger-Definition
- Orchestrator-APIs
- Warnungsanforderungen
- Anfragen zu Assets
- Kalenderanforderungen
- Umgebungsabfragen
- Ordneranforderungen
- Anforderungen für generische Aufgaben
- Jobanfragen
- Bibliotheksabfragen
- Lizenzabfragen
- Paketanfragen
- Berechtigungsabfragen
- Prozessabfragen
- Roboteranfragen
- Rollenanfragen
- Zeitplanabfragen
- Anfragen zu Einstellungen
- Aufgabenanforderungen
- Aufgabenkataloganforderungen
- Aufgabenformularanforderungen
- Mandantenabfragen
- Transaktionsanfragen
- Benutzerabfragen
- Webhook-Abfragen
Wichtig :
Bitte beachten Sie, dass dieser Inhalt teilweise mithilfe von maschineller Übersetzung lokalisiert wurde.
Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

Kein Support
Anleitung für die Orchestrator-API
Letzte Aktualisierung 18. Juli 2025
Anforderungen für generische Aufgaben
linkExterne Aufgaben
linkCreate External Task
Erstellen Sie neue externe Aufgaben für Vorgänge, die in externen Systemen wie JIRA oder Salesforce ausgeführt werden.
Posten
{OrchestratorURL}/tasks/GenericTasks/CreateTask
Anforderungsheader
Schlüssel |
Wert |
---|---|
Autorisierung |
Inhaber |
Anforderungstext
{
"type": "ExternalTask",
"externalTag": "JIRA",
"title": "Close Ticket",
"priority": "High",
"data": {},
"taskCatalogName": "Tickets"
}
{
"type": "ExternalTask",
"externalTag": "JIRA",
"title": "Close Ticket",
"priority": "High",
"data": {},
"taskCatalogName": "Tickets"
}
Antwortcode
201 Erstellt
Antworttext
{
"status": 0,
"data": {},
"action": null,
"externalTag": "JIRA",
"id": 1378
}
{
"status": 0,
"data": {},
"action": null,
"externalTag": "JIRA",
"id": 1378
}
Externe Aufgabe abschließen
Schließen Sie eine externe Aufgabe basierend auf der
taskId
ab. Der taskId
muss wie im folgenden Beispiel im Text der Anforderung enthalten sein.
Posten
{OrchestratorURL}/tasks/GenericTasks/CompleteTask
Anforderungsheader
Schlüssel |
Wert |
---|---|
Autorisierung |
Inhaber |
Anforderungstext
{
"taskId": 1378,
"data": {},
"action": "close"
}
{
"taskId": 1378,
"data": {},
"action": "close"
}
Antwortcode
204 Kein Inhalt
Dokumentvalidierungsaufgaben
linkDokumentvalidierungsaufgabe erstellen
Erstellen Sie eine Dokumentvalidierungsaufgabe im Orchestrator, mit der Benutzer die Ergebnisse der Dokumentextraktion validieren können.
Posten
{OrchestratorURL}/tasks/GenericTasks/CreateTask
Anforderungsheader
Schlüssel |
Wert |
---|---|
Autorisierung |
Inhaber |
Anforderungstext
{
"type": "DocumentValidationTask",
"externalTag": "DV",
"title": "Build Certificate",
"priority": "Low",
"data": {
"BucketId": 25,
"DocumentId": "Construction Tender Document",
"DocumentPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\Construction Tender Document.zip",
"EncodedDocumentPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\encoded.zip",
"TextPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\text.zip",
"DocumentObjectModelPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\dom.zip",
"TaxonomyPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\taxonomy.zip",
"AutomaticExtractionResultsPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\input_results.zip",
"ValidatedExtractionResultsPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\output_results.zip",
"Version": "1.0"
},
"taskCatalogName": "MinodoraCertificates"
}
{
"type": "DocumentValidationTask",
"externalTag": "DV",
"title": "Build Certificate",
"priority": "Low",
"data": {
"BucketId": 25,
"DocumentId": "Construction Tender Document",
"DocumentPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\Construction Tender Document.zip",
"EncodedDocumentPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\encoded.zip",
"TextPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\text.zip",
"DocumentObjectModelPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\dom.zip",
"TaxonomyPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\taxonomy.zip",
"AutomaticExtractionResultsPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\input_results.zip",
"ValidatedExtractionResultsPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\output_results.zip",
"Version": "1.0"
},
"taskCatalogName": "MinodoraCertificates"
}
Antwortcode
201 Erstellt
Antworttext
{
"status": 0,
"data": {
"BucketId": 25,
"DocumentId": "Construction Tender Document",
"DocumentPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\Construction Tender Document.zip",
"EncodedDocumentPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\encoded.zip",
"TextPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\text.zip",
"DocumentObjectModelPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\dom.zip",
"TaxonomyPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\taxonomy.zip",
"AutomaticExtractionResultsPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\input_results.zip",
"ValidatedExtractionResultsPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\output_results.zip",
"Version": "1.0"
},
"action": null,
"externalTag": "DV",
"organizationUnitId": 1424,
"id": 27627
}
{
"status": 0,
"data": {
"BucketId": 25,
"DocumentId": "Construction Tender Document",
"DocumentPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\Construction Tender Document.zip",
"EncodedDocumentPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\encoded.zip",
"TextPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\text.zip",
"DocumentObjectModelPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\dom.zip",
"TaxonomyPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\taxonomy.zip",
"AutomaticExtractionResultsPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\input_results.zip",
"ValidatedExtractionResultsPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\output_results.zip",
"Version": "1.0"
},
"action": null,
"externalTag": "DV",
"organizationUnitId": 1424,
"id": 27627
}
Dokumentvalidierungsaufgabe erstellen
Gibt die Details einer Dokumentvalidierungsaufgabe basierend auf der
taskId
zurück. Die taskId
muss in der Anforderung enthalten sein. Beispiel: {OrchestratorURL}/tasks/GenericTasks/GetTaskDataById?taskId=1378
.
Abrufen
{OrchestratorURL}/tasks/GenericTasks/GetTaskDataById?taskId=1378
Anforderungsheader
Schlüssel |
Wert |
---|---|
Autorisierung |
Inhaber |
Antwortcode
200 OK
Antworttext
{
"status": 0,
"data": {
"BucketId": 25,
"DocumentId": "Construction Tender Document",
"DocumentPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\Construction Tender Document.zip",
"EncodedDocumentPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\encoded.zip",
"TextPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\text.zip",
"DocumentObjectModelPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\dom.zip",
"TaxonomyPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\taxonomy.zip",
"AutomaticExtractionResultsPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\input_results.zip",
"ValidatedExtractionResultsPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\output_results.zip",
"Version": "1.0"
},
"action": null,
"externalTag": null,
"organizationUnitId": 828,
"id": 1378
}
{
"status": 0,
"data": {
"BucketId": 25,
"DocumentId": "Construction Tender Document",
"DocumentPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\Construction Tender Document.zip",
"EncodedDocumentPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\encoded.zip",
"TextPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\text.zip",
"DocumentObjectModelPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\dom.zip",
"TaxonomyPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\taxonomy.zip",
"AutomaticExtractionResultsPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\input_results.zip",
"ValidatedExtractionResultsPath": "default\\bc40e5c8-3e5d-4a4e-8beb-8ed4595c265d\\output_results.zip",
"Version": "1.0"
},
"action": null,
"externalTag": null,
"organizationUnitId": 828,
"id": 1378
}