# Como pré-indexar um documento via API

## Visão geral

Confira abaixo o modelo de estrutura XML para pré-indexar documento (EXECUTEACTION: PREINDEX):

| Estrutura do XML                                                                                    | Requerido                              | Descrição                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| --------------------------------------------------------------------------------------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| \<?xml version="1.0" encoding="UTF-8"?>                                                             | Sim                                    | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| \<eContent>                                                                                         | Sim                                    | Raiz.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| \<header>                                                                                           | Sim                                    | Cabeçalho de identificação pelo Zeev docs.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| \<module name="SILENTLOGINEXECUTEACTION" />                                                         | <p><br>Sim</p>                         | <p>Identificação da aplicação.<br>Atributo(s):<br><em>code</em> (obrigatório) - código da aplicação.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| \<machine />                                                                                        | Sim                                    | Nome da máquina onde a ação é realizada.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| <p><br>      \<application code=" " /></p>                                                          | <p><br>Sim</p>                         | <p>Identificação da aplicação.<br>Atributo(s):<br><em>code</em> (obrigatório) - código da aplicação.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| \<userToken />                                                                                      | Sim                                    | Token de identificação do usuário para SilentLogin. Disponibilizada interface para geração do token através de web service.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| \<identification />                                                                                 | Não                                    | Nó de livre preenchimento, podendo ser utilizado para inclusão de identificação do sistema que gerou o XML de SilentLogin.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| \<adHocUser />                                                                                      | Não                                    | Usuário que será gravado o log de acesso e ação.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| \</ header>                                                                                         | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| \<structure>                                                                                        | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| \<events>                                                                                           | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| <p><br>         \<event name="PREINDEX"></p>                                                        | <p><br>Sim</p>                         | <p>Informações do módulo de entrada.<br>Atributo(s):<br><em>name</em> (obrigatório) - nome da função a ser chamada.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| \<content>                                                                                          | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| \<fields>                                                                                           | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| <p><br><br><br><br><br><br>                     \<field name=" " value=" " commandOrName=" " /></p> | <p><br><br><br><br><br><br><br>Sim</p> | <p>Campos da aplicação destino que devem ser populados com o novo documento.<br>Atributo(s):<br><em>name</em> (obrigatório) - nome dos campos da aplicação pela qual se deseja filtrar os documentos.<br><em>value</em> (obrigatório) - valor pelo qual o campo deve ser filtrado.<br><em>commandOrName</em> (opcional) - esse atributo só é válido para os campos de sistema DOCTYPE\_ID, IDXQUEUE\_ID, IDXSITDOC\_ID e PNDRSN\_ID. Ao utilizar o DOCTYPE\_ID, o atributo commandOrName deve ser preenchido com o mesmo valor do campo "Comando" do tipo de documento que deseja utilizar para atualizar o documento. Para os demais, o atributo commandOrName deve ser preenchido com o mesmo valor do campo "Nome" da fila, situação e/ou pendência. <strong>Caso seja informado o value, o atributo commandOrName não será considerado.</strong><br>ATENÇÃO: Os campos <strong>DOCTYPE\_ID, IDXQUEUE\_ID, IDXSITDOC\_ID, PNDRSN\_ID</strong> são <strong>obrigatórios</strong>.</p> |
| \</ fields>                                                                                         | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| \</ content>                                                                                        | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| \</ event>                                                                                          | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| \</ events>                                                                                         | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| \</structure>                                                                                       | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| \</eContent >                                                                                       | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |

<br>

Efetue o download do modelo de XML:

{% file src="/files/kVrZ6M4ID9RL85BuxMbh" %}

O retorno do método será o ID do novo documento pré-indexado.

{% hint style="warning" %}
**Importante:** por padrão os dados de valores de formulário enviados via API não serão validados quanto à obrigatoriedade, tipo de dado e máscaras. Esse controle deverá ser feito pela aplicação que está dando origem à chamada ou então por uma validação incluída no processo referenciado. Apenas validado a obrigatoriedade de tipo de documento, etapa, situação e pendência.
{% endhint %}

&#x20;


---

# 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/zeevdocs/integracoes/como-integrar-outras-ferramentas-com-o-zeev-docs/como-preparar-uma-instrucao-para-executar-uma-operacao/como-pre-indexar-um-documento-via-api.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.