Verificar direitos da API

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 15 min. de leitura

    • . Verificar direitos da API fornece endpoints que permitem obter uma lista de direitos válidos, detalhes sobre as características dos direitos e as informações de uso mais recentes de um direito.

    Para acessar esta API, o plug-in Verificação de direito (com.sn_ent_verify) deve ser ativado.

    Esta API é fornecida no sn_ent_verify namespace.

    O usuário chamador deve ter a função sn_pss_core.pss_integrator.

    Os endpoints REST desta API consultam dados das seguintes tabelas:
    • Conta [customer_account]
    • Consumidor [csm_consumer]
    • Direito [service_entitlement]
    • Característica de direito [sn_pss_core_entitlement_characteristic]
    • Usos de direito [sn_pss_core_entitlement_usage]
    • Residência [csm_household]
    • Base de instalação [sn_install_base_item]
    • Modelo do produto [cmdb_model]
    • Oferta de produto [sn_prd_pm_product_offering]
    • Especificação do produto [sn_prd_pm_product_specification]
    • Contrato de serviço [sn_pss_core_service_contract]
    • Linha de contrato de serviço [sn_pss_core_service_contract_line]
    • Produto vendido [sn_install_base_sold_product]

    Verificar direitos - OBTER /sn_ent_verifyentitlements

    Retorna os registros de direito válidos com base no filtro fornecido.

    Você pode filtrar direitos com base em:
    • Conta
    • Cliente
    • Contrato
    • Residência
    • Base de instalação
    • Modelo do produto
    • Oferta de produto
    • Especificação de produto
    • Linha do contrato de serviço
    • Direito vendido
    • Produto vendido
    • Estado
    No mínimo, você deve especificar a conta ou o consumidor para filtrar os direitos.

    Quando vários parâmetros de filtro são passados, o endpoint aplica o. E. operador para os parâmetros. Por exemplo, se você passar parâmetros de filtro, como "conta: boxeo" e. "estado: rascunho" , O endpoint retorna todos os direitos com a conta: Boxeo E. rascunho.

    Você pode implementar a paginação para os resultados de retorno aprovando os parâmetros de paginação do sistema sysparm_offsete. sysparm_limit. Por padrão sysparm_offsetestá definido como 0 e. sysparm_limitdefinido como 10. Portanto, se, após a aplicação do filtro, 100 direitos atenderem aos critérios, a resposta incluirá os primeiros 10 direitos. Você pode modificar esses valores passando-os na chamada de endpoint.

    Formato de URL

    URL com controle de versão: /api/sn_ent_verifyentitlements

    URL padrão: /api/sn_ent_verifyentitlements

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

    Parâmetros de solicitação compatíveis

    Tabela 1. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: Cadeia de caracteres
    sysparm_limit Opcional.
    Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use sysparm_offsetparâmetro para paginar a recuperação de registro.

    Na resposta, o parâmetro booliano hasMoreretornado. Indica se há mais registros a serem retornados que atendem aos critérios de filtro.

    Tipo de dados: Número

    Padrão: 10

    Máximo: 100
    sysparm_offset Opcional.
    Índice de registro inicial para o qual começar a recuperar registros. Use este valor para paginar a recuperação de registro. Esta funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis.

    Por exemplo, na primeira vez que você chamar este endpoint, sysparm_offsetdefinido como "0". Para simplesmente percorrer todos os registros disponíveis, use se você não tiver certeza de que você está usando o sysparm_offset até chegar ao final de todos os registros.

    Não passe um número negativo em sysparm_offsetparâmetro.

    Tipo de dados: Número

    Padrão: 0
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    conta . accountou consumero parâmetro deve ser passado. Eles são mutuamente exclusivos. Sys_id do registro de conta para o qual retornar registros de direito.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum

    Tabela: Conta [customer_account]
    cliente . accountou consumero parâmetro deve ser passado. Eles são mutuamente exclusivos. Sys_id do registro do consumidor para o qual retornar registros de direito.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum

    Tabela: Consumidor [csm_consumer]
    contrato Sys_id do registro do contrato para o qual os registros de direito serão retornados.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum

    Tabela: Contrato [sn_pss_core_service_contract]
    display_value Sinalizador que indica se o valor do campo associado, o valor de exibição ou ambos devem ser retornados.
    Valores válidos:
    • Verdadeiro: A resposta contém somente os valores de exibição dos campos. Por exemplo: "state": "Rascunho" .
    • Falso: A resposta contém somente os valores dos campos. Por exemplo: "state": "rascunho" .
    • Todos: A resposta contém todas as informações dos campos.

      Por exemplo:

      "state": {
  "name": "state",
  "label": "State",
  "value": "draft",
  "display_value": "true",
  "type": "string"
}

    Tipo de dados: Cadeia de caracteres

    Padrão: falso
    residência Sys_id do registro de residência para o qual retornar registros de direito.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum

    Tabela: Residência [csm_household]
    install_base Sys_id do registro da base de instalação para o qual retornar registros de direito.

    O endpoint usa o sys_id do registro da base de instalação para pesquisar a tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product] para retornar todos os direitos cobertos pela base de instalação associada.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum

    Base de instalação [sn_install_base_item]
    Produto Sys_id do registro do produto para o qual retornar registros de direito.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum

    Tabela: Modelo de produto [cmdb_model]
    product_offering Sys_id do registro de oferta de produto para o qual retornar registros de direito.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum

    Tabela: Oferta de produto [sn_prd_pm_product_offering]
    product_specification Sys_id do registro de especificação do produto para o qual retornar registros de direito.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum

    Tabela: Especificação do produto [sn_prd_pm_product_specification]
    service_contract_line Sys_id do registro de linha do contrato de serviço para o qual retornar registros de direito.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]
    sold_entitlement Sys_id do registro de direito vendido para o qual retornar registros de direito.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum

    Tabela: Produto vendido [sn_install_base_sold_product]
    sold_product Sys_id do registro de produto vendido para o qual retornar registros de direito.

    O endpoint usa o sys_id do registro de Produto vendido para pesquisar a tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product] para retornar todos os direitos cobertos pelo produto vendido associado.

    Tipo de dados: Cadeia de caracteres

    Padrão: Nenhum

    Tabela: Produto vendido [sn_install_base_sold_product]
    estado Estado dos direitos a serem retornados.
    Valores válidos:
    • ativo
    • Cancelados(as)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: Cadeia de caracteres

    Padrão: Todos
    Tabela 3. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

    Tabela 4. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    direitos Lista de direitos que correspondem aos critérios de filtro aprovados.

    Tipo de dados: Matriz de objetos

    "entitlements": [
  {
    "account": "String",
    "consumer": "String",
    "contract": "String",
    "end_date": "String",
    "entitlement_name": "String",
    "household": "String",
    "product": "String",
    "product_offering": "String",
    "product_specification": "String",
    "service_contract_line": "String",
    "sold_entitlement": "String",
    "start_date": "String",
    "state": "String",
    "sys_id": "String"
  }
]
    conta.direitos Sys_id do registro da conta associado a este direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conta [customer_account]
    direitos.consumidor Sys_id do registro do consumidor associado a este direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Consumidor [csm_consumer]
    direitos.contrato Sys_id do registro do contrato associado a este direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato [sn_pss_core_service_contract]
    end_date Valor do campo Data de término no registro de direito associado.

    Tipo de dados: Cadeia de caracteres
    entitlement.entitlement_name Nome do direito.

    Tipo de dados: Cadeia de caracteres
    residência.direitos Sys_id do registro de residência associado a este direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Residência [csm_household]
    entitlements.product Sys_id do registro do produto associado a este direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]
    entitlements.product_offering Sys_id do registro de oferta de produto associado a este direito.

    Tipo de dados: Cadeia de caracteres

    Oferta de produto [sn_prd_pm_product_offering]
    entitlements.product_specification Sys_id do registro de especificação do produto associado a este direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]
    entitlements.service_contract_line Sys_id do registro de linha do contrato de serviço associado a este direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]
    entitlements.sold_entitlement Sys_id do registro de direito vendido associado a este direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]
    start_date Valor do campo Data de início no registro de direito associado.

    Tipo de dados: Cadeia de caracteres
    entitlements.state Estado do registro de direitos.
    Valores possíveis:
    • ativo
    • Cancelados(as)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: Cadeia de caracteres
    entitlements.sys_id Sys_id do registro de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]
    erro Descreve o erro que ocorreu.

    Tipo de dados: Objeto

    "error": {
  "detail": "String",
  "message": "String"
}
    Exemplos de respostas de erro:
    • Mensagem de erro: O tamanho da página -20 é inválido. O tamanho da página deve ser um número inteiro entre 1 e 100

      Condição de erro: Inválida sysparm_limitparâmetro aprovado. . sysparm_limito parâmetro deve estar entre 1 e 100.

    • Mensagem de erro: O deslocamento de página -23 é inválido. O deslocamento deve ser um número inteiro maior ou igual a 0

      Condição de erro: Inválida sysparm_offsetparâmetro aprovado. . sysparm_offseto parâmetro deve ser um número inteiro.

    • Mensagem de erro: Parâmetro de consulta inválido - conta

      Condição de erro: Parâmetro de consulta inválido, "conta", foi aprovado. O parâmetro deve ser "Conta".

    • Mensagem de erro: Valor de escolha inválido: estado: Drft

      Condição de erro: Valor inválido, "drft", foi aprovado. O valor do parâmetro deve ser "rascunho".
    error.detail Informações detalhadas sobre o motivo da falha na chamada de endpoint.

    Tipo de dados: Cadeia de caracteres
    mensagem.erro Mensagem que descreve o erro em alto nível.

    Tipo de dados: Cadeia de caracteres
    hasMore Sinalizador que indica se há mais registros de direito a serem retornados.
    Valores possíveis:
    • Verdadeiro: Mais registros de direito a serem retornados.
    • Falso: Não há mais registros de direito.

    Tipo de dados: Booliano
    status Status da chamada de endpoint.
    Valores possíveis:
    • Falha: Ocorreu um erro ao processar a solicitação.
    • Sucesso: A chamada foi processada com sucesso.

    Tipo de dados: Cadeia de caracteres
    sysparm_limit . sysparm_limitos parâmetros foram passados na chamada de endpoint, contém o valor passado, caso contrário, contém o valor padrão.

    Tipo de dados: Número
    sysparm_offset . sysparm_offsetos parâmetros foram passados na chamada de endpoint, contém o valor passado, caso contrário, contém o valor padrão.

    Tipo de dados: Número

    Solicitação de curl

    O exemplo de código a seguir mostra como retornar direitos para uma conta específica.

    curl "https://instance.service-now.com/api/sn_ent_verify/verifyentitlements?account=9e2fd2ee11b43110f877366201dea674" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Resultados de retorno:

    {
  "result": {
    "sysparm_offset": "0",
    "sysparm_limit": "10",
    "has_more": "false",
    "entitlements": [
      {
        "sys_id": "38374bf251e27110f877bf82d3ddf30a",
        "entitlement_name": "test ent",
        "account": "9e2fd2ee11b43110f877366201dea674",
        "consumer": null,
        "household": null,
        "contract": "0e1747f251e27110f877bf82d3ddf31c",
        "service_contract_line": "da278fb251e27110f877bf82d3ddf3b7",
        "state": "active",
        "product_offering": null,
        "product_specification": null,
        "sold_entitlement": null,
        "product": null,
        "start_date": "2023-11-21",
        "end_date": ""
      },
      {
        "sys_id": "e6ad4e4151723d10f877bf82d3ddf3fb",
        "entitlement_name": "tets entitlement",
        "account": "9e2fd2ee11b43110f877366201dea674",
        "consumer": null,
        "household": null,
        "contract": "0e1747f251e27110f877bf82d3ddf31c",
        "service_contract_line": "e79dce4151723d10f877bf82d3ddf31d",
        "state": "active",
        "product_offering": null,
        "product_specification": null,
        "sold_entitlement": null,
        "product": null,
        "start_date": "2023-11-21",
        "end_date": ""
      }
    ],
    "status": "success"
  }
}

    Solicitação de curl

    O exemplo de código a seguir mostra como retornar direitos para uma conta específica e linha de contrato de serviço.

    curl "https://instance.service-now.com/api/sn_ent_verify/verifyentitlements?service_contract_line=e79dce4151723d10f877bf82d3ddf31d&account=9e2fd2ee11b43110f877366201dea674" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Resultados de retorno:

    {
  "result": {
    "sysparm_offset": "0",
    "sysparm_limit": "10",
    "has_more": "false",
    "entitlements": [
      {
        "sys_id": "e6ad4e4151723d10f877bf82d3ddf3fb",
        "entitlement_name": "test entitlement",
        "account": "9e2fd2ee11b43110f877366201dea674",
        "consumer": null,
        "household": null,
        "contract": "0e1747f251e27110f877bf82d3ddf31c",
        "service_contract_line": "e79dce4151723d10f877bf82d3ddf31d",
        "state": "active",
        "product_offering": null,
        "product_specification": null,
        "sold_entitlement": null,
        "product": null,
        "start_date": "2023-11-21",
        "end_date": ""
      }
    ],
    "status": "success"
  }
}

    Solicitação de curl

    O exemplo de código a seguir mostra uma resposta de erro.

    curl "https://instance.service-now.com/api/sn_ent_verify/verifyentitlements?service_contract_line=e79dce4151723d10f877bf82d3ddf31d" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Resultados de retorno:

    {
  "error": {
    "detail": "At least one of Account or Consumer parameter is mandatory.",
    "message": "At least one of Account or Consumer parameter is mandatory."
  },
  "status": "failure"
}

    Verificar direitos - OBTER /sn_ent_verifyentitlements/getEntitlementCharacteristic/id

    Retorna detalhes do registro de característica de direito especificado e seu registro de uso mais recente.

    O registro de uso mais recente de uma característica é definido como o registro em que a data de início do período é menor ou igual à data atual e a data de término do período é maior ou igual à data atual.

    Formato de URL

    URL com controle de versão: /api/sn_ent_verifyentitlements/getEntitlementCharacteristic/

    URL padrão: /api/sn_ent_verifyentitlements/getEntityCharacteristic/

    Nota:
    As versões disponíveis são especificadas em REST API Explorer . Para REST APIs com script, há informações adicionais de versão no Formulário de serviço REST com script .

    Parâmetros de solicitação compatíveis

    Tabela 7. Parâmetros de caminho
    Nome Descrição
    api_version Opcional. Versão do endpoint a ser acessado. Por exemplo, v1 ou v2 . Especifique este valor somente para usar uma versão de endpoint diferente da mais recente.

    Tipo de dados: Cadeia de caracteres
    id Sys_id do registro de característica de direito a ser retornado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica de direito [sn_pss_core_entitlement_characteristic]
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    display_value Sinalizador que indica se o valor do campo associado, o valor de exibição ou ambos devem ser retornados.
    Valores válidos:
    • Verdadeiro: A resposta contém somente os valores de exibição dos campos. Por exemplo: "state": "Rascunho" .
    • Falso: A resposta contém somente os valores dos campos. Por exemplo: "state": "rascunho" .
    • Todos: A resposta contém todas as informações dos campos.

      Por exemplo:

      "state": {
  "name": "state",
  "label": "State",
  "value": "draft",
  "display_value": "true",
  "type": "string"
}

    Tipo de dados: Cadeia de caracteres

    Padrão: falso
    Tabela 9. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    Nenhum(a)

    Cabeçalhos

    Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis .

    Tabela 10. Cabeçalhos da solicitação
    Cabeçalho Descrição
    Aceitar Formato de dados do corpo da resposta. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json
    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

    Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 12. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    403 Proibido. O usuário não tem direitos de acesso ao registro especificado.
    404 Não encontrado. O item solicitado não foi encontrado.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON ou XML)

    Nome Descrição
    característica Sys_id do registro de característica de direito associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]
    characteric_option Sys_id do registro de opções de característica associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]
    entitlement_usage Detalhes sobre o registro de uso de direito associado ao registro de característica de direito especificado.

    Tipo de dados: Matriz de objetos

    "entitlement_usage": [
  {
    "entitlement_characteristic": "String",
    "period_end": "String",
    "period_start": "String",
    "sys_id": "String",
    "total_units": "String",
    "used_units": "String"
  }
]
    entitlement_usage. ​entitlement_characteric Sys_id do registro de característica de direito associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica de direito [sn_pss_core_entitlement_characteristic]
    entitlement_usage. ​period_end Valor do campo Término do período no registro de uso de direito. Este valor é a data em que o acompanhamento de uso termina para este direito.

    Tipo de dados: Cadeia de caracteres
    entitlement_usage. ​period_start Valor do campo Início do período no registro de uso de direito. Este valor é a data em que o acompanhamento de uso começa para este direito.

    Tipo de dados: Cadeia de caracteres
    entitlement_usage. ​sys_id Sys_id do registro de uso de direito retornado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Usos de direito [sn_pss_core_entitlement_usage]
    entitlement_usage. ​total_units Número total de unidades compradas.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo total_units da tabela Usos de direito [sn_pss_core_entitlement_usage].
    entitlement_usage. ​used_units Número de unidades que foram usadas.

    Tipo de dados: Cadeia de caracteres

    Tabela: No campo used_units da tabela Usos de direito [sn_pss_core_entitlement_usage].
    sys_id Sys_id do registro de característica de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica de direito [sn_pss_core_entitlement_characteristic]
    tipo Valor do campo de tipo no registro de característica de direito.
    Valores possíveis:
    • cobertura
    • coverage_and_usage

    Tipo de dados: Cadeia de caracteres
    valor Cobertura para fornecer a característica.

    Para algumas características, as coberturas são definidas na tabela de opções de características. No entanto, se não houver coberturas definidas na tabela de opções de características, você poderá passar as informações de cobertura em valueparâmetro.

    As opções de característica são definidas somente para os tipos de características de:
    • caixa de seleção
    • escolha
    • sim/não
    Para todos os outros tipos de características, o valueo parâmetro deve conter o valor de cobertura.

    Por exemplo, se a característica for "Número de substituições" e suas coberturas não estiverem definidas na tabela de opções de características, você poderá especificar as coberturas, como "10", "20", neste parâmetro.

    Nota:
    Este parâmetro contém o valor de cobertura final da característica. Se houver informações na tabela de opções de características, elas serão propagadas para este parâmetro.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo de código a seguir mostra como chamar este endpoint usando todos os seus valores padrão.

    curl "https://instance.servicenow.com/api/sn_ent_verify/verifyentitlements/getEntitlementCharacteristic/3c817faa43823110341605ed0bb8f23a" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Resultados de retorno:

    {
  "result": {
    "sys_id": "3c817faa43823110341605ed0bb8f23a",
    "characteristic": "b73177aa43823110341605ed0bb8f246",
    "type": "coverage",
    "characteristic_option": "ff617baa43823110341605ed0bb8f266",
    "value": "Minor parts",
    "entitlement_usage": [
      {
        "sys_id": "03e3224d51b23d10f877bf82d3ddf310",
        "period_start": "2022-12-12",
        "period_end": "2025-12-12",
        "entitlement_characteristic": "3c817faa43823110341605ed0bb8f23a",
        "total_units": "10",
        "used_units": "5"
      }
    ]
  }
}

    Solicitação de curl

    O exemplo de código a seguir mostra como chamar este endpoint e retornar todos os valores de exibição.

    curl "https://instance.servicenow.com/api/sn_ent_verify/verifyentitlements/getEntitlementCharacteristic/3c817faa43823110341605ed0bb8f23a?display_value=all" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Resultados de retorno:

    {
  "result": {
    "sys_id": {
      "label": "Sys ID",
      "value": "3c817faa43823110341605ed0bb8f23a",
      "displayValue": "3c817faa43823110341605ed0bb8f23a",
      "type": "GUID"
    },
    "characteristic": {
      "name": "characteristic",
      "label": "Characteristic",
      "value": "b73177aa43823110341605ed0bb8f246",
      "display_value": "Repair parts covered",
      "type": "reference"
    },
    "type": {
      "name": "type",
      "label": "Type",
      "value": "coverage",
      "display_value": "Coverage",
      "type": "string"
    },
    "characteristic_option": {
      "name": "characteristic_option",
      "label": "Characteristic option",
      "value": "ff617baa43823110341605ed0bb8f266",
      "display_value": "Minor parts",
      "type": "reference"
    },
    "value": {
      "name": "value",
      "label": "Value",
      "value": "Minor parts",
      "display_value": "Minor parts",
      "type": "string"
    },
    "entitlement_usage": [
      {
        "sys_id": {
          "label": "Sys ID",
          "value": "03e3224d51b23d10f877bf82d3ddf310",
          "displayValue": "03e3224d51b23d10f877bf82d3ddf310",
          "type": "GUID"
        },
        "period_start": {
          "name": "period_start",
          "label": "Period start",
          "value": "2022-12-12",
          "display_value": "2022-12-12",
          "type": "glide_date"
        },
        "period_end": {
          "name": "period_end",
          "label": "Period end",
          "value": "2025-12-12",
          "display_value": "2025-12-12",
          "type": "glide_date"
        },
        "entitlement_characteristic": {
          "name": "entitlement_characteristic",
          "label": "Entitlement characteristic",
          "value": "3c817faa43823110341605ed0bb8f23a",
          "display_value": "Repair parts covered",
          "type": "reference"
        },
        "total_units": {
          "name": "total_units",
          "label": "Total units",
          "value": "10",
          "display_value": "10",
          "type": "string"
        },
        "used_units": {
          "name": "used_units",
          "label": "Used units",
          "value": "5",
          "display_value": "5",
          "type": "string"
        }
      }
    ]  
  }
}