# 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](https://kb.zeev.it/apis/como-gerar-tokens-para-autenticar-nas-apis) 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](/zeev/apis/all/instances/report.md);
3. Enviar a requisição: Utilize o endpoint [#api-2-instances-instanceid](#api-2-instances-instanceid "mention") 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](/zeev/apis/como-utilizar-as-apis-do-zeev/como-realizar-filtros-e-manipulacoes-adicionais-nas-apis-com-odata.md) 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`

{% openapi src="/files/DYIxvabeLXa2mL6uE2si" path="/api/2/instances/{instanceid}" method="get" %}
[ZeevApi's\_new.json](https://3371003943-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MD66pBdRalAQgnhNstG%2Fuploads%2Ff5huLIsAqm88oSjkTavv%2FZeevApi's_new.json?alt=media\&token=aae47f9f-90ca-48d0-b250-fc38fe74e6c0)
{% endopenapi %}

Exemplo de requisição

{% tabs %}
{% tab title="Node.js" %}

```javascript
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
```

{% endtab %}
{% endtabs %}

***

## Links relacionados:

* [O que é preciso para fazer integrações do Zeev para outros sistemas?](/zeev/integracoes/o-que-e-preciso-para-fazer-integracoes.md)
* [Como autenticar nas APIs do Zeev](/zeev/apis/como-utilizar-as-apis-do-zeev/como-gerar-tokens-para-autenticar-nas-apis.md)
* [Como controlar o volume máximo de requisições à APIs](/zeev/apis/como-utilizar-as-apis-do-zeev/como-controlar-o-volume-maximo-de-requisicoes-a-apis.md)
* [Como acessar o Swagger / OpenAPI](/zeev/apis/como-utilizar-as-apis-do-zeev/como-acessar-o-swagger-openapi.md)
* [Como filtrar e monitorar solicitações](/zeev/gestao-de-solicitacoes-em-andamento/monitoramento/como-filtrar-e-monitorar-solicitacoes.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://kb.stoque.com.br/zeev/apis/all/instances/consult.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.