API de direito

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

    • A API de direito 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-venda para clientes que compram um produto, como um dispositivo ou computador. As verificações de direito são feitas por agentes para determinar quais serviços os clientes estão qualificados para receber pelos produtos que compraram. Use a API de direito 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:
    • Contratos e direitos 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)

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

    Direito - GET /sn_pss_core/entitlement/{id}

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

    A seguir está 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 para produtos vendidos cobertos e itens-base de instalação cobertos.

    Formato da URL

    URL com controle de versões: /api/sn_pss_core/v1/entitlement/{id}

    URL padrão: /api/sn_pss_core/entitlement/{id}

    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. Somente especifique este valor 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. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    Tabela 2. Parâmetros de consulta
    Nome Descrição
    display_value Tipo de dados a serem retornados.
    Valores válidos:
    • falso: retorna o valor de todos os campos. Por exemplo, "state":"draft".
    • verdadeiro: retorna o display_value para todos os campos. Por exemplo, "estado":"Rascunho"
    • all: retorna todas as informações de todos os campos.
      "state": { 
  "name": "state",
  "label": "State",
  "value": "draft",
  "display_value": "Draft",
  "type": "string"
}

    Tipo de dados: cadeia de caracteres

    Padrão: falso
    Tabela 3. Parâmetros do corpo da solicitação (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/json ou 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 6. Códigos de status
    Código de status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    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 de conta ao qual o direito pertence. Localizado na tabela Conta [customer_account].

    Tipo de dados: cadeia de caracteres
    cliente
    Sys_id do registro do consumidor ao qual o direito pertence. Localizado na tabela Consumidor [csm_consumer].

    Tipo de dados: cadeia de caracteres
    contrato Sys_id do registro do contrato ao qual o direito pertence. Localizado na tabela Contrato de serviço [sn_pss_core_service_contract].

    Tipo de dados: cadeia de caracteres
    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.
    direitos_características Lista de características associadas ao direito. Os dados nesta matriz são inseridos na tabela Característica [sn_pss_core_entitlement_characteristic].

    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"
  }
]
    direito_características.​característica
    Sys_id do registro de característica associado ao direito. Localizado na tabela Característica [sn_prd_pm_characteristic].

    Tipo de dados: cadeia de caracteres
    direito_características.​característica_opção Sys_id do registro de opção de característica associado ao direito. Localizado na tabela Opção de característica [sn_prd_pm_characteristic_option].

    Tipo de dados: cadeia de caracteres
    direito_características.​direito Sys_id do registro de direito associado. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​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_characteristics.​entitlement_usage.​direito Sys_id do registro de direito associado ao uso de direito. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​entitlement_usage.​entitlement_characteristics Sys_id do registro de característica de direito associado ao uso de direito. Localizado na tabela Característica [sn_pss_core_entitlement_characteristic].

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​entitlement_usage.​period_end Data de término em que o uso do direito não é mais rastreado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    entitlement_characteristics.​entitlement_usage.​period_start Data de início em que o uso do direito é rastreado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    entitlement_characteristics.​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_characteristics.​entitlement_usage.​sys_created_by Nome do usuário que criou o registro de uso de direito.

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​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_characteristics.​entitlement_usage.​sys_id Sys_id do registro de uso de direito. Localizado na tabela Uso de direito [sn_pss_core_entitlement_usage].

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​entitlement_usage.​sys_updated_by Nome do usuário que atualizou pela última vez o registro de uso de direito.

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​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_characteristics.​entitlement_usage.​total_units Valor de cobertura total da característica de direito associada.

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​entitlement_usage.​used_units Número de unidades usadas pela conta ou consumidor entre period_start e period_end.

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​type Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura_e_uso

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​value
    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 da residência associado ao direito. Localizado na tabela Residência [csm_household].

    Tipo de dados: cadeia de caracteres
    install_base_items_covered Lista de itens-base de instalação cobertos pelo direito. Localizado na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    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"
  }
]
    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.​contract Sys_id do registro do contrato de serviço associado ao item-base de instalação. Localizado na tabela Contrato de serviço [sn_pss_core_service_contract].

    Tipo de dados: cadeia de caracteres
    install_base_items_covered.​install_base Sys_id do item-base de instalação coberto pela linha do contrato de serviço. Localizado na tabela Item-base de instalação [sn_install_base_item].

    Tipo de dados: cadeia de caracteres
    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. Localizado na tabela Direito [service_entitlement].

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

    Tipo de dados: cadeia de caracteres
    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. Localizado na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    Tipo de dados: cadeia de caracteres
    install_base_items_covered.​sys_updated_by Nome do usuário que atualizou pela última vez o registro do item-base de instalação.

    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. Localizado na tabela Modelo de Produto [cmdb_model].

    Tipo de dados: cadeia de caracteres
    produto_oferta Sys_id do registro de oferta de produto associado ao direito. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    direito_vendido Sys_id do registro do produto vendido associado ao direito. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres
    produtos_vendidos_cobertos Lista de produtos cobertos. Localizado na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    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"
  }
]
    vendidos_produtos_cobertos.​adicionados 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
    vendidos_produtos_cobertos.​contrato Sys_id do registro do contrato de serviço associado ao produto vendido coberto. Localizado na tabela Contrato de serviço [sn_pss_core_service_contract].

    Tipo de dados: cadeia de caracteres
    spoke_products_covered.​direito Sys_id do registro de direito associado ao produto vendido coberto. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    produtos_vendidos_cobertos.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
    vendidos_produtos_cobertos.​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao produto vendido coberto. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    produtos_vendidos_cobertos.​produtos_vendidos Sys_id do produto coberto pelo direito. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres
    produtos_vendidos_cobertos.​sys_created_by Nome do usuário que criou o registro coberto pelo produto vendido.

    Tipo de dados: cadeia de caracteres
    produtos_vendidos_cobertos.​sys_created_on Data e hora em que o registro coberto do produto vendido foi criado.

    Tipo de dados: cadeia de caracteres
    vendidos_produtos_cobertos.​sys_id Sys_id do produto coberto por este contrato de serviço. Localizado na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    Tipo de dados: cadeia de caracteres
    produtos_vendidos_cobertos.​sys_updated_by Nome do usuário que atualizou pela última vez o registro coberto do produto vendido.

    Tipo de dados: cadeia de caracteres
    produtos_vendidos_cobertos.​sys_updated_on Data e hora em que o registro coberto do 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
    • cancelado(a)
    • 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. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    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"
          }
        ]
      }
    ]
  }
}

    Direito - POST /sn_pss_core/entitlement

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

    A seguir está a lista de tabelas nas quais os dados de direito são armazenados:
    • Característica [sn_pss_core_entitlement_characteristic]
    • 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 para produtos vendidos cobertos e itens-base de instalação cobertos.

    Formato da URL

    URL com controle de versões: /api/sn_pss_core/v1/entitlement

    URL padrão: /api/sn_pss_core/entitlement

    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. Somente especifique este valor 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. Parâmetros do corpo da solicitação (JSON)
    Nome Descrição
    conta Obrigatório se o parâmetro consumer não for passado.
    Sys_id do registro de conta ao qual o direito pertence. Localizado na tabela Conta [customer_account].

    Tipo de dados: cadeia de caracteres
    cliente Obrigatório se o parâmetro account não for passado.
    Sys_id do registro do consumidor ao qual o direito pertence. Localizado na tabela Consumidor [csm_consumer].

    Tipo de dados: cadeia de caracteres
    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.
    direitos_características Lista de características associadas ao direito. Os dados nesta matriz são inseridos na tabela Característica [sn_pss_core_entitlement_characteristic].

    Tipo de dados: matriz de objetos

    "entitlement_characteristics": [
  {
    "characteristic": "String",
    "characteristic_option": "String",
    "entitlement_usage": {Object},
    "type": "String",
    "value": "String"
  }
]
    direito_características.​característica Obrigatório.
    Sys_id do registro de característica associado ao direito. Localizado na tabela Característica [sn_prd_pm_characteristic].

    Tipo de dados: cadeia de caracteres
    direito_características.​característica_opção Sys_id do registro de opção de característica associado ao direito. Localizado na tabela Opção de característica [sn_prd_pm_characteristic_option].

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​entitlement_usage Valor unitário usado para a característica de direito associada. Esses dados são inseridos na tabela Uso de direito [sn_pss_core_entitlement_usage].

    Somente passe este parâmetro se entitlement_characteristics estiver sob o direito.

    Tipo de dados: objeto

    "entitlement_usage": {
    "used_units": "String"
}
    entitlement_characteristics.​entitlement_usage.​usage_units Uso da característica de direito associada.

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​type Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura_e_uso

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​value Obrigatório se o parâmetro input_type contido no registro especificado no parâmetro entitlement_characteristics.characteristic não for escolha.
    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 da residência estão ativos e o parâmetro consumer é aprovado.
    Sys_id do registro da residência associado ao direito. Localizado na tabela Residência [csm_household].

    Tipo de dados: cadeia de caracteres
    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.added 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. Localizado na tabela Item-base de instalação [sn_install_base_item].

    Tipo de dados: cadeia de caracteres
    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. Localizado na tabela Modelo de Produto [cmdb_model].

    Tipo de dados: cadeia de caracteres
    produto_oferta Sys_id do registro de oferta de produto associado ao direito. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    direito_vendido Sys_id do registro do produto vendido associado ao direito. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres
    produtos_vendidos_cobertos Lista de produtos cobertos pelo direito. Os dados neste parâmetro são inseridos na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "added": "String",
    "removed": "String",
    "sold_product": "String"
  }
]
    produtos_vendidos_cobertos.adicionados 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
    produtos_vendidos_cobertos.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
    produtos_vendidos_cobertos.produto_vendido Sys_id do produto coberto pelo direito. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres
    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
    • cancelado(a)
    • 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/json ou application/xml.

    Padrão: application/json
    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/json ou 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 códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.

    Tabela 12. Códigos de status
    Código de status Descrição
    201 Bem-sucedido. A solicitação foi processada com sucesso e os registros foram criados.
    400 Solicitação Incorreta. Foi detectado um tipo de solicitação incorreto ou solicitação malformada.
    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
    direitos_características Lista dos objetos de característica de direito criados sob o direito.

    Tipo de dados: matriz de objetos

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

    Tipo de dados: objeto

    "entitlement_usage": {
    "sys_id": "String"
}
    entitlement_characteristics.​entitlement_usage.​sys_id Sys_id do registro de uso de direito. Localizado na tabela Uso de direito [sn_pss_core_entitlement_usage].

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​sys_id Sys_id de um registro de características de direito associado ao direito. Localizado na tabela Característica [sn_pss_core_entitlement_characteristic].

    Tipo de dados: cadeia de caracteres
    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. Localizado na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    Tipo de dados: cadeia de caracteres
    produtos_vendidos_cobertos Lista de sys_ids dos produtos cobertos pelo direito.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "sys_id": "String"
  }
]
    vendidos_produtos_cobertos.​sys_id Sys_id de um produto associado ao direito. Localizado na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

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

    Tipo de dados: cadeia de caracteres

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