# ServiceNow

{% hint style="info" %}
O conteúdo desta documentação está em revisão e pode ser alterado. Agradecemos sua compreensão enquanto trabalhamos para melhorá-la.
{% endhint %}

**ServiceNow** interage com o ServiceNow por meio de sua API REST.

## **Parâmetros**

Dê uma olhada nos parâmetros de configuração do conector. Parâmetros suportados por [expressões Double Braces](https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/double-braces/overview) estão marcados com `(DB)`.

### **Aba General**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Dynamic Account</strong></td><td>Quando ativo, o conector usará a conta dinamicamente. Caso contrário, usará a conta de forma estática.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Account Name</strong> <code>(DB)</code></td><td>O nome da conta dinâmica usada pelo conector. Esta conta deve ter sido previamente configurada em um conector <a href="../tools/store-account"><strong>Store Account</strong></a> no pipeline para que este processo tenha efeito. Este parâmetro fica disponível apenas se o parâmetro <strong>Dynamic Account</strong> estiver ativo.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Account</strong></td><td>A conta usada pelo conector. Este parâmetro fica disponível apenas se o parâmetro <strong>Dynamic Account</strong> estiver inativo.</td><td>N/A</td><td>Account</td></tr><tr><td><strong>Instance Name</strong> <code>(DB)</code></td><td>O nome da instância do ServiceNow.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Fail On Error</strong></td><td>Se a opção for ativada, a execução do pipeline com erro será interrompida. Caso contrário, a execução do pipeline continua, mas o resultado mostrará um valor falso para a propriedade <code>"success"</code>.</td><td>False</td><td>Booleano</td></tr></tbody></table>

### **Aba Opcional**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Display</strong></td><td>Defina este parâmetro como <code>true</code> para retornar apenas scorecards onde o campo Display do indicador está selecionado. Defina como <code>all</code> para retornar scorecards com qualquer valor no campo Display. O valor padrão é <code>true</code>.</td><td>True</td><td>String</td></tr><tr><td><strong>Display Value</strong></td><td>Retorna o valor de exibição (<code>true</code>), valor real (<code>false</code>) ou ambos (<code>all</code>) para campos de referência (padrão: <code>false</code>).</td><td>False</td><td>String</td></tr><tr><td><strong>Exclude Reference Link</strong></td><td>Defina como <code>true</code> para excluir links da API Table para campos de referência (padrão: <code>false</code>).</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Favorites</strong></td><td>Defina este parâmetro como <code>true</code> para retornar apenas scorecards que são favoritos do usuário da consulta.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Include Aggregates</strong></td><td>Defina este parâmetro como <code>true</code> para retornar todos os agregados disponíveis para um indicador, mesmo que já tenha sido aplicado um agregado. Se não for especificado, o padrão será <code>false</code> e não retornará agregados.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Include Available Aggregates</strong></td><td>Defina este parâmetro como <code>true</code> para retornar todos os agregados disponíveis para um indicador quando nenhum agregado tiver sido aplicado. Se não for especificado, o padrão será <code>false</code> e não retornará agregados.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Include Available Breakdowns</strong></td><td>Defina este parâmetro como <code>true</code> para retornar todas as divisões disponíveis para um indicador. Se não for especificado, o padrão será <code>false</code> e não retornará divisões.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Include Score Notes</strong></td><td>Defina este parâmetro como <code>true</code> para retornar todas as notas associadas à pontuação. O elemento de nota inclui o texto da nota, autor e timestamp de quando a nota foi adicionada.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Include Scores</strong></td><td>Defina este parâmetro como <code>true</code> para retornar todas as pontuações de um scorecard. Se não for especificado, o padrão será <code>false</code> e retornará apenas o valor mais recente da pontuação.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Input Display Value</strong></td><td>Defina como <code>true</code> para usar o valor bruto dos campos de entrada (padrão: <code>false</code>).</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Key</strong></td><td>Defina este parâmetro como <code>true</code> para retornar apenas scorecards de indicadores-chave.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Models</strong> <code>(DB)</code></td><td>Define tanto os modelos de solicitação quanto de resposta.</td><td>N/A</td><td>JSON</td></tr><tr><td><strong>Per Page</strong></td><td>Insira o número máximo de scorecards que cada consulta pode retornar. O valor padrão é <code>10</code>, com um máximo de <code>100</code>.</td><td>10</td><td>Number</td></tr><tr><td><strong>Release</strong></td><td>A versão do ServiceNow a ser alvo, o padrão é Helsinki. Consulte <a href="https://docs.servicenow.com">https://docs.servicenow.com</a>.</td><td>HELSINKI</td><td>String</td></tr><tr><td><strong>Request Models</strong> <code>(DB)</code></td><td>Define o modelo de solicitação.</td><td>N/A</td><td>JSON</td></tr><tr><td><strong>Resource</strong> <code>(DB)</code></td><td>O recurso padrão, pode ser substituído pelo cabeçalho <code>CamelServiceNowResource</code>.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Response Models</strong> <code>(DB)</code></td><td>Define o modelo de resposta.</td><td>N/A</td><td>JSON</td></tr><tr><td><strong>Sort By</strong></td><td>Especifique o campo a ser usado ao ordenar resultados. Por padrão, as consultas ordenam registros por valor.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Sort Dir</strong></td><td>Especifique a direção da ordenação, crescente ou decrescente. Por padrão, as consultas ordenam registros em ordem decrescente. Use <code>sysparm_sortdir=asc</code> para ordenar em ordem crescente.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Suppress Auto Sys Field</strong></td><td>Defina como <code>true</code> para suprimir a geração automática de campos de sistema (padrão: <code>false</code>).</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Suppress Pagination Header</strong></td><td>Defina como <code>true</code> para remover o cabeçalho Link da resposta. O cabeçalho Link permite solicitar páginas adicionais de dados quando o número de registros excede o limite de consulta.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Table</strong> <code>(DB)</code></td><td>A tabela padrão, pode ser substituída pelo cabeçalho <code>CamelServiceNowTable</code>.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Target</strong></td><td>Defina este parâmetro como <code>true</code> para retornar apenas scorecards que possuem uma meta.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Top Level Only</strong></td><td>Retorna apenas categorias cujo pai é um catálogo.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Api Version</strong> <code>(DB)</code></td><td>A versão da REST API do ServiceNow, o padrão é a mais recente.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Date Format</strong> <code>(DB)</code></td><td>O formato de data usado para serialização/deserialização JSON.</td><td>yyyy-MM-dd</td><td>String</td></tr><tr><td><strong>Date Time Format</strong> <code>(DB)</code></td><td>O formato de data/hora usado para serialização/deserialização JSON.</td><td>yyyy-MM-dd HH:mm:ss</td><td>String</td></tr><tr><td><strong>Retrieve Target Record On Import</strong></td><td>Defina este parâmetro como <code>true</code> para recuperar o registro alvo ao usar a API de conjunto de importação. O resultado do conjunto de importação é substituído pelo registro alvo.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Time Format</strong> <code>(DB)</code></td><td>O formato de tempo usado para serialização/deserialização JSON.</td><td>HH:mm:ss</td><td>String</td></tr><tr><td><strong>Body</strong></td><td>O corpo, se aplicável.</td><td><code>{}</code></td><td>JSON</td></tr></tbody></table>

