ServiceNow
O ServiceNow melhora os níveis de serviço, energiza os funcionários e permite que sua empresa trabalhe com velocidade de luz. Criar, ler e atualizar registros armazenados no ServiceNow, incluindo Incidentes, Perguntas, Usuários e muito mais.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: - China Cloud operado pela 21Vianet |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: - China Cloud operado pela 21Vianet |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: - China Cloud operado pela 21Vianet |
| Contato | |
|---|---|
| Nome | Microsoft |
| URL | https://learn.microsoft.com/connectors/service-now/ |
| Metadados do conector | |
|---|---|
| Publicador | Microsoft |
| Site | https://www.servicenow.com/ |
| Política de privacidade | https://www.servicenow.com/privacy-statement.html |
| Categorias | Site |
Observação
A operação Obter Artigos de Conhecimento só pode ser usada quando o plug-in da API de Conhecimento (sn_km_api) é ativado.
Problemas e limitações conhecidos
Ao usar a ação Criar Registro , não é possível especificar a descrição completa do registro. O valor do campo será ignorado devido a limitações da API REST Service-Now.
A ação Obter Registros pode retornar uma "Tabela Inválida" ou outro erro no Power Apps. Para implementações do Power Apps, a solução sugerida é utilizar a ação Obter Registros no Power Automate e passar os dados de volta para o Power Apps.
Atualmente, o conector dá suporte apenas a URLs de instância que terminam com "service-now.com". O uso de domínios alternativos, como "servicenowservices.com", pode levar a erros de conexão. Nesses casos, especialmente ao trabalhar com o novo domínio do ServiceNow no GCC, é recomendável usar a Autenticação Básica.
Se você encontrar um erro pop-up informando "Redirect_uri inválido", copie a URL completa da janela pop-up e extraia o parâmetro redirect_uri (por exemplo, redirect_uri=https%3a%2f%2ftip1-shared.consent.azure-apim.net%2fredirect). Depois de decodificar a URL (substituindo %3a por : e %2f por /), atualize o campo URL de Redirecionamento no registro de aplicativo OAuth da instância do ServiceNow, conforme mostrado na imagem abaixo. Em seguida, tente adicionar novamente a conexão.
Como configurar uma conexão do ServiceNow Power Platform que usa a ID do Microsoft Entra
Há dois tipos de conexão:
Microsoft Entra ID OAuth usando Certificado: esse é um tipo de autenticação baseado em token de aplicativo em que um aplicativo registrado na ID do Entra pode ser usado para acessar o ServiceNow obtendo um token com o recurso definido como o aplicativo de ID entra do representante do ServiceNow.
Microsoft Entra ID OAuth usando o Logon do Usuário: este é um tipo de autenticação baseado em token de usuário em que o usuário final pode entrar no aplicativo Entra ID 1P (ServiceNow Connector 1p App) e obter um token de acesso com o escopo definido para o aplicativo de ID entra representante do ServiceNow.
Etapas para criar uma conexão OAuth da ID do Microsoft Entra usando o Certificado
Etapa 1: registrar um "Aplicativo A" na ID do Microsoft Entra para integração do OIDC com o ServiceNow. Este é o aplicativo de ID do Entra representante do ServiceNow.
Ir para registros de aplicativo > Novo registro para criar um novo registro de aplicativo
Nome: qualquer nome de escolha
URI de redirecionamento: não necessário
Adicionar
audeemailupnàs declarações em "Declarações opcionais"
Etapa 2: registrar a mesma ID de um provedor OIDC no ServiceNow
Navegue até
System OAuth > Application Registry > New > Configure an OIDC providerverificar tokens de ID- Nome: qualquer nome de escolha
-
ID do cliente: o
client ID"Aplicativo A" criado na Etapa 1 - Segredo do cliente: isso não será realmente usado, qualquer valor pode ser definido
No formulário de registro do provedor OIDC, adicione uma nova configuração de provedor OIDC. Selecione o ícone de pesquisa no campo Configuração do Provedor OIDC OAuth para abrir os registros das configurações do OIDC, selecione "Novo".
- Provedor OIDC: ID do Microsoft Entra
-
URL de Metadados OIDC: a URL deve estar no formulário
https://login.microsoftonline.com/<tenantID>/.well-known/openid-configuration, substituirtenantIDporDirectory (tenant) ID - Período de vida do cache de configuração OIDC: 120
- Aplicativo: Global
- Declaração do usuário: oid
- Campo de usuário: ID do usuário
- Habilitar a verificação de declaração JTI: Desabilitado
Selecione "Enviar" e atualize o formulário de entidade OIDC OAuth
Etapa 3: registrar um "Aplicativo B" na ID do Microsoft Entra para Uso do Conector. Esse é o aplicativo que desempenha a função de um usuário com permissões elevadas na instância do ServiceNow
Navegue até
App registrations > New registrationcriar um novo aplicativo- Nome: qualquer nome de escolha
- Em Certificados &segredos, carregue o arquivo .cer do certificado em caso de certificado SNI, basta adicionar
trustedCertificateSubjectso manifesto do aplicativo com o relevanteauthorityIdesubjectName
Etapa 4: Criar um usuário do sistema no ServiceNow. Este é o "Aplicativo B" como um usuário na instância do ServiceNow
Navegue até
User Administration > Userscriar um novo usuário- ID do usuário: A ID do objeto da entidade de serviço de "Aplicativo B" criada na Etapa 3
- Verificar
Web service access only
Etapa 5: Conectar usando o Conector – Copilot Studio – Configuração do conector
Configure o conector com as seguintes informações e conecte-se:
- Nome da instância: o nome da instância do ServiceNow
- ID do locatário: A ID do locatário do Microsoft Entra
- ID do cliente: A ID do cliente do "Aplicativo B" criado na Etapa 3
- URI do recurso: A ID do cliente do "Aplicativo A" criado na Etapa 1 (não no URI do Aplicativo)
- Segredo do Certificado do Cliente: o arquivo .pfx do certificado criado na Etapa 3
- Senha do certificado: a senha do arquivo .pfx
Etapas para criar o logon do usuário do Microsoft Entra ID OAuth
Para configurar uma conexão de logon de usuário do Microsoft Entra ID OAuth, conclua as etapas 1 e 2, conforme descrito na seção de autenticação de certificado acima.
A etapa 1 permanece a mesma. Na Etapa 2, atualize a declaração de usuário para upn ou propriedade de declaração personalizada do token (para provedores de identidade de terceiros que não sejam o Entra) no ServiceNow. O campo de utilizador deve corresponder ao campo da tabela do utilizador do sistema ServiceNow que contém o upn ou o ID de utilizador.
As etapas 3 e 4 da seção de autenticação de certificado acima não são necessárias. Em vez disso, "Aplicativo B" nesse caso é um aplicativo 1p que é criado para o conector do ServiceNow. O aplicativo abaixo precisa receber permissões no "Aplicativo A".
ID do "Aplicativo B": c26b24aa-7874-4e06-ad55-7d06b1f79b63
Importante
Nesse cenário, o "Aplicativo B" deve usar a ID c26b24aa-7874-4e06-ad55-7d06b1f79b63 que é um aplicativo 1p pré-existente pertencente à Microsoft, não um aplicativo criado pelo usuário (como é necessário para criar uma conexão OAuth do Microsoft Entra ID usando o Certificado).
Ao criar a conexão para o conector do ServiceNow, o usuário precisa selecionar "Logon de Usuário do Microsoft Entra ID" como o tipo de autenticação e só precisa fornecer o nome da Instância do ServiceNow e a ID do recurso (que seria o identificador para "Aplicativo A"). Depois disso, o botão de entrada levará o usuário por meio do logon da ID do Entra usando sua própria conta.
Usando um provedor de identidade de terceiros ou incompatibilidades de dados existentes entre o usuário na ID do Entra e a tabela de usuários do ServiceNow
- Se houver uma incompatibilidade entre a propriedade do identificador de usuário no token de ID do Entra e o valor do identificador de usuário que está na tabela ServiceNow
- Por exemplo, o token contém o upn completo (juntamente com o domínio –
abc@contoso.com) e a tabela de usuários do ServiceNow contém apenas o identificador de usuário (abc). É recomendável adicionar um atributo personalizado ao token que contém um valor que corresponde ao identificador do usuário no identificador do ServiceNow aplicando uma fórmula e aproveitando essa nova propriedade para fazer o mapeamento de declaração na Etapa 2. - Documentação do Microsoft Learn que descreve o processo de adição de uma nova propriedade de declaração: https://learn.microsoft.com/entra/external-id/customers/how-to-add-attributes-to-token
- Por exemplo, o token contém o upn completo (juntamente com o domínio –
"Como configurar uma conexão do ServiceNow Power Platform que usa a ID do Microsoft Entra":
- ID externa Autenticação de Tokens (OIDC) para APIs Rest – Suporte e Resolução de Problemas
- Conector do Microsoft Graph do Catálogo do ServiceNow | Microsoft Learn
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Autenticação Básica | Entrar usando a autenticação básica | Todas as regiões | Não compartilhável |
| Microsoft Entra ID OAuth usando Certificado | OAuth com a ID do Microsoft Entra usando o certificado PFX. | Somente POWERPLATFORM | Compartilhável |
| Logon do usuário do Microsoft Entra ID | Fazer logon com as credenciais de ID do Microsoft Entra | Todas as regiões | Não compartilhável |
| Usar o Oauth2 | Entrar com o Oauth2 | Todas as regiões | Não compartilhável |
| Padrão [PRETERIDO] | Essa opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores. | Todas as regiões | Não compartilhável |
Autenticação Básica
ID de autenticação: basicAuthentication
Aplicável: todas as regiões
Entrar usando a autenticação básica
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Exemplo | cadeia | Nome da instância para service-now.com ou URL personalizada para a conta migrada | Verdade |
| Nome de usuário | cadeia | Nome de usuário para esta instância | Verdade |
| Senha | secureString | A senha dessa conta | Verdade |
Microsoft Entra ID OAuth com o Certificado
ID de autenticação: aadOAuthCert
Aplicável: somente POWERPLATFORM
OAuth com a ID do Microsoft Entra usando o certificado PFX.
Essa é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para obter mais informações, consulte a visão geral dos Conectores para aplicativos de tela – Power Apps | Microsoft Docs
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Nome da Instância | cadeia | O nome da instância usado para identificar a URL do Site do ServiceNow | Verdade |
| ID do locatário | cadeia | Verdade | |
| ID do cliente | cadeia | Verdade | |
| URI de recurso | cadeia | Verdade | |
| Segredo do certificado do cliente | clientCertificate | O segredo do certificado do cliente permitido por este aplicativo | Verdade |
Logon do usuário do Microsoft Entra ID
ID de autenticação: entraIDUserLogin
Aplicável: todas as regiões
Fazer logon com as credenciais de ID do Microsoft Entra
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| URI de recurso | cadeia | Verdade | |
| Nome da Instância | cadeia | O nome da instância usado para identificar a URL do Site do ServiceNow | Verdade |
Utilizar o Oauth2
ID de autenticação: oauth2ServiceNow
Aplicável: todas as regiões
Entrar com o Oauth2
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Nome da Instância | cadeia | O nome da instância usado para identificar a URL do Site do ServiceNow | Verdade |
| ID do cliente | cadeia | A ID usada para identificar esse aplicativo com o provedor de serviços | Verdade |
| Segredo do cliente | secureString | O segredo compartilhado usado para autenticar este aplicativo com o provedor de serviços | Verdade |
Padrão [PRETERIDO]
Aplicável: todas as regiões
Essa opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Exemplo | cadeia | Nome da instância para service-now.com ou URL personalizada para a conta migrada | Verdade |
| Nome de usuário | cadeia | Nome de usuário para esta instância | Verdade |
| Senha | secureString | A senha dessa conta | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 600 | 60 segundos |
Ações
| Atualizar registro |
Atualiza um registro para um tipo de objeto do ServiceNow, como 'Incidentes' |
| Carregar um anexo de arquivo de várias partes (versão prévia) |
Carregar um anexo de um formulário de várias partes |
| Carregar um arquivo binário como um anexo (versão prévia) |
Carrega um arquivo binário como um anexo para um registro especificado |
| Criar registro |
Crie um registro em uma tabela do ServiceNow. |
| Excluir Registro |
Exclui um registro para um tipo de objeto do ServiceNow como 'Incidentes |
| Excluir um anexo (versão prévia) |
Excluir um anexo |
| Item de pedido |
Ordena ou compra um item de catálogo específico. |
| Listar registros |
Obtém registros de um determinado tipo de objeto ServiceNow, como 'Incidentes' |
| Obter artigos de conhecimento |
Retorna uma lista de artigos da base de dados de conhecimento (KB) que podem ser pesquisados e filtrados |
| Obter categorias de catálogo |
Recupera a lista de categorias para um catálogo específico |
| Obter catálogos |
Recupera uma lista de catálogos |
| Obter item de catálogo |
Recupere um item de catálogo específico. |
| Obter itens de catálogo |
Recupera uma lista de itens de catálogo com base nos parâmetros especificados, como um texto de pesquisa ou um catálogo. |
| Obter metadados de anexo (versão prévia) |
Recuperar metadados para anexos |
| Obter registro |
Obtém um registro para um tipo de objeto ServiceNow como 'Incidents' |
| Obter tipos de registro |
Lista os tipos de registro disponíveis |
| Recuperar conteúdo do anexo (versão prévia) |
Recuperar o conteúdo do anexo |
| Recuperar metadados de anexo (versão prévia) |
Recuperar metadados de anexo |
Atualizar registro
Atualiza um registro para um tipo de objeto do ServiceNow, como 'Incidentes'
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
tableType | True | string |
Tipo de registro a ser listado |
|
ID do sistema
|
sysid | True | string |
ID do sistema para o registro. |
|
body
|
body | True | dynamic | |
|
Exibir referências do sistema
|
sysparm_display_value | boolean |
Determina se as referências do sistema devem ser incluídas |
|
|
Excluir links de referência
|
sysparm_exclude_reference_link | boolean |
Determina se os links de referência devem ser excluídos |
|
|
Fields
|
sysparm_fields | string |
Lista separada por vírgulas de campos a serem retornados. Exemplo: nome, email, telefone |
Retornos
Carregar um anexo de arquivo de várias partes (versão prévia)
Carregar um anexo de um formulário de várias partes
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do anexo
|
attachment_content | True | file |
Anexo a ser carregado |
|
Nome da tabela
|
table_name | True | string |
Nome da tabela à qual você deseja anexar o arquivo. |
|
ID da tabela
|
table_sys_id | True | string |
Sys_id do registro na tabela especificada à qual você deseja anexar o arquivo |
Retornos
- Corpo
- UploadAttachmentResponse
Carregar um arquivo binário como um anexo (versão prévia)
Carrega um arquivo binário como um anexo para um registro especificado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome da tabela
|
table_name | True | string |
Nome da tabela à qual você deseja anexar o arquivo |
|
Sys ID
|
table_sys_id | True | string |
Sys_id do registro na tabela especificada à qual você deseja anexar o arquivo |
|
Nome do Arquivo
|
file_name | True | string |
Nome para dar o anexo |
|
File
|
file | True | binary |
Arquivo binário a ser anexado ao registro especificado |
Retornos
- Corpo
- UploadAttachmentResponse
Criar registro
Crie um registro em uma tabela do ServiceNow.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
tableType | True | string |
Tipo de registro a ser listado |
|
body
|
body | True | dynamic | |
|
Exibir referências do sistema
|
sysparm_display_value | boolean |
Determina se as referências do sistema devem ser incluídas |
|
|
Excluir links de referência
|
sysparm_exclude_reference_link | boolean |
Determina se os links de referência devem ser excluídos |
|
|
Fields
|
sysparm_fields | string |
Lista separada por vírgulas de campos a serem retornados. Exemplo: nome, email, telefone |
Retornos
Excluir Registro
Exclui um registro para um tipo de objeto do ServiceNow como 'Incidentes
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
tableType | True | string |
Tipo de registro a ser listado |
|
ID do sistema
|
sysid | True | string |
ID do sistema para o registro. |
Excluir um anexo (versão prévia)
Excluir um anexo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Sys ID
|
sys_id | True | string |
Sys_id do anexo a ser excluído |
Item de pedido
Ordena ou compra um item de catálogo específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Item ID
|
sys_id | True | string |
O sys_id do item de catálogo a ser pedido |
|
Corpo do Item de Ordem
|
body | True | dynamic |
O corpo da solicitação do item de pedido. Ele contém a quantidade, o usuário solicitado e quaisquer variáveis adicionais exigidas pelo item de catálogo |
Retornos
- Corpo
- OrderItemResponse
Listar registros
Obtém registros de um determinado tipo de objeto ServiceNow, como 'Incidentes'
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
tableType | True | string |
Tipo de registro a ser listado |
|
Exibir referências do sistema
|
sysparm_display_value | boolean |
Determina se as referências do sistema devem ser incluídas |
|
|
Excluir links de referência
|
sysparm_exclude_reference_link | boolean |
Determina se os links de referência devem ser excluídos |
|
|
Query
|
sysparm_query | string |
Consulta codificada usada para filtrar o conjunto de resultados. Exemplo: active=true^ORDERBYnumber^ORDERBYDESCcategory |
|
|
Limit
|
sysparm_limit | integer |
Limite a ser aplicado na paginação. O padrão é 10000. |
|
|
Offset
|
sysparm_offset | integer |
Número de registros a serem excluídos da consulta. |
|
|
Fields
|
sysparm_fields | string |
Lista separada por vírgulas de campos a serem retornados. Exemplo: nome, email, telefone |
Retornos
Obter artigos de conhecimento
Retorna uma lista de artigos da base de dados de conhecimento (KB) que podem ser pesquisados e filtrados
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Fields
|
fields | string |
Lista separada por vírgulas de campos da tabela Conhecimento. |
|
|
Limit
|
limit | integer |
Número máximo de registros a serem retornados. |
|
|
Query
|
query | True | string |
Texto a ser pesquisado. |
|
Filter
|
filter | string |
Consulta codificada a ser usada para filtrar o conjunto de resultados. |
|
|
Kb
|
kb | string |
Lista separada por vírgulas de sys_ids de base de dados de conhecimento. |
Retornos
- Corpo
- GetArticlesResponse
Obter categorias de catálogo
Recupera a lista de categorias para um catálogo específico
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do catálogo
|
catalogId | True | string |
A ID do catálogo para o qual recuperar categorias |
|
Limit
|
sysparm_limit | integer |
Número de categorias de catálogo a serem recuperadas |
|
|
Offset
|
sysparm_offset | integer |
Deslocamento para a consulta |
Retornos
Obter catálogos
Recupera uma lista de catálogos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
sysparm_limit | integer |
Número de catálogos a serem recuperados |
|
|
Pesquisar Texto
|
sysparm_text | string |
Pesquisar texto para filtrar catálogos por nome ou descrição |
Retornos
- Corpo
- GetCatalogsResponse
Obter item de catálogo
Recupere um item de catálogo específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Item ID
|
sys_id | True | string |
O sys_id do item de catálogo a ser recuperado |
Retornos
- Corpo
- GetCatalogItemResponse
Obter itens de catálogo
Recupera uma lista de itens de catálogo com base nos parâmetros especificados, como um texto de pesquisa ou um catálogo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Categoria
|
sysparm_category | string |
A ID da categoria pela qual filtrar itens. Se não for especificado, todos os itens serão retornados. |
|
|
Limit
|
sysparm_limit | True | integer |
Número de itens de catálogo a serem recuperados |
|
Pesquisar Texto
|
sysparm_text | string |
Pesquisar texto para filtrar itens por |
|
|
Catalog
|
sysparm_catalog | string |
A ID do catálogo pela qual filtrar itens. Se não for especificado, os itens de todos os catálogos serão retornados |
Retornos
- Corpo
- GetCatalogItemsResponse
Obter metadados de anexo (versão prévia)
Recuperar metadados para anexos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
sysparm_limit | string |
Limite a ser aplicado na paginação. Observação: valores de sysparm_limit extraordinariamente grandes podem afetar o desempenho do sistema. Padrão: 1000 |
|
|
Offset
|
sysparm_offset | string |
Número de registros a serem excluídos da consulta. Use esse parâmetro para obter mais registros do que o especificado em sysparm_limit. Por exemplo, se sysparm_limit estiver definido como 500, mas houver registros adicionais que você deseja consultar, você poderá especificar um valor de sysparm_offset de 500 para obter o segundo conjunto de registros. Padrão: 0 |
|
|
Query
|
sysparm_query | string |
Consulta codificada. As consultas para a API de Anexo são relativas à tabela Anexos [sys_attachment]. Por exemplo: (sysparm_query=file_name=attachment.doc) |
Obter registro
Obtém um registro para um tipo de objeto ServiceNow como 'Incidents'
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
tableType | True | string |
Tipo de registro a ser listado |
|
ID do sistema
|
sysid | True | string |
ID do sistema para o registro. |
|
Exibir referências do sistema
|
sysparm_display_value | boolean |
Determina se as referências do sistema devem ser incluídas |
|
|
Excluir links de referência
|
sysparm_exclude_reference_link | boolean |
Determina se os links de referência devem ser excluídos |
|
|
Fields
|
sysparm_fields | string |
Lista separada por vírgulas de campos a serem retornados. Exemplo: nome, email, telefone |
Retornos
Obter tipos de registro
Recuperar conteúdo do anexo (versão prévia)
Recuperar o conteúdo do anexo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Sys ID
|
sys_id | True | string |
Sys_id do anexo para o qual recuperar o conteúdo |
Recuperar metadados de anexo (versão prévia)
Recuperar metadados de anexo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
sys_id | True | string |
Sys_id do anexo para recuperar metadados para |
Definições
UploadAttachmentResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
average_image_color
|
result.average_image_color | string |
Se o anexo for uma imagem, a soma de todas as cores. |
|
comprimido
|
result.compressed | string |
Sinalizador que indica se o arquivo de anexo foi compactado. |
|
content_type
|
result.content_type | string |
Tipo de conteúdo do arquivo de anexo associado, como imagem ou jpeg ou application/x-shockwave-flash. |
|
created_by_name
|
result.created_by_name | string |
Nome completo da entidade que originalmente criou o arquivo de anexo. |
|
download_link
|
result.download_link | string |
Baixe a URL do anexo na instância do ServiceNow. |
|
nome_do_arquivo
|
result.file_name | string |
Nome do arquivo do anexo. |
|
image_height
|
result.image_height | string |
Se um arquivo de imagem, a altura da imagem. Unidade: Pixels |
|
image_width
|
result.image_width | string |
Se um arquivo de imagem, a largura da imagem. Unidade: Pixels |
|
size_bytes
|
result.size_bytes | string |
Tamanho do anexo. Unidade: Bytes |
|
size_compressed
|
result.size_compressed | string |
Tamanho do anexo. Unidade: Bytes |
|
sys_created_by
|
result.sys_created_by | string |
Entidade que originalmente criou o arquivo de anexo. |
|
sys_created_on
|
result.sys_created_on | string |
Data e hora em que o arquivo de anexo foi salvo inicialmente na instância. |
|
sys_id
|
result.sys_id | string |
Sys_id do arquivo de anexo. |
|
sys_mod_count
|
result.sys_mod_count | string |
Número de vezes que o arquivo de anexo foi modificado (carregado na instância). |
|
sys_tags
|
result.sys_tags | string |
Todas as marcas do sistema associadas ao arquivo de anexo. |
|
sys_updated_by
|
result.sys_updated_by | string |
Todas as marcas do sistema associadas ao arquivo de anexo. |
|
sys_updated_on
|
result.sys_updated_on | string |
Data e hora em que o arquivo de anexo foi atualizado pela última vez. |
|
table_name
|
result.table_name | string |
Nome da tabela à qual o anexo está associado. |
|
table_sys_id
|
result.table_sys_id | string |
Sys_id da tabela associada ao anexo. |
|
updated_by_name
|
result.updated_by_name | string |
Nome completo da entidade que atualizou o arquivo de anexo pela última vez. |
GetTypesResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object |
Conjunto de resultados de todos os tipos de registro para a instância atual. |
|
Nome de exibição
|
result.label | string |
Nome de exibição do tipo de registro. |
|
Value
|
result.value | string |
Valor do tipo de registro. |
GetCatalogsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object | |
|
title
|
result.title | string | |
|
sys_id
|
result.sys_id | string | |
|
has_categories
|
result.has_categories | boolean | |
|
has_items
|
result.has_items | boolean | |
|
descrição
|
result.description | string | |
|
desktop_image
|
result.desktop_image | string |
GetCatalogCategoriesResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object | |
|
title
|
result.title | string | |
|
descrição
|
result.description | string | |
|
full_description
|
result.full_description | string | |
|
icon
|
result.icon | string | |
|
header_icon
|
result.header_icon | string | |
|
homepage_image
|
result.homepage_image | string | |
|
count
|
result.count | integer | |
|
Subcategorias
|
result.subcategories | array of object | |
|
sys_id
|
result.subcategories.sys_id | string | |
|
title
|
result.subcategories.title | string | |
|
sys_id
|
result.sys_id | string |
GetCatalogItemsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
resultado
|
result | array of object | |
|
short_description
|
result.short_description | string | |
|
kb_article
|
result.kb_article | string | |
|
icon
|
result.icon | string | |
|
descrição
|
result.description | string | |
|
availability
|
result.availability | string | |
|
mandatory_attachment
|
result.mandatory_attachment | boolean | |
|
request_method
|
result.request_method | string | |
|
tipo
|
result.type | string | |
|
visible_standalone
|
result.visible_standalone | boolean | |
|
local_currency
|
result.local_currency | string | |
|
sys_class_name
|
result.sys_class_name | string | |
|
sys_id
|
result.sys_id | string | |
|
content_type
|
result.content_type | string | |
|
preço
|
result.price | string | |
|
recurring_frequency
|
result.recurring_frequency | string | |
|
price_currency
|
result.price_currency | string | |
|
ordem
|
result.order | integer | |
|
make_item_non_conversational
|
result.make_item_non_conversational | boolean | |
|
proprietário
|
result.owner | string | |
|
show_price
|
result.show_price | boolean | |
|
recurring_price
|
result.recurring_price | string | |
|
show_quantity
|
result.show_quantity | boolean | |
|
imagem
|
result.picture | string | |
|
url
|
result.url | string | |
|
recurring_price_currency
|
result.recurring_price_currency | string | |
|
localized_price
|
result.localized_price | string | |
|
catalogs
|
result.catalogs | array of object | |
|
sys_id
|
result.catalogs.sys_id | string | |
|
ativo
|
result.catalogs.active | boolean | |
|
title
|
result.catalogs.title | string | |
|
nome
|
result.name | string | |
|
localized_recurring_price
|
result.localized_recurring_price | string | |
|
show_wishlist
|
result.show_wishlist | boolean | |
|
sys_id
|
result.category.sys_id | string | |
|
title
|
result.category.title | string | |
|
turn_off_nowassist_conversation
|
result.turn_off_nowassist_conversation | boolean | |
|
show_delivery_time
|
result.show_delivery_time | boolean |
GetCatalogItemResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
short_description
|
result.short_description | string |
short_description |
|
kb_article
|
result.kb_article | string |
kb_article |
|
icon
|
result.icon | string |
icon |
|
descrição
|
result.description | string |
descrição |
|
availability
|
result.availability | string |
availability |
|
mandatory_attachment
|
result.mandatory_attachment | boolean |
mandatory_attachment |
|
request_method
|
result.request_method | string |
request_method |
|
tipo
|
result.type | string |
tipo |
|
visible_standalone
|
result.visible_standalone | boolean |
visible_standalone |
|
sys_class_name
|
result.sys_class_name | string |
sys_class_name |
|
sys_id
|
result.sys_id | string |
sys_id |
|
content_type
|
result.content_type | string |
content_type |
|
ordem
|
result.order | integer |
ordem |
|
make_item_non_conversational
|
result.make_item_non_conversational | boolean |
make_item_non_conversational |
|
proprietário
|
result.owner | string |
proprietário |
|
show_price
|
result.show_price | boolean |
show_price |
|
show_quantity
|
result.show_quantity | boolean |
show_quantity |
|
imagem
|
result.picture | string |
imagem |
|
url
|
result.url | string |
url |
|
catalogs
|
result.catalogs | array of object |
catalogs |
|
sys_id
|
result.catalogs.sys_id | string |
sys_id |
|
ativo
|
result.catalogs.active | boolean |
ativo |
|
title
|
result.catalogs.title | string |
title |
|
nome
|
result.name | string |
nome |
|
show_wishlist
|
result.show_wishlist | boolean |
show_wishlist |
|
sys_id
|
result.category.sys_id | string |
sys_id |
|
title
|
result.category.title | string |
title |
|
turn_off_nowassist_conversation
|
result.turn_off_nowassist_conversation | boolean |
turn_off_nowassist_conversation |
|
show_delivery_time
|
result.show_delivery_time | boolean |
show_delivery_time |
|
categories
|
result.categories | array of object |
categories |
|
sys_id
|
result.categories.sys_id | string |
sys_id |
|
ativo
|
result.categories.active | boolean |
ativo |
|
sys_id
|
result.categories.category.sys_id | string |
sys_id |
|
ativo
|
result.categories.category.active | boolean |
ativo |
|
title
|
result.categories.category.title | string |
title |
|
title
|
result.categories.title | string |
title |
|
variables
|
result.variables | array of object |
variables |
|
ui_policy
|
result.ui_policy | array of |
ui_policy |
|
onChange
|
result.client_script.onChange | array of |
onChange |
|
onSubmit
|
result.client_script.onSubmit | array of |
onSubmit |
|
onLoad
|
result.client_script.onLoad | array of |
onLoad |
|
data_lookup
|
result.data_lookup | array of |
data_lookup |
|
variablesSchema
|
result.variablesSchema | object |
OrderItemResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
sys_id
|
result.sys_id | string |
sys_id |
|
número
|
result.number | string |
número |
|
request_number
|
result.request_number | string |
request_number |
|
request_id
|
result.request_id | string |
request_id |
|
tabela
|
result.table | string |
tabela |
GetArticlesResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contagem
|
meta.count | integer |
Número de artigos de KB disponíveis |
|
participante
|
meta.end | integer |
Índice final do conjunto de resultados |
|
Fields
|
meta.fields | string |
Campos no artigo |
|
Filter
|
meta.filter | string |
Filtro usado para adquirir os dados |
|
Kb
|
meta.kb | string |
Lista de artigos da base de dados de conhecimento sys_ids |
|
Linguagem
|
meta.language | string |
Lista de idiomas separados por vírgulas dos artigos de KB que foram solicitados |
|
Query
|
meta.query | string |
Consulta de solicitação especificada |
|
Start
|
meta.start | string |
Índice inicial do conjunto de resultados |
|
Situação
|
meta.status.code | string |
Status da chamada |
|
Kb
|
meta.ts_query_id | string |
Lista de idiomas separados por vírgulas dos artigos de KB que foram solicitados |
|
artigos
|
articles | array of object | |
|
Valor de Exibição
|
articles.fields.display_value | string |
Exibir o valor do campo solicitado |
|
Etiqueta
|
articles.fields.label | string |
Rótulo que representa o campo solicitado |
|
Nome
|
articles.fields.name | string |
Nome do campo solicitado |
|
Tipo
|
articles.fields.type | string |
Tipo de dados do campo solicitado |
|
Value
|
articles.fields.value | string |
Valor do campo solicitado |
|
Link
|
articles.Link | string |
Link para o artigo |
|
id
|
articles.id | string |
Artigo de conhecimento sys_id da tabela Conhecimento [kb_knowledge] |
|
Número
|
articles.number | string |
Artigo de conhecimento sys_id da tabela Conhecimento [kb_knowledge] |
|
Classificação
|
articles.rank | float |
Pesquisar classificação do artigo específico para esta pesquisa |
|
Score
|
articles.score | float |
Pontuação de relevância, resultados classificados em ordem decrescente por pontuação |
|
Fragmento
|
articles.snippet | string |
Texto mostrando uma pequena parte do artigo de conhecimento |
|
Title
|
articles.title | string |
Descrição curta ou título do artigo de conhecimento |