ServiceNow® As APIs permitem que você crie aplicações e experiências personalizadas. As APIs foram aprimoradas e atualizadas no Zurich versão.
Destaques da API para Zurich versão
- Use APIs JavaScript do lado do servidor em scripts para mudar a funcionalidade da aplicação.
- Execute APIs de cliente sempre que ocorrer um evento baseado em cliente, como quando um formulário é carregado, um formulário é enviado ou um valor de campo é alterado.
- Use REST APIs de entrada para interagir com vários ServiceNow funcionalidades em sua aplicação.
- As APIs do Client Next Experience incluem APIs de cliente compatíveis com a IU do Next Experience.
Para obter mais informações, consulte API implementation and reference.
Novidades da versão Zurich
Tabela 1. Novas classes com escopo e métodos adicionais para as classes com escopo existentes em Zurich
| Classe |
Métodos |
| GlideCurrencyCode - Scoped, Global |
- GetCurrencyCode()
- GetNumericCurrencyCode()
|
| GlideCurrencySymbol - Scoped, Global |
- GetCurrencySymbol()
- GetSymbols ActiveClassificadosCurrencyCurrencySymbols()
|
| GlideRecord - Scoped |
AddUserQuery() |
| GlideSysAttachment - Scoped |
- AddAttribute()
- AddMultipleAttributes()
- DeleteAllAtributos()
- DeleteAttribute()
- FetchAllAtributos()
- FetchAttribute()
- UpdateAllAtributos()
- UpdateAttribute()
|
| GlideSystem - Scoped |
Adicionado suporte para tipos de mensagem adicionais a serem exibidos na parte superior dos formulários:
- AddHighMessage()
- AddLowMessage()
- AddSuccessMessage()
- AddModerateMessage()
|
Tabela 2. Novas classes globais e métodos adicionais para classes globais existentes em Zurich
| Classe |
Métodos |
| GlideRecord - Global |
AddUserQuery() |
| GlideSysAttachment - Global |
- AddAttribute()
- AddMultipleAttributes()
- DeleteAllAtributos()
- DeleteAttribute()
- FetchAllAtributos()
- FetchAttribute()
- UpdateAllAtributos()
- UpdateAttribute()
|
| GlideSystem - Global |
Adicionado suporte para tipos de mensagem adicionais a serem exibidos na parte superior dos formulários:
- AddHighMessage()
- AddLowMessage()
- AddModerateMessage()
- AddSuccessMessage()
|
| Message - Global |
Recupera mensagens localizadas da tabela Mensagem [sys_ui_message]. Ele oferece suporte à internacionalização (i18n) buscando mensagens dinamicamente com base no idioma da sessão do usuário ou em um parâmetro de idioma especificado.
- GetMessage()
- GetMessageLang()
|
Tabela 3. Novas classes de cliente e métodos adicionais para as classes de cliente existentes em Zurich
| Classe |
Métodos |
| GlideForm (g_form) - Client |
- AddChoice()
- AddHighMessage()
- AddLowMessage()
- AddModerateMessage()
- AddSuccessMessage()
- ClearChoices()
- DisableChoice()
- EnableChoice()
- ObAnotaçãoByName()
- GetAnotações()
- GetChoice()
- GetOptions()
- HideAnotação()
- HideRelacionadosLinks()
- HideTemplateBar()
- RemoveChoice()
- SetChoiceLabel()
- SetLinkedRelatedDisplay()
- ShowAnotação()
- MostrarLinks Relacionados()
- ShowTemplateBar()
- ToggleAnotações()
|
| GlideModal (Next Experience) - Client |
- destruir()
- get()
- GetID()
- GetPreference()
- GetPreferences()
- RenderWithContent (objeto)
- RenderWithContent (cadeia de caracteres)
- SetDialog()
- SetPreference()
- SetTitle()
- tipo ()
|
| GlideNavigation (Next Experience) - Client |
RefreshNavigator() |
| StopWatch (Next Experience) - Client |
- Cronômetro()
- GetTime()
- restart()
- ToString()
|
| GlideForm (Next Experience) - Client |
- AddChoice()
- AddHighMessage()
- AddLowMessage()
- AddModerateMessage()
- AddSuccessMessage()
- ClearChoices()
- DisableChoice()
- EnableChoice()
- ObAnotaçãoByName()
- GetAnotações()
- GetChoice()
- GetOptions()
- HideAnotação()
- RemoveChoice()
- SetChoiceLabel()
- ShowAnotação()
- ToggleAnotações()
|
| GlideUser (Next Experience) - Client |
GetRoles() |
Tabela 4. Novas REST APIs e endpoints adicionais para REST APIs existentes em Zurich
| API |
Endpoints |
| Conversation Member API |
- COLOQUE now/conversation/member/user_id/drop
- COLOQUE now/conversation/member/user_id/update
|
| Omnichannel Callback API |
- POST /api/sn_omni_callback/callback/attempt
- POST /api/sn_omni_callback/callback/create
- PATCH /api/sn_omni_callback/callback/update
|
Tabela 5. Novas REST APIs e endpoints adicionais para REST APIs existentes no ServiceNow Store
| Aplicação |
Versão do app |
API |
Endpoints |
| Inventário de rede avançado |
10.0 |
DCIM Metric Data Feed API |
PUBLICAR /api/sn_ni_adv/dcim/feed/ |
| Gestão de orçamentos |
6.0.1 |
Quote Management API |
- EXCLUA /sn_tmf_api/quote_management_api/quote/
- OBTENHA /sn_tmf_api/quote_management_api/quote
- OBTENHA /sn_tmf_api/quote_management_api/quote/
- PATCH /sn_tmf_api/quote_management_api/quote/
- PUBLICAR /sn_tmf_api/quote_management_api/quote
|
| Telecomunicações em aberto |
4.1.1 |
Work Order Management API |
- /Sn_tmf_api/work_order_management_api/cancelWorkOrder
- OBTENHA /sn_tmf_api/work_order_management_api/workordermanagement
- OBTENHA /sn_tmf_api/work_order_management_api/workorder/
- PATCH /sn_tmf_api/work_order_management_api/Workorder/
- PUBLICAR /sn_tmf_api/work_order_management_api/Workorder
|
Alterado nesta versão
Tabela 6. Classes com escopo alteradas em Zurich
| Classe |
Métodos |
| GlideSysAttachment - Scoped |
Suporte para copiar atributos de registros de anexo de origem e excluir atributos com anexos.
- copiar()
- Cópia (targetFieldName)
- CopyAttachsPorFieldNames()
- DeleteAllAttachment()
- DeleteAttachment()
|
| IdentificationEngine - Scoped |
Habilite o. referenceItemsPropriedades da carga de entrada a ser preenchida antes de identificar um IC usando as regras de IRE definidas em uma classe.
- OrUpdateCI()
- CriarOrUpdateCIEnhanced()
- IdentifyCIEnhanced()
|
| ProducerV2 - Scoped |
Send() - Adicionado um valor de retorno e tratamento de erros. |
| RESTMessageV2 - Scoped, Global |
SetHtttpMethod() - Adicionado suporte para chamadas de método HEAD por meio de methodparâmetro. |
Tabela 7. Classes globais alteradas em Zurich
| Classe |
Métodos |
| GlideSysAttachment - Global |
Suporte para copiar atributos de registros de anexo de origem e excluir atributos com anexos.
- copiar()
- Cópia (targetFieldName)
- CopyAttachsPorFieldNames()
- DeleteAllAttachment()
- DeleteAttachment()
|
| IdentificationEngineScriptableApi - Global |
Habilite o. referenceItemsPropriedades da carga de entrada a ser preenchida antes de identificar um IC usando as regras de IRE definidas em uma classe.
- OrUpdateCI()
- CriarOrUpdateCIEnhanced()
- IdentifyCIEnhanced()
|
| RESTMessageV2 - Scoped, Global |
SetHtttpMethod() - Adicionado suporte para chamadas de método HEAD por meio de methodparâmetro. |
Tabela 8. REST APIs alteradas no ServiceNow Store
| Aplicação |
Versão do app |
API |
Endpoints |
| Processamento de faturas de contas a pagar |
v9.5.17 |
AP Invoice API |
Os seguintes endpoints agora oferecem suporte a anexos:
- PUBLIQUE sn_spend_intg/ap_invoice/json
- PUBLIQUE sn_spend_intg/ap_invoice/xml
|
| Telecomunicações em aberto |
v4.1.1 |
Service Order Open API |
Os endpoints a seguir agora são compatíveis com tipos de valor de característica de serviço complexos por meio de serviceOrderItem.service.serviceCharacteristic.valueTypeparâmetro:
- OBTENHA /sn_tmf_api/order/serviceOrder
- OBTENHA /sn_tmf_api/order/serviceOrder/
- PATCH /sn_tmf_api/order/serviceOrder/
- PUBLICAR /sn_tmf_api/order/serviceOrder
|
| Telecomunicações em aberto |
v4.1.1 |
Product Catalog Open API |
Os endpoints de especificação de produto a seguir são atualizados para oferecer suporte a tipos de valor de característica de especificação de produto complexos por meio do productSpecCharacteristic.valueType parâmetro:
- POST /sn_tmf_api/catalogmanagement/productSpecification
- PATCH /sn_tmf_api/catalogmanagement/productSpecification/
- OBTENHA /sn_tmf_api/catalogmanagement/productSpecification/
- OBTENHA /sn_tmf_api/catalogmanagement/productSpecification
|
| Telecomunicações em aberto |
v4.1.1 |
Product Inventory Open API |
Os endpoints a seguir agora são compatíveis com tipos de valor de característica de produto complexos por meio de productCharacteristic.valueTypeparâmetro:
- OBTENHA /sn_prd_invt/product
- OBTENHA /sn_prd_invt/product/id
- OBTENHA /sn_prd_invt/productinventory
- OBTENHA /sn_prd_invt/productinventory/
- PUBLICAR /sn_prd_invt/product
- PUBLICAR /sn_prd_invt/productinventory
|
| Telecomunicações em aberto |
v4.1.1 |
Product Order Open API |
Os endpoints a seguir agora são compatíveis com tipos de valor de característica de produto complexos por meio de productOrderItem.product.productCharacteristic.valueTypeparâmetro:
- OBTENHA /sn_ind_tmt_orum/order/product Order
- OBTENHA /sn_ind_tmt_orn/order/product Order/
- OBTENHA /sn_ind_tmt_orn/productorder
- OBTENHA /sn_ind_tmt_orn/productorder/
- PATCH /sn_ind_tmt_orn/order/product Order/
- PATCH /sn_ind_tmt_orn/productOrder/
- PUBLICAR /sn_ind_tmt_orum/order/product Order
- PUBLICAR /sn_ind_tmt_orum/productOrder
|
| API do Virtual Agent |
v4.0.0 |
Virtual Agent Bot Integration API |
Novas opções para actionparâmetro do corpo da solicitação com exemplos correspondentes. PUBLICAR /sn_va_as_service/bot/integration |
Descontinuações
- . GlideEncrypter A API não oferece mais suporte ao padrão de criptografia de dados triplo (3DES) devido à atualização NIST 800-131A Rev 2 diretrizes.
- Para instâncias existentes que fazem upgrade para Zurich versão, o. GlideEncrypter A API está disponível para uso, mas foi atualizada para usar automaticamente o. Estrutura de gestão principal algoritmo. Consulte GlideEncrypter - Global (deprecated) Para obter mais informações sobre como continuar chamando esta API.
- Para todas as novas instâncias criadas a partir do Zurich versão, o. GlideEncrypter A API não é mais compatível. Diretamente use Key Management Framework em vez disso, para todas as operações de criptografia.
- Grupos dinâmicos foram removidos do esquema dinâmico na plataforma principal. Para atributos dinâmicos definidos com um grupo de atributos dinâmicos associado antes de Zurich dois métodos originalmente projetados para grupos de atributos dinâmicos continuam a funcionar para compatibilidade com versões anteriores.
Esses métodos retornam nulo para atributos migrados e atributos recém-criados.
Os clientes são solicitados a migrar para o atual Atributo dinâmico definições para aproveitar as melhorias futuras em recursos e funcionalidades. Para obter detalhes de migração, consulte Guia de migração do Zurich de esquema dinâmico [KB2146133] artigo na Base de conhecimento do Now Support.
Informações de ativação
As seguintes APIs estão disponíveis por padrão:
- Identificação e Reconciliação
- IdentificationEngine
- IdentificationEngineScriptableApi
- GlideCurrencyCode
- GlideCurrencySymbol
- GlideForm (Next Experience)
- GlideModal (Next Experience)
- GlideNavigation (Next Experience)
- GlideRecord
- GlideSysAttachment
- GlideUser (Next Experience)
- Cronômetro (Next Experience)
As seguintes APIs exigem ativação de plug-in:
- ProdutorV2 Requer o plug-in ServiceNow Stream Connect Installer (com.glide.hub.stream_connect.installer).
- Pedido de produto em aberto A API requer o plug-in Gestão de pedidos para telecomunicações (sn_ind_tmt_orum).
- Ordem de serviço aberta A API requer o plug-in Gestão de pedidos para telecomunicações (sn_ind_tmt_orum).