Consultar solicitação específica

Como consultar uma solicitação específica utilizando API?

Para consultar os dados de uma instância específica utilizando API siga estes passos:

1. Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;

2. Obtenha o instanceId: Obtenha o código identificador da instância. Você pode encontra-lo na página Monitorar > Solicitações ou através de consultas de API's como explicado em Listar todas as solicitações do sistema;

3. Enviar a requisição: Utilize o endpoint Consultar solicitação específica para enviar a requisição. Lembre-se de substituir seu_endereco.do.zeev no exemplo pelo endereço que você usa para acessar o Zeev;

4. oData: opcionalmente, utilize regras oData para manipular o resultado da API. Essa API aceita $select

Como incluir a lista de tarefas pendentes e de tarefas concluídas junto as informações da solicitação?

Por padrão, essa consulta não traz a lista de tarefas pendentes e já concluídas. Para trazer essa informação, você deve instruir a chamada da API explicitamente que deseja essa informação. Para isso, são disponibilizados dois parâmetros:

• showPendingInstanceTasks=true Indica que você deseja que a lista com informações das tarefas atualmente pendentes na solicitação sejam mostradas.

• showFinishedInstanceTasks=true Indica que você deseja que a lista com informações das tarefas já concluídas na solicitação sejam mostradas.

Como incluir a lista das pessoas atualmente responsáveis por uma tarefa da solicitação?

Para trazer essa informação, é preciso, primeiro, que o parâmetro showPendingInstanceTasks=true seja ativado. Ele irá trazer a lista das tarefas pendentes.

Então, você deve acrescentar o parâmetro showPendingAssignees=true . Esse parâmetro indica que você quer trazer junto o nome e identificação das pessoas responsáveis por cada tarefa pendente.

Como incluir valores de campos de formulário?

Por padrão, essa API não traz os valores de campos de formulário da solicitação. Para trazer essa informação, você precisa informar explicitamente o identificador dos campos de formulário que você deseja obter, usando o parâmetro formFieldNames. Por exemplo:

formFieldNames=nomeCompleto&formFieldNames=idade&formFieldNames=endereco

Obter dados da instância específica por código identificador da instância da solicitação (Auth)

get

Parâmetros de rota

instanceIdinteger · int32Obrigatório

Código identificador da instância da solicitação

Parâmetros de consulta

formFieldNamesstring[]Opcional

Campos do formulário que devem ser retornados na consulta. Para mais de um, repita o parâmetro para cada campo a ser retornado.

showPendingInstanceTasksbooleanOpcional

Indicação se devem ser listadas as tarefas pendentes da solicitação nesse momento

showFinishedInstanceTasksbooleanOpcional

Indicação se devem ser listadas as tarefas finalizadas da solicitação nesse momento

showPendingAssigneesbooleanOpcional

Indicação se devem ser listados os responsáveis pelas tarefas pendentes da solicitação nesse momento

useCachebooleanOpcional

Indicação se a consulta pode vir do cache

Respostas

200

Sucesso.

application/jsontext/jsontext/xml

idinteger · int32Opcional

Identificador da instância de solicitação

masterInstanceIdinteger · int32Opcional

Identificador da primeira instância em uma cadeia de subprocessos

starterInstanceIdinteger · int32Opcional

Identificador da solicitação que deu início a esta

requestNamestringOpcional

Nome e versão do aplicativo

reportLinkstringOpcional

Endereço para visualizar a instância no monitoramento de solicitações

confirmationCodestringOpcional

Código de verificação para acesso ao relatório da solicitação

uidstring · uuidOpcional

Identificador GUID da instância de solicitação

Example: 00000000-0000-0000-0000-000000000000

simulationbooleanOpcional

Indica se a instância é um teste

activebooleanOpcional

Indica se a solicitação está ativa

flowResultstringOpcional

Descrição do resultado da solicitação

flowResultIdinteger · int32Opcional

Identificador do resultado da solicitação

startDateTimestring · date-timeOpcional

Data de início da solicitação

endDateTimestring · date-timeOpcional

Data de conclusão da solicitação

lastFinishedTaskDateTimestring · date-timeOpcional

Data em que a ultima atividade foi executada

leadTimeInDaysnumber · doubleOpcional

Tempo para conclusão da solicitação em dias

400

Solicitação ou dados da solicitação são inválidas

application/jsontext/jsontext/xml

401

Pessoa não autorizada

application/jsontext/jsontext/xml

403

Pessoa não tem permissão de executar essa operação

application/jsontext/jsontext/xml

404

O registro não foi encontrado

application/jsontext/jsontext/xml

429

Muitas requisições em um determinado período de tempo

application/jsontext/jsontext/xml

500

Ocorreu algum erro interno no servidor

application/jsontext/jsontext/xml

get

/api/2/instances/{instanceid}

HTTPcURLJavaScriptPython

GET /api/2/instances/{instanceid} HTTP/1.1
Host: seu_endereco.do.zeev
Accept: */*

{
  "id": 1,
  "masterInstanceId": 1,
  "starterInstanceId": 1,
  "requestName": "text",
  "reportLink": "text",
  "confirmationCode": "text",
  "uid": "00000000-0000-0000-0000-000000000000",
  "simulation": true,
  "active": true,
  "flowResult": "text",
  "flowResultId": 1,
  "startDateTime": "2026-03-21T06:28:33.934Z",
  "endDateTime": "2026-03-21T06:28:33.934Z",
  "lastFinishedTaskDateTime": "2026-03-21T06:28:33.934Z",
  "leadTimeInDays": 1,
  "flow": {
    "id": 1,
    "uid": "00000000-0000-0000-0000-000000000000",
    "name": "text",
    "version": 1
  },
  "service": {
    "id": 1,
    "uid": "00000000-0000-0000-0000-000000000000",
    "name": "text"
  },
  "formFields": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "row": 1
    }
  ],
  "requester": {
    "id": 1,
    "name": "text",
    "email": "text",
    "username": "text",
    "team": {
      "id": 1,
      "name": "text",
      "code": "text"
    },
    "position": {
      "id": 1,
      "name": "text",
      "code": "text"
    }
  },
  "instanceTasks": [
    {
      "id": 1,
      "subprocessId": 1,
      "startDateTime": "2026-03-21T06:28:33.934Z",
      "endDateTime": "2026-03-21T06:28:33.934Z",
      "expectedEndDateTime": "2026-03-21T06:28:33.934Z",
      "leadTimeInDays": 1,
      "onTime": true,
      "active": true,
      "result": "text",
      "alias": "text",
      "task": {
        "id": 1,
        "name": "text",
        "type": "text",
        "businessHours": true,
        "timeout": 1
      },
      "executor": {
        "userId": 1,
        "name": "text",
        "email": "text",
        "username": "text"
      },
      "assignees": [
        {
          "id": 1,
          "userId": 1,
          "name": "text",
          "email": "text",
          "username": "text",
          "team": {
            "id": 1,
            "name": "text",
            "code": "text"
          },
          "position": {
            "id": 1,
            "name": "text",
            "code": "text"
          }
        }
      ]
    }
  ]
}

Exemplo de requisição

Node.js

let consultInstanceId = 9632;

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "GET",
  headers: myHeaders
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/instances/${consultInstanceId}`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

//Consulte parâmetros disponíveis

---

Links relacionados:

• O que é preciso para fazer integrações do Zeev para outros sistemas?

• Como autenticar nas APIs do Zeev

• Como controlar o volume máximo de requisições à APIs

• Como acessar o Swagger / OpenAPI

• Como filtrar e monitorar solicitações