Anforderungen für generische Aufgaben

API-Anforderungsbeispiele zum Erstellen externer Aufgaben, die mit Systemen wie JIRA oder Salesforce verknüpft sind

Externe Aufgaben

Create External Task

Erstellen Sie neue externe Aufgaben für Vorgänge, die in externen Systemen wie JIRA oder Salesforce ausgeführt werden.

Posten

https://{yourDomain}/tasks/GenericTasks/CreateTask

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Anforderungstext

{
  "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
}

Complete external task

Schließen Sie eine externe Aufgabe basierend auf der taskIdab. Der taskId muss wie im folgenden Beispiel im Text der Anforderung enthalten sein.

Posten

https://{yourDomain}/tasks/GenericTasks/CompleteTask

Anforderungsheader

Schlüssel	Wert
Autorisierung	Inhaber

Anforderungstext

{
  "taskId": 1378,
  "data": {},
  "action": "close"
}

Antwortcode

204 Kein Inhalt

Dokumentvalidierungsaufgaben

Dokumentvalidierungsaufgabe erstellen

Erstellen Sie eine Dokumentvalidierungsaufgabe im Orchestrator, mit der Benutzer die Ergebnisse der Dokumentextraktion validieren können.

Posten

https://{yourDomain}/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"
}

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
}

Dokumentvalidierungsaufgabe erstellen

Gibt die Details einer Dokumentvalidierungsaufgabe basierend auf der taskIdzurück. Die taskId muss in der Anforderung enthalten sein. Beispiel: https://{yourDomain}/tasks/GenericTasks/GetTaskDataById?taskId=1378.

Abrufen

https://{yourDomain}/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
}