ServiceNow® As APIs permitem criar aplicações e experiências personalizadas. As APIs foram aprimoradas e atualizadas na versão Yokohama.
Destaques da API para a versão Yokohama
- Use as APIs JavaScript do lado do servidor em scripts para mudar a funcionalidade da aplicação.
- Execute as APIs do cliente sempre que ocorrer um evento baseado no 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árias funcionalidades ServiceNow em sua aplicação.
Para obter mais informações, consulte API implementation and reference.
Novo na versão Yokohama
Tabela 1. Novas classes com escopo e métodos adicionais para classes com escopo existentes em Yokohama
| Classe |
Métodos |
| Console - Scoped, Global |
- erro ()
- grupo ()
- groupCollapsedString()
- groupEnd()
- info()
- log ()
- tabela ()
- tempo ()
- timeEnd ()
- timeLog()
- rastreamento ()
- aviso ()
|
| Fetch - Scoped, Global |
buscar () |
| Fetch Headers - Scoped, Global |
- Cabeçalhos ()
- anexar ()
- excluir ()
- entradas ()
- paraCada()
- obter ()
- getSetCookie()
- tem ()
- chaves ()
- definir ()
- valores ()
|
| Fetch Request - Scoped, Global |
- Solicitação ()
- arrayBuffer()
- blob()
- bytes ()
- clone()
- dadosformulário ()
- json()
- texto ()
|
| Fetch RequestInit - Scoped, Global |
requestInit() |
| Fetch Response - Scoped,Global |
- arrayBuffer()
- blob()
- bytes ()
- dadosformulário ()
- json()
- texto ()
|
| GlideUser - Scoped |
- getTimeZoneLabel()
- getTimeZoneLabelLang()
|
| OrderUtil - Scoped |
- getStateFromOrder()
- isOrderInDraftState()
|
| PDFGenerationAPI - Scoped, Global |
- convertToPDFAsync()
- convertToPDFWithHeaderFooterAsync()
|
| ProcessMiningIntegrationAPI - Scoped |
- criarProjeto()
- excluirProjeto()
- getBreakDownStats()
- getFindings()
- getMiningStatus()
- getProject()
- scheduleMining()
|
| RESTMessageV2 - Scoped, Global |
setAllowedRedirectURIs() |
| SOAPMessageV2 - Scoped, Global |
- setAllowedRedirectURIs()
- definirFollowRedirect()
|
| UriMatcher - Scoped |
- UriMatcher()
- correspondência ()
|
| UriMatcherResponse - Scoped |
- getErrorMessages ()
- éErro()
- isFragmentMatches()
- isHostMatches()
- isMatch()
- isPathMatches()
- isSchemeMatches()
|
| v_record - Scoped, Global |
setLastErrorMessage () |
Tabela 3. Novas REST APIs e endpoints adicionais para REST APIs existentes no Yokohama
| API |
Endpoints |
| AWA Offer Work API |
POST /now/awa/documents/{document_table}/{document_sys_id}/offer |
| Continuous Integration and Continuous Delivery (CICD) Update Set API |
- POST /sn_cicd/update_set/recuperar
- POST /sn_cicd/update_set/commitMultiple
- POST /sn_cicd/update_set/preview/{remote_update_set_id}
- POST /sn_cicd/update_set/back_out
- POST /sn_cicd/update_set/commit/{remote_update_set_id}
- POST /sn_cicd/update_set/criar
|
Tabela 4. Novas classes com escopo e métodos adicionais para classes com escopo existentes no ServiceNow Store
| Aplicação |
Versão do Aplicativo |
Classe |
Métodos |
| Gestão de leads |
v3.0 |
LeadAPIHelperOOB - Scoped |
- getJSONFromGR()
- getLeadsJSON()
- getTransformedLead()
|
| Gestão de leads |
v3.0 |
LeadAPIProcessUtilOOB - Scoped |
- processCreateLead()
- processGetAllLeads()
- processGrtLeadById()
- processUpdateLead()
|
| Gestão de leads |
v3.0 |
LeadAPIValidationUtilOOB - Scoped |
- validLeadObjectForPatchCall()
- validLeadObjectForPostCall()
|
| Gestão de pedidos |
v6.0 |
OrderGuide - Scoped |
isOrderInDraftState() |
Tabela 5. Novas classes de cliente e métodos adicionais para classes de cliente existentes no ServiceNow Store
| Aplicação |
Versão do Aplicativo |
Classe |
Métodos |
| Customer Service Management |
v1.2 |
openFrameAPI - Client |
setICContext() |
Tabela 6. Novas REST APIs e endpoints adicionais para REST APIs existentes no ServiceNow Store
| Aplicação |
Versão do Aplicativo |
API |
Endpoints |
| Operações de contas a pagar |
v8.0 |
AP Invoice API |
- POST /sn_spend_intg/ap_invoice/xml
|
| Modelo de Produto Expandido e Classes de Ativo |
v1.0 |
AI Assets API |
- GET /sn_ent/asset/ai_dataset/{sys_id}
- GET /sn_ent/asset/ai_model/{sys_id}
- GET /sn_ent/asset/ai_prompt/{sys_id}
- GET /sn_ent/asset/ai_system/{sys_id}
- POST /sn_ent/asset/ai_dataset
- POST sn_ent/asset/ai_model
- POST /sn_ent/asset/ai_prompt
- POST /sn_ent/asset/ai_system
- PUT /sn_ent/asset/ai_dataset/{sys_id}
- PUT /sn_ent/asset/ai_model/{sys_id}
- PUT /sn_ent/asset/ai_prompt/{sys_id}
- PUT /sn_ent/asset/ai_system/{sys_id}
|
| Contratos e direitos do cliente |
v6.0 |
Service Contract API |
- POST /sn_pss_core/servicecontract
- GET /sn_pss_core/servicecontract/{id}
- POST /sn_pss_core/servicecontract/contractline
- GET /sn_pss_core/servicecontract/contractline/{id}
|
| Contratos e direitos do cliente |
v6.0 |
Verify Entitlements API |
GET /sn_ent_verify/verifyentitlements |
| Gestão de leads |
v3.0 |
lead API |
- GET /sn_lead_mgmt_core/lead
- GET /sn_lead_mgmt_core/lead/{sys_id}
- PATCH /sn_lead_mgmt_core/lead/{sys_id}
- POST /sn_lead_mgmt_core/lead
|
| Gestão de vendas e pedidos |
v4.0 |
Sales Agreement API |
- GET /sn_sales_agmt_core/salesagreement /{id}
- POST /sn_sales_agmt_core/salesagreement
|
Alterado nesta versão
Tabela 7. Classes com escopo alteradas em Yokohama
| Classe |
Métodos |
| PDFGenerationAPI - Scoped, Global |
- convertToPDF()
- convertToPDFWithHeaderFooter()
Novas propriedades, glide.pdf.url.whitelisting.enabled e com.snc.pdf.whitelisted_urls, foram adicionadas para garantir que os URLs externos fornecidos sejam renderizados na saída do PDF.
Uma nova propriedade, acessibilidadeEnabled, foi adicionada para suporte à acessibilidade de PDF.
|
Tabela 8. Classes globais alteradas em Yokohama
| Classe |
Métodos |
| PDFGenerationAPI - Scoped, Global |
- convertToPDF()
- convertToPDFWithHeaderFooter()
Novas propriedades, glide.pdf.url.whitelisting.enabled e com.snc.pdf.whitelisted_urls, foram adicionadas para garantir que os URLs externos fornecidos sejam renderizados na saída do PDF.
Uma nova propriedade, acessibilidadeEnabled, foi adicionada para suporte à acessibilidade de PDF.
|
Tabela 9. REST APIs alteradas em Yokohama
| API |
Endpoints |
| Attachment API |
POST /now/attachment/file: um novo parâmetro, criação_time, pode ser usado para capturar os horários de criação de anexos quando o App Now Mobile está off-line e o anexo é carregado para um registro posteriormente. |
Tabela 10. Classes com escopo alteradas no ServiceNow Store
| Aplicação |
Versão do Aplicativo |
Classe |
Métodos |
| Lead para o núcleo de dinheiro |
V1.4 |
LeadtoCashCore - Scoped |
Desempenho aprimorado da API de instância de confirmação para melhorar a geração de números para o campo de número:
- efeito(): o objeto de retorno _records_count é adicionado para fornecer detalhes sobre registros recém-inseridos para uma tabela específica, como o nome da tabela e o número de registros inseridos.
- confirmInstance(): um novo parâmetro adicional, useNumberGenerator, foi adicionado para gerar e aplicar opcionalmente sys_ids a novos registros de tabela em massa.
|
Tabela 11. Classes de cliente alteradas no ServiceNow Store
| Aplicação |
Versão do Aplicativo |
Classe |
Métodos |
| Customer Service Management |
v1.2 |
openFrameAPI - Client |
subscrição(): novos eventos adicionados
- openframe_wrap_up_enviado
- openframe_ heart_beat
|
Tabela 12. REST APIs alteradas no ServiceNow Store
| Aplicação |
Versão do Aplicativo |
API |
Endpoints |
| Operações de contas a pagar |
v8.0 |
AP Invoice API |
Adicione propriedades que oferecem suporte a informações de endereço de faturamento.
- POST /sn_spend_intg/ap_invoice/cxml
- POST /sn_spend_intg/ap_invoice/json
|
Informações de ativação
As seguintes APIs estão disponíveis por padrão:
- Anexo
- Console
- Obtenção
- Buscar.Cabeçalhos
- Buscar.Solicitação
- Buscar.Resposta
- Buscar.InícioDeSolicitação
- GlideDynamicAttribute
- GlideDynamicAttributeStore
- GlideElementDynamicAttributeStore
- GlideTransientDynamicAttribute
- GlideUser
- openFrameAPI
- PDFGenerationAPI
- RESTMessageV2
- ScriptableCurrencyCode
- ScriptableUriMatcher
- SOAPMessageV2
- UriMatcher
- UriMatcherResponse
As seguintes APIs requerem ativação de plug-in:
- A API Ativo de IA requer que o plug-in Asset Classes (sn_ent) seja ativado.
- A API de fatura do AP requer que o plug-in Processamento de fatura de contas a pagar (com.sn_ap_apm) seja ativado.
- A API de trabalho de oferta do AWA requer que o plug-in Advanced Work Assignment (com.glide.awa) seja ativado.
- A API lead requer que o plug-in Lead Management Data Model (sn_lead_mgmt_core) seja ativado.
- A API openFrame requer que o plug-in com.sn_openframe_store seja ativado.
- A API OrderUtil (inclusão de script) requer que o plug-in Gestão de pedidos (com.sn_ind_tmt_orm) seja ativado.
- A ProcessMiningIntegrationAPI requer que o plug-in Process Mining Core (com.sn_process_optimization) seja ativado.
- A API do contrato de vendas requer que os seguintes plug-ins sejam ativados:
- Modelo de dados do contrato de vendas (com.sn_sales_agmt_core)
- Gestão de catálogo de produtos Core (com.sn_prd_pm)
- Preços (com.sn_csm_pricing)
- A API Service Contract requer que os seguintes plug-ins sejam ativados:
- Contratos e direitos do cliente (com.sn_pss_core)
- Gestão da base de instalação do Atendimento ao cliente (com.snc.install)
- Gestão de catálogo de produtos Core (com.sn_prd)
- A API v_record requer que o plug-in Tabelas remotas (com.glide.script.vtable) seja ativado.
- A API Verificar direitos requer que o plug-in Verificação de direitos (com.sn_ent_verify) seja ativado.