Notas de versão da API

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 5 min. de leitura

    • 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 API implementation and reference.

    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
    CMDBQBScopedScriptableAPI - Scoped
    • criarRelatório()
    • deleteQuery ()
    • getSavedQueryExecutionDetails()
    • salvarConsulta()
    • updateQuery ()
    HistoryWalker - Scoped, Global walkTo (ponto de verificação)
    NumberFormatter - Scoped, Global
    • parseWithLocale()
    • parseWithSeparators()
    PDAutomationProvider - Scoped, Global
    • ativarProcesso()
    • desativarProcesso()
    • duplicarProcesso()
    PDFGenerationAPI - Scoped, Global editar ()
    PersonalAuthAPI - Scoped
    • PersonalAuthAPI()
    • getInitiatorURL()
    • isTokenValid()
    • revokeToken()
    PlaybookExperience - Scoped restartPlaybook()
    Tabela 2. Novas classes globais e métodos adicionais para classes globais existentes em Xanadu
    Classe Métodos
    CMDBQueryBuilderAPI - Global
    • criarRelatório()
    • deleteQuery ()
    • salvarConsulta()
    • updateQuery ()
    DynamicSchemaAPI - Global
    • clearDynamicCategoryCache ()
    • clearDynamicChoiceSetCache ()
    • clearDynamicAttributeGroupCache()
    • clearDynamicAttributeGroupCacheItem()
    • clearDynamicCategoryCacheItem()
    • clearDynamicChoiceSetItem()
    • obter ()
    GlideAggregate - Global
    • getDynamicAttributeValue() - duas assinaturas
    • getDynamicAttributeDisplayValue() - duas assinaturas
    GlideDate - Global parseDate()
    GlideDynamicAttributeStore - Global
    • limpar ()
    • getDisplayValue()
    • getValue()
    • setDisplayValue()
    • setDynamicAttributeDisplayValue()
    • setDynamicAttributeValue()
    • setDynamicAttributeValues()
    • setValue()
    • toString()
    GlideElementDynamicAttributeStore - Global
    • 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()
    HistoryWalker - Scoped, Global walkTo (ponto de verificação)
    NumberFormatter - Scoped, Global
    • parseWithLocale()
    • parseWithSeparators()
    PDFGenerationAPI - Scoped, Global 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
    m_form - Client
    • addErrorMessage()
    • addInfoMessage()
    • getValue()
    • setAffectedInputs()
    • setValue()
    MobileScriptIncludeCaller - Client
    • MobileScriptIncludeCaller()
    • addParam ()
    • chamada ()
    Tabela 4. Novas REST APIs no Xanadu
    Classe Métodos
    Cloud Services Catalog API
    • 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
    Proactive Engagement API 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
    openFrameAPI - Client getAWAAgentPresence()
    Tabela 6. Novas classes com escopo e métodos adicionais para classes com escopo existentes no armazenamento ServiceNow
    Classe Métodos
    sb - Scoped, Global
    • 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
    sb - Scoped, Global
    • arquivo ()
    • finalização de compra ()
    • publicar ()
    • retirar ()
    Tabela 8. Novas REST APIs no armazenamento ServiceNow
    Classe Métodos
    Proactive Engagement API CRIAR /sn_pren/self_remediation/experience_issue/create
    Product Catalog Open API
    • 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}
    Resource Inventory Open API 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
    Service Test Management Open API
    • 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
    TISC API POST /sn_sec_tisc/threat_intel_data/add_observables

    Alterado nesta versão

    Tabela 9. Classes com escopo alteradas em Xanadu
    Classe Métodos
    HistoryWalker - Scoped, Global 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
    GlideAggregate - Global 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()
    HistoryWalker - Scoped, Global 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
    AWA Manual Assignment API Adição de novos parâmetros de corpo de solicitação.

    POST /awa/workitems/{work_item_sys_id}/assignments
    Continuous Integration/Continuous Delivery (CICD) API 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
    LeadtoCashCore - Scoped 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
    openFrameAPI - Client Adição de cargas de resposta workitem_rejected e workitem_accepted.

    assinar ()
    Tabela 14. REST APIs alteradas no armazenamento ServiceNow
    Classe Métodos
    Service Order Open API
    • 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
    Product Catalog Open API
    • 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
    WSD Extra Service Request API Adição de um novo parâmetro de corpo de solicitação,reservaDateTimeChanged.

    GET /sn_wsd_rsv/reservable/list_reservables/{sys_ids}
    WSD Reservable API Adição de novo parâmetro de consulta, reserva_início_hora.

    GET /sn_wsd_rsv/reservable/list_reservables/{sys_ids}
    WSD Reservable V2 API 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.