orchestrator
2024.10
true
- Primeros pasos
- Autenticación
- Definición de Swagger
- API de Orchestrator
- Solicitudes de alertas
- Solicitudes de activos
- Solicitudes de calendario
- Solicitudes de entornos
- Solicitudes de carpetas
- Solicitudes de tareas genéricas
- Solicitudes de trabajos
- Solicitudes de bibliotecas
- Solicitudes de licencia
- Solicitudes de paquetes
- Solicitudes de permisos
- Solicitudes de espacios de trabajo personales
- Solicitudes de procesos
- Solicitudes de elementos en cola
- Solicitudes de política de retención de cola
- Solicitudes de robots
- Solicitudes de roles
- Solicitudes de horarios
- Solicitudes de configuración
- Solicitudes de cubos de almacenamiento
- Solicitudes de tareas
- Solicitudes de catálogos de tareas
- Solicitudes de formularios de tareas
- Solicitudes de tenants
- Solicitudes de transacciones
- Solicitudes de usuario
- Solicitudes de Webhooks
- API de gestión de plataformas
Solicitudes de tareas genéricas
Guía de la API de Orchestrator
Última actualización 4 de dic. de 2024
Solicitudes de tareas genéricas
Crear nuevas tareas externas para operaciones realizadas en sistemas externos, como JIRA o Salesforce.
Publicar
https://{yourDomain}/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 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://{yourDomain}/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
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://{yourDomain}/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
}
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://{yourDomain}/tasks/GenericTasks/GetTaskDataById?taskId=1378
.
Obtener
https://{yourDomain}/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
}