Pontos de extremidade de trabalhos

Pontos de extremidade de trabalhos e parâmetros

Recuperar detalhes sobre um trabalho específico

Para saber mais sobre as relações de objetos e como usá-las na API, vá para a seção Relações de objeto .

Para obter mais informações sobre trabalhos, visite a página de ajuda Trabalhos: interface de administrador .

Recuperar detalhes sobre um trabalho específico

Para recuperar detalhes sobre um trabalho existente e seu estado atual, use o ponto de extremidade GET {baseURL}/v3/jobs/{jobId}. Use vários parâmetros para filtrar os trabalhos que você deseja exibir.

Nota

Apenas fluxos de trabalho de aplicativos podem ser usados.

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

Parâmetros

jobId (cadeia de caracteres): obrigatório. Insira o ID do trabalho para o qual deseja exibir detalhes.
includeMessages (booleano): opcional. Pode ser deixado sem um valor. Você pode escolher entre os seguintes valores: "true" (verdadeiro) e "false" (falso). Se esse parâmetro for definido como "false" (falso), um objeto reduzido será retornado. Quando não especificado, o valor "true" (verdadeiro) é usado.

Exemplo de solicitação: 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

Relações de objetos

Se desejar obter informações sobre um trabalho específico, você precisará de um jobId . Para obter esse jobId, use o ponto de extremidade GET {baseURL}/v3/workflows/{workflowId}/jobs. Para obter mais informações sobre esse ponto de extremidade, acesse a página de ajuda Pontos de extremidade de fluxos de trabalho .

Solicitações Postman

Para saber mais sobre solicitações Postman, visite a página de ajuda Como usar Postman .

Nesta secção:

Pontos de extremidade de trabalhos