ServiceNow
O ServiceNow melhora os níveis de serviço, energiza os funcionários e permite que sua empresa trabalhe à velocidade da luz. Crie, leia e atualize registros armazenados no ServiceNow, incluindo Incidentes, Perguntas, Usuários e muito mais.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - China Cloud operado pela 21Vianet |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - China Cloud operado pela 21Vianet |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - China Cloud operado pela 21Vianet |
| Contato | |
|---|---|
| Nome | Microsoft |
| URL | https://learn.microsoft.com/connectors/service-now/ |
| Metadados do conector | |
|---|---|
| Editora | Microsoft |
| Sítio Web | https://www.servicenow.com/ |
| Política de privacidade | https://www.servicenow.com/privacy-statement.html |
| Categorias | Sítio Web |
Observação
A operação Get Knowledge Articles só pode ser usada quando o plug-in Knowledge API (sn_km_api) é ativado.
Problemas conhecidos e limitações
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 Service-Now limitações da API REST.
A ação Obter Registos pode devolver uma "Tabela Inválida" ou outro erro nas Power Apps. Para implementações de 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 suporta apenas URLs de instância que terminam com "service-now.com". Usar domínios alternativos como "servicenowservices.com" pode levar a erros de conexão. Nesses casos, particularmente ao trabalhar com um novo domínio ServiceNow no GCC, é recomendável usar a Autenticação Básica.
Se você encontrar um erro pop-up informando "redirect_uri inválido", copie o URL completo 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 do 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 ServiceNow Power Platform que usa a ID do Microsoft Entra
Existem dois tipos de conexão:
Microsoft Entra ID OAuth usando Certificado: Este é um tipo de autenticação baseado em token de aplicativo onde um aplicativo registrado no Entra ID pode ser usado para acessar o ServiceNow obtendo um token com o recurso definido como o aplicativo Entra ID representante do ServiceNow.
Microsoft Entra ID OAuth usando Login de Usuário: Este é um tipo de autenticação baseada em token de usuário onde 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 Entra ID representante do ServiceNow.
Etapas para criar uma conexão OAuth do Microsoft Entra ID usando o certificado
Passo 1: Registar uma "Aplicação A" no Microsoft Entra ID para integração OIDC com ServiceNow. Este é o aplicativo Entra ID representante do ServiceNow.
Ir para Registos de > aplicações Novo registo para criar um novo registo de aplicação
Nome: qualquer nome de escolha
URI de redirecionamento: não necessário
Adicione
aud,email&upnàs declarações em "Declarações opcionais"
Etapa 2: Registrar a mesma ID que um provedor OIDC no ServiceNow
Navegue até para
System OAuth > Application Registry > New > Configure an OIDC providerverificar tokens de ID- Nome: qualquer nome de escolha
-
ID do cliente: o
client IDde "Aplicativo A" criado na Etapa 1 - Segredo do cliente: este não será realmente usado, qualquer valor pode ser definido
No formulário de registro do provedor OIDC, adicione uma nova configuração do provedor OIDC. Selecione o ícone de pesquisa no campo OAuth OIDC Provider Configuration para abrir os registros de configurações OIDC, selecione "New".
- Provedor OIDC: Microsoft Entra ID
-
URL de metadados OIDC: O URL deve estar no formato
https://login.microsoftonline.com/<tenantID>/.well-known/openid-configuration, substituatenantIDporDirectory (tenant) ID - Tempo de vida útil do cache de configuração OIDC: 120
- Aplicação: Global
- Reivindicação do usuário: oid
- Campo de utilizador: ID de utilizador
- Ativar verificação de declaração JTI: Desativado
Selecione "Enviar" e atualize o formulário OAuth OIDC Entity
Etapa 3: Registre um "Aplicativo B" no Microsoft Entra ID para uso do conector. Este é o aplicativo que desempenha o papel de um usuário com permissões elevadas na instância ServiceNow
Navegue até para
App registrations > New registrationcriar um novo aplicativo- Nome: qualquer nome de escolha
- Em Certificados & segredos, carregue o arquivo de .cer do certificado Em caso de certificado SNI, basta adicionar
trustedCertificateSubjectsno manifesto do pedido com o correspondenteauthorityIdesubjectName
Etapa 4: Criar um usuário do sistema no ServiceNow. Este é o "Aplicativo B" como um usuário na instância ServiceNow
Navegue até para
User Administration > Userscriar um novo usuário- ID do usuário: o ID do objeto da entidade de serviço do "Aplicativo B" criado 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 de ServiceNow
- ID do locatário: a ID do locatário do locatário do Microsoft Entra
- ID do cliente: O ID do cliente do "Aplicativo B" criado na Etapa 3
- URI DO RECURSO: O ID do cliente do "Aplicativo A" criado na Etapa 1 (não o 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 login de usuário do Microsoft Entra ID OAuth
Para configurar uma conexão de Login de Usuário OAuth do Microsoft Entra ID, conclua as Etapas 1 e 2 conforme descrito na seção de autenticação de certificado acima.
O passo 1 permanece o mesmo. Na Etapa 2, atualize a declaração do usuário para Upn ou propriedade de declaração personalizada do token (para provedores de identidade de terceiros que nã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", neste caso, é um aplicativo 1p que é criado para o conector ServiceNow. O aplicativo abaixo precisa receber permissões no "Aplicativo A".
ID da "Aplicação B": c26b24aa-7874-4e06-ad55-7d06b1f79b63
Importante
Neste cenário, o "Aplicativo B" deve usar a ID c26b24aa-7874-4e06-ad55-7d06b1f79b63 que é um aplicativo 1p pré-existente de propriedade da 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 ServiceNow, o usuário precisa selecionar "Microsoft Entra ID User Login" como o tipo de autenticação e só precisa fornecer o nome da instância ServiceNow e o ID do recurso (que seria o identificador para "Aplicativo A"). Depois disso, o botão de login levará o usuário através do login do Entra ID usando sua própria conta.
Usando um provedor de identidade de 3ª Parte ou incompatibilidades de dados existentes entre o usuário no Entra ID 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 (junto com o domínio –
abc@contoso.com) e a tabela de usuários 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 de usuário no identificador ServiceNow aplicando uma fórmula e, em seguida, 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 (junto com o domínio –
"Como configurar uma conexão ServiceNow Power Platform que usa o Microsoft Entra ID" referências:
- ID externo a Autenticação de Tokens (OIDC) para APIs Rest – Suporte e Resolução de Problemas
- Catálogo ServiceNow Conector Microsoft Graph | Microsoft Learn
A criar uma ligação
O conector suporta os 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 Microsoft Entra ID usando certificado PFX. | Apenas POWERPLATFORM | Compartilhável |
| Login de usuário do Microsoft Entra ID | Login com credenciais do Microsoft Entra ID | Todas as regiões | Não compartilhável |
| Use Oauth2 | Iniciar sessão com Oauth2 | Todas as regiões | Não compartilhável |
| Padrão [DEPRECATED] | Esta 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
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Instância | cadeia (de caracteres) | Nome da instância para service-now.com ou URL personalizada para a conta migrada | Verdade |
| Nome de utilizador | cadeia (de caracteres) | Nome de usuário para esta instância | Verdade |
| Palavra-passe | securestring | A palavra-passe desta conta | Verdade |
Microsoft Entra ID OAuth com o Certificado
ID da autenticação: aadOAuthCert
Aplicável: apenas POWERPLATFORM
OAuth com Microsoft Entra ID usando certificado PFX.
Esta é 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 de conectores para aplicativos de tela - Power Apps | Documentos Microsoft
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Nome da instância | cadeia (de caracteres) | O nome da instância usado para identificar o URl do Site ServiceNow | Verdade |
| ID do inquilino | cadeia (de caracteres) | Verdade | |
| ID do Cliente | cadeia (de caracteres) | Verdade | |
| URI do recurso | cadeia (de caracteres) | Verdade | |
| Segredo do certificado do cliente | certificado do cliente | O segredo do certificado do cliente permitido por este aplicativo | Verdade |
Login de usuário do Microsoft Entra ID
ID de autenticação: entraIDUserLogin
Aplicável: Todas as regiões
Login com credenciais do Microsoft Entra ID
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| URI do recurso | cadeia (de caracteres) | Verdade | |
| Nome da instância | cadeia (de caracteres) | O nome da instância usado para identificar a URL do Site ServiceNow | Verdade |
Utilizar o Oauth2
ID de autenticação: oauth2ServiceNow
Aplicável: Todas as regiões
Iniciar sessão com Oauth2
Esta conexão não é compartilhável. Se o aplicativo avançado 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 (de caracteres) | O nome da instância usado para identificar o URl do Site ServiceNow | Verdade |
| ID de Cliente | cadeia (de caracteres) | O ID usado para identificar este 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 [DEPRECATED]
Aplicável: Todas as regiões
Esta 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.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Instância | cadeia (de caracteres) | Nome da instância para service-now.com ou URL personalizada para a conta migrada | Verdade |
| Nome de utilizador | cadeia (de caracteres) | Nome de usuário para esta instância | Verdade |
| Palavra-passe | securestring | A palavra-passe desta conta | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 600 | 60 segundos |
Ações
| Atualizar Registo |
Atualiza um registro para um tipo de objeto ServiceNow como 'Incidentes' |
| Carregar um anexo de ficheiro com várias partes (Pré-visualização) |
Carregar um anexo a partir de um formulário com várias partes |
| Carregar um ficheiro binário como anexo (Pré-visualização) |
Carrega um arquivo binário como um anexo para um registro especificado |
| Criar registo |
Crie um registro em uma tabela ServiceNow. |
| Eliminar um anexo (Pré-visualização) |
Excluir um anexo |
| Excluir registro |
Exclui um registro para um tipo de objeto ServiceNow como 'Incidentes |
| Item de pedido |
Encomenda ou compra um item de catálogo específico. |
| Listar Registos |
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 anexos (visualização) |
Recuperar metadados para anexos |
| Obter Registo |
Obtém um registro para um tipo de objeto ServiceNow como 'Incidentes' |
| Obter tipos de registro |
Lista os tipos de registro disponíveis |
| Recuperar conteúdo de anexo (Pré-visualização) |
Recuperar conteúdo de anexo |
| Recuperar metadados de anexos (Pré-visualização) |
Recuperar metadados de anexos |
Atualizar Registo
Atualiza um registro para um tipo de objeto ServiceNow como 'Incidentes'
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registo
|
tableType | True | string |
Tipo de registo a listar |
|
ID do sistema
|
sysid | True | string |
ID do sistema para o registro. |
|
body
|
body | True | dynamic | |
|
Referências do sistema de exibição
|
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 |
|
|
Campos
|
sysparm_fields | string |
Lista separada por vírgulas dos campos a serem retornados. Exemplo: nome,e-mail,telefone |
Devoluções
Carregar um anexo de ficheiro com várias partes (Pré-visualização)
Carregar um anexo a partir de um formulário com várias partes
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo do anexo
|
attachment_content | True | file |
Anexo a carregar |
|
Nome da tabela
|
table_name | True | string |
Nome da tabela à qual pretende anexar o ficheiro. |
|
Id da tabela
|
table_sys_id | True | string |
Sys_id do registro na tabela especificada à qual você deseja anexar o arquivo |
Devoluções
Carregar um ficheiro binário como anexo (Pré-visualização)
Carrega um arquivo binário como um anexo para um registro especificado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da tabela
|
table_name | True | string |
Nome da tabela à qual pretende anexar o ficheiro |
|
ID do sistema
|
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 a fornecer ao anexo |
|
Ficheiro
|
file | True | binary |
Arquivo binário a ser anexado ao registro especificado |
Devoluções
Criar registo
Crie um registro em uma tabela ServiceNow.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registo
|
tableType | True | string |
Tipo de registo a listar |
|
body
|
body | True | dynamic | |
|
Referências do sistema de exibição
|
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 |
|
|
Campos
|
sysparm_fields | string |
Lista separada por vírgulas dos campos a serem retornados. Exemplo: nome,e-mail,telefone |
Devoluções
Eliminar um anexo (Pré-visualização)
Excluir um anexo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do sistema
|
sys_id | True | string |
Sys_id do anexo a eliminar |
Excluir registro
Exclui um registro para um tipo de objeto ServiceNow como 'Incidentes
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registo
|
tableType | True | string |
Tipo de registo a listar |
|
ID do sistema
|
sysid | True | string |
ID do sistema para o registro. |
Item de pedido
Encomenda ou compra um item de catálogo específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Item ID
|
sys_id | True | string |
A sys_id do item de catálogo a ser encomendado |
|
Corpo do item de pedido
|
body | True | dynamic |
O corpo da solicitação de item de ordem. Ele contém a quantidade, o usuário solicitado e quaisquer variáveis adicionais exigidas pelo item de catálogo |
Devoluções
- Body
- OrderItemResponse
Listar Registos
Obtém registros de um determinado tipo de objeto ServiceNow, como 'Incidentes'
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registo
|
tableType | True | string |
Tipo de registo a listar |
|
Referências do sistema de exibição
|
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: ative=true^ORDERBYnumber^ORDERBYDESCcategory |
|
|
Limite
|
sysparm_limit | integer |
Limite a ser aplicado na paginação. O padrão é 10000. |
|
|
Compensação
|
sysparm_offset | integer |
Número de registos a excluir da consulta. |
|
|
Campos
|
sysparm_fields | string |
Lista separada por vírgulas dos campos a serem retornados. Exemplo: nome,e-mail,telefone |
Devoluções
Obter artigos de conhecimento
Retorna uma lista de artigos da base de dados de conhecimento (KB) que podem ser pesquisados e filtrados
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Campos
|
fields | string |
Lista de campos separados por vírgulas da tabela Conhecimento. |
|
|
Limite
|
limit | integer |
Número máximo de registos a devolver. |
|
|
Query
|
query | True | string |
Texto para pesquisar. |
|
Filter
|
filter | string |
Consulta codificada a ser usada para filtrar o conjunto de resultados. |
|
|
Kb
|
kb | string |
Lista separada por vírgulas da base de dados de conhecimento sys_ids. |
Devoluções
- Body
- GetArticlesResponse
Obter categorias de catálogo
Recupera a lista de categorias para um catálogo específico
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do catálogo
|
catalogId | True | string |
A id do catálogo para o qual recuperar categorias |
|
Limite
|
sysparm_limit | integer |
Número de categorias de catálogo a serem recuperadas |
|
|
Compensação
|
sysparm_offset | integer |
Deslocamento para a consulta |
Devoluções
Obter catálogos
Recupera uma lista de catálogos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
sysparm_limit | integer |
Número de catálogos a recuperar |
|
|
Pesquisar Texto
|
sysparm_text | string |
Pesquisar texto para filtrar catálogos por nome ou descrição |
Devoluções
- Body
- GetCatalogsResponse
Obter item de catálogo
Recupere um item de catálogo específico.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Item ID
|
sys_id | True | string |
A sys_id do item de catálogo a ser recuperado |
Devoluções
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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Categoria
|
sysparm_category | string |
O ID da categoria pelo qual filtrar itens. Se não for especificado, todos os itens serão devolvidos. |
|
|
Limite
|
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 |
Devoluções
Obter metadados de anexos (visualização)
Recuperar metadados para anexos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Limite
|
sysparm_limit | string |
Limite a ser aplicado na paginação. Nota: Valores de sysparm_limit anormalmente grandes podem afetar o desempenho do sistema. Padrão: 1000 |
|
|
Compensação
|
sysparm_offset | string |
Número de registos a excluir 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ê pode 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 Registo
Obtém um registro para um tipo de objeto ServiceNow como 'Incidentes'
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registo
|
tableType | True | string |
Tipo de registo a listar |
|
ID do sistema
|
sysid | True | string |
ID do sistema para o registro. |
|
Referências do sistema de exibição
|
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 |
|
|
Campos
|
sysparm_fields | string |
Lista separada por vírgulas dos campos a serem retornados. Exemplo: nome,e-mail,telefone |
Devoluções
Obter tipos de registro
Recuperar conteúdo de anexo (Pré-visualização)
Recuperar conteúdo de anexo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do sistema
|
sys_id | True | string |
Sys_id do anexo para recuperar conteúdo para |
Recuperar metadados de anexos (Pré-visualização)
Recuperar metadados de anexos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
sys_id | True | string |
Sys_id do anexo para recuperar metadados para |
Definições
UploadAttachmentResponse
| Name | 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 anexo foi compactado. |
|
content_type
|
result.content_type | string |
Tipo de conteúdo do arquivo anexo associado, como imagem ou jpeg ou aplicativo/x-shockwave-flash. |
|
created_by_name
|
result.created_by_name | string |
Nome completo da entidade que criou originalmente o ficheiro anexo. |
|
download_link
|
result.download_link | string |
URL de download do anexo na instância ServiceNow. |
|
nome_do_ficheiro
|
result.file_name | string |
Nome do ficheiro 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 anexo. |
|
sys_created_on
|
result.sys_created_on | string |
Data e hora em que o arquivo anexo foi inicialmente salvo na instância. |
|
sys_id
|
result.sys_id | string |
Sys_id do ficheiro anexo. |
|
sys_mod_count
|
result.sys_mod_count | string |
Número de vezes que o arquivo anexo foi modificado (carregado para a instância). |
|
sys_tags
|
result.sys_tags | string |
Todas as tags do sistema associadas ao arquivo anexo. |
|
sys_updated_by
|
result.sys_updated_by | string |
Todas as tags do sistema associadas ao arquivo anexo. |
|
sys_updated_on
|
result.sys_updated_on | string |
Data e hora em que o ficheiro 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 anexo pela última vez. |
GetTypesResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Resultado
|
result | array of object |
Conjunto de resultados de todos os tipos de registro para instância atual. |
|
Nome de exibição
|
result.label | string |
Nome para exibição do tipo de registro. |
|
Valor
|
result.value | string |
Valor do tipo de registo. |
GetCatalogsResponse
| Name | 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
| Name | 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
| Name | 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 | |
|
disponibilidade
|
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 | |
|
order
|
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 | |
|
active
|
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
| Name | 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 |
|
disponibilidade
|
result.availability | string |
disponibilidade |
|
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 |
|
order
|
result.order | integer |
order |
|
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 |
|
active
|
result.catalogs.active | boolean |
active |
|
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 |
|
active
|
result.categories.active | boolean |
active |
|
sys_id
|
result.categories.category.sys_id | string |
sys_id |
|
active
|
result.categories.category.active | boolean |
active |
|
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 |
|
emAlterar
|
result.client_script.onChange | array of |
emAlterar |
|
emEnviar
|
result.client_script.onSubmit | array of |
emEnviar |
|
onCarregar
|
result.client_script.onLoad | array of |
onCarregar |
|
data_lookup
|
result.data_lookup | array of |
data_lookup |
|
variablesSchema
|
result.variablesSchema | object |
OrderItemResponse
| Name | 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 |
|
id_de_pedido
|
result.request_id | string |
id_de_pedido |
|
tabela
|
result.table | string |
tabela |
GetArticlesResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Contar
|
meta.count | integer |
Número de artigos da Base de Dados de Conhecimento disponíveis |
|
Fim
|
meta.end | integer |
Índice final do conjunto de resultados |
|
Campos
|
meta.fields | string |
Campos no artigo |
|
Filter
|
meta.filter | string |
Filtro usado para adquirir os dados |
|
Kb
|
meta.kb | string |
Lista de sys_ids de artigos da base de dados de conhecimento |
|
Linguagem
|
meta.language | string |
Lista de idiomas separados por vírgulas dos artigos da Base de Dados de Conhecimento 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 |
Estado da chamada |
|
Kb
|
meta.ts_query_id | string |
Lista de idiomas separados por vírgulas dos artigos da Base de Dados de Conhecimento solicitados |
|
artigos
|
articles | array of object | |
|
Valor de exibição
|
articles.fields.display_value | string |
Exibir valor do campo solicitado |
|
Etiqueta
|
articles.fields.label | string |
Etiqueta 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 |
|
Valor
|
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 Knowledge [kb_knowledge] |
|
Número
|
articles.number | string |
Artigo de conhecimento sys_id da tabela Knowledge [kb_knowledge] |
|
Classificação
|
articles.rank | float |
Classificação de pesquisa do artigo específico para esta pesquisa |
|
Score
|
articles.score | float |
Pontuação de relevância, resultados ordenados por ordem decrescente por pontuação |
|
Trechos
|
articles.snippet | string |
Texto mostrando uma pequena parte do artigo de conhecimento |
|
Title
|
articles.title | string |
Breve descrição ou título do artigo de conhecimento |