Skip to main content

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

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 deseas mostrar.

Nota

Solo se pueden utilizar 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 deseas 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”.

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

Relaciones entre objetos

Si deseas 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.