ServiceNow
Saiba mais sobre o conector ServiceNow e como usá-lo na Digibee Integration Platform.
O conteúdo desta documentação está em revisão e pode ser alterado. Agradecemos sua compreensão enquanto trabalhamos para melhorá-la.
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 estão marcados com (DB).
Aba General
Dynamic Account
Quando ativo, o conector usará a conta dinamicamente. Caso contrário, usará a conta de forma estática.
False
Booleano
Account Name (DB)
O nome da conta dinâmica usada pelo conector. Esta conta deve ter sido previamente configurada em um conector Store Account no pipeline para que este processo tenha efeito. Este parâmetro fica disponível apenas se o parâmetro Dynamic Account estiver ativo.
N/A
String
Account
A conta usada pelo conector. Este parâmetro fica disponível apenas se o parâmetro Dynamic Account estiver inativo.
N/A
Account
Instance Name (DB)
O nome da instância do ServiceNow.
N/A
String
Fail On Error
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 "success".
False
Booleano
Aba Opcional
Display
Defina este parâmetro como true para retornar apenas scorecards onde o campo Display do indicador está selecionado. Defina como all para retornar scorecards com qualquer valor no campo Display. O valor padrão é true.
True
String
Display Value
Retorna o valor de exibição (true), valor real (false) ou ambos (all) para campos de referência (padrão: false).
False
String
Exclude Reference Link
Defina como true para excluir links da API Table para campos de referência (padrão: false).
False
Booleano
Favorites
Defina este parâmetro como true para retornar apenas scorecards que são favoritos do usuário da consulta.
False
Booleano
Include Aggregates
Defina este parâmetro como true 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á false e não retornará agregados.
False
Booleano
Include Available Aggregates
Defina este parâmetro como true 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á false e não retornará agregados.
False
Booleano
Include Available Breakdowns
Defina este parâmetro como true para retornar todas as divisões disponíveis para um indicador. Se não for especificado, o padrão será false e não retornará divisões.
False
Booleano
Include Score Notes
Defina este parâmetro como true 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.
False
Booleano
Include Scores
Defina este parâmetro como true para retornar todas as pontuações de um scorecard. Se não for especificado, o padrão será false e retornará apenas o valor mais recente da pontuação.
False
Booleano
Input Display Value
Defina como true para usar o valor bruto dos campos de entrada (padrão: false).
False
Booleano
Key
Defina este parâmetro como true para retornar apenas scorecards de indicadores-chave.
False
Booleano
Models (DB)
Define tanto os modelos de solicitação quanto de resposta.
N/A
JSON
Per Page
Insira o número máximo de scorecards que cada consulta pode retornar. O valor padrão é 10, com um máximo de 100.
10
Number
Release
A versão do ServiceNow a ser alvo, o padrão é Helsinki. Consulte https://docs.servicenow.com.
HELSINKI
String
Request Models (DB)
Define o modelo de solicitação.
N/A
JSON
Resource (DB)
O recurso padrão, pode ser substituído pelo cabeçalho CamelServiceNowResource.
N/A
String
Response Models (DB)
Define o modelo de resposta.
N/A
JSON
Sort By
Especifique o campo a ser usado ao ordenar resultados. Por padrão, as consultas ordenam registros por valor.
N/A
String
Sort Dir
Especifique a direção da ordenação, crescente ou decrescente. Por padrão, as consultas ordenam registros em ordem decrescente. Use sysparm_sortdir=asc para ordenar em ordem crescente.
N/A
String
Suppress Auto Sys Field
Defina como true para suprimir a geração automática de campos de sistema (padrão: false).
False
Booleano
Suppress Pagination Header
Defina como true 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.
False
Booleano
Table (DB)
A tabela padrão, pode ser substituída pelo cabeçalho CamelServiceNowTable.
N/A
String
Target
Defina este parâmetro como true para retornar apenas scorecards que possuem uma meta.
False
Booleano
Top Level Only
Retorna apenas categorias cujo pai é um catálogo.
False
Booleano
Api Version (DB)
A versão da REST API do ServiceNow, o padrão é a mais recente.
N/A
String
Date Format (DB)
O formato de data usado para serialização/deserialização JSON.
yyyy-MM-dd
String
Date Time Format (DB)
O formato de data/hora usado para serialização/deserialização JSON.
yyyy-MM-dd HH:mm:ss
String
Retrieve Target Record On Import
Defina este parâmetro como true 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.
False
Booleano
Time Format (DB)
O formato de tempo usado para serialização/deserialização JSON.
HH:mm:ss
String
Body
O corpo, se aplicável.
{}
JSON
Aba Headers
Resource (DB)
O recurso a ser acessado.
N/A
String
Action (DB)
A ação a ser executada.
N/A
String
Action Subject (DB)
O assunto da ação.
N/A
String
Model (DB)
Define o modelo de dados.
N/A
String
Request Model (DB)
Define o modelo de dados da solicitação.
N/A
String
Response Model (DB)
Define o modelo de dados da resposta.
N/A
String
Content Type (DB)
O tipo de conteúdo.
N/A
String
Content Meta (DB)
Metadados associados ao conteúdo.
N/A
JSON
Response Meta (DB)
Metadados associados à resposta.
N/A
JSON
Api Version (DB)
A versão da API REST.
N/A
String
Response Type (DB)
O tipo de resposta.
N/A
String
Retrieve Target Record
Defina este parâmetro como true para recuperar o registro alvo.
False
Boolean
Table (DB)
A tabela padrão a ser acessada.
N/A
String
Sys Id (DB)
O ID do sistema (sys_id) do registro alvo.
N/A
String
User SysId (DB)
O ID do sistema (sys_id) do usuário.
N/A
String
User Id (DB)
O ID do usuário.
N/A
String
Cart Item Id (DB)
O ID do item do carrinho.
N/A
String
File Name (DB)
O nome do arquivo.
N/A
String
Table Sys Id (DB)
O ID do sistema (sys_id) da tabela.
N/A
String
Encryption Context (DB)
O contexto para criptografia.
N/A
String
Category (DB)
A sys_param categoria.
N/A
String
Type (DB)
O sys_param tipo.
N/A
String
Catalog (DB)
O sys_param catálogo.
N/A
String
Query (DB)
O sys_param consulta.
N/A
String
Display Value (DB)
Retorna o valor de exibição (true), valor real (false) ou ambos (all) para campos de referência.
False
String
Input Display Value
Defina este parâmetro como true para usar o valor bruto dos campos de entrada.
False
Boolean
Exclude Reference Link
Defina como true para excluir links da API da Tabela para campos de referência.
False
Boolean
Fields (DB)
Os campos sys_param a serem recuperados.
N/A
String
Limit
O sys_param limite para resultados de consulta.
N/A
Number
Text (DB)
O sys_param texto.
N/A
String
Offset
O sys_param offset para paginação.
N/A
Number
View (DB)
A sys_param visualização.
N/A
String
Suppress Auto Sys Field
Defina como true para suprimir a geração automática de campos do sistema.
False
Boolean
Suppress Pagination Header
Defina como true para remover o cabeçalho de Link da resposta, o que permite solicitar páginas adicionais de dados.
False
Boolean
Min Fields (DB)
Os campos sys_param mínimos a serem recuperados.
N/A
String
Max Fields (DB)
Os campos sys_param máximos a serem recuperados.
N/A
String
Sum Fields (DB)
Os campos sys_param de soma a serem calculados.
N/A
String
Avg Fields (DB)
Os campos sys_param de média a serem calculados.
N/A
String
Count
Defina como true para retornar uma contagem dos registros.
False
Boolean
Group By (DB)
Os campos sys_param para agrupar por agregação.
N/A
String
Order By (DB)
Os campos sys_param para ordenar resultados.
N/A
String
Having (DB)
A cláusula sys_param having para filtrar resultados agregados.
N/A
String
UUID (DB)
O sys_param UUID.
N/A
String
Breakdown (DB)
O campo sys_param divisão.
N/A
String
Include Scores
Defina este parâmetro como true para retornar todas as pontuações de um scorecard. Se não for especificado, apenas a pontuação mais recente será retornada.
False
Boolean
Include Score Notes
Defina este parâmetro como true para retornar todas as notas associadas a uma pontuação, incluindo texto, autor e timestamp.
False
Boolean
Include Aggregates
Defina este parâmetro como true para retornar todos os agregados disponíveis, mesmo que um agregado já tenha sido aplicado.
False
Boolean
Include Available Breakdowns
Defina este parâmetro como true para retornar todas as divisões disponíveis para um indicador.
False
Boolean
Include Available Aggregates
Defina este parâmetro como true para retornar todos os agregados disponíveis quando nenhum agregado foi aplicado.
False
Boolean
Favorites
Defina este parâmetro como true para retornar apenas scorecards que são favoritos do usuário que consulta.
False
Boolean
Key
Defina este parâmetro como true para retornar apenas scorecards de indicadores-chave.
False
Boolean
Target
Defina este parâmetro como true para retornar apenas scorecards que possuem uma meta.
False
Boolean
Display (DB)
Defina este parâmetro como true para retornar scorecards onde o campo Exibição está selecionado. Use all para retornar scorecards com qualquer valor no campo Exibição.
True
String
Per Page
Especifique o número máximo de scorecards a serem retornados em uma consulta. O padrão é 10, com um máximo de 100.
10
Number
Sort By (DB)
Especifique o campo a ser usado para ordenar resultados. Por padrão, os registros são ordenados por valor.
N/A
String
Sort Dir (DB)
Especifique a direção da ordenação: crescente ou decrescente. Por padrão, os resultados são ordenados em ordem decrescente. Use sysparm_sortdir=asc para crescente.
N/A
String
Contains (DB)
O sys_param contains clause.
N/A
String
Tags (DB)
O sys_param tags para categorizar registros.
N/A
String
Page (DB)
O número da página sys_param para paginação.
N/A
String
Elements Filter (DB)
O sys_param elements filter.
N/A
String
Breakdown Relation (DB)
O sys_param breakdown relation.
N/A
String
Data Source (DB)
O sys_param data source a ser consultado.
N/A
String
Top Level Only
Defina como true para retornar apenas categorias cujo pai seja um catálogo.
False
Boolean
Aba Documentation
Documentation
Seção para documentar qualquer informação necessária sobre a configuração do conector e regras de negócio.
N/A
String
Atualizado