### **Aba Headers**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Resource</strong> <code>(DB)</code></td><td>O recurso a ser acessado.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Action</strong> <code>(DB)</code></td><td>A ação a ser executada.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Action Subject</strong> <code>(DB)</code></td><td>O assunto da ação.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Model</strong> <code>(DB)</code></td><td>Define o modelo de dados.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Request Model</strong> <code>(DB)</code></td><td>Define o modelo de dados da solicitação.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Response Model</strong> <code>(DB)</code></td><td>Define o modelo de dados da resposta.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Content Type</strong> <code>(DB)</code></td><td>O tipo de conteúdo.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Content Meta</strong> <code>(DB)</code></td><td>Metadados associados ao conteúdo.</td><td>N/A</td><td>JSON</td></tr><tr><td><strong>Response Meta</strong> <code>(DB)</code></td><td>Metadados associados à resposta.</td><td>N/A</td><td>JSON</td></tr><tr><td><strong>Api Version</strong> <code>(DB)</code></td><td>A versão da API REST.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Response Type</strong> <code>(DB)</code></td><td>O tipo de resposta.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Retrieve Target Record</strong></td><td>Defina este parâmetro como <code>true</code> para recuperar o registro alvo.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Table</strong> <code>(DB)</code></td><td>A tabela padrão a ser acessada.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Sys Id</strong> <code>(DB)</code></td><td>O ID do sistema (sys_id) do registro alvo.</td><td>N/A</td><td>String</td></tr><tr><td><strong>User SysId</strong> <code>(DB)</code></td><td>O ID do sistema (sys_id) do usuário.</td><td>N/A</td><td>String</td></tr><tr><td><strong>User Id</strong> <code>(DB)</code></td><td>O ID do usuário.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Cart Item Id</strong> <code>(DB)</code></td><td>O ID do item do carrinho.</td><td>N/A</td><td>String</td></tr><tr><td><strong>File Name</strong> <code>(DB)</code></td><td>O nome do arquivo.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Table Sys Id</strong> <code>(DB)</code></td><td>O ID do sistema (sys_id) da tabela.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Encryption Context</strong> <code>(DB)</code></td><td>O contexto para criptografia.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Category</strong> <code>(DB)</code></td><td>A sys_param categoria.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Type</strong> <code>(DB)</code></td><td>O sys_param tipo.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Catalog</strong> <code>(DB)</code></td><td>O sys_param catálogo.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Query</strong> <code>(DB)</code></td><td>O sys_param consulta.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Display Value</strong> <code>(DB)</code></td><td>Retorna o valor de exibição (<code>true</code>), valor real (<code>false</code>) ou ambos (<code>all</code>) para campos de referência.</td><td>False</td><td>String</td></tr><tr><td><strong>Input Display Value</strong></td><td>Defina este parâmetro como <code>true</code> para usar o valor bruto dos campos de entrada.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Exclude Reference Link</strong></td><td>Defina como <code>true</code> para excluir links da API da Tabela para campos de referência.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Fields</strong> <code>(DB)</code></td><td>Os campos sys_param a serem recuperados.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Limit</strong></td><td>O sys_param limite para resultados de consulta.</td><td>N/A</td><td>Number</td></tr><tr><td><strong>Text</strong> <code>(DB)</code></td><td>O sys_param texto.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Offset</strong></td><td>O sys_param offset para paginação.</td><td>N/A</td><td>Number</td></tr><tr><td><strong>View</strong> <code>(DB)</code></td><td>A sys_param visualização.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Suppress Auto Sys Field</strong></td><td>Defina como <code>true</code> para suprimir a geração automática de campos do sistema.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Suppress Pagination Header</strong></td><td>Defina como <code>true</code> para remover o cabeçalho de Link da resposta, o que permite solicitar páginas adicionais de dados.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Min Fields</strong> <code>(DB)</code></td><td>Os campos sys_param mínimos a serem recuperados.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Max Fields</strong> <code>(DB)</code></td><td>Os campos sys_param máximos a serem recuperados.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Sum Fields</strong> <code>(DB)</code></td><td>Os campos sys_param de soma a serem calculados.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Avg Fields</strong> <code>(DB)</code></td><td>Os campos sys_param de média a serem calculados.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Count</strong></td><td>Defina como <code>true</code> para retornar uma contagem dos registros.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Group By</strong> <code>(DB)</code></td><td>Os campos sys_param para agrupar por agregação.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Order By</strong> <code>(DB)</code></td><td>Os campos sys_param para ordenar resultados.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Having</strong> <code>(DB)</code></td><td>A cláusula sys_param having para filtrar resultados agregados.</td><td>N/A</td><td>String</td></tr><tr><td><strong>UUID</strong> <code>(DB)</code></td><td>O sys_param UUID.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Breakdown</strong> <code>(DB)</code></td><td>O campo sys_param divisão.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Include Scores</strong></td><td>Defina este parâmetro como <code>true</code> para retornar todas as pontuações de um scorecard. Se não for especificado, apenas a pontuação mais recente será retornada.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Include Score Notes</strong></td><td>Defina este parâmetro como <code>true</code> para retornar todas as notas associadas a uma pontuação, incluindo texto, autor e timestamp.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Include Aggregates</strong></td><td>Defina este parâmetro como <code>true</code> para retornar todos os agregados disponíveis, mesmo que um agregado já tenha sido aplicado.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Include Available Breakdowns</strong></td><td>Defina este parâmetro como <code>true</code> para retornar todas as divisões disponíveis para um indicador.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Include Available Aggregates</strong></td><td>Defina este parâmetro como <code>true</code> para retornar todos os agregados disponíveis quando nenhum agregado foi aplicado.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Favorites</strong></td><td>Defina este parâmetro como <code>true</code> para retornar apenas scorecards que são favoritos do usuário que consulta.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Key</strong></td><td>Defina este parâmetro como <code>true</code> para retornar apenas scorecards de indicadores-chave.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Target</strong></td><td>Defina este parâmetro como <code>true</code> para retornar apenas scorecards que possuem uma meta.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Display</strong> <code>(DB)</code></td><td>Defina este parâmetro como <code>true</code> para retornar scorecards onde o campo Exibição está selecionado. Use <code>all</code> para retornar scorecards com qualquer valor no campo Exibição.</td><td>True</td><td>String</td></tr><tr><td><strong>Per Page</strong></td><td>Especifique o número máximo de scorecards a serem retornados em uma consulta. O padrão é 10, com um máximo de 100.</td><td>10</td><td>Number</td></tr><tr><td><strong>Sort By</strong> <code>(DB)</code></td><td>Especifique o campo a ser usado para ordenar resultados. Por padrão, os registros são ordenados por valor.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Sort Dir</strong> <code>(DB)</code></td><td>Especifique a direção da ordenação: crescente ou decrescente. Por padrão, os resultados são ordenados em ordem decrescente. Use <code>sysparm_sortdir=asc</code> para crescente.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Contains</strong> <code>(DB)</code></td><td>O sys_param contains clause.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Tags</strong> <code>(DB)</code></td><td>O sys_param tags para categorizar registros.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Page</strong> <code>(DB)</code></td><td>O número da página sys_param para paginação.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Elements Filter</strong> <code>(DB)</code></td><td>O sys_param elements filter.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Breakdown Relation</strong> <code>(DB)</code></td><td>O sys_param breakdown relation.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Data Source</strong> <code>(DB)</code></td><td>O sys_param data source a ser consultado.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Top Level Only</strong></td><td>Defina como <code>true</code> para retornar apenas categorias cujo pai seja um catálogo.</td><td>False</td><td>Boolean</td></tr></tbody></table>

### **Aba Documentation**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td>Seção para documentar qualquer informação necessária sobre a configuração do conector e regras de negócio.</td><td>N/A</td><td>String</td></tr></tbody></table>