orchestrator
latest
false
UiPath logo, featuring letters U and I in white
Guía de la API de Orchestrator
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated 23 de oct. de 2024

Solicitudes de tareas genéricas

Tareas externas

Crear Tarea Externa

Crear nuevas tareas externas para operaciones realizadas en sistemas externos, como JIRA o Salesforce.

Publicar

https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/tasks/GenericTasks/CreateTask

Solicitar encabezados.

Clave

Valor

Autorización

Portador

Solicitar cuerpo

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

Código de respuesta

201 Creado

Cuerpo de respuesta

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

Completar tarea externa

Completar una tarea externa basada en taskId. El taskId debe estar incluido en el cuerpo de la solicitud como se muestra en el siguiente ejemplo.

Publicar

https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/tasks/GenericTasks/CompleteTask

Solicitar encabezados.

Clave

Valor

Autorización

Portador

Solicitar cuerpo

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

Código de respuesta

209 Sin contenido

Tareas de validación de documentos

Crear tarea de validación de documentos

Cree una tarea de validación de documentos en Orchestrator que permita a los usuarios validar los resultados de la extracción de documentos.

Publicar

https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/tasks/GenericTasks/CreateTask

Solicitar encabezados.

Clave

Valor

Autorización

Portador

Solicitar cuerpo

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

Código de respuesta

201 Creado

Cuerpo de respuesta

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

Recuperar Tarea de validación de documentos

Devolver los detalles de una tarea de validación de documentos basados en taskId. El taskId debe estar incluido en la solicitud. Por ejemplo, https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/tasks/GenericTasks/GetTaskDataById?taskId=1378.

Obtener

https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/tasks/GenericTasks/GetTaskDataById?taskId=1378

Solicitar encabezados.

Clave

Valor

Autorización

Portador

Código de respuesta

200 OK

Cuerpo de respuesta

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

¿Te ha resultado útil esta página?

Obtén la ayuda que necesitas
RPA para el aprendizaje - Cursos de automatización
Foro de la comunidad UiPath
Uipath Logo White
Confianza y seguridad
© 2005-2024 UiPath. Todos los derechos reservados.