Orchestrator
2021.10
false
Orchestrator API Guide
Last updated 18 de jun de 2024

Generic Tasks Requests

External Tasks

Create External Task

Create a new external tasks for operations performed in external systems, such as JIRA or Salesforce.

POST

{OrchestratorURL}/tasks/GenericTasks/CreateTask

Request headers

Key

Value

Authorization

Bearer

Request body

{
  "type": "ExternalTask",
  "externalTag": "JIRA",
  "title": "Close Ticket",
  "priority": "High",
  "data": {},
  "taskCatalogName": "Tickets"
}{
  "type": "ExternalTask",
  "externalTag": "JIRA",
  "title": "Close Ticket",
  "priority": "High",
  "data": {},
  "taskCatalogName": "Tickets"
}

Response code

201 Created

Response body

{
    "status": 0,
    "data": {},
    "action": null,
    "externalTag": "JIRA",
    "id": 1378
}{
    "status": 0,
    "data": {},
    "action": null,
    "externalTag": "JIRA",
    "id": 1378
}

Complete External Task

Complete an external task based on the taskId. The taskId must be included in the body of the request as in the example below.

POST

{OrchestratorURL}/tasks/GenericTasks/CompleteTask

Request headers

Key

Value

Authorization

Bearer

Request body

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

Response code

204 No Content

Document Validation Tasks

Create Document Validation Task

Create a document validation task in Orchestrator enabling users to validate document extraction results.

POST

{OrchestratorURL}/tasks/GenericTasks/CreateTask

Request headers

Key

Value

Authorization

Bearer

Request body

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

Response code

201 Created

Response body

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

Retrieve Document Validation Task

Return a document validation task details based on the taskId. The taskId must be included in the request. For example, {OrchestratorURL}/tasks/GenericTasks/GetTaskDataById?taskId=1378.

GET

{OrchestratorURL}/tasks/GenericTasks/GetTaskDataById?taskId=1378

Request headers

Key

Value

Authorization

Bearer

Response code

200 OK

Response body

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

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.