API de direito

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

    • . Direito A API fornece endpoints para criar e recuperar registros de direito de uma instância.

    As verificações de direito ocorrem como parte dos serviços de suporte pós-vendas para clientes que compram um produto, como um dispositivo ou computador. Verificações de direito são feitas por agentes para determinar quais serviços os clientes estão qualificados a receber pelos produtos que compraram. Use Direito API para definir e recuperar direitos.

    Esta API acessa e armazena dados nas seguintes tabelas:
    • Conta [customer_account]
    • Consumidor [csm_consumer]
    • 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]
    • Produto vendido [sn_install_base_sold_product]
    Para acessar esta API, os seguintes plug-ins devem ser ativados na instância associada:
    • Direitos e contratos do cliente (com.sn_pss_core)  
    • Gestão da base de instalação do Atendimento ao cliente (com.snc.install_base)
    • Gestão de catálogo de produtos Core (com.sn_prd_pm)

    Para chamar esta API com sucesso, você deve ter a função sn_pss_core.pss_integrator. Esta API é executada no sn_pss_core namespace.

    Direito - OBTENHA /sn_pss_core/entitlement/

    Retorna o registro de direito especificado, sua cobertura associada e os detalhes de uso mais recentes.

    A lista de tabelas nas quais os dados de direito são armazenados:
    • Características [sn_pss_core_entitlement_characteristic]
    • Direito [service_entitlement]
    • Uso de direito [sn_pss_core_entitlement_usage]
    • Produto vendido coberto [sn_install_base_m2m_contract_sold_product] - Esta tabela contém informações sobre os produtos vendidos cobertos e os itens-base de instalação cobertos.

    Formato de URL

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

    URL padrão: /api/sn_pss_core/entitlement/

    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
    id Sys_id do registro de direito a ser recuperado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    display_value Tipo de dados a serem retornados.
    Valores válidos:
    • Falso: Retorna o. valor para todos os campos. Por exemplo, "estado":"rascunho" .
    • Verdadeiro: Retorna o. display_value para todos os campos. Por exemplo, "estado":"Rascunho"
    • Todos: Retorna todas as informações de todos os campos.

    Tipo de dados: Cadeia de caracteres

    Padrão: falso
    Tabela 3. Solicitar parâmetros do corpo (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.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    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

    Nome Descrição
    conta
    Sys_id do registro da conta ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conta [customer_account]
    cliente
    Sys_id do registro do consumidor ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Consumidor [csm_consumer]
    contrato Sys_id do registro do contrato ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]
    end_date Data de término do direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Nunca termina até que seja removido manualmente.
    entitlement_characterísticas Lista de características associadas ao direito.

    Tipo de dados: Matriz de objetos

    "entitlement_characteristics" [
  {
    "characteristic": "String",
    "characteristic_option": "String",
    "entitlement": "String",
    "entitlement_usage": [Array],
    "service_contract_line": "String",
    "sys_created_by": "String",
    "sys_created_on": "String",
    "sys_id": "String",
    "sys_updated_by": "String",
    "sys_updated_on": "String",
    "type": "String",
    "value": "String"
  }
]

    Armazenado em: Característica [sn_pss_core_entitlement_characteric]
    entitlement_characterísticas. ​característica
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]
    entitlement_characterísticas. ​characteric_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]
    entitlement_characterísticas. ​direito Sys_id do registro de direito associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]
    entitlement_characterísticas. ​entitlement_usage Lista de usos de direito associados à característica de direito.

    Tipo de dados: Matriz de objetos

    "entitlement_usage": [
  {
    "entitlement": "String",
    "entitlement_characteristic": "String",
    "period_end": "String",
    "period_start": "String",
    "service_contract_line": "String",
    "sys_created_by": "String",
    "sys_created_on": "String",
    "sys_id": "String",
    "sys_updated_by": "String",
    "sys_updated_on": "String",
    "total_units": "String",
    "used_units": "String"
  }
]
    entitlement_characterísticas. ​entitlement_usage. ​direito Sys_id do registro de direito associado ao uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]
    entitlement_characterísticas. ​entitlement_usage. ​entitlement_characteric Sys_id do registro de característica de direito associado ao uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_pss_core_entitlement_characteristic]
    entitlement_characterísticas. ​entitlement_usage. ​period_end Data de término em que o uso de direito não é mais rastreado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd
    entitlement_characterísticas. ​entitlement_usage. ​period_start Data de início de quando o uso de direito é rastreado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd
    entitlement_characterísticas. ​entitlement_usage. ​service_contract_line Sys_id da linha do contrato de serviço à qual o uso de direito atual pertence.

    Tipo de dados: Cadeia de caracteres
    entitlement_characterísticas. ​entitlement_usage. ​sys_created_by Nome do usuário que criou o registro de uso de direito.

    Tipo de dados: Cadeia de caracteres
    entitlement_characterísticas. ​entitlement_usage. ​sys_created_on Data e hora em que o registro de uso de direito foi criado.

    Tipo de dados: Cadeia de caracteres
    entitlement_characterísticas. ​entitlement_usage. ​sys_id Sys_id do registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Uso de direito [sn_pss_core_entitlement_usage]
    entitlement_characterísticas. ​entitlement_usage. ​sys_updated_by Nome do usuário que atualizou o registro de uso de direito pela última vez.

    Tipo de dados: Cadeia de caracteres
    entitlement_characterísticas. ​entitlement_usage. ​sys_updated_on Data e hora em que o registro de uso de direito foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres
    entitlement_characterísticas. ​entitlement_usage. ​total_units Valor de cobertura total da característica de direito associada.

    Tipo de dados: Cadeia de caracteres
    entitlement_characterísticas. ​entitlement_usage. ​used_units Número de unidades usadas pela conta ou consumidor entre period_starte o. period_end.

    Tipo de dados: Cadeia de caracteres
    entitlement_characterísticas. ​tipo Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: Cadeia de caracteres
    entitlement_characterísticas. ​valor
    Valor da característica.

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

    Tipo de dados: Cadeia de caracteres
    residência
    Sys_id do registro de residência associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Residência [csm_household]
    install_base_items_covered Lista de itens-base de instalação cobertos pelo direito.

    Tipo de dados: Matriz de objetos

     "install_base_items_covered": [ 
  {
    "added": "String",
    "contract": "String",
    "entitlement": "String",
    "install_base": "String",
    "removed": "String",
    "service_contract_line": "String",
    "sys_created_by": "String",
    "sys_created_on": "String",
    "sys_id": "String",
    "sys_updated_by": "String",
    "sys_updated_on": "String"
  }
]

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]
    install_base_items_covered. ​adicionado Data em que o item-base de instalação associado foi adicionado ao direito.

    Tipo de dados: Cadeia de caracteres
    install_base_items_covered. ​contrato Sys_id do registro do contrato de serviço associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]
    install_base_items_covered. ​install_base Sys_id do item-base de instalação coberto pela linha de contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]
    install_base_items_covered. ​removido Data em que o item-base de instalação associado foi removido do direito.

    Tipo de dados: Cadeia de caracteres
    install_base_items_covered. ​direito Sys_id do registro de direito associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]
    install_base_items_covered. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]
    install_base_items_covered. ​sys_created_by Nome do usuário que criou o registro do item-base de instalação.

    Tipo de dados: Cadeia de caracteres
    install_base_items_covered. ​sys_created_on Data e hora em que o registro do item-base de instalação foi criado.

    Tipo de dados: Cadeia de caracteres
    install_base_items_covered. ​sys_id Sys_id do item-base de instalação coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]
    install_base_items_covered. ​sys_updated_by Nome do usuário que atualizou o registro do item-base de instalação pela última vez.

    Tipo de dados: Cadeia de caracteres
    install_base_items_covered. ​sys_updated_on Data e hora em que o registro do item-base de instalação foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres
    Produto Sys_id do registro do modelo de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]
    sold_entitlement Sys_id do registro de produto vendido associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]
    sold_products_covered Lista de produtos cobertos.

    Tipo de dados: Matriz de objetos

    "sold_products_covered": [ 
  {
    "added": "String",
    "contract": "String",
    "entitlement": "String",
    "removed": "String",
    "service_contract_line": "String",
    "sold_product": "String",
    "sys_created_by": "String",
    "sys_created_on": "String",
    "sys_id": "String",
    "sys_updated_by": "String",
    "sys_updated_on": "String"
  }
]

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]
    sold_products_covered. ​adicionado Data em que o produto vendido associado foi adicionado ao direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Data atual
    sold_products_covered. ​contrato Sys_id do registro do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]
    sold_products_covered. ​direito Sys_id do registro de direito associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]
    sold_products_covered.removido Data em que o produto vendido associado foi removido do direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Sem data de término
    sold_products_covered. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]
    sold_products_covered. ​sold_product Sys_id do produto coberto pelo direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]
    sold_products_covered. ​sys_created_by Nome do usuário que criou o registro coberto pelo produto vendido.

    Tipo de dados: Cadeia de caracteres
    sold_products_covered. ​sys_created_on Data e hora em que o registro coberto pelo produto vendido foi criado.

    Tipo de dados: Cadeia de caracteres
    sold_products_covered. ​sys_id Sys_id do produto coberto por este contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]
    sold_products_covered. ​sys_updated_by Nome do usuário que atualizou o registro coberto pelo produto vendido pela última vez.

    Tipo de dados: Cadeia de caracteres
    sold_products_covered. ​sys_updated_on Data e hora em que o registro coberto pelo produto vendido foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres
    start_date
    Data de início do direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd
    estado
    Estado atual do direito.
    Valores válidos: (Diferencia maiúsculas de minúsculas)
    • ativo
    • Cancelados(as)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: Cadeia de caracteres
    sys_created_by Nome do usuário que criou o registro de direito.

    Tipo de dados: Cadeia de caracteres
    sys_created_on Data e hora em que o registro de direito foi criado.

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]
    sys_updated_by Nome do usuário que atualizou o registro de direito pela última vez.

    Tipo de dados: Cadeia de caracteres
    sys_updated_on Data e hora em que o registro de direito foi criado.

    Tipo de dados: Cadeia de caracteres

    Solicitação de curl

    O exemplo a seguir mostra como chamar este endpoint para recuperar um modelo de direito.

    curl "https://instance.servicenow.com/api/sn_pss_core/entitlement/fc73d2de89226110f877430a4e008" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

    Resposta:

    {
  "result": {
    "sys_id": "5a651515d1f53110f8776589fa411f7b",
    "sys_created_by": "admin",
    "sys_updated_by": "admin",
    "sys_created_on": "2023-10-09 11:31:59",
    "sys_updated_on": "2023-10-09 11:31:59",
    "entitlement_name": "indep entl",
    "account": "4c325111d1f53110f8776589fa411f3d",
    "consumer": null,
    "household": null,
    "contract": null,
    "service_contract_line": null,
    "state": "active",
    "product_offering": null,
    "sold_entitlement": null,
    "product": null,
    "start_date": "2023-10-03",
    "end_date": "2024-12-03",
    "sold_products_covered": [
      {
        "sys_id": "d6651515d1f53110f8776589fa411f7c",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:31:59",
        "sys_updated_on": "2023-10-09 11:31:59",
        "contract": null,
        "service_contract_line": null,
        "entitlement": "5a651515d1f53110f8776589fa411f7b",
        "sold_product": "0df21151d1f53110f8776589fa411f1b",
        "added": "",
        "removed": ""
      }
    ],
    "install_base_items_covered": [
      {
        "sys_id": "12651515d1f53110f8776589fa411f7d",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:31:59",
        "sys_updated_on": "2023-10-09 11:31:59",
        "contract": null,
        "service_contract_line": null,
        "entitlement": "5a651515d1f53110f8776589fa411f7b",
        "install_base": "e2639951d1f53110f8776589fa411f2b",
        "added": "",
        "removed": ""
      }
    ],
    "entitlement_characteristics": [
      {
        "sys_id": "12651515d1f53110f8776589fa411f7e",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:31:59",
        "sys_updated_on": "2023-10-09 11:31:59",
        "service_contract_line": null,
        "entitlement": "5a651515d1f53110f8776589fa411f7b",
        "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
        "value": "5",
        "characteristic": "63418db7539e61106bfcddeeff7b1238",
        "type": "coverage_and_usage",
        "entitlement_usage": [
          {
            "sys_id": "de651515d1f53110f8776589fa411f7e",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:31:59",
            "sys_updated_on": "2023-10-09 11:31:59",
            "entitlement": "5a651515d1f53110f8776589fa411f7b",
            "service_contract_line": null,
            "entitlement_characteristic": "12651515d1f53110f8776589fa411f7e",
            "period_start": "2023-10-03",
            "period_end": "2024-12-03",
            "total_units": "5",
            "used_units": "25"
          }
        ]
      }
    ]
  }
}

    POST /sn_pss_core/entitlement

    Cria um registro de direito e todos os registros detalhados relacionados.

    A lista de tabelas nas quais os dados de direito são armazenados:
    • Característica [sn_pss_core_entitlement_characteric]
    • Direito [service_entitlement]
    • Uso de direito [sn_pss_core_entitlement_usage]
    • Produtos vendidos cobertos [sn_install_base_m2m_contract_sold_product] - Esta tabela contém informações sobre os produtos vendidos cobertos e os itens-base de instalação cobertos.

    Formato de URL

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

    URL padrão: /api/sn_pss_core/entitlement

    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
    Tabela 8. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 9. Solicitar parâmetros do corpo (JSON)
    Nome Descrição
    conta Necessário se consumero parâmetro não foi passado.
    Sys_id do registro da conta ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conta [customer_account]
    cliente Necessário se accounto parâmetro não foi passado.
    Sys_id do registro do consumidor ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Consumidor [csm_consumer]
    end_date Data de término do direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Nunca termina até que seja removido manualmente.
    entitlement_characterísticas Lista de características associadas ao direito.

    Tipo de dados: Matriz de objetos

    "entitlement_characteristics": [
  {
    "characteristic": "String",
    "characteristic_option": "String",
    "entitlement_usage": {Object},
    "type": "String",
    "value": "String"
  }
]

    Armazenado em: Característica [sn_pss_core_entitlement_characteric]
    entitlement_characterísticas. ​característica Obrigatório.
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]
    entitlement_characterísticas. ​characteric_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]
    entitlement_characterísticas. ​entitlement_usage Valor unitário usado para a característica de direito associada.

    Passe este parâmetro somente se o entitlement_characteristics estiver no direito.

    Tipo de dados: Objeto

    "entitlement_usage": {
    "used_units": "String"
}

    Armazenado em: Uso de direito [sn_pss_core_entitlement_usage]
    entitlement_characterísticas. ​entitlement_usage. ​usage_units Uso da característica de direito associada.

    Tipo de dados: Cadeia de caracteres
    entitlement_characterísticas. ​tipo Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: Cadeia de caracteres
    entitlement_characterísticas. ​valor Necessário se input_typeparâmetro contido no registro especificado em entitlement_characteristics.characteristicparâmetro, não é opção .
    Valor da característica.

    Tipo de dados: Cadeia de caracteres
    entitlement_name Obrigatório.
    Nome do direito.

    Tipo de dados: Cadeia de caracteres
    residência Aprovado somente quando os plug-ins domésticos estão ativos e consumero parâmetro foi passado.
    Sys_id do registro de residência associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Residência [csm_household]
    install_base_items_covered
    Lista de itens-base de instalação cobertos pelo direito. As informações nesta matriz são inseridas na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    Tipo de dados: Matriz de objetos

    "install_base_items_covered": [ 
  {
    "added": "String",
    "install_base": "String",
    "removed": "String"
  }
]

    Para obter mais informações sobre Itens-base de instalação Configure Install base.
    install_base_items_covered.adicionado Data em que o item-base de instalação associado foi adicionado ao direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Data atual
    install_base_items_covered. ​install_base Sys_id do registro do item-base de instalação associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]
    install_base_items_covered. ​removido Data em que o item-base de instalação associado foi removido do direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Sem data de término
    Produto Sys_id do registro do modelo de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]
    sold_entitlement Sys_id do registro de produto vendido associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]
    sold_products_covered Lista de produtos cobertos pelo direito.

    Tipo de dados: Matriz de objetos

    "sold_products_covered": [ 
  {
    "added": "String",
    "removed": "String",
    "sold_product": "String"
  }
]

    Vendido coberto em: Produto vendido [sn_install_base_m2m_contract_sold_product]
    sold_products_covered.adicionado Data em que o produto vendido associado foi adicionado ao direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Data atual
    sold_products_covered.removido Data em que o produto vendido associado foi removido do direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Sem data de término
    sold_products_covered.sold_product Sys_id do produto coberto pelo direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]
    start_date Obrigatório.
    Data de início do direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd
    estado Obrigatório.
    Estado atual do direito.
    Valores válidos: (Diferencia maiúsculas de minúsculas)
    • ativo
    • Cancelados(as)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: Cadeia de caracteres

    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
    Tipo de conteúdo Formato de dados do corpo da solicitação. 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
    201 Bem-sucedido. A solicitação foi processada com sucesso e os registros foram criados.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    403 Proibido. O usuário não tem permissão para acessar a API.
    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)

    Nome Descrição
    entitlement_characterísticas Lista de objetos de característica de direito criados no direito.

    Tipo de dados: Matriz de objetos

    "entitlement_characteristics" [
  {
    "entitlement_usage": {Object},
    "sys_id": "String"
  }
]
    entitlement_characterísticas. ​entitlement_usage Objeto de uso de direito inserido em entitlement_characteristic.

    Tipo de dados: Objeto

    "entitlement_usage": {
    "sys_id": "String"
}
    entitlement_characterísticas. ​entitlement_usage. ​sys_id Sys_id do registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Uso de direito [sn_pss_core_entitlement_usage]
    entitlement_characterísticas. ​sys_id Sys_id de um registro de características de direito associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_pss_core_entitlement_characteristic]
    entitlement_name
    Nome do direito.

    Tipo de dados: Cadeia de caracteres
    install_base_items_covered Lista de sys_ids dos itens-base de instalação cobertos pelo direito.

    Tipo de dados: Matriz de objetos

    "install_base_items_covered": [ 
  {
    "sys_id": "String"
  }
]
    install_base_items_covered. ​sys_id Sys_id de itens-base de instalação cobertos pelo direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]
    sold_prodocts_covered Lista de sys_ids dos produtos cobertos pelo direito.

    Tipo de dados: Matriz de objetos

    "sold_products_covered": [ 
  {
    "sys_id": "String"
  }
]
    sold_products_covered. ​sys_id Sys_id de um produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]
    sys_id Sys_id do registro de direito associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    Solicitação de curl

    O exemplo a seguir mostra como criar um modelo de direito.

    curl "https://instance.servicenow.com/api/sn_pss_core/entitlement" \
--request POST \
--header "Accept:application/json" \
--data
{
  "state": "active",
  "entitlement_name": "indep entl",
  "account": "4c325111d1f53110f8776589fa411f3d",
  "start_date": "2023-10-03",
  "end_date": "2024-12-03",
  "sold_products_covered": [
    {
      "sold_product": "0df21151d1f53110f8776589fa411f1b"
    }
  ], 
  "install_base_items_covered": [
    {
      "install_base": "e2639951d1f53110f8776589fa411f2b"
    }
  ],
  "entitlement_characteristics": [
    {
      "characteristic": "63418db7539e61106bfcddeeff7b1238",
      "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
      "value": "20",
      "type": "coverage_and_usage",
      "entitlement_usage": {
        "used_units": "25"
      } 
    }
  ]
}

    Resposta:

    {
  "result": {
    "sys_id": "5a651515d1f53110f8776589fa411f7b",
    "entitlement_name": "indep entl",
    "sold_products_covered": [
      {
        "sys_id": "d6651515d1f53110f8776589fa411f7c"
      }
    ],
    "install_base_items_covered": [
      {
        "sys_id": "12651515d1f53110f8776589fa411f7d"
      }
    ],
    "entitlement_characteristics": [
      {
        "sys_id": "12651515d1f53110f8776589fa411f7e",
        "entitlement_usage": {
          "sys_id": "de651515d1f53110f8776589fa411f7e"
        }
      }
    ]
  }
}