Skip to main content

Puntos de conexión de tareas

Puntos de conexión y parámetros de trabajos

Recuperar detalles sobre las tareas en ejecución

Recuperar detalles sobre una tarea específica

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 tareas, visita la página de ayuda Tareas: interfaz de administrador.

Recuperar detalles de todas las tareas

Para obtener detalles sobre todas las tareas y su estado actual, utiliza el punto de conexión GET {baseURL}/v3/jobs/. Utiliza varios parámetros para filtrar las tareas que quieres mostrar.

Nota

Solo los administradores pueden usar este punto de conexión.

Parámetros

  • sortField (cadena): opcional. Ordena los resultados por estos valores permitidos: CreateDate, AppName, CompletionDateTime, Prioridad, Estado.

  • direction (cadena): opcional. Ordena en orden ascendente o descendente. Los valores permitidos son: asc o desc.

  • offset (cadena): opcional. Ingresa la compensación para la paginación.

  • limit (cadena): opcional. Ingresa el límite para la paginación.

  • priorities (cadena): opcional. Para filtrar por prioridades de tarea, ingresa uno de los siguientes valores: Bajo, Medio, Alto, Crítico , y los Valores numéricos.

  • statuses (cadena): opcional. Para filtrar por estado, ingresa uno o más de estos valores: En cola, Inicializando, En ejecución y Completar.

  • users (cadena): opcional. Para filtrar por un usuario, ingresa una Id. de usuario válida. Filtra solo en el caso de allUsers = true.

  • allUsers (booleano): opcional. Para incluir a todos los usuarios, selecciona Verdadero.

  • workflowNames (cadena): opcional. Para filtrar por un nombre de flujo de trabajo, ingresa uno o más de workflowName.

  • completedBefore (cadena): opcional. Devuelve tareas completadas antes de la fecha especificada. Se excluyen las tareas completadas en la fecha determinada. El formato requerido es aaaa-MM-dd.

  • completedAfter (cadena): opcional. Devuelve tareas completadas después de la fecha especificada. Se excluyen las tareas completadas en la fecha determinada. El formato requerido es aaaa-MM-dd.

Ejemplo de solicitud: cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Ejemplo de respuesta

  • 200: OK

    {
  "data": [
    {
      "jobId": "68dd3292c97fddfcc003adcb",
      "status": "Completed",
      "workflowName": "Workflow1.yxmd",
      "workflowId": "68dd32922a719467662d27c7",
      "submittedBy": "Jane Doe",
      "startTime": "2025-10-01T13:54:26Z",
      "queueTime": "2025-10-01T13:54:26Z",
      "executionTime": "00:00:02",
      "priority": "6"
    },
    {
      "jobId": "68dd3336c97fddfcc003add2",
      "status": "Completed",
      "workflowName": "Workflow1",
      "workflowId": "68dd32922a719467662d27c7",
      "submittedBy": "Jane Doe",
      "startTime": "2025-10-01T13:57:10Z",
      "queueTime": "2025-10-01T13:57:10Z",
      "executionTime": "00:00:02",
      "priority": "Low"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 50,
    "totalItems": 3,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}

  • 401: Unauthorized (sin autorización)

Recuperar detalles sobre una tarea específica

Para obtener detalles sobre una tarea existente y su estado actual, utiliza el punto de conexión GET {baseURL}/v3/jobs/{jobId}. Utiliza varios parámetros para filtrar las tareas 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. de la tarea para la que quieres mostrar detalles.

  • includeMessages (booleano): opcional. Se puede dejar sin un valor. Puedes elegir entre los siguientes valores: “verdadero” y “falso”. Si este parámetro se establece como “falso”, entonces se devolverá un objeto reducido. Cuando no se especifica, se utiliza el valor “verdadero”.

Ejemplo de solicitud: cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c?includeMessages=true' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Ejemplo de respuesta

  • 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.

Ejemplo de solicitud: cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c/messages' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Ejemplo de respuesta

  • 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.

Ejemplo de solicitud: cURL

curl -X 'DELETE' \
  'http://localhost/webapi/v3/jobs/678f97baa15300008c0039fc' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Ejemplo de respuesta

  • 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 una tarea específica, 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.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.

En esta sección: