ServiceNow® As APIs permitem criar aplicações e experiências personalizadas. As APIs foram aprimoradas e atualizadas na versão Xanadu.
Destaques da API para a versão Xanadu
- 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 .
Novidades da versão Xanadu
Tabela 1. Novas classes com escopo e métodos adicionais para classes com escopo existentes em Xanadu
| Classe |
Métodos |
|
- criarRelatório()
- deleteQuery ()
- getSavedQueryExecutionDetails()
- salvarConsulta()
- updateQuery ()
|
|
walkTo (ponto de verificação) |
|
- parseWithLocale()
- parseWithSeparators()
|
|
- ativarProcesso()
- desativarProcesso()
- duplicarProcesso()
|
|
editar () |
|
- PersonalAuthAPI()
- getInitiatorURL()
- isTokenValid()
- revokeToken()
|
|
restartPlaybook() |
Tabela 2. Novas classes globais e métodos adicionais para classes globais existentes em Xanadu
| Classe |
Métodos |
|
- criarRelatório()
- deleteQuery ()
- salvarConsulta()
- updateQuery ()
|
|
- clearDynamicCategoryCache ()
- clearDynamicChoiceSetCache ()
- clearDynamicAttributeGroupCache()
- clearDynamicAttributeGroupCacheItem()
- clearDynamicCategoryCacheItem()
- clearDynamicChoiceSetItem()
- obter ()
|
|
- getDynamicAttributeValue() - duas assinaturas
- getDynamicAttributeDisplayValue() - duas assinaturas
|
|
parseDate() |
|
- limpar ()
- getDisplayValue()
- getValue()
- setDisplayValue()
- setDynamicAttributeDisplayValue()
- setDynamicAttributeValue()
- setDynamicAttributeValues()
- setValue()
- toString()
|
|
- getDynamicAttribute()
- getDynamicAttributeDisplayValue()
- getDynamicAttributeValue()
- setDynamicAttributeValue()
- setDynamicAttributeValues()
- setDynamicAttributeDisplayValue()
- setDynamicAttributeDisplayValues()
|
| GlideRecord - Global |
- getDynamicAttribute() - duas assinaturas
- getDynamicAttributeValue() - duas assinaturas
- getDynamicAttributeDisplayValue() - duas assinaturas
- setDynamicAttributeValue() - duas assinaturas
- setDynamicAttributeDisplayValue() - duas assinaturas
- setDynamicAttributeValues()
|
|
walkTo (ponto de verificação) |
|
- parseWithLocale()
- parseWithSeparators()
|
|
editar () |
Tabela 3. Novas APIs móveis de cliente e métodos adicionais para APIs móveis de cliente existentes em Xanadu
| Classe |
Métodos |
|
- addErrorMessage()
- addInfoMessage()
- getValue()
- setAffectedInputs()
- setValue()
|
|
- MobileScriptIncludeCaller()
- addParam ()
- chamada ()
|
Tabela 4. Novas REST APIs no Xanadu
| Classe |
Métodos |
|
- GET /now/cmp_catalog_api/itemsbyciclass
- GET /now/cmp_catalog_api/itemsbyrb
- GET /now/cmp_catalog_api/services
- GET /now/cmp_catalog_api/stacks
- GET /now/cmp_catalog_api/status
- POST /now/cmp_catalog_api/submitoprequest
- POST /now/cmp_catalog_api/submitrequest
|
|
CRIAR /api/sn_pren/self_remediation/experience_issue/create |
Tabela 5. Novas classes de cliente e métodos adicionais para classes de cliente existentes no armazenamento ServiceNow
| Classe |
Métodos |
|
getAWAAgentPresence() |
Tabela 6. Novas classes com escopo e métodos adicionais para classes com escopo existentes no armazenamento ServiceNow
| Classe |
Métodos |
|
- arquivo ()
- finalização de compra ()
- publicar ()
- retirar ()
|
Tabela 7. Novas classes globais e métodos adicionais para classes globais existentes no armazenamento ServiceNow
| Classe |
Métodos |
|
- arquivo ()
- finalização de compra ()
- publicar ()
- retirar ()
|
Tabela 8. Novas REST APIs no armazenamento ServiceNow
| Classe |
Métodos |
|
CRIAR /sn_pren/self_remediation/experience_issue/create |
|
- EXCLUIR /sn_tmf_api/catalogmanagement/productOffering/{id}
- EXCLUIR /sn_tmf_api/catalogmanagement/productSpecification/{id}
- PATCH /sn_tmf_api/catalogmanagement/productOffering/{id}
- PATCH /sn_tmf_api/catalogmanagement/productSpecification/{id}
|
|
Adição de suporte para tabelas de cabo, perna e topologia. Essa mudança é refletida nas descrições das propriedades @type, id e resourceRelationship.resource.
- EXCLUIR /sn_ni_core/resource/{id}
- GET /sn_ni_core/resource
- GET /sn_ni_core/resource/{id}
- PATCH /sn_ni_core/resource/{id}
- POST /sn_ni_core/resource
- POST /sn_ni_core/resourceinventoryviatemplate
|
|
- GET /sn_sprb_mgmt/servicetestmanagement/serviceTest
- GET /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
- GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
- GET /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
- PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTest/{id}
- PATCH /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification/{id}
- POST /sn_sprb_mgmt/servicetestmanagement/serviceTest
- POST /sn_sprb_mgmt/servicetestmanagement/serviceTestSpecification
|
|
POST /sn_sec_tisc/threat_intel_data/add_observables |
Alterado nesta versão
Tabela 9. Classes com escopo alteradas em Xanadu
| Classe |
Métodos |
|
Parâmetro adicionado para especificar o tipo de implementação do walker de histórico a ser usado. Caminhante do histórico () |
Tabela 10. Classes globais alteradas em Xanadu
| Classe |
Métodos |
|
Adicionado suporte para esquema dinâmico.
- adicionarAgregado()
- adicionarTer()
- getValue()
- agruparPor()
- orderBy()
- orderByAggregate ()
|
| GlideRecord - Global |
Adicionado suporte para esquema dinâmico.
- adicionarConsulta()
- getDisplayValue()
- getValue()
- orderBy()
- orderByDesc()
- setDisplayValue()
- setValue()
|
|
Parâmetro adicionado para especificar o tipo de implementação do walker de histórico a ser usado. Caminhante do histórico () |
Tabela 11. REST APIs alteradas em Xanadu
| Classe |
Métodos |
|
Adição de novos parâmetros de corpo de solicitação. POST /awa/workitems/{work_item_sys_id}/assignments |
|
Adição de novos parâmetros de consulta opcionais para especificar se um pacote de testes deve ser executado como um teste de desempenho e no Cloud Runner. POST /sn_cicd/testsuite/executar |
Tabela 12. Classes com escopo alteradas no armazenamento ServiceNow
| Classe |
Métodos |
|
A inclusão de script LeadtoCashCore foi aprimorada para oferecer suporte a casos de uso de reconfiguração:
- createInstance() — Retorna _state identificando se o registro da entidade está em um estado ativo ou inativo.
- delta() - additionalParams agora oferece suporte à capacidade de ignorar atributos para comparar em JSONs de origem e sujos.
- efeito() - additionalParams agora oferece suporte à capacidade de fornecer chaves de variáveis de contexto em vez de nomes de campo de dicionário. Além disso, o efeito() retorna o parâmetro _state que identifica se o registro da entidade está em um estado ativo ou inativo.
|
Tabela 13. APIs de cliente alteradas no armazenamento ServiceNow
| Classe |
Métodos |
|
Adição de cargas de resposta workitem_rejected e workitem_accepted. assinar () |
Tabela 14. REST APIs alteradas no armazenamento ServiceNow
| Classe |
Métodos |
|
- Para todos os endpoints, o namespace e os caminhos do endpoint mudaram de sn_ind_tmt_ord para sn_tmf_api.
- Os métodos a seguir retornam dois novos parâmetros, href e orderDate.
- GET /sn_tmf_api/order/serviceOrder
- POST /sn_tmf_api/order/serviceOrder/cancelserviceorder
- API aberta de ordem de serviço – POST /sn_tmf_api/order/serviceOrder
- POST /sn_tmf_api/order/serviceOrder/outboundresponse
|
|
- Para todos os endpoints, o namespace e os caminhos do endpoint mudaram de sn_ind_tmt_ord para sn_tmf_api.
- Os métodos productOffering retornam dois novos parâmetros opcionais, href e lifecycleStatus:
- GET /sn_tmf_api/catalogmanagement/productOffering
- GET /sn_tmf_api/catalogmanagement/productOffering/{id}
- PATCH /sn_tmf_api/catalogmanagement/productOffering/{id}
- POST /sn_tmf_api/catalogmanagement/productOffering
- Os métodos productSpecification retornam três novos parâmetros opcionais, isBundle, hrefe lifecycleStatus:
- GET /sn_tmf_api/catalogmanagement/productSpecification
- GET /sn_tmf_api/catalogmanagement/productSpecification/{id}
- PATCH /sn_tmf_api/catalogmanagement/productSpecification/{id}
- POST /sn_tmf_api/catalogmanagement/productSpecification
|
|
Adição de um novo parâmetro de corpo de solicitação,reservaDateTimeChanged. GET /sn_wsd_rsv/reservable/list_reservables/{sys_ids} |
|
Adição de novo parâmetro de consulta, reserva_início_hora. GET /sn_wsd_rsv/reservable/list_reservables/{sys_ids} |
|
Adição de novo parâmetro de consulta, reserva_início_hora. POST /sn_wsd_rsv/v2/reservable/list_reservables |
Informações de ativação
As seguintes APIs estão disponíveis por padrão:
- API do catálogo de serviços em nuvem
- DynamicSchemaAPI
- GlideAggregate
- GlideDate
- GlideDynamicAttributeStore
- GlideElementAttributeStore
- GlideRecord
- Andarilho do Histórico
- NumberFormatter
- openFrameAPI
- PDAutomationProvider
- PDFGenerationAPI
- Playbook Experience
- API aberta do Catálogo de produtos
- API aberta de ordem de serviço
As seguintes APIs requerem ativação de plug-in:
- A AWA Manual Assignment API requer que o plug-in Atribuição avançada de trabalho (com.glide.awa) seja ativado.
- A PersonalAuthAPI requer que o plug-in Autenticação pessoal (com.snc.sn_ihub_personal_auth) seja ativado.
- A API de envolvimento proativo requer que o plug-in Envolvimento proativo (proactive-engagement) seja ativado.
- O PSBPublicAPIUtil requer que a aplicação Central de controle de serviços para provedores (sn_sb_pro) e os plug-ins Central de controle de serviços Base (sn_sb) sejam ativados.
- A API Resource Inventory Open requer que o plug-in da aplicação Customer Network Inventory Core (com.app-ni-core) seja ativado.
- A API aberta da Gestão de testes de serviços requer que o plug-in Customer Service Problem Management (com.sn_sprb_mgmt) seja ativado.
- A API WSD Extra Service Request requer que o plug-in Workplace Reservation Management (com.sn_wsd_rsv) seja ativado.
- A API reservável do WSD requer que o plug-in Workplace Reservation Management (com.sn_wsd_rsv) seja ativado.
- A API WSD V2 reservável requer que o plug-in Workplace Reservation Management (com.sn_wsd_rsv) seja ativado.