Skip to main content

Puntos de conexión de tareas

Puntos de conexión y parámetros de tareas

Recuperar detalles sobre una tarea específica

Retrieve Messages of a Specific Job

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

Nota

Solo se pueden utilizar flujos de tareas de aplicaciones.

Users are able to see jobs run by them and jobs run on schedules shared via Collections.

Parámetros

  • jobId (cadena): obligatorio. Ingresa el ID de tarea 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”.

Ejemplo de solicitud: cURL

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

Response Example

  • 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

  • 404: NotFound

Retrieve Messages of a Specific Job

To retrieve all messages of a specific job, use the GET {baseURL}/v3/jobs/{jobId}/messages endpoint.

Nota

Only Curators can use this endpoint.

Parameters

  • jobId (string): Required. Enter the Job ID for which you want to display messages.

Request Example: cURL

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

Response Example

  • 200: OK

    {
  "status": 0,
  "text": "string",
  "toolId": 0
}

  • 401: Unauthorized

  • 404: NotFound

Relaciones entre objetos

Si deseas 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 flujo 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: