---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# API de ingestão de conteúdo externo

# API de ingestão de conteúdo externo {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 19 min. de leitura

A API de ingestão de conteúdo externo fornece endpoints que permitem a ingestão de conteúdo de fontes fora da sua instância \[ ServiceNow® para o índice da aplicação ServiceNow® Pesquisa com IA.

## API de ingestão de conteúdo externo -- DELETE /ais/external_content/deleteByQuery/{schema_table_name} {#ariaid-title2}

Exclui todos os documentos externos que correspondem à consulta especificada do índice Pesquisa com IA.

### Formato da URL

URL com controle de versão: /api/now/{api_version}/ais/external_content/deleteByQuery/{schema_table_name}?query={query}

### Parâmetros de solicitação compatíveis

{#ext_content-DELETE-deleteByQuery__entry__2}{#ext_content-DELETE-deleteByQuery__version-RESTAPI}

| Nome | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| esquema_tabela_nome | O nome da tabela de esquema de conteúdo externo que define o esquema para os documentos indexados a serem excluídos. Por exemplo, <kbd class="ph userinput">u_ext_content</kbd>. Tipo de dados: cadeia de caracteres |
[Tabela 1. Parâmetros de caminho]

{#ext_content-DELETE-deleteByQuery__entry__8}

| Nome | Descrição |
|-|-|
| consulta | Uma consulta válida com escape de URL para a tabela de esquema especificada por schema_table_name. Por exemplo, <kbd class="ph userinput">title=Introduction</kbd> para consultar documentos cujo título seja Introdução. Tipo de dados: cadeia de caracteres |
[Tabela 2. Parâmetros de consulta]

{#ext_content-DELETE-deleteByQuery__entry__12}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)]

### Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#ext_content-DELETE-deleteByQuery__entry__16}{#ext_content-DELETE-deleteByQuery__accept-JSON-only-entry-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 4. Cabeçalhos da solicitação]

{#ext_content-DELETE-deleteByQuery__entry__20}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 5. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#ext_content-DELETE-deleteByQuery__table_wwn_rhd_ct__entry__2}{#ext_content-DELETE-deleteByQuery__entry-200-status-code}{#ext_content-DELETE-deleteByQuery__entry-400-status-code}{#ext_content-DELETE-deleteByQuery__entry-500-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 6. Códigos de status]

{#ext_content-DELETE-deleteByQuery__table_wwn_rhd_ct}

### Parâmetros do corpo da resposta (JSON ou XML)

{#ext_content-DELETE-deleteByQuery__entry__32}

| Nome | Descrição |
|-|-|
| erro | Objeto que descreve o erro encontrado durante o processamento da solicitação. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes do erro encontrado durante o processamento da solicitação. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem do erro encontrado durante o processamento da solicitação. Tipo de dados: cadeia de caracteres |
| resultado | Resultado de uma solicitação processada com sucesso. Tipo de dados: cadeia de caracteres |
| status | Status de uma solicitação malsucedida. Valores válidos: * failure {#ext_content-DELETE-deleteByQuery__ul_h5r_z54_pnb} Tipo de dados: cadeia de caracteres |
[ ]

### Solicitação de cURL

Exclua documentos com valores de campo de título <kbd class="ph userinput">Introdução</kbd> e <kbd class="ph userinput">Relatório de 31 de outubro de 2020</kbd> da tabela de esquema u_ext_content.

    curl "https://instance.service-now.com/api/now/v2/ais/external_content/deleteByQuery/u_ext_content?query=title%3DIntroduction%20OR%20title%3DReport%20for%2031%20October%202020" \
    --request DELETE \
    --user "username":"password" \
    --header "Accept: application/json"

    {
      "result": "Delete By Query Successfully Executed"
    }

## API de ingestão de conteúdo externo -- DELETE /ais/external_content/deleteDocument/{schema_table_name}/{document_id} {#ariaid-title3}

Exclui o documento externo com um identificador exclusivo especificado do índice Pesquisa com IA.

### Formato da URL

URL com controle de versões: /api/now/{api_version}/ais/external_content/deleteDocument/{schema_table_name}/{document_id}

### Parâmetros de solicitação compatíveis

{#ext_content-DELETE-deleteDocument__entry__2}{#ext_content-DELETE-deleteDocument__version-RESTAPI}

| Parâmetro | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| document_id | O identificador exclusivo do documento externo a ser excluído. Por exemplo, <kbd class="ph userinput">ADMIN-2027858531-16</kbd>. Tipo de dados: cadeia de caracteres |
| esquema_tabela_nome | O nome da tabela de esquema de conteúdo externo que define o esquema para o documento indexado excluir. Por exemplo, <kbd class="ph userinput">u_ext_content</kbd>. Tipo de dados: cadeia de caracteres |
[Tabela 7. Parâmetros de caminho]

{#ext_content-DELETE-deleteDocument__entry__10}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 8. Parâmetros de consulta]

{#ext_content-DELETE-deleteDocument__entry__14}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)]

### Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#ext_content-DELETE-deleteDocument__entry__18}{#ext_content-DELETE-deleteDocument__accept-JSON-only-entry-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
[Tabela 10. Cabeçalhos da solicitação]

{#ext_content-DELETE-deleteDocument__entry__22}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 11. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#ext_content-DELETE-deleteDocument__entry__26}{#ext_content-DELETE-deleteDocument__entry-200-status-code}{#ext_content-DELETE-deleteDocument__entry-400-status-code}{#ext_content-DELETE-deleteDocument__entry-500-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 12. Códigos de status]

### Parâmetros do corpo da resposta (JSON ou XML)

{#ext_content-DELETE-deleteDocument__entry__34}

| Elemento | Descrição |
|-|-|
| erro | Objeto que descreve o erro encontrado durante o processamento da solicitação. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes do erro encontrado durante o processamento da solicitação. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem do erro encontrado durante o processamento da solicitação. Tipo de dados: cadeia de caracteres |
| resultado | Resultado de uma solicitação processada com sucesso. Tipo de dados: cadeia de caracteres |
| status | Status de uma solicitação malsucedida. Valores válidos: * failure {#ext_content-DELETE-deleteDocument__ul_h5r_z54_pnb} Tipo de dados: cadeia de caracteres |
[ ]

### Solicitação de cURL

Exclua o documento com o identificador <kbd class="ph userinput">ADMIN-2587918521-27</kbd> da tabela de esquema u_ext_content.

    curl 'https://instance.service-now.com/api/now/v2/ais/external_content/deleteDocument/u_ext_content/ADMIN-2587918521-27' \
    --request DELETE \
    --user 'username':'password' \
    --header 'Accept: application/json'

    {
      "result":"Document removed"
    }

## API de ingestão de conteúdo externo -- POST /ais/external_content/ingestDocument/{schema_table_name} {#ariaid-title4}

Envia uma lista de documentos externos para o criador de lotes de ingestão Pesquisa com IA para indexação. Depois que a indexação é concluída, o conteúdo dos documentos ingeridos se torna pesquisável.
Você pode usar este endpoint para alimentar documentos externos com conteúdo de texto e metadados.  
Se você precisar associar conteúdo binário pesquisável e metadados a um documento externo, siga estas etapas:

1. Armazene o conteúdo binário em Pesquisa com IA usando o endpoint [POST /ais/external_content/storeContent](https://servicenow-prod.fluidtopics.net/nDBQAalH57pSUkgDP17Rmw#ext_content-POST-storeContent "Armazena conteúdo binário como um objeto de conteúdo em Pesquisa com IA."). Registre o valor do parâmetro de corpo de resposta result.
2. Envie o documento externo para Pesquisa com IA usando este endpoint. Defina o parâmetro do corpo da solicitação content_pointer do documento para corresponder ao valor do parâmetro do corpo da resposta result registrado.

{#ext_content-POST-ingestDocument__ol_bz4_prf_ynb} Durante a ingestão, Pesquisa com IA analisa o conteúdo binário e adiciona seu conteúdo pesquisável ao registro indexado que representa o documento externo. A análise remove o objeto de conteúdo armazenado.

### Formato da URL

URL com controle de versão: /api/now/{api_version}/ais/external_content/ingestDocument/{schema_table_name}

### Parâmetros de solicitação compatíveis

{#ext_content-POST-ingestDocument__entry__2}{#ext_content-POST-ingestDocument__version-RESTAPI}

| Parâmetro | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
| esquema_tabela_nome | O nome da tabela de esquema de conteúdo externo que define o esquema para documentos externos na solicitação. Por exemplo, <kbd class="ph userinput">u_ext_content</kbd>. Tipo de dados: cadeia de caracteres |
[Tabela 13. Parâmetros de caminho]

{#ext_content-POST-ingestDocument__entry__8}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 14. Parâmetros de consulta]

{#ext_content-POST-ingestDocument__entry__12}

| Elemento | Descrição |
|-|-|
| \[matriz\] | Obrigatório. Matriz sem nome de objetos na qual cada objeto representa um documento externo a ser ingerido para indexação. Tipo de dados: matriz [ { "content_pointer": "String", "document_id": "String", "principals": {Object}, "properties": {Object} } ] |
| \[matriz\].content_pointer | Identificador de uma instância de conteúdo binário armazenado usando o endpoint [POST /ais/external_content/storeContent](https://servicenow-prod.fluidtopics.net/nDBQAalH57pSUkgDP17Rmw#ext_content-POST-storeContent "Armazena conteúdo binário como um objeto de conteúdo em Pesquisa com IA."). Durante a ingestão, Pesquisa com IA analisa o conteúdo binário e adiciona seu conteúdo pesquisável ao registro indexado que representa o documento externo. A análise remove o objeto de conteúdo armazenado. Nota: Este identificador deve corresponder ao elemento de corpo de resposta result retornado pelo endpoint storeContent. Tipo de dados: cadeia de caracteres |
| \[matriz\].document_id | Obrigatório. Identificador exclusivo do documento externo na tabela de esquema de conteúdo externo especificada pelo parâmetro de caminho schema_table_name. Nota: Quando você ingere um documento, ele substitui qualquer documento existente na mesma tabela de esquema de conteúdo externo que tenha o mesmo document_id. Se dois ou mais documentos na mesma solicitação de ingestão tiverem o mesmo document_id, a solicitação falhará. Tipo de dados: cadeia de caracteres |
| \[matriz\].principais | Objeto que contém pares de chave-valor que descrevem as permissões de acesso do documento externo para entidades de segurança definidas externamente (usuários e grupos). Nota: Se você omitir este parâmetro para um documento, a solicitação será bem-sucedida, mas Pesquisa com IA rejeitará o documento com a mensagem de feedback de ingestão O principal do documento está ausente. Se este objeto de parâmetro não incluir nenhum par de chave-valor que conceda acesso a um documento, a solicitação será bem-sucedida, mas Pesquisa com IA rejeitará o documento com a mensagem de feedback de ingestão O principal do documento é inválido. Tipo de dados: objeto "principals": { "everyone": Boolean, "groups.deny": [Array], "groups.read": [Array], "none": Boolean, "users.deny": [Array], "users.read": [Array] } Versões compatíveis: disponível a partir da v2 da API. |
| \[matriz\].principais.todos | Sinalizador que indica se o acesso ao documento externo é permitido para todos os usuários. Quando este parâmetro é definido como true, todos os Now Platform usuários podem exibir o registro indexado criado a partir do documento. Nota: Se você definir este parâmetro e \[array\].principals.none como true para um documento, a solicitação será bem-sucedida, mas Pesquisa com IA rejeitará o documento com a mensagem de feedback de ingestão O principal do documento é inválido. Você só pode definir um desses dois parâmetros como true em uma solicitação. Valores válidos: * true: permite o acesso ao documento para todos os usuários. Pesquisa com IA ignora todas as configurações de parâmetro \[array\].principals.groups.\* e \[array\].principals.users.\* do documento. * false: não permite que todos os usuários acessem o documento externo. Os usuários só poderão acessar o documento se \[array\].principals.none estiver definido como falso e se for permitido pela interação de seus mapeamentos de usuário e os parâmetros \[array\].principals.groups.\* e \[array\].principals.users.\*. {#ext_content-POST-ingestDocument__ul_kp3_w1b_ppb} Tipo de dados: booliano Padrão: true Versões compatíveis: disponível a partir da v2 da API. |
| \[matriz\].principals.groups.deny | Matriz de cadeias de caracteres em que cada cadeia de caracteres é o nome de um grupo definido externamente que tem acesso negado ao documento externo. Now Platform usuários mapeados para qualquer um desses grupos externos não podem exibir o registro de resultado de pesquisa indexado criado a partir do documento. Se \[array\].principals.everyone ou \[array\].principals.none estiver definido como true, este parâmetro não terá efeito. Este parâmetro tem precedência sobre \[array\].principals.groups.read. Se o mesmo usuário estiver mapeado para grupos externos com permissões de acesso de leitura e negação para um documento, Pesquisa com IA negará a esse usuário o acesso ao registro indexado. Por padrão, \[array\].principals.users.read tem precedência sobre este parâmetro. Para reverter esta ordem de precedência para uma origem indexada, consulte [Como alterar a precedência das permissões de leitura e negação de grupo do usuário para uma origem indexada de conteúdo externo.](https://www.servicenow.com/docs/access?context=defining-access-perms-ext-docs-ais&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US). Tipo de dados: matriz Os valores podem estar em qualquer formato, dependendo dos nomes dos grupos especificados externamente. Os exemplos incluem: "groups.deny": [ "hr-admin", "legal" ] Versões compatíveis: disponível a partir da v2 da API. |
| \[array\].principals.groups.read | Matriz de cadeias de caracteres em que cada cadeia de caracteres é o nome de um grupo definido externamente que tem permissão para acessar o documento externo. Now Platform usuários mapeados para qualquer um desses grupos externos podem exibir o registro de resultado de pesquisa indexado criado a partir do documento. Se \[array\].principals.everyone ou \[array\].principals.none estiver definido como true, este parâmetro não terá efeito. \[array\].principals.groups.deny tem precedência sobre este parâmetro. Se o mesmo usuário estiver mapeado para grupos externos com permissões de acesso de leitura e negação para um documento, Pesquisa com IA negará a esse usuário o acesso ao registro indexado. Tipo de dados: matriz Os valores podem estar em qualquer formato, dependendo dos nomes dos grupos especificados externamente. Os exemplos incluem: "groups.read": [ "devops", "it", "report-admins" ] Versões compatíveis: disponível a partir da v2 da API. |
| \[matriz\].principais.nenhum | Opção booliana que indica se o acesso ao documento externo foi negado para todos os usuários. Quando este parâmetro é definido como true, somente Now Platform usuários com a função de privilégio elevado ais_high_security_admin podem exibir o registro indexado criado a partir do documento. Nota: Se você definir este parâmetro e \[array\].principals.everyone como true para um documento, Pesquisa com IA rejeitará o documento durante a ingestão com a mensagem de erro O principal do documento é inválido. Você só pode definir um desses dois parâmetros como true em uma solicitação. Valores válidos: * true: nega o acesso ao documento para todos os usuários, exceto aqueles com a função de privilégio elevado ais_high_security_admin. Pesquisa com IA ignora todas as configurações de parâmetro \[array\].principals.groups.\* e \[array\].principals.users.\* do documento. * false: não negue o acesso ao documento para todos os usuários. Os usuários podem acessar o documento se \[array\].principals.everyone estiver definido como trueou se for permitido pela interação de seus mapeamentos de usuário e os parâmetros \[array\].principals.groups.read e \[array\].principals.users.read. {#ext_content-POST-ingestDocument__ul_ufr_z1b_ppb} Tipo de dados: booliano Padrão: false Versões compatíveis: disponível a partir da v2 da API. |
| \[matriz\].principais.usuários.deny | Matriz de cadeias de caracteres em que cada cadeia de caracteres é o nome de um usuário definido externamente que tem acesso negado ao documento externo. Now Platform usuários mapeados para qualquer um desses usuários externos não podem exibir o registro de resultado de pesquisa indexado criado a partir do documento. Se \[array\].principals.everyone ou \[array\].principals.none estiver definido como true, este parâmetro não terá efeito. Este parâmetro tem precedência sobre \[array\].principals.users.read. Se o mesmo usuário for mapeado para usuários externos com permissões de acesso de leitura e de negação para um documento, Pesquisa com IA negará a esse usuário o acesso ao registro indexado. Tipo de dados: matriz Os valores podem estar em qualquer formato, dependendo dos nomes dos usuários especificados externamente. Os exemplos incluem: "users.deny": [ "ad\bow-ruggeri", "abel-tuter@sharepoint" ] Versões compatíveis: disponível a partir da v2 da API. |
| \[array\].principals.users.read | Matriz de cadeias de caracteres em que cada cadeia de caracteres é o nome de um usuário definido externamente que tem permissão para acessar o documento externo. Now Platform usuários mapeados para qualquer um desses usuários externos podem exibir o registro de resultado de pesquisa indexado criado a partir do documento. Se \[array\].principals.everyone ou \[array\].principals.none estiver definido como true, este parâmetro não terá efeito. \[array\].principals.users.deny tem precedência sobre este parâmetro. Se o mesmo usuário for mapeado para usuários externos com permissões de acesso de leitura e de negação para um documento, Pesquisa com IA negará a esse usuário o acesso ao registro indexado. Por padrão, este parâmetro tem precedência sobre \[array\].principals.groups.deny. Para reverter esta ordem de precedência para uma origem indexada, consulte [Como alterar a precedência das permissões de leitura e negação de grupo do usuário para uma origem indexada de conteúdo externo.](https://www.servicenow.com/docs/access?context=defining-access-perms-ext-docs-ais&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US). Tipo de dados: matriz Os valores podem estar em qualquer formato, dependendo dos nomes dos usuários especificados externamente. Os exemplos incluem: "users.read": [ "ad\abel-tuter", "beth-anglin@sharepoint" ] Versões compatíveis: disponível a partir da v2 da API. |
| \[matriz\].propriedades | Objeto que contém pares de nome-valor em que cada par representa um nome de campo e valor a ser ingerido para o documento. Todos os nomes e valores de campo devem ser especificados como cadeias de caracteres. Após a ingestão, esses valores de campo do documento podem ser acessados por meio da origem indexada definida para a tabela de esquema de conteúdo externo especificada pelo parâmetro de caminho schema_table_name. Os usuários podem pesquisar esses valores de campo em fontes de pesquisa derivadas desta fonte indexada. Tipo de dados: objeto Os nomes de campo podem conter apenas letras minúsculas e sublinhados. Os valores podem incluir qualquer caractere. O tamanho do valor é limitado pelo atributo max_length definido para o campo na tabela de esquema de conteúdo externo. Exemplos de pares de nome-valor de campo incluem: "properties": { "creation_date": "2020-11-03 12:27:43", "file_size": "10285", "title": "Introduction", "url": "file:///myhost/reports/Introduction.pdf" } |
[Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)]

### Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#ext_content-POST-ingestDocument__entry__36}{#ext_content-POST-ingestDocument__accept-JSON-only-entry-RESTAPI}{#ext_content-POST-ingestDocument__content_type-JSON-only-entry-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
[Tabela 16. Cabeçalhos da solicitação]

{#ext_content-POST-ingestDocument__entry__42}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 17. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#ext_content-POST-ingestDocument__entry__46}{#ext_content-POST-ingestDocument__entry-200-status-code}{#ext_content-POST-ingestDocument__entry-400-status-code}{#ext_content-POST-ingestDocument__entry-500-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 202 | Sucesso parcial. A solicitação foi processada. Alguns documentos têm mensagens de erro ou de aviso de feedback de ingestão. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 18. Códigos de status]

### Parâmetros do corpo da resposta (JSON ou XML)

{#ext_content-POST-ingestDocument__entry__56}

| Nome | Descrição |
|-|-|
| erro | Objeto que descreve o erro encontrado durante o processamento da solicitação. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes do erro encontrado durante o processamento da solicitação. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem do erro encontrado durante o processamento da solicitação. Tipo de dados: cadeia de caracteres |
| resultado | Cadeia de caracteres no formato JSON que representa o objeto de resultado da solicitação de ingestão. Tipo de dados: cadeia de caracteres "result": "{\"duration_in_ms\": Number, \"feedback\": [Array] }" |
| resultado.duração_em_ms | Tempo gasto na ingestão de documentos externos. Tipo de dados: número Unidade: Milissegundos |
| resultado.feedback | Matriz de objetos em que cada objeto representa o feedback de um documento ingerido do corpo da solicitação. Tipo de dados: matriz "feedback": [ { "document_id": "String", "messages": [Array] } ] |
| resultado.feedback.document_id | Identificador exclusivo do documento externo conforme especificado no corpo da solicitação. Tipo de dados: cadeia de caracteres |
| resultado.feedback.messages | Matriz de objetos sem nome em que cada objeto representa uma mensagem de feedback de ingestão registrada durante a indexação do documento externo. Tipo de dados: matriz "messages": [ { "code": "String", "component": "String", "level": "String", "message": "String" } ] |
| resultado.feedback.messages.code | Código para uma exceção lançada pelo componente de fluxo de trabalho de indexação que registrou a mensagem de feedback de ingestão. Tipo de dados: cadeia de caracteres |
| resultado.feedback.messages.component | Identificador do componente de fluxo de trabalho de indexação que registrou a mensagem de feedback de ingestão. Tipo de dados: cadeia de caracteres |
| resultado.feedback.messages.level | Nível de registro em log para a mensagem de feedback de ingestão. Valores válidos: * ERROR * INFO * MINOR_ERROR * WARN {#ext_content-POST-ingestDocument__ul_xsh_c15_4nb} Tipo de dados: cadeia de caracteres |
| resultado.feedback.messages.message | Texto registrado para a mensagem de feedback de ingestão. Tipo de dados: cadeia de caracteres |
| status | Status de uma solicitação malsucedida. Valores válidos: * failure {#ext_content-POST-ingestDocument__ul_h5r_z54_pnb} Tipo de dados: cadeia de caracteres |
[ ]

### Ordem de precedência para permissões principais {#ext_content-POST-ingestDocument__principal-precedence-section}

A ordem de precedência das permissões \[array\].principals depende do valor do atributo user_read_takes_precedence_over_group_deny da origem indexada usada para ingerir um documento externo.{#ext_content-POST-ingestDocument__table_vlm_d2t_vpb__entry__2}

| Valor de atributo | Ordem de precedência para permissões principais |
|-|-|
| verdadeiro | Da precedência mais alta para a mais baixa: 1. \[array\].principals.everyone, \[array\].principals.none 2. \[array\].principals.users.deny 3. \[array\].principals.users.read 4. \[array\].principals.groups.deny 5. \[array\].principals.groups.read {#ext_content-POST-ingestDocument__ol_y41_h2t_vpb} Nota: Este é o valor de atributo padrão para fontes indexadas de conteúdo externo. |
| falso | Da precedência mais alta para a mais baixa: 1. \[array\].principals.everyone, \[array\].principals.none 2. \[array\].principals.users.deny, \[array\].principals.groups.deny 3. \[array\].principals.users.read, \[array\].principals.groups.read {#ext_content-POST-ingestDocument__ol_d5s_h2t_vpb} Nota: Para obter instruções sobre como definir o valor deste atributo, consulte [Como alterar a precedência das permissões de leitura e negação de grupo do usuário para uma origem indexada de conteúdo externo](https://www.servicenow.com/docs/access?context=defining-access-perms-ext-docs-ais&version=xanadu&pubname=xanadu-platform-administration&ft:locale=en-US). |
[ ]

{#ext_content-POST-ingestDocument__table_vlm_d2t_vpb}  

### Solicitação de cURL

Alimente dois documentos externos (com ponteiros de conteúdo para objetos de conteúdo binário armazenados anteriormente usando o endpoint [POST /ais/external_content/storeContent](https://servicenow-prod.fluidtopics.net/nDBQAalH57pSUkgDP17Rmw#ext_content-POST-storeContent "Armazena conteúdo binário como um objeto de conteúdo em Pesquisa com IA.") ) para indexação na tabela de esquema u_ext_content.

    curl 'https://instance.servicenow.com/api/now/v2/ais/external_content/ingestDocument/u_ext_content' \
      --request POST \
      --user 'username':'password' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '[
      {
        "document_id": "ADMIN-2027858531-16",
        "content_pointer": "749b52a1-baa8-4556-a4f3-00404c95e6a8",
        "properties": {
          "title": "Introduction",
          "url": "file:///myhost/reports/Introduction.pdf",
          "file_name": "Introduction.pdf",
          "file_size": "10285",
          "creation_date": "2020-11-01 12:27:43"
        },
        "principals": {
          "everyone": false,
          "groups.read": [
            "report-users",
            "report-admins"
          ],
          "users.deny": [
            "ad\abel-tuter"
          ]
        }
      },
      {
        "document_id": "ADMIN-2587918521-27",
        "content_pointer": "bd605435-268b-464f-a7c3-0c5ea894a5c2",
        "properties": {
          "title": "Report for 31 August 2020",
          "url": "file:///myhost/reports/Report-2020-08-31.pdf",
          "file_size": "27597",
          "creation_date": "2020-09-01 12:48:13"
        },
        "principals": {
          "everyone": false,
          "groups.read": [
            "report-users",
            "report-admins"
          ],
          "users.read": [
            "ad\beth-anglin"
          ]
        }
      }
    ]'

    {
      "result":"{\"duration_in_ms\":3822,\"feedback\":[{\"messages\":[{\"level\":\"INFO\",\"message\":\"CREATED\",\"component\":\"init\"},{\"level\":\"INFO\",\"message\":\"OK\",\"component\":\"index-886de18e750030108b23bcd69cdc2dd3-indexer.index-886de18e750030108b23bcd69cdc2dd3-content-dispatcher\"},{\"level\":\"INFO\",\"message\":\"COMPLETED\",\"component\":\"sink.sink\"}],\"document_id\":\"ADMIN-2027858531-16\"},{\"messages\":[{\"level\":\"INFO\",\"message\":\"CREATED\",\"component\":\"init\"},{\"level\":\"WARN\",\"message\":\"field \\u0027text\\u0027 tokens exceed index.maxTokens\",\"code\":\"INDEX_ENGINE-32\",\"component\":\"ingestGlideDocument.standardAnalyzer\"},{\"level\":\"INFO\",\"message\":\"OK\",\"component\":\"index-886de18e750030108b23bcd69cdc2dd3-indexer.index-886de18e750030108b23bcd69cdc2dd3-content-dispatcher\"},{\"level\":\"INFO\",\"message\":\"COMPLETED\",\"component\":\"sink.sink\"}],\"document_id\":\"ADMIN-2587918521-27\"}]}"
    }

## API de ingestão de conteúdo externo -- POST ais/external_content/storeContent {#ariaid-title5}

Armazena conteúdo binário como um objeto de conteúdo em Pesquisa com IA.
Você pode associar o conteúdo binário armazenado a um documento externo seguindo estas etapas:

1. Armazene o conteúdo binário usando este endpoint. Registre o valor do parâmetro de corpo de resposta result.
2. Envie o documento externo para Pesquisa com IA usando o endpoint [POST /ais/external_content/ingestDocument/{schema_table_name}](https://servicenow-prod.fluidtopics.net/nDBQAalH57pSUkgDP17Rmw#ext_content-POST-ingestDocument "Envia uma lista de documentos externos para o criador de lotes de ingestão Pesquisa com IA para indexação. Depois que a indexação é concluída, o conteúdo dos documentos ingeridos se torna pesquisável."). Defina o parâmetro do corpo da solicitação content_pointer do documento para corresponder ao valor do parâmetro do corpo da resposta result registrado.

{#ext_content-POST-storeContent__ol_bz4_prf_ynb} Durante a ingestão, Pesquisa com IA analisa o conteúdo binário e adiciona seu conteúdo pesquisável ao registro indexado que representa o documento externo. A análise remove o objeto de conteúdo armazenado.

### Formato da URL

URL com controle de versões: /api/now/{api_version}/ais/external_content/storeContent

### Parâmetros de solicitação compatíveis

{#ext_content-POST-storeContent__entry__2}{#ext_content-POST-storeContent__version-RESTAPI}

| Parâmetro | Descrição |
|-|-|
| api_version | Opcional. Versão do endpoint a ser acessada. Por exemplo, <kbd class="ph userinput">v1</kbd> ou <kbd class="ph userinput">v2</kbd>. Somente especifique este valor para usar uma versão de endpoint diferente da mais recente. Tipo de dados: cadeia de caracteres |
[Tabela 19. Parâmetros de caminho]

{#ext_content-POST-storeContent__entry__6}

| Nome | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 20. Parâmetros de consulta]

{#ext_content-POST-storeContent__entry__10}

| Elemento | Descrição |
|-|-|
| \[dados binários\] | Obrigatório. Conteúdo binário a ser armazenado como um objeto de conteúdo em Pesquisa com IA. |
[Tabela 21. Parâmetros do corpo da solicitação]

### Cabeçalhos

Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte [Cabeçalhos de REST API compatíveis](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#ext_content-POST-storeContent__entry__14}{#ext_content-POST-storeContent__accept-JSON-only-entry-RESTAPI}

| Cabeçalho | Descrição |
|-|-|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Valores válidos: * application/msword * application/octet-stream * application/pdf * application/vnd.ms-excel * application/vnd.ms-powerpoint * application/vnd.ms-powerpoint.presentation.macroenabled.12 * application/vnd.openxmlformats-officedocument.presentationml.presentation * application/vnd.openxmlformats-officedocument.presentationml.template * application/vnd.openxmlformats-officedocument.spreadsheetml.sheet * application/vnd.openxmlformats-officedocument.wordprocessingml.document * application/vnd.openxmlformats-officedocument.wordprocessingml.template * text/html * text/plain {#ext_content-POST-storeContent__ul_zkc_tb5_4nb} |
[Tabela 22. Cabeçalhos da solicitação]

{#ext_content-POST-storeContent__entry__20}

| Cabeçalho | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 23. Cabeçalhos de resposta]

### Códigos de status

Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte [Códigos de resposta HTTP de REST API](https://servicenow-prod.fluidtopics.net/_wb_5~ll90zKaDApNe9ciw "REST (Transferência de Estado Representacional) é uma arquitetura sem estado simples que fornece padrões entre sistemas de computador na Web, facilitando a comunicação entre eles.").
{#ext_content-POST-storeContent__entry__24}{#ext_content-POST-storeContent__entry-200-status-code}{#ext_content-POST-storeContent__entry-400-status-code}{#ext_content-POST-storeContent__entry-500-status-code}

| Código de status | Descrição |
|-|-|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada. |
| 500 | Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro. |
[Tabela 24. Códigos de status]

### Parâmetros do corpo da resposta (JSON ou XML)

{#ext_content-POST-storeContent__entry__32}

| Elemento | Descrição |
|-|-|
| erro | Objeto que descreve o erro encontrado durante o processamento da solicitação. Tipo de dados: objeto "error": { "detail": "String", "message": "String" } |
| erro.detalhe | Detalhes do erro encontrado durante o processamento da solicitação. Tipo de dados: cadeia de caracteres |
| mensagem.erro | Mensagem do erro encontrado durante o processamento da solicitação. Tipo de dados: cadeia de caracteres |
| resultado | Identificador do objeto de conteúdo binário armazenado pela solicitação bem-sucedida. Tipo de dados: cadeia de caracteres "result" : "91841766-2a5f-4c64-a20a-27ca485eca21" Nota: Para anexar o conteúdo armazenado a um documento externo ingerido, especifique este identificador como o elemento do corpo da solicitação content_pointer para uma solicitação ao endpoint ingestDocument. |
| status | Status de uma solicitação malsucedida. Valores válidos: * failure {#ext_content-POST-storeContent__ul_h5r_z54_pnb} Tipo de dados: cadeia de caracteres |
[ ]

### Solicitação de cURL

Armazene conteúdo binário para um arquivo PDF como um objeto de conteúdo.

    curl 'https://instance.servicenow.com/api/now/v2/ais/external_content/storeContent' \
    --request POST \
    --user 'username':'password' \
    --header 'Content-Type: application/pdf' \
    --data-binary '@Report-2020-08-31.pdf'

O corpo da resposta inclui o identificador exclusivo do novo objeto de conteúdo.

    {
      "result" : "fb439a4f-62ad-4dab-9654-5088d99a6ff9"
    }