Pontos de extremidade de trabalhos

Pontos de extremidade de trabalhos e parâmetros

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.

Os usuários podem ver os trabalhos executados por eles e os trabalhos executados em agendamentos compartilhados por meio de coleções.

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'

Exemplo de resposta

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 (401: Não autorizado)
404: NotFound (404: Não encontrado)

Recuperar mensagens de um trabalho específico

Para recuperar todas as mensagens de um trabalho específico, use o ponto de extremidade GET {baseURL}/v3/jobs/{jobId}/messages.

Nota

Somente administradores podem usar esse ponto de extremidade.

Parâmetros

jobId (cadeia de caracteres): obrigatório. Insira o ID do trabalho para o qual deseja exibir mensagens.

Exemplo de solicitação: cURL

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

Exemplo de resposta

200: OK

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

401: Unauthorized (401: Não autorizado)
404: NotFound (404: Não encontrado)

Cancelar um trabalho específico

Para cancelar um trabalho específico, use o ponto de extremidade DELETE {baseURL}/v3/jobs/{jobId}. O trabalho deve estar no estado "Em fila" ou "Em execução".

Se você cancelar um trabalho em execução, ele será cancelado. Se você cancelar um trabalho em fila, ele será excluído.

Nota

Os administradores podem cancelar qualquer trabalho, enquanto outras funções podem cancelar trabalhos que os usuários dessas funções tenham criado, acionado ou agendado.

Other roles can cancel jobs they have created, triggered, or scheduled. It includes jobs shared with them through Collections, even if they are not the job owner.

Parâmetros

jobId (cadeia de caracteres): obrigatório. Insira o ID do trabalho que você deseja cancelar.

Exemplo de solicitação: cURL

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

Exemplo de resposta

200: OK
- Response when you cancel a running job:
```
{
  "message": "Cancelled Successfully."
}
```
- Response when you cancel a queued job:
```
{
  "message": "Deleted Successfully."
}
```
400: BadRequest (400: Solicitação incorreta)
- Response when the job is not in ‘Queued’ or ‘Running’ state:
```
{
  "message": "This job is not in 'Queued' or 'Running' state."
}
```
- Response when the user making the API call does not have permission to cancel the job:
```
{
  "message": "You do not have permission to cancel this job."
}
```
401: Unauthorized (401: Não autorizado)
404: NotFound (404: Não encontrado)

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 Workflow Endpoints.

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