API Verificar direitos

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 15 min. de leitura

    • A API Verificar direitos 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 essa API, o plug-in Entitlement Verification (sn_ent_verify) deve ser ativado.

    Esta API é fornecida no namespace sn_ent_verify.

    O usuário que faz a chamada 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]
    • Oferta de produto [sn_prd_pm_product_offering]
    • Modelo do produto [cmdb_model]
    • 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 - /sn_ent_verify/verifyentitlements

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

    Você pode filtrar direitos com base em:
    • Conta
    • Consumidor
    • Contrato
    • Residência
    • Base de instalação
    • Modelo de Produto
    • Oferta de produto
    • Linha do contrato de serviço
    • Direito vendido
    • Produto vendido
    • Estado
    Você deve especificar pelo menos a conta ou o consumidor para filtrar os direitos.

    Quando vários parâmetros de filtro são aprovados, o endpoint aplica o operador AND aos parâmetros. Por exemplo, se você passar parâmetros de filtro como "conta = boxeo" e "estado = rascunho", o endpoint retornará todos os direitos com Conta = boxeo E estado = rascunho.

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

    Formato de URL

    URL com controle de versões: /api/sn_ent_verify/v1/verifyentitlements

    URL padrão: /api/sn_ent_verify/verifyentitlements

    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 acessada. 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 o parâmetro sysparm_offset para paginar a recuperação do registro.

    Na resposta, o parâmetro booliano hasMore é retornado. Indica se há mais registros a serem retornados que atendam 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 iniciar a recuperação de registros. Use este valor para paginar a recuperação do 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ê chama este endpoint, sysparm_offset é definido como "0". Para simplesmente paginar todos os registros disponíveis, use sysparm_offset=sysparm_offset+sysparm_limit, até chegar ao fim de todos os registros.

    Não passe um número negativo no parâmetro sysparm_offset.

    Tipo de dados: número

    Padrão: 0
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    conta O parâmetro account ou consumer deve ser passado. Eles são mutuamente exclusivos. Sys_id do registro de conta para o qual serão retornados registros de direito. Localizado na tabela Conta [customer_account].

    Tipo de dados: cadeia de caracteres

    Padrão: Nenhum
    cliente O parâmetro account ou consumer deve ser passado. Eles são mutuamente exclusivos. Sys_id do registro do consumidor para o qual os registros de direito serão retornados. Localizado na tabela Consumidor [csm_consumer].

    Tipo de dados: cadeia de caracteres

    Padrão: Nenhum
    contrato Sys_id do registro do contrato para o qual os registros de direito serão retornados. Localizado na tabela Contrato [sn_pss_core_service_contract].

    Tipo de dados: cadeia de caracteres

    Padrão: Nenhum
    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: "estado": "Rascunho".
    • falso: a resposta contém somente os valores dos campos. Por exemplo: "estado": "rascunho".
    • all: a resposta contém todas as informações dos campos.

      Por exemplo:

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

    Tipo de dados: cadeia de caracteres

    Padrão: falso
    residência Sys_id do registro da residência para o qual os registros de direito serão retornados. Localizado na tabela Residência [csm_household].

    Tipo de dados: cadeia de caracteres

    Padrão: Nenhum
    install_base Sys_id do registro da base de instalação para o qual os registros de direito serão retornados. Localizado na tabela Base de instalação [sn_install_base_item].

    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
    Produto Sys_id do registro do produto para o qual os registros de direito serão retornados. Localizado na tabela Product Model [cmdb_model].

    Tipo de dados: cadeia de caracteres

    Padrão: Nenhum
    product_offering Sys_id do registro de oferta de produto para o qual os registros de direito serão retornados. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres

    Padrão: Nenhum
    linha_contrato_serviço Sys_id do registro de linha do contrato de serviço para o qual os registros de direito serão retornados. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres

    Padrão: Nenhum
    vendido_direito Sys_id do registro de direito vendido para o qual os registros de direito serão retornados. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres

    Padrão: Nenhum
    produto_vendido Sys_id do registro de produto vendido para o qual serão retornados registros de direito. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    O endpoint usa o sys_id do registro do 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
    state Estado dos direitos a serem retornados.
    Valores válidos:
    • ativo
    • cancelado,
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: cadeia de caracteres

    Padrão: Todos
    Tabela 3. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum

    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/json ou application/xml.

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

    Códigos de status

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

    Tabela 6. Códigos de status
    Código de 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",
    "service_contract_line": "String",
    "sold_entitlement": "String",
    "start_date": "String",
    "state": "String",
    "sys_id": "String"
  }
]
    direitos.conta Sys_id do registro de conta associado a este direito. Localizado na tabela Conta [customer_account].

    Tipo de dados: cadeia de caracteres
    direitos.consumidor Sys_id do registro do consumidor associado a este direito. Localizado na tabela Consumidor [csm_consumer].

    Tipo de dados: cadeia de caracteres
    direitos.contrato Sys_id do registro do contrato associado a este direito. Localizado na tabela Contrato [sn_pss_core_service_contract].

    Tipo de dados: cadeia de caracteres
    end_date Valor do campo Data de término no registro de direito associado.

    Tipo de dados: cadeia de caracteres
    direitos.nome_do_direito Nome do direito.

    Tipo de dados: cadeia de caracteres
    direitos.doméstico Sys_id do registro da residência associado a este direito. Localizado na tabela Residência [csm_household].

    Tipo de dados: cadeia de caracteres
    direitos.produto Sys_id do registro do produto associado a este direito. Localizado na tabela Product Model [cmdb_model].

    Tipo de dados: cadeia de caracteres
    direitos.product_offering Sys_id do registro de oferta de produto associado a este direito. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    direitos.service_contract_line Sys_id do registro de linha do contrato de serviço associado a este direito. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    direitos.sold_entitlement Sys_id do registro de direito vendido associado a este direito. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres
    direitos.data_início Valor do campo Data de início no registro de direito associado.

    Tipo de dados: cadeia de caracteres
    direitos.estado Estado do registro de direitos.
    Valores válidos:
    • ativo
    • cancelado(a)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: cadeia de caracteres
    direitos.sys_id Sys_id do registro de direito. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    Erro Descreve o erro ocorrido.

    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: parâmetro sysparm_limit inválido aprovado. O parâmetro sysparm_limit 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: parâmetro sysparm_offset inválido aprovado. O parâmetro sysparm_offset deve ser um número inteiro.

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

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

    • Mensagem de erro: valor de opção inválido: estado = drft

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

    Tipo de dados: cadeia de caracteres
    erro.mensagem 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 válidos:
    • verdadeiro: mais registros de direito a serem retornados.
    • falso: não há mais registros de direito.

    Tipo de dados: booliano
    status Status da chamada do endpoint.
    Valores válidos:
    • falha: ocorreu um erro ao processar a solicitação.
    • sucesso: a chamada foi processada com sucesso.

    Tipo de dados: cadeia de caracteres
    sysparm_limit Se os parâmetros sysparm_limit foram passados na chamada de endpoint, ele conterá o valor passado, caso contrário, conterá o valor padrão.

    Tipo de dados: número
    sysparm_offset Se os parâmetros sysparm_offset foram passados na chamada de endpoint, ele conterá o valor passado, caso contrário, conterá 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"

    Retornar resultados:

    {
  "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,
        "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,
        "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"

    Retornar resultados:

    {
  "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,
          "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"

    Retornar resultados:

    {
  "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 - /sn_ent_verify/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ões: /api/sn_ent_verify/v1/verifyentitlements/getEntitlementCharacteristic/{id}

    URL padrão: /api/sn_ent_verify/verifyentitlements/getEntitlementCharacteristic/{id}

    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 acessada. 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 retornar. Localizado na tabela Característica de direito [sn_pss_core_entitlement_characteristic].

    Tipo de dados: cadeia de caracteres
    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: "estado": "Rascunho".
    • falso: a resposta contém somente os valores dos campos. Por exemplo: "estado": "rascunho".
    • all: a resposta contém todas as informações dos campos.

      Por exemplo:

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

    Tipo de dados: cadeia de caracteres

    Padrão: falso
    Tabela 9. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    Nenhum

    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/json ou application/xml.

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

    Códigos de status

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

    Tabela 12. Códigos de status
    Código de 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. Localizado na tabela Característica [sn_prd_pm_characteristic].

    Tipo de dados: cadeia de caracteres
    opção_característica Sys_id do registro de opções da característica associada. Localizado na tabela Opção de característica [sn_prd_pm_characteristic_option].

    Tipo de dados: cadeia de caracteres
    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_characteristic Sys_id do registro de característica de direito associado. Localizado na tabela Característica de direito [sn_pss_core_entitlement_characteristic].

    Tipo de dados: cadeia de caracteres
    entitlement_usage.​period_end Valor do campo de término do período no registro de uso do 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 de início do período no registro de uso do 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. Localizado na tabela Usos de direito [sn_pss_core_entitlement_usage].

    Tipo de dados: cadeia de caracteres
    entitlement_usage.​total_units Número total de unidades compradas. Localizado no campo de unidades totais no registro de uso de direito.

    Tipo de dados: cadeia de caracteres
    entitlement_usage.​used_units Número de unidades que foram usadas. Localizado no campo de unidades usadas no registro de uso do direito.

    Tipo de dados: cadeia de caracteres
    sys_id SYS ID do registro da característica de direito. Localizado na tabela Característica de direito [sn_pss_core_entitlement_characteristic].

    Tipo de dados: cadeia de caracteres
    tipo Valor do campo de tipo no registro da característica de direito.
    Valores possíveis:
    • cobertura
    • cobertura_e_uso

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

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

    As opções de característica são definidas somente para os tipos de característica de:
    • caixa de seleção
    • escolha
    • sim/não
    Para todos os outros tipos de características, o parâmetro value 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 Opção de característica, 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 Opção de característica, 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"

    Retornar resultados:

    {
  "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"

    Retornar resultados:

    {
  "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"
        }
      }
    ]  
  }
}