Puntos de conexión de trabajos
Puntos de conexión y parámetros de trabajos
Recuperar detalles sobre un trabajo específico
Recuperar mensajes de un trabajo específico
Cancelar un trabajo específico
Para obtener más información sobre las relaciones entre objetos y cómo utilizarlas en la API, ve a la sección Relaciones entre objetos.
Para obtener más información sobre trabajos, visita la página de ayuda Trabajos: interfaz de administrador.
Recuperar detalles sobre un trabajo específico
Para obtener detalles sobre un trabajo existente y su estado actual, utiliza el punto de conexión GET {baseURL}/v3/jobs/{jobId}. Utiliza varios parámetros para filtrar los trabajos que quieres mostrar.
Nota
Solo se pueden utilizar los flujos de trabajos de aplicaciones.
Los usuarios pueden ver los trabajos ejecutados por ellos y los trabajos ejecutados en programaciones compartidas a través de Colecciones.
Parámetros
jobId (cadena): obligatorio. Ingresa el Id. del trabajo para el que quieres mostrar detalles.
includeMessages (booleano): opcional. Se puede dejar sin un valor. Puedes elegir entre los siguientes valores: “true” (verdadero) y “false” (falso). Si este parámetro se establece como “false”, entonces se devolverá un objeto reducido. Cuando no se especifica, se utiliza el valor “true”.
curl -X 'GET' \ 'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c?includeMessages=true' \ -H 'accept: application/json' \ -H 'authorization: Bearer BearerTokenGoesHere'
200: OK
{ "id": "string", "appId": "string", "createDateTime": "2024-09-19T10:02:54.589Z", "status": "string", "disposition": "string", "outputs": [ { "id": "string", "availableFormats": [ "string" ], "fileName": "string" } ], "messages": [ { "status": 0, "text": "string", "toolId": 0 } ], "priority": "Default", "workerTag": "string", "runWithE2": true }401: Unauthorized (sin autorización)
404: NotFound
Recuperar mensajes de un trabajo específico
Para obtener información sobre un trabajo específico, utiliza el punto de conexión GET {baseURL}/v3/jobs/{jobId}/messages.
Nota
Solo los administradores pueden usar este punto de conexión.
Parámetros
jobId (cadena): obligatorio. Ingresa el ID del trabajo para el que deseas mostrar mensajes.
curl -X 'GET' \ 'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c/messages' \ -H 'accept: application/json' \ -H 'authorization: Bearer BearerTokenGoesHere'
200: OK
{ "status": 0, "text": "string", "toolId": 0 }401: Unauthorized (sin autorización)
404: NotFound
Cancelar un trabajo específico
Para cancelar un trabajo específico, utiliza el punto de conexión DELETE {baseURL}/v3/jobs/{jobId}. El trabajo debe estar en el estado “Queued” (en cola) o “Running” (en ejecución).
Si cancelas un trabajo en ejecución, este se cancela. Si cancelas un trabajo en cola, este se elimina.
Nota
Los administradores pueden cancelar cualquier trabajo.
Otros roles pueden cancelar trabajos que hayan creado, iniciado o programado. Esto incluye trabajos compartidos con ellos a través de Colecciones, incluso si no son los propietarios del trabajo.
Parámetros
jobId (cadena): obligatorio. Ingresa el Id. del trabajo que quieres cancelar.
curl -X 'DELETE' \ 'http://localhost/webapi/v3/jobs/678f97baa15300008c0039fc' \ -H 'accept: application/json' \ -H 'authorization: Bearer BearerTokenGoesHere'
200: OK
Respuesta cuando se cancela un trabajo en ejecución:
{ "message": "Cancelled Successfully." }Respuesta cuando se cancela un trabajo en cola:
{ "message": "Deleted Successfully." }
400: BadRequest
Respuesta cuando el trabajo no está en los estados “En cola” o “En ejecución”:
{ "message": "This job is not in 'Queued' or 'Running' state." }Respuesta cuando el usuario que realiza la llamada a la API no tiene permiso para cancelar el trabajo:
{ "message": "You do not have permission to cancel this job." }
401: Unauthorized (sin autorización)
404: NotFound
Relaciones entre objetos
Si quieres obtener información sobre un trabajo específico, necesitas un jobId. Para obtener este jobId, utiliza el punto de conexión GET {baseURL}/v3/workflows/{workflowId}/jobs. Para obtener más información sobre este punto de conexión, consulta la página de ayuda Puntos de conexión de flujos de trabajo.
Solicitudes de Postman
Para obtener más información sobre las solicitudes de Postman, visita la página de ayuda Cómo usar Postman.