API de contrato de serviço

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

    • A API de contrato de serviço fornece endpoints para criar e recuperar registros de contrato de serviço.

    Nota:
    Esta API serve para criar dados nas tabelas da aplicação Contratos e direitos do cliente. Não é uma API de finalidade geral.
    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)
    • Gestão de catálogo de produtos Core (com.sn_prd)

    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.

    Antes de usar esta API, você deve ter dados associados nas tabelas a seguir. Para obter informações adicionais, confira Create service contracts.

    • Conta [customer_account]
    • Consumidor [csm_consumer]
    • 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]
    • Produto vendido [sn_install_base_sold_product]

    Contrato de serviço - GET /sn_pss_core/servicecontract/{id}

    Recupera um registro de contrato de serviço especificado.

    Este endpoint recupera dados nas seguintes tabelas ao processar a solicitação:
    • Característica [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.
    • Contrato de serviço [sn_pss_core_service_contract]
    • Linha de contrato de serviço [sn_pss_core_service_contract_line]

    Formato da URL

    URL com controle de versão: /api/sn_pss_core/v1/servicecontract/{id}

    URL padrão: /api/sn_pss_core/servicecontract/{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 contrato de serviço a ser recuperado. Localizado na tabela Contrato de serviço [sn_pss_core_service_contract].

    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 (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/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 permissão para acessar a API.
    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
    conta
    Sys_id do registro de conta ao qual o contrato de serviço pertence. Localizado na tabela Conta [customer_account].

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

    Tipo de dados: cadeia de caracteres
    términos
    Data em que o contrato de serviço termina.

    Tipo de dados: cadeia de caracteres
    residência
    Sys_id da residência associada ao contrato de serviço. Localizado na Residência [csm_household].

    Tipo de dados: cadeia de caracteres
    install_base_items_covered Lista de itens-base de instalação cobertos pela linha de contrato de serviço.

    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 contrato de serviço associado começa a cobrir o item-base de instalação.

    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.​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.​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 contrato de serviço associado termina a cobertura do item-base de instalação.

    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
    número Número do contrato de serviço gerado automaticamente.

    Tipo de dados: cadeia de caracteres
    linhas_de_contrato_de_serviço Lista de linhas de contrato de serviço (serviços) associadas ao contrato de serviço.

    Tipo de dados: matriz de objetos

    "service_contract_lines": [
  {
    "child_contract_lines": [Array],
    "contract": "String",
    "ends": "String",
    "entitlements": [Array],
    "entitlement_characteristics": [Array],
    "install_base_items_covered": [Array],
    "name": "String",
    "parent_contract_line": "String",
    "product_model": "String",
    "product_offering": "String",
    "sold_product": "String",
    "sold_products_covered": [Array],
    "starts": "String",
    "state": "String",
    "sys_created_by": "String",
    "sys_created_on": "String",
    "sys_id": "String",
    "sys_updated_by": "String",
    "sys_update_on": "String"
  }
]
    service_contract_lines.​child_contract_lines Lista de linhas de contrato de serviço secundárias associadas à linha de contrato de serviço.

    Tipo de dados: matriz de objetos

    "child_contract_lines": [
  {
    "child_contract_lines": [Array],
    "contract": "String",
    "ends": "String",
    "entitlements": [Array],
    "entitlement_characteristics": [Array],
    "install_base_items_covered": [Array],
    "name": "String",
    "parent_contract_line": "String",
    "product_model": "String",
    "product_offering": "String",
    "sold_product": "String",
    "sold_products_covered": [Array],
    "starts": "String",
    "state": "String",
    "sys_created_by": "String",
    "sys_created_on": "String",
    "sys_id": "String",
    "sys_updated_by": "String",
    "sys_update_on": "String"
  }
]
    service_contract_lines.​child_contract_lines.​child_contract_lines Lista de linhas de contrato de serviço secundário associadas à linha de contrato de serviço secundário. Os mesmos parâmetros que em child_contract_lines.
    service_contract_lines.​child_contract_lines.​contract Sys_id do contrato de serviço associado à linha do contrato de serviço secundário. Localizado na tabela Contrato de serviço [sn_pss_core_service_contract].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​ends Data em que a linha do contrato de serviço secundário termina.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: nunca termina até que seja removido manualmente.
    service_contract_lines.​child_contract_lines.​direitos Lista de direitos associados à linha de contrato de serviço secundária.

    Tipo de dados: matriz de objetos

    "entitlements": [
  {
    "account": "String",
    "consumer": "String",
    "contract": "String",
    "end_date": "String",
    "entitlement_characteristics": [Array],
    "entitlement_name": "String",
    "household": "String",
    "install_base_items_covered": [Array],
    "product": "String",
    "product_offering": "String"
    "service_contract_line": "String",
    "sold_entitlement": "String",
    "sold_products_covered": [Array],
    "start_date": "String",
    "state": "String",
    "sys_created_by": "String",
    "sys_created_on": "String",
    "sys_id": "String",
    "sys_updated_by": "String",
    "sys_updated_on": "String"
  }
]
    service_contract_lines.​child_contract_lines.​direitos.​conta
    Sys_id do registro de conta ao qual o direito pertence. Localizado na tabela Conta [customer_account].

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​direitos.​contract 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
    service_contract_lines.​child_contract_lines.​direitos.​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.
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_characteristics Lista de características associadas ao direito.

    Tipo de dados: matriz de objetos

    "entitlement_characteristics": [
  {
    "characteristic": "String",
    "characteristic_option": "String",
    "entitlement": "String",
    "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"
  }
]
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_characteristics.​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
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_characteristics.​characterstic_option 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
    service_contract_lines.​child_contract_lines.​direitos.​direito_características.​direito Sys_id do registro de direito. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_characterics.​entitlement_usage Lista de valores de uso para o produto associado.

    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_update_on": "String",
    "total_units": "String",
    "used_units": "String"
  }
]
    service_contract_lines.​child_contract_lines.​direitos.​direito_características.​direito_uso.​direito Sys_id do registro de direito associado ao uso de direito. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​direitos.​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
    service_contract_lines.​child_contract_lines.​entitlements.​entitlement_characterics.​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
    service_contract_lines.​child_contract_lines.​entitlements.​entitlement_characterics.​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
    service_contract_lines.​child_contract_lines.​entitlements.​entitlement_characterics.​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
    service_contract_lines.​child_contract_lines.​entitlements.​entitlement_characterics.​entitlement_usage.​sys_created_by Nome do usuário que criou o registro de uso de direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlements.​entitlement_characterics.​entitlement_usage.​sys_created_on Data e hora em que o registro de uso de direito foi criado.

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlements.​entitlement_characterics.​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
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_characterics.​service_contract_line Linha de contrato secundária à qual a característica de direito atual pertence.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_characterics.​sys_created_by Nome do usuário que criou a característica de direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlements.​entitlement_characterics.​sys_created_on Data e hora em que a característica de direito foi criada.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlements.​entitlement_characteristics.​sys_id Sys_id do registro da característica de direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlements.​entitlement_characterics.​sys_updated_by Nome do usuário que atualizou pela última vez a característica de direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlements.​entitlement_characterics.​sys_updated_on Data e hora em que a característica de direito foi atualizada pela última vez.

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_characterics.​value
    Valor da característica.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_name
    Nome do direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​direitos.​household
    Sys_id do registro da residência associado ao direito. Localizado na tabela Residência [csm_household].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlements.​install_base_items_covered Lista de itens-base de instalação cobertos pela linha de contrato de serviço secundário. 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"
  }
]
    service_contract_lines.​child_contract_lines.​entitlements.​install_base_items_covered.​added
    Data em que o item-base de instalação associado foi adicionado à linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    service_contract_lines.​child_contract_lines.​entitlements.​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
    service_contract_lines.​child_contract_lines.​direitos.​install_base_items_covered.​direito Sys_id do registro de direito 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
    service_contract_lines.​child_contract_lines.​entitlements.​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
    service_contract_lines.​child_contract_lines.​direitos.​install_base_items_covered.​removed
    Data em que a linha do contrato de serviço associado termina a cobertura do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    service_contract_lines.​child_contract_lines.​entitlements.​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
    service_contract_lines.​child_contract_lines.​entitlements.​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
    service_contract_lines.​child_contract_lines.​entitlements.​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
    service_contract_lines.​child_contract_lines.​entitlements.​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
    service_contract_lines.​child_contract_lines.​entitlements.​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
    service_contract_lines.​child_contract_lines.​entitlements.​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
    service_contract_lines.​child_contract_lines.​direitos.​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
    service_contract_lines.​child_contract_lines.​direitos.​product_offering 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
    service_contract_lines.​child_contract_lines.​direitos.​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao direito. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlements.​sold_entitlement 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
    service_contract_lines.​child_contract_lines.​direitos.​sold_products_covered 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"
  }
]
    service_contract_lines.​child_contract_lines.​direitos.​sold_products_covered.​added
    Data em que o contrato de serviço associado começa a cobrir o produto.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    service_contract_lines.​child_contract_lines.​entitlements.​sold_products_covered.​contract 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
    service_contract_lines.​child_contract_lines.​direitos.​sold_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
    service_contract_lines.​child_contract_lines.​direitos.​sold_products_covered.​removed
    Data em que o contrato de serviço associado termina a cobertura do produto associado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    service_contract_lines.​child_contract_lines.​entitlements.​sold_products_covered.​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
    service_contract_lines.​child_contract_lines.​direitos.​sold_products_covered.​sold_product Sys_id do produto coberto pelo contrato de serviço. Localizado na tabela Produto vendido [sn_install_base_sold_product].

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

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlements.​sold_products_covered.​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
    service_contract_lines.​child_contract_lines.​entitlements.​sold_products_covered.​sys_updated_by Nome do usuário que atualizou pela última vez o registro coberto do produto vendido.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlements.​sold_products_covered.​sys_updated_on Nome do usuário que atualizou pela última vez o registro coberto do produto vendido.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​direitos.​start_date
    Data de início do direito.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    service_contract_lines.​child_contract_lines.​direitos.​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
    service_contract_lines.​child_contract_lines.​entitlements.​sys_created_by Nome do usuário que criou o registro de direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlements.​sys_created_on Data e hora em que o registro de direito foi criado.

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlements.​sys_updated_by Nome do usuário que atualizou o registro de direito pela última vez.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlements.​sys_updated_on Data e hora em que o registro de direito foi criado.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlement_characteristics 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"
  }
]
    service_contract_lines.​child_contract_lines.​entitlement_characteristics.​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
    service_contract_lines.​child_contract_lines.​entitlement_characteristics.​characterstic_option 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
    service_contract_lines.​child_contract_lines.​direito_características.​direito Sys_id do registro de direito. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlement_characteristics.​service_contract_line Sys_id do registro de linha do contrato de serviço associado à característica de direito. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlement_characteristics.​sys_created_by Nome do usuário que criou o registro de características de direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlement_characteristics.​sys_created_on Data e hora em que o registro de características de direito foi criado.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlement_characteristics.​sys_id Sys_id do registro de características de direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlement_characteristics.​sys_updated_by Nome do usuário que atualizou pela última vez o registro de características de direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlement_characteristics.​sys_updated_on Data e hora em que o registro de características de direito foi atualizado pela última vez.

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlement_characterics.​value
    Valor da característica.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​install_base_items_covered Lista de itens-base de instalação cobertos pela linha de contrato de serviço secundário. 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"
  }
]
    service_contract_lines.​child_contract_lines.​install_base_items_covered.​added
    Data em que o item-base de instalação associado foi adicionado à linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    service_contract_lines.​child_contract_lines.​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
    service_contract_lines.​child_contract_lines.​install_base_items_covered.​entitlement Sys_id do registro de direito 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
    service_contract_lines.​child_contract_lines.​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
    service_contract_lines.​child_contract_lines.​install_base_items_covered.​removed
    Data em que a linha do contrato de serviço associado termina a cobertura do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    service_contract_lines.​child_contract_lines.​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
    service_contract_lines.​child_contract_lines.​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
    service_contract_lines.​child_contract_lines.​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
    service_contract_lines.​child_contract_lines.​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
    service_contract_lines.​child_contract_lines.​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
    service_contract_lines.​child_contract_lines.​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
    service_contract_lines.​child_contract_lines.​nome Nome da linha do contrato de serviço secundário.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​parent_contract_line Sys_id do registro de linha de contrato primário associado à linha de contrato de serviço secundária.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​product_model Sys_id do produto associado à linha de contrato de serviço secundário. Localizado na tabela Modelo de Produto [cmdb_model].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​product_offering Sys_id do registro de oferta de produto associado à linha de contrato de serviço secundária. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​sold_product Sys_id do registro do produto vendido associado à linha do contrato de serviço secundário. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​sold_products_covered 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"
  }
]
    service_contract_lines.​child_contract_lines.​sold_products_covered.​added
    Data em que o contrato de serviço associado começa a cobrir o produto.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    service_contract_lines.​child_contract_lines.​sold_products_covered.​contract 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
    service_contract_lines.​child_contract_lines.​sold_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
    service_contract_lines.​child_contract_lines.​sold_products_covered.​removed
    Data em que o contrato de serviço associado termina a cobertura do produto associado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    service_contract_lines.​child_contract_lines.​sold_products_covered.​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
    service_contract_lines.​child_contract_lines.​sold_products_covered.​sold_product Sys_id do produto coberto pelo contrato de serviço. Localizado na tabela Produto vendido [sn_install_base_sold_product].

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

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​sold_products_covered.​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
    service_contract_lines.​child_contract_lines.​sold_products_covered.​sys_updated_by Nome do usuário que atualizou pela última vez o registro coberto do produto vendido.

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​starts Data de início da linha de contrato de serviço secundário.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    service_contract_lines.​child_contract_lines.​sys_created_by Nome do usuário que criou o registro de linha de contrato de serviço secundário.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​sys_created_on Data e hora em que o registro de linha do contrato de serviço secundário foi criado.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​sys_id Sys_id de um registro de linha de contrato de serviço secundário. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​sys_updated_by Nome do usuário que atualizou pela última vez o registro de linha de contrato de serviço secundário.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​sys_updated_on Data e hora em que o registro da linha do contrato de serviço secundário foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​Contract
    Sys_id do contrato de serviço associado à linha do contrato de serviço. Localizado na tabela Contrato de serviço [sn_pss_core_service_contract].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​término Data em que a linha do contrato de serviço termina.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: nunca termina até que seja removido manualmente.
    service_contract_lines.​direitos Lista de direitos associados ao contrato de serviço. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: matriz de objetos

    "entitlements": [
  {
    "account": "String",
    "consumer": "String",
    "contract": "String",
    "end_date": "String",
    "entitlement_characteristics": [Array],
    "entitlement_name": "String",
    "household": "String",
    "install_base_items_covered": [Array],
    "product": "String",
    "product_offering": "String",
    "service_contract_line": "String",
    "sold_entitlement": "String",
    "sold_products_covered": [Array],
    "start_date": "String",
    "state": "String",
    "sys_created_by": "String",
    "sys_created_on": "String",
    "sys_id": "String",
    "sys_updated_by": "String",
    "sys_updated_on": "String"
  }
]
    service_contract_lines.​entitlements.​account
    Sys_id do registro de conta ao qual o direito pertence. Localizado na tabela Conta [customer_account].

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​direitos.​contract 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
    service_contract_lines.​entitlements.​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.
    service_contract_lines.​entitlements.​entitlement_characteristics Lista de características associadas ao direito. Localizado 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"
  }
]
    service_contract_lines.​direitos.​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
    service_contract_lines.​entitlements.​entitlement_characteristics.characterstic_option 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
    service_contract_lines.​direitos.​direito_características.​direito Sys_id do registro de direito associado. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​entitlement_characteristics.​entitlement_usage Lista de valores de uso para o produto associado.

    Tipo de dados: matriz de objetos

    "entitlement_usage": [
  {
    "entitlement": "String",
    "entitlement_characteristic": "String",
    "period_end": "String",
    "period_start": "String",
    "sys_created_by": "String",
    "sys_created_on": "String",
    "sys_id": "String",
    "sys_updated_by": "String",
    "sys_update_on": "String",
    "total_units": "String",
    "used_units": "String"
  }
]
    service_contract_lines.​entitlements.​entitlement_characteristics.​entitlement_usage.​entitlement Sys_id do registro de direito associado ao uso de direito. Localizado na tabela Direito [service_entitlement].

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​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
    service_contract_lines.​entitlements.​entitlement_characteristics.​service_contract_line Sys_id do registro de linha do contrato de serviço associado à característica de direito. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​entitlement_characteristics.​sys_created_by Nome do usuário que criou o registro de características de direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​entitlement_characteristics.​sys_created_on Data e hora em que o registro de características de direito foi criado.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​entitlement_characteristics.​sys_id Sys_id do registro de características de direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​entitlement_characteristics.​sys_updated_by Nome do usuário que atualizou pela última vez o registro de características de direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​entitlement_characteristics.​sys_updated_on Data e hora em que o registro de características de direito foi atualizado pela última vez.

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​entitlement_characteristics.​value
    Valor da característica.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​entitlement_name
    Nome do direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​household
    Sys_id do registro da residência associado ao direito. Localizado na tabela Residência [csm_household].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​install_base_items_covered Lista de itens-base de instalação cobertos pela linha de contrato de serviço.

    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"
  }
]
    service_contract_lines.​entitlements.​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
    service_contract_lines.​entitlements.​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
    service_contract_lines.​entitlements.​install_base_items_covered.​entitlement 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
    service_contract_lines.​entitlements.​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
    service_contract_lines.​entitlements.​install_base_items_covered.​removed Data em que o item-base de instalação associado foi removido do direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​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
    service_contract_lines.​entitlements.​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
    service_contract_lines.​entitlements.​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
    service_contract_lines.​entitlements.​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
    service_contract_lines.​entitlements.​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
    service_contract_lines.​entitlements.​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
    service_contract_lines.​direitos.​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
    service_contract_lines.​entitlements.​product_offering 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
    service_contract_lines.​direitos.​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao direito. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​sold_entitlement 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
    service_contract_lines.​entitlements.​sold_products_covered 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"
  }
]
    service_contract_lines.​entitlements.​sold_products_covered.​added 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
    service_contract_lines.​entitlements.​sold_products_covered.​contract 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
    service_contract_lines.​entitlements.​sold_products_covered.​entitlement Sys_id do registro de direito associado ao produto vendido coberto. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​sold_products_covered.removed 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
    service_contract_lines.​entitlements.​sold_products_covered.​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
    service_contract_lines.​entitlements.​sold_products_covered.​sold_product Sys_id do produto coberto pelo direito. Localizado na tabela Produto vendido [sn_install_base_sold_product].

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

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​sold_products_covered.​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
    service_contract_lines.​entitlements.​sold_products_covered.​sys_updated_by Nome do usuário que atualizou pela última vez o registro coberto do produto vendido.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​sold_products_covered.​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
    service_contract_lines.​entitlements.​start_date
    Data de início do direito.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    service_contract_lines.​direitos.​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
    service_contract_lines.​entitlements.​sys_created_by Nome do usuário que criou o registro de direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​sys_created_on Data e hora em que o registro de direito foi criado.

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

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​sys_updated_on Data e hora em que o registro de direito foi criado.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlement_characteristics Lista de características associadas à linha do contrato de serviço. Localizado 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"
  }
]
    service_contract_lines.​entitlement_characteristics.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
    service_contract_lines.​entitlement_characteristics.characteristic_option 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
    service_contract_lines.​direito_características.​direito Sys_id do registro de direito associado. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlement_characteristics.​entitlement_usage Lista de valores de uso para o produto associado.

    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_update_on": "String",
    "total_units": "String",
    "used_units": "String"
  }
]
    service_contract_lines.​entitlement_characteristics.​entitlement_usage.​entitlement Sys_id do registro de direito associado ao uso de direito. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​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
    service_contract_lines.​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
    service_contract_lines.​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
    service_contract_lines.​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
    service_contract_lines.​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
    service_contract_lines.​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
    service_contract_lines.​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
    service_contract_lines.​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
    service_contract_lines.​entitlement_characteristics.​entitlement_usage.​total_units Número total de unidades compradas.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlement_characteristics.​entitlement_usage.​used_units Número de unidades que foram usadas.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlement_characteristics.​service_contract_line Sys_id do registro de linha do contrato de serviço associado à característica de direito. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlement_characteristics.​sys_created_by Nome do usuário que criou o registro de características de direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlement_characteristics.​sys_created_on Data e hora em que o registro de características de direito foi criado.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlement_characteristics.​sys_id Sys_id do registro de características de direito.

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlement_characteristics.​sys_updated_on Data e hora em que o registro de características de direito foi atualizado pela última vez.

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlement_characteristics.value
    Valor da característica.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​install_base_items_covered Lista de itens-base de instalação cobertos pela linha de contrato de serviço. 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"
  }
]
    service_contract_lines.​install_base_items_covered.​added
    Data em que o item-base de instalação associado foi adicionado à linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​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
    service_contract_lines.​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
    service_contract_lines.​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
    service_contract_lines.​install_base_items_covered.​removed
    Data em que a linha do contrato de serviço associado termina a cobertura do item-base de instalação.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​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
    service_contract_lines.​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
    service_contract_lines.​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
    service_contract_lines.​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
    service_contract_lines.​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
    service_contract_lines.​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
    service_contract_lines.​nome
    Nome da linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​parent_contract_line Sys_id da linha de contrato de serviço da qual a linha de contrato de serviço atual é secundária.

    Nulo para as linhas de contrato criadas em um contrato.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​product_model Sys_id do produto associado à linha do contrato de serviço. Localizado na tabela Modelo de Produto [cmdb_model].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​product_offering Sys_id do registro de oferta de produto associado à linha do contrato de serviço. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​sold_product Sys_id do registro do produto vendido associado à linha do contrato de serviço. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​sold_products_covered 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"
  }
]
    service_contract_lines.​sold_products_covered.​adicionado Data em que o produto vendido associado foi adicionado à linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    service_contract_lines.​sold_products_covered.​contract 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
    service_contract_lines.​sold_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
    service_contract_lines.​sold_products_covered.removed Data em que o produto vendido associado foi removido da linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    service_contract_lines.​sold_products_covered.​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
    service_contract_lines.​sold_products_covered.​sold_product Sys_id do produto coberto pelo direito. Localizado na tabela Produto vendido [sn_install_base_sold_product].

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

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​sold_products_covered.​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
    service_contract_lines.​sold_products_covered.​sys_updated_by Nome do usuário que atualizou pela última vez o registro coberto do produto vendido.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​sold_products_covered.​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
    service_contract_lines.​inícios
    Data de início da linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    service_contract_lines.​estado
    Estado atual da linha do contrato.
    Valores válidos: (diferencia maiúsculas de minúsculas)
    • ativo
    • cancelado(a)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​sys_created_by Nome do usuário que criou o registro de linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​sys_created_on Data e hora em que o registro da linha do contrato de serviço foi criado.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​sys_id Sys_id de um registro de linha de contrato de serviço. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​sys_updated_by Nome do usuário que atualizou pela última vez o registro de linha de contrato de serviço.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​sys_updated_on Data e hora em que o registro da linha do contrato de serviço foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres
    short_description
    Breve descrição ou nome do contrato de serviço.

    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 contrato.

    Tipo de dados: cadeia de caracteres
    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
    vendidos_produtos_cobertos.​removido Data em que o produto vendido associado foi removido do contrato.

    Tipo de dados: cadeia de caracteres
    vendidos_produtos_cobertos.​service_line_contract 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 contrato de serviço. 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
    de início
    Data em que o contrato de serviço começa.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: inicia assim que aprovado.
    estado
    Estado atual do contrato de serviço.
    Valores válidos: (diferencia maiúsculas de minúsculas)
    • ativo
    • cancelado(a)
    • rascunho
    • expirado

    Tipo de dados: cadeia de caracteres
    sys_created_by Nome do usuário que criou o registro do contrato de serviço.

    Tipo de dados: cadeia de caracteres
    sys_created_on Data e hora em que o contrato de serviço foi criado.

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

    Tipo de dados: cadeia de caracteres
    sys_updated_by Nome do usuário que atualizou o registro do contrato de serviço pela última vez.

    Tipo de dados: cadeia de caracteres
    sys_updated_on Data e hora em que o registro do contrato de serviço foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres
    contrato_fornecedor
    Identificador exclusivo para um contrato externo associado.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint.

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

    Resposta:

    {
    "result": {
        "sys_id": "d8641151d1f53110f8776589fa411fde",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:27:29",
        "sys_updated_on": "2023-10-09 11:27:29",
        "account": "4c325111d1f53110f8776589fa411f3d",
        "consumer": null,
        "household": null,
        "number": "CNTR0010004",
        "state": "active",
        "starts": "2022-12-03",
        "ends": "",
        "short_description": null,
        "vendor_contract": "External Reference",
        "service_contract_lines": [
            {
                "sys_id": "d4641d91d1f53110f8776589fa411fbb",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "name": "CLI",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "parent_contract_line": null,
                "sold_product": null,
                "starts": "2022-12-03",
                "ends": "",
                "product_offering": null,
                "product_model": null,
                "child_contract_lines": [
                    {
                        "sys_id": "3a39ecdc01154f4ab782da0169c9c922",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "name": "Child CLI",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "parent_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "sold_product": null,
                        "starts": "2022-12-03",
                        "ends": "",
                        "product_offering": null,
                        "product_model": null,
                        "child_contract_lines": [],
                        "entitlements": [
                            {
                                "sys_id": "7439fd84c2494ba6951e58f333cfe8d4",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "entitlement_name": "Child CLI - ENTL",
                                "account": "4c325111d1f53110f8776589fa411f3d",
                                "consumer": null,
                                "household": null,
                                "contract": "d8641151d1f53110f8776589fa411fde",
                                "service_contract_line": "3a39ecdc01154f4ab782da0169c9c922",
                                "state": "active",
                                "product_offering": null,
                                "sold_entitlement": null,
                                "product": null,
                                "start_date": "2022-12-03",
                                "end_date": "",
                                "entitlement_characteristics": [],
                                "sold_products_covered": [],
                                "install_base_items_covered": []
                            }
                        ],
                        "sold_products_covered": [
                            {
                                "sys_id": "dfb62e9c4c6843009be02a68f65b9118",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "contract": "d8641151d1f53110f8776589fa411fde",
                                "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                                "entitlement": null,
                                "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
                                "added": "2023-12-03",
                                "removed": "2023-12-03"
                            }
                        ],
                        "install_base_items_covered": [
                            {
                                "sys_id": "2583912e81964501b52a2e44d4797a28",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "contract": "d8641151d1f53110f8776589fa411fde",
                                "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                                "entitlement": null,
                                "install_base": "a1731551d1f53110f8776589fa411f8d",
                                "added": "2023-12-03",
                                "removed": "2023-12-03"
                            }
                        ],
                        "entitlement_characteristics": [
                            {
                                "sys_id": "3a00c975bb49412cae169200c7f6236e",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                                "entitlement": null,
                                "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
                                "value": "5",
                                "characteristic": "63418db7539e61106bfcddeeff7b1238",
                                "type": "coverage"
                            }
                        ]
                    }
                ],
                "entitlements": [
                    {
                        "sys_id": "a8641d91d1f53110f8776589fa411fc0",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "entitlement_name": "ENTL",
                        "account": "4c325111d1f53110f8776589fa411f3d",
                        "consumer": null,
                        "household": null,
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "state": "active",
                        "product_offering": null,
                        "sold_entitlement": null,
                        "product": null,
                        "start_date": "2022-12-03",
                        "end_date": "",
                        "sold_products_covered": [
                            {
                                "sys_id": "a0641d91d1f53110f8776589fa411fc2",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "contract": "d8641151d1f53110f8776589fa411fde",
                                "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                                "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                                "sold_product": "da23d151d1f53110f8776589fa411f27",
                                "added": "",
                                "removed": ""
                            }
                        ],
                        "install_base_items_covered": [
                            {
                                "sys_id": "e0641d91d1f53110f8776589fa411fc3",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "contract": "d8641151d1f53110f8776589fa411fde",
                                "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                                "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                                "install_base": "43739151d1f53110f8776589fa411fc1",
                                "added": "2023-12-03",
                                "removed": "2023-12-03"
                            }
                        ],
                        "entitlement_characteristics": [
                            {
                                "sys_id": "a8641d91d1f53110f8776589fa411fd0",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "service_contract_line": null,
                                "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                                "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
                                "value": "5",
                                "characteristic": "63418db7539e61106bfcddeeff7b1238",
                                "type": "coverage_and_usage",
                                "entitlement_usage": [
                                    {
                                        "sys_id": "a8641d91d1f53110f8776589fa411fd1",
                                        "sys_created_by": "admin",
                                        "sys_updated_by": "admin",
                                        "sys_created_on": "2023-10-09 11:27:29",
                                        "sys_updated_on": "2023-10-09 11:27:29",
                                        "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                                        "service_contract_line": null,
                                        "entitlement_characteristic": "a8641d91d1f53110f8776589fa411fd0",
                                        "period_start": "2022-12-03",
                                        "period_end": "",
                                        "total_units": "5",
                                        "used_units": "3"
                                    }
                                ]
                            }
                        ]
                    }
                ],
                "sold_products_covered": [
                    {
                        "sys_id": "98641d91d1f53110f8776589fa411fbc",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "entitlement": null,
                        "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
                        "added": "2023-12-03",
                        "removed": "2023-12-03"
                    }
                ],
                "install_base_items_covered": [
                    {
                        "sys_id": "58641d91d1f53110f8776589fa411fbd",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "entitlement": null,
                        "install_base": "a1731551d1f53110f8776589fa411f8d",
                        "added": "2023-12-03",
                        "removed": "2023-12-03"
                    }
                ],
                "entitlement_characteristics": [
                    {
                        "sys_id": "e0641d91d1f53110f8776589fa411fbf",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "entitlement": null,
                        "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
                        "value": "5",
                        "characteristic": "63418db7539e61106bfcddeeff7b1238",
                        "type": "coverage"
                    }
                ]
            },
            {
                "sys_id": "e4641d91d1f53110f8776589fa411fd2",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "name": "CLI 2",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "parent_contract_line": null,
                "sold_product": null,
                "starts": "2022-12-03",
                "ends": "",
                "product_offering": null,
                "product_model": null,
                "child_contract_lines": [],
                "entitlements": [],
                "sold_products_covered": [
                    {
                        "sys_id": "e8641d91d1f53110f8776589fa411fd3",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "e4641d91d1f53110f8776589fa411fd2",
                        "entitlement": null,
                        "sold_product": "7f23995dd1b53110f8776589fa411f66",
                        "added": "2023-12-03",
                        "removed": "2023-12-03"
                    }
                ],
                "install_base_items_covered": [
                    {
                        "sys_id": "a8641d91d1f53110f8776589fa411fd4",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "e4641d91d1f53110f8776589fa411fd2",
                        "entitlement": null,
                        "install_base": "a483d951d1f53110f8776589fa411fad",
                        "added": "2023-12-03",
                        "removed": "2023-12-03"
                    }
                ],
                "entitlement_characteristics": [
                    {
                        "sys_id": "a8641d91d1f53110f8776589fa411fd5",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "service_contract_line": "e4641d91d1f53110f8776589fa411fd2",
                        "entitlement": null,
                        "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
                        "value": "5",
                        "characteristic": "63418db7539e61106bfcddeeff7b1238",
                        "type": "coverage"
                    }
                ]
            }
        ],
        "sold_products_covered": [
            {
                "sys_id": "9c641d91d1f53110f8776589fa411fb9",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "service_contract_line": null,
                "entitlement": null,
                "sold_product": "0df21151d1f53110f8776589fa411f1b",
                "added": "2023-12-03",
                "removed": "2023-12-03"
            }
        ],
        "install_base_items_covered": [
            {
                "sys_id": "d8641d91d1f53110f8776589fa411fba",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "service_contract_line": null,
                "entitlement": null,
                "install_base": "e2639951d1f53110f8776589fa411f2b",
                "added": "2023-12-03",
                "removed": "2023-12-03"
            }
        ]
    }
}

    Contrato de serviço - GET /sn_pss_core/servicecontract/contractline/{id}

    Recupera um registro de linha de contrato de serviço especificado.

    Este endpoint recupera dados nas seguintes tabelas ao processar a solicitação:
    • Característica [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.
    • Linha de contrato de serviço [sn_pss_core_service_contract_line]

    Formato da URL

    URL com controle de versão: /api/sn_pss_core/v1/servicecontract/contractline/{id}

    URL padrão: /api/sn_pss_core/servicecontract/contractline/{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. 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 linha do contrato de serviço a ser recuperado. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    Tabela 8. 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 9. Parâmetros do corpo da solicitação (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/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
    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 permissão para acessar a API.
    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
    child_contract_lines Lista de linhas de contrato de serviço secundárias associadas à linha de contrato de serviço.

    Tipo de dados: matriz de objetos

    "child_contract_lines": [
  {
    "child_contract_lines": [Array],
    "contract": "String",
    "ends": "String",
    "entitlements": [Array],
    "entitlement_characteristics": [Array],
    "install_base_items_covered": [Array],
    "name": "String",
    "parent_contract_line": "String",
    "product_model": "String",
    "product_offering": "String",
    "sold_product": "String",
    "sold_products_covered": [Array],
    "starts": "String",
    "state": "String",
    "sys_created_by": "String",
    "sys_created_on": "String",
    "sys_id": "String",
    "sys_updated_by": "String",
    "sys_update_on": "String"
  }
]
    child_contract_lines.​child_contract_lines Lista de objetos de linha de contrato de serviço secundário criados na linha de contrato de serviço secundário. Os objetos nesta matriz têm os mesmos elementos que os objetos no parâmetro child_contract_lines.

    Tipo de dados: matriz de objetos
    child_contract_lines.​Contract Sys_id do contrato de serviço associado à linha do contrato de serviço secundário. Localizado na tabela Contrato de serviço [sn_pss_core_service_contract].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​término Data em que a linha do contrato de serviço secundário termina.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: nunca termina até que seja removido manualmente.
    child_contract_lines.​direitos Lista de direitos associados à linha de contrato de serviço secundária.

    Tipo de dados: matriz de objetos

    "entitlements": [
  {
    "account": "String",
    "consumer": "String",
    "contract": "String",
    "end_date": "String",
    "entitlement_characteristics": [Array],
    "entitlement_name": "String",
    "household": "String",
    "install_base_items_covered": [Array],
    "product": "String",
    "product_offering": "String"
    "service_contract_line": "String",
    "sold_entitlement": "String",
    "sold_products_covered": [Array],
    "start_date": "String",
    "state": "String",
    "sys_created_by": "String",
    "sys_created_on": "String",
    "sys_id": "String",
    "sys_updated_by": "String",
    "sys_updated_on": "String"
  }
]
    child_contract_lines.​direitos.​conta
    Sys_id do registro de conta ao qual o direito pertence. Localizado na tabela Conta [customer_account].

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

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​direitos.​contract 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
    child_contract_lines.​direitos.​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.
    child_contract_lines.​entitlements.​entitlement_characteristics 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"
  }
]
    child_contract_lines.​direitos.​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
    child_contract_lines.​entitlements.​entitlement_characteristics.​characterstic_option 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
    child_contract_lines.​direitos.​direito_características.​direito Sys_id do registro de direito. Localizado na tabela Direito [service_entitlement].

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

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

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlements.​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
    child_contract_lines.​entitlements.​entitlement_characteristics.​type Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura_e_uso

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlements.​entitlement_characteristics.​value
    Valor da característica.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlements.​entitlement_name
    Nome do direito.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​direitos.​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
    child_contract_lines.​entitlements.​install_base_items_covered Lista de itens-base de instalação cobertos pela linha de contrato de serviço secundário. 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"
  }
]
    child_contract_lines.​entitlements.​install_base_items_covered.​added
    Data em que o item-base de instalação associado foi adicionado à linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    child_contract_lines.​entitlements.​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
    child_contract_lines.​entitlements.​install_base_items_covered.​entitlement Sys_id do registro de direito 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
    child_contract_lines.​entitlements.​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
    child_contract_lines.​entitlements.​install_base_items_covered.​removed
    Data em que a linha do contrato de serviço associado termina a cobertura do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    child_contract_lines.​entitlements.​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
    child_contract_lines.​entitlements.​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
    child_contract_lines.​entitlements.​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
    child_contract_lines.​entitlements.​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
    child_contract_lines.​entitlements.​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
    child_contract_lines.​entitlements.​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
    child_contract_lines.​direitos.​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
    child_contract_lines.​direitos.​product_offering 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
    child_contract_lines.​direitos.​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao direito. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlements.​sold_entitlement 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
    child_contract_lines.​entitlements.​sold_products_covered 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"
  }
]
    child_contract_lines.​entitlements.​sold_products_covered.​added
    Data em que o contrato de serviço associado começa a cobrir o produto.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    child_contract_lines.​entitlements.​sold_products_covered.​contract 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
    child_contract_lines.​entitlements.​sold_products_covered.​entitlement Sys_id do registro de direito associado ao produto vendido coberto. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlements.​sold_products_covered.​removed
    Data em que o contrato de serviço associado termina a cobertura do produto associado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    child_contract_lines.​entitlements.​sold_products_covered.​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
    child_contract_lines.​entitlements.​sold_products_covered.​sold_product Sys_id do produto coberto pelo contrato de serviço. Localizado na tabela Produto vendido [sn_install_base_sold_product].

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

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

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlements.​sold_products_covered.​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
    child_contract_lines.​entitlements.​sold_products_covered.​sys_updated_by Nome do usuário que atualizou pela última vez o registro coberto do produto vendido.

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

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​direitos.​start_date
    Data de início do direito.

    Tipo de dados: cadeia de caracteres

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

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​direitos.​sys_created_on Data e hora em que o registro de direito foi criado.

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

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

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​direitos.​sys_updated_on Data e hora em que o registro de direito foi criado.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlement_characteristics 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"
  }
]
    child_contract_lines.​entitlement_characteristics.​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
    child_contract_lines.​entitlement_characteristics.​characteristic_option 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
    child_contract_lines.​direito_características.​direito Sys_id do registro de direito. Localizado na tabela Direito [service_entitlement].

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

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

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​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
    child_contract_lines.​entitlement_characteristics.​service_contract_line Sys_id do registro de linha do contrato de serviço associado à característica de direito. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlement_characteristics.​sys_created_by Nome do usuário que criou o registro de características de direito.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlement_characteristics.​sys_created_on Data e hora em que o registro de características de direito foi criado.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlement_characteristics.​sys_id Sys_id do registro de características de direito.

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

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlement_characteristics.​sys_updated_on Data e hora em que o registro de características de direito foi atualizado pela última vez.

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

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlement_characteristics.​value
    Valor da característica.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​install_base_items_covered Lista de itens-base de instalação cobertos pela linha de contrato de serviço secundário. 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"
  }
]
    child_contract_lines.​install_base_items_covered.​added
    Data em que o item-base de instalação associado foi adicionado à linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    child_contract_lines.​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
    child_contract_lines.​install_base_items_covered.​direito Sys_id do registro de direito 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
    child_contract_lines.​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
    child_contract_lines.​install_base_items_covered.​removed
    Data em que a linha do contrato de serviço associado termina a cobertura do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    child_contract_lines.​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
    child_contract_lines.​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
    child_contract_lines.​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
    child_contract_lines.​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
    child_contract_lines.​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
    child_contract_lines.​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
    child_contract_lines.​nome Nome da linha do contrato de serviço secundário.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​parent_contract_lines Sys_id do registro de linha de contrato primário associado à linha de contrato de serviço secundária.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​product_model Sys_id do produto associado à linha de contrato de serviço secundário. Localizado na tabela Modelo de Produto [cmdb_model].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​product_offering Sys_id do registro de oferta de produto associado à linha de contrato de serviço secundária. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​sold_product Sys_id do registro do produto vendido associado à linha do contrato de serviço secundário. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​sold_products_covered 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"
  }
]
    child_contract_lines.​sold_products_covered.​adicionado
    Data em que o contrato de serviço associado começa a cobrir o produto.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    child_contract_lines.​sold_products_covered.​contract 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
    child_contract_lines.​sold_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
    child_contract_lines.​sold_products_covered.​removido
    Data em que o contrato de serviço associado termina a cobertura do produto associado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    child_contract_lines.​sold_products_covered.​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
    child_contract_lines.​sold_products_covered.​sold_product Sys_id do produto coberto pelo contrato de serviço. Localizado na tabela Produto vendido [sn_install_base_sold_product].

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

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

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​sold_products_covered.​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
    child_contract_lines.​sold_products_covered.​sys_updated_by Nome do usuário que atualizou pela última vez o registro coberto do produto vendido.

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

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​inícios Data de início da linha de contrato de serviço secundário.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    child_contract_lines.​estado
    Estado atual da linha do contrato.
    Valores válidos: (diferencia maiúsculas de minúsculas)
    • ativo
    • cancelado(a)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​sys_created_by Nome do usuário que criou o registro de linha de contrato de serviço secundário.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​sys_created_on Data e hora em que o registro de linha do contrato de serviço secundário foi criado.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​sys_id Sys_id de um registro de linha de contrato de serviço secundário. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​sys_updated_by Nome do usuário que atualizou pela última vez o registro de linha de contrato de serviço secundário.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​sys_updated_on Data e hora em que o registro da linha do contrato de serviço secundário foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres
    contrato
    Sys_id do contrato de serviço associado à linha do contrato de serviço. Localizado na tabela Contrato de serviço [sn_pss_core_service_contract].

    Tipo de dados: cadeia de caracteres
    términos Data em que a linha do contrato de serviço termina.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: nunca termina até que seja removido manualmente.
    direitos Lista de direitos associados à linha do contrato de serviço. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: matriz de objetos

    "entitlements": [
  {
    "account": "String",
    "consumer": "String",
    "contract": "String",
    "end_date": "String",
    "entitlement_characteristics": [Array],
    "entitlement_name": "String",
    "household": "String",
    "install_base_items_covered": [Array],
    "product": "String",
    "product_offering": "String",
    "service_contract_line": "String",
    "sold_entitlement": "String",
    "sold_products_covered": [Array],
    "start_date": "String",
    "state": "String",
    "sys_created_by": "String",
    "sys_created_on": "String",
    "sys_id": "String",
    "sys_updated_by": "String",
    "sys_updated_on": "String"
  }
]
    direitos.​conta
    Sys_id do registro de conta ao qual o direito pertence. Localizado na tabela Conta [customer_account].

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

    Tipo de dados: cadeia de caracteres
    direitos.​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
    direitos.​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.​direito_características Lista de características associadas ao direito. Localizado 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"
  }
]
    direitos.​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
    direitos.​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
    direitos.​direito_características.​direito Sys_id do registro de direito associado. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    direitos.​entitlement_características.​entitlement_usage

    Tipo de dados: matriz de objetos

    "entitlement_usage": [
  {
    "entitlement": "String",
    "entitlement_characteristic": [Array],
    "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"
  }
]
    direitos.​direito_características.​direito_uso.​direito Sys_id do registro de direito associado ao uso de direito. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    direitos.​entitlement_characteristics.​entitlement_usage.​entitlement_characterism 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
    direitos.​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
    direitos.​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
    direitos.​entitlement_characteristics.​entitlement_usage.​service_contract_line Linha de contrato de serviço à qual o uso de direito atual pertence.

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

    Tipo de dados: cadeia de caracteres
    direitos.​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
    direitos.​entitlement_characteristics.​service_contract_line Sys_id do registro de linha do contrato de serviço associado à característica de direito. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    direitos.​entitlement_characteristics.​sys_created_by Nome do usuário que criou o registro de características de direito.

    Tipo de dados: cadeia de caracteres
    direitos.​entitlement_characteristics.​sys_created_on Data e hora em que o registro de características de direito foi criado.

    Tipo de dados: cadeia de caracteres
    direitos.​entitlement_characteristics.​sys_id Sys_id do registro de características de direito.

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

    Tipo de dados: cadeia de caracteres
    direitos.​entitlement_characteristics.​sys_updated_on Data e hora em que o registro de características de direito foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres
    direitos.​direitos_características.tipo Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura_e_uso

    Tipo de dados: cadeia de caracteres
    direitos.​entitlement_características.valor
    Valor da característica.

    Tipo de dados: cadeia de caracteres
    direitos.​entitlement_name
    Nome do direito.

    Tipo de dados: cadeia de caracteres
    direitos.​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
    direitos.​install_base_items_covered Lista de itens-base de instalação cobertos pela linha de contrato de serviço.

    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"
  }
]
    direitos.​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
    direitos.​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
    direitos.​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
    direitos.​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
    direitos.​install_base_items_covered.​removed Data em que o item-base de instalação associado foi removido do direito.

    Tipo de dados: cadeia de caracteres
    direitos.​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
    direitos.​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
    direitos.​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
    direitos.​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
    direitos.​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
    direitos.​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
    direitos.​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
    direitos.​product_offering 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
    direitos.​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao 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 do produto vendido associado ao direito. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres
    direitos.​sold_products_covered 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"
  }
]
    direitos.​sold_products_covered.​added 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
    direitos.​sold_products_covered.​contract 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
    direitos.​sold_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
    direitos.​sold_products_covered.removed 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
    direitos.​sold_products_covered.​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
    direitos.​sold_products_covered.​sold_product Sys_id do produto coberto pelo direito. Localizado na tabela Produto vendido [sn_install_base_sold_product].

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

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

    Tipo de dados: cadeia de caracteres
    direitos.​sold_products_covered.​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
    direitos.​sold_products_covered.​sys_updated_by Nome do usuário que atualizou pela última vez o registro coberto do produto vendido.

    Tipo de dados: cadeia de caracteres
    direitos.​sold_products_covered.​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
    direitos.​start_date
    Data de início do direito.

    Tipo de dados: cadeia de caracteres

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

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

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

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

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

    Tipo de dados: cadeia de caracteres
    direitos_características Lista de características de direito associadas à linha do contrato de serviço. Localizado na tabela Característica [sn_pss_core_entitlement_characteristic].

    Tipo de dados: matriz de objetos

    "entitlement_characteristics": [
  {
    "characteristic": "String",
    "characteristic_option": "String",
    "entitlement": "String",
    "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. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​service_contract_line Sys_id do registro de linha do contrato de serviço associado à característica de direito. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    direito_características.​sys_created_by Nome do usuário que criou o registro de características de direito.

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​sys_created_on Data e hora em que o registro de características de direito foi criado.

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​sys_id Sys_id do registro de características de direito.

    Tipo de dados: cadeia de caracteres
    direito_características.​sys_updated_by Nome do usuário que atualizou pela última vez o registro de características de direito.

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​sys_updated_on Data e hora em que o registro de características de direito foi atualizado pela última vez.

    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
    install_base_items_covered Lista de itens-base de instalação cobertos pela linha de contrato de serviço. 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 à linha do contrato de serviço.

    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.​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.​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 a linha do contrato de serviço associado termina a cobertura do item-base de instalação.

    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
    nome
    Nome da linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres
    parent_contract_line Sys_id da linha de contrato de serviço da qual a linha de contrato de serviço atual é secundária.

    Nulo para as linhas de contrato criadas em um contrato.

    Tipo de dados: cadeia de caracteres
    product_model Sys_id do produto associado à linha do contrato de serviço. 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 à linha do contrato de serviço. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    produto_vendido Sys_id do registro do produto vendido associado à linha do contrato de serviço. 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 à linha do contrato de serviço.

    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 da linha do contrato de serviço.

    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
    de início
    Data de início da linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    estado
    Estado atual da linha do contrato.
    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 linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres
    sys_created_on Data e hora em que o registro da linha do contrato de serviço foi criado.

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id de um registro de linha de contrato de serviço. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    sys_updated_by Nome do usuário que atualizou pela última vez o registro de linha de contrato de serviço.

    Tipo de dados: cadeia de caracteres
    sys_updated_on Data e hora em que o registro da linha do contrato de serviço foi atualizado pela última vez.

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    O exemplo de código a seguir mostra como chamar este endpoint.

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

    Resposta:

    {
  "result": {
    "sys_id": "16e451d1d1f53110f8776589fa411f80",
    "sys_created_by": "admin",
    "sys_updated_by": "admin",
    "sys_created_on": "2023-10-09 11:29:47",
    "sys_updated_on": "2023-10-09 11:29:47",
    "name": "CLI",
    "contract": "a4b415d1d1f53110f8776589fa411f20",
    "parent_contract_line": null,
    "sold_product": null,
    "starts": "2022-12-03",
    "ends": "",
    "product_offering": null,
    "product_model": null,
    "child_contract_lines": [
      {
        "sys_id": "3a39ecdc01154f4ab782da0169c9c922",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:27:29",
        "sys_updated_on": "2023-10-09 11:27:29",
        "name": "Child CLI",
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "parent_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "sold_product": null,
        "starts": "2022-12-03",
        "ends": "",
        "product_offering": null,
        "product_model": null,
        "child_contract_lines": [],
        "entitlements": [
          {
            "sys_id": "7439fd84c2494ba6951e58f333cfe8d4",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "entitlement_name": "Child CLI - ENTL",
            "account": "4c325111d1f53110f8776589fa411f3d",
            "consumer": null,
            "household": null,
            "contract": "a4b415d1d1f53110f8776589fa411f20",
            "service_contract_line": "3a39ecdc01154f4ab782da0169c9c922",
            "state": "active",
            "product_offering": null,
            "sold_entitlement": null,
            "product": null,
            "start_date": "2022-12-03",
            "end_date": "",
            "entitlement_characteristics": [],
            "sold_products_covered": [],
            "install_base_items_covered": []
          }
        ],
        "sold_products_covered": [
          {
            "sys_id": "dfb62e9c4c6843009be02a68f65b9118",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "contract": "a4b415d1d1f53110f8776589fa411f20",
            "service_contract_line": "3a39ecdc01154f4ab782da0169c9c922",
            "entitlement": null,
            "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
            "added": "2023-12-03",
            "removed": "2023-12-03"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "2583912e81964501b52a2e44d4797a28",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "contract": "a4b415d1d1f53110f8776589fa411f20",
            "service_contract_line": "3a39ecdc01154f4ab782da0169c9c922",
            "entitlement": null,
            "install_base": "a1731551d1f53110f8776589fa411f8d",
            "added": "2023-12-03",
            "removed": "2023-12-03"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "3a00c975bb49412cae169200c7f6236e",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:27:29",
            "sys_updated_on": "2023-10-09 11:27:29",
            "service_contract_line": "3a39ecdc01154f4ab782da0169c9c922",
            "entitlement": null,
            "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
            "value": "5",
            "characteristic": "63418db7539e61106bfcddeeff7b1238",
            "type": "coverage"
          }
        ]
      }
    ],
    "entitlements": [
      {
        "sys_id": "16e419d1d1f53110f8776589fa411f3c",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:48",
        "sys_updated_on": "2023-10-09 11:29:48",
        "entitlement_name": "ENTL 2",
        "account": "4c325111d1f53110f8776589fa411f3d",
        "consumer": null,
        "household": null,
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "state": "active",
        "product_offering": null,
        "sold_entitlement": null,
        "product": null,
        "start_date": "2022-12-03",
        "end_date": "",
        "sold_products_covered": [
          {
            "sys_id": "1ae419d1d1f53110f8776589fa411f3d",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "contract": "a4b415d1d1f53110f8776589fa411f20",
            "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
            "entitlement": "16e419d1d1f53110f8776589fa411f3c",
            "sold_product": "da23d151d1f53110f8776589fa411f27",
            "added": "",
            "removed": ""
          }
        ],
        "install_base_items_covered": [],
        "entitlement_characteristics": [
          {
            "sys_id": "1ae419d1d1f53110f8776589fa411f3e",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "service_contract_line": null,
            "entitlement": "16e419d1d1f53110f8776589fa411f3c",
            "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
            "value": "5",
            "characteristic": "63418db7539e61106bfcddeeff7b1238",
            "type": "coverage_and_usage",
            "entitlement_usage": [
              {
                "sys_id": "56e419d1d1f53110f8776589fa411f3f",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:29:48",
                "sys_updated_on": "2023-10-09 11:29:48",
                "entitlement": "16e419d1d1f53110f8776589fa411f3c",
                "service_contract_line": null,
                "entitlement_characteristic": "1ae419d1d1f53110f8776589fa411f3e",
                "period_start": "2022-12-03",
                "period_end": "",
                "total_units": "5",
                "used_units": "2"
              }
            ]
          }
        ]
      }
    ],
    "sold_products_covered": [
      {
        "sys_id": "5ae451d1d1f53110f8776589fa411f81",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:47",
        "sys_updated_on": "2023-10-09 11:29:47",
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "entitlement": null,
        "sold_product": "0df21151d1f53110f8776589fa411f1b",
        "added": "2023-12-03",
        "removed": "2023-12-03"
      }
    ],
    "install_base_items_covered": [],
    "entitlement_characteristics": [
      {
        "sys_id": "dae451d1d1f53110f8776589fa411f82",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:47",
        "sys_updated_on": "2023-10-09 11:29:47",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "entitlement": null,
        "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
        "value": "5",
        "characteristic": "63418db7539e61106bfcddeeff7b1238",
        "type": "coverage"
      }
    ]
  }
}

    Contrato de serviço - POST /sn_pss_core/servicecontract

    Cria um registro de contrato de serviço e todas as entidades relacionadas a partir de uma carga especificada.

    A API Service Contract armazena dados em várias tabelas. A seguir está a lista de tabelas nas quais os registros são criados por este endpoint ao criar um contrato de serviço:
    • Característica [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.
    • Contrato de serviço [sn_pss_core_service_contract]
    • Linha de contrato de serviço [sn_pss_core_service_contract_line]

    O corpo da solicitação deste endpoint faz referência a campos nas tabelas a seguir. Essas informações precisam ser adicionadas à sua instância antes de usar esta API. Para obter informações adicionais, confira Create service contracts.

    • Conta [customer_account]
    • Opção de característica [sn_prd_pm_characteristic_option]
    • Consumidor [csm_consumer]
    • Residência [csm_household]

    Formato da URL

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

    URL padrão: /api/sn_pss_core/servicecontract

    Parâmetros de solicitação compatíveis

    Tabela 13. 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 14. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 15. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    conta Obrigatório se o parâmetro consumer não for especificado.
    Sys_id do registro de conta ao qual o contrato de serviço pertence. Localizado na tabela Conta [customer_account].

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

    Tipo de dados: cadeia de caracteres
    términos
    Data em que o contrato de serviço termina.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: nunca termina até que seja removido manualmente.
    residência Válido somente para contratos de serviço ao consumidor.
    Sys_id da residência associada ao contrato de serviço. Localizado na Residência [csm_household].

    Tipo de dados: cadeia de caracteres

    Padrão: nulo (sem residência)
    install_base_items_covered Lista de itens-base de instalação cobertos pelo contrato de serviço. Os dados neste parâmetro são inseridos na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    Para obter mais informações sobre Itens-base de instalação Configure install base.

    Tipo de dados: matriz de objetos

    "install_base_items_covered": [ 
  {
    "added": "String",
    "install_base": "String",
    "removed": "String"
  }
]
    install_base_items_covered.added
    Data em que o contrato de serviço associado começa a cobrir o item-base de instalação.

    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 contrato de serviço associado termina a cobertura do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    linhas_de_contrato_de_serviço Lista de linhas de contrato de serviço associadas ao contrato de serviço. Esses dados são inseridos na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: matriz de objetos

    "service_contract_lines": [
  {
    "child_contract_lines": [Array],
    "ends": "String",
    "entitlements": [Array],
    "entitlement_characteristics": [Array],
    "install_base_items_covered": [Array],
    "name": "String",
    "product_model": "String",
    "product_offering": "String",
    "sold_product": "String",
    "sold_products_covered": [Array],
    "starts": "String",
    "state": "String"
  }
]
    service_contract_lines.​child_contract_lines Lista de linhas de contrato de serviço secundárias na linha de contrato de serviço. Os dados neste parâmetro são inseridos na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: matriz de objetos

    "child_contract_lines": [
  {
    "child_contract_lines": [Array],
    "ends": "String",
    "entitlements": [Array],
    "entitlement_characteristics": [Array],
    "install_base_items_covered": [Array],
    "name": "String",
    "product_model": "String",
    "product_offering": "String",
    "sold_product": "String",
    "sold_products_covered": [Array],
    "starts": "String",
    "state": "String"
  }
]
    service_contract_lines.​child_contract_lines.​child_contract_lines Lista de objetos de linha de contrato de serviço secundário a serem criados na linha de contrato de serviço secundário. Os objetos nesta matriz têm os mesmos elementos que os objetos no parâmetro service_contract_lines.child_contract_lines.

    Tipo de dados: matriz de objetos
    service_contract_lines.​child_contract_lines.​ends Data em que a linha do contrato de serviço termina.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: nunca termina até que seja removido manualmente.
    service_contract_lines.​child_contract_lines.​direitos Lista de direitos a serem associados à linha de contrato de serviço secundária. Esses direitos são inseridos na tabela Direito [service_entitlement].

    Tipo de dados: matriz de objetos

    "entitlements:" [
  {
    "account": "String",
    "consumer": "String",
    "end_date": "String",
    "entitlement_characteristics": [Array],
    "entitlement_name": "String",
    "household": "String",
    "install_base_items_covered": [Array],
    "product": "String",
    "product_offering": "String",
    "sold_entitlement": "String",
    "sold_products_covered": [Array],
    "start_date": "String",
    "state": "String"
  }
]
    service_contract_lines.​child_contract_lines.​direitos.​conta
    Sys_id do registro de conta ao qual o direito pertence. Localizado na tabela Conta [customer_account].

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​direitos.​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.
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_characteristics 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"
  }
]
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_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
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_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
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_characterics.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"
}
    service_contract_lines.​child_contract_lines.​entitlements.​entitlement_characterics.entitlement_usage.​used_units Uso da característica de direito associada.

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​direitos.​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
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_name Obrigatório.
    Nome do direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​direitos.​household 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
    service_contract_lines.​child_contract_lines.​entitlements.​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"
  }
]
    service_contract_lines.​child_contract_lines.​entitlements.​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
    service_contract_lines.​child_contract_lines.​entitlements.​install_base_items_covered.​install_base Sys_id do item-base de instalação coberto pelo direito. Localizado na tabela Item-base de instalação [sn_install_base_item].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​direitos.​install_base_items_covered.​removed 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
    service_contract_lines.​child_contract_lines.​direitos.​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
    service_contract_lines.​child_contract_lines.​direitos.​product_offering 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
    service_contract_lines.​child_contract_lines.​entitlements.​sold_entitlement 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
    service_contract_lines.​child_contract_lines.​direitos.​sold_products_covered Lista de produtos vendidos cobertos pelo direito.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "added": "String",
    "removed": "String",
    "sold_product": "String"
  }
]
    service_contract_lines.​child_contract_lines.​direitos.​sold_products_covered.​added 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
    service_contract_lines.​child_contract_lines.​direitos.​sold_products_covered.​removed 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
    service_contract_lines.​child_contract_lines.​direitos.​start_date Obrigatório.
    Data de início do direito.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    service_contract_lines.​child_contract_lines.​direitos.​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
    service_contract_lines.​child_contract_lines.​entitlement_characteristics Lista de características associadas à linha do contrato de serviço. 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"
  }
]
    service_contract_lines.​child_contract_lines.​atribuição_características.característica Obrigatório.
    Sys_id do registro de característica associado à linha do contrato de serviço. Localizado na tabela Característica [sn_prd_pm_characteristic].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlement_characteristics.characterstic_option
    Sys_id do registro de opção da característica associado à linha do contrato de serviço. Localizado na tabela Opção de característica [sn_prd_pm_characteristic_option].

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

    Tipo de dados: objeto

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlement_characteristics.type Tipo de característica de linha de contrato de serviço.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlement_characteristics.value Obrigatório se o parâmetro entitlement_characteristics.type não for passado.
    Valor da característica.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​install_base_items_covered
    Lista de itens-base de instalação cobertos pela linha de contrato de serviço. 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

     "install_base_items_covered": [ 
  {
    "added": "String",
    "install_base": "String",
    "removed": "String"
  }
]
    service_contract_lines.​child_contract_lines.​install_base_items_covered.​added
    Data em que o item-base de instalação associado foi adicionado à linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    service_contract_lines.​child_contract_lines.​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
    service_contract_lines.​child_contract_lines.​install_base_items_covered.​removed
    Data em que a linha do contrato de serviço associado termina a cobertura do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    service_contract_lines.​child_contract_lines.​name
    Nome da linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​product_model Sys_id do produto associado à linha do contrato de serviço. Localizado na tabela Modelo de Produto [cmdb_model].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​product_offering Sys_id do registro de oferta de produto associado à linha do contrato de serviço. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​sold_product Sys_id do registro do produto vendido associado à linha do contrato de serviço. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​sold_products_covered
    Lista de produtos cobertos pela linha de contrato de serviço.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "added": "String",
    "removed": "String",
    "sold_product": "String"
  }
]
    service_contract_lines.​child_contract_lines.​.sold_products_covered.​added Data em que a linha do contrato de serviço associado começa a cobrir o produto associado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    service_contract_lines.​child_contract_lines.​sold_products_covered.​removed Data em que a linha do contrato de serviço associado termina a cobertura do produto associado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    service_contract_lines.​child_contract_lines.​sold_products_covered.​sold_product
    Sys_id de um produto associado à linha do contrato de serviço. Localizado na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​starts Obrigatório.
    Data de início da linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    service_contract_lines.​child_contract_lines.​estado Obrigatório.
    Estado atual da linha do contrato.
    Valores válidos: (diferencia maiúsculas de minúsculas)
    • ativo
    • cancelado(a)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: cadeia de caracteres
    service_contract_lines.ends Data em que a linha do contrato de serviço termina.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: nunca termina até que seja removido manualmente.
    service_contract_lines.entitlements Lista de direitos a serem associados à linha do contrato de serviço. Esses direitos são inseridos na tabela Direito [service_entitlement].

    Tipo de dados: matriz de objetos

    "entitlements:" [
  {
    "account": "String",
    "consumer": "String",
    "end_date": "String",
    "entitlement_characteristics": [Array],
    "entitlement_name": "String",
    "household": "String",
    "install_base_items_covered": [Array],
    "product": "String",
    "product_offering": "String",
    "sold_entitlement": "String",
    "sold_products_covered": [Array],
    "start_date": "String",
    "state": "String"
  }
]
    service_contract_lines.​entitlements.​account
    Sys_id do registro de conta ao qual o direito pertence. Localizado na tabela Conta [customer_account].

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​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.
    service_contract_lines.​entitlements.​entitlement_characteristics 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"
  }
]
    service_contract_lines.​direitos.​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
    service_contract_lines.​entitlements.​entitlement_characteristics.characterstic_option 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
    service_contract_lines.​entitlements.​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"
}
    service_contract_lines.​entitlements.​entitlement_characteristics.entitlement_usage.​usage_units Uso da característica de direito associada.

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​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
    service_contract_lines.​entitlements.​entitlement_name Obrigatório.
    Nome do direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​household 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
    service_contract_lines.​entitlements.​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"
  }
]
    service_contract_lines.​entitlements.​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
    service_contract_lines.​entitlements.​install_base_items_covered.​install_base Sys_id do item-base de instalação coberto pelo direito. Localizado na tabela Item-base de instalação [sn_install_base_item].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​install_base_items_covered.​removed 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
    service_contract_lines.​direitos.​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
    service_contract_lines.​entitlements.​product_offering 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
    service_contract_lines.​entitlements.​sold_entitlement 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
    service_contract_lines.​entitlements.​sold_products_covered Lista de produtos vendidos cobertos pelo direito.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "added": "String",
    "removed": "String",
    "sold_product": "String"
  }
]
    service_contract_lines.​entitlements.​sold_products_covered.​added 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
    service_contract_lines.​entitlements.​sold_products_covered.​removed 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
    service_contract_lines.​entitlements.​sold_products_covered.​sold_product 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
    service_contract_lines.​entitlements.​start_date Obrigatório.
    Data de início do direito.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    service_contract_lines.​direitos.​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
    service_contract_lines.​entitlement_characteristics Lista de características associadas à linha do contrato de serviço. 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"
  }
]
    service_contract_lines.​entitlement_characteristics.​característica Obrigatório.
    Sys_id do registro de característica associado à linha do contrato de serviço. Localizado na tabela Característica [sn_prd_pm_characteristic].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlement_characteristics.​characteristic_option
    Sys_id do registro de opção da característica associado à linha do contrato de serviço. Localizado na tabela Opção de característica [sn_prd_pm_characteristic_option].

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

    Tipo de dados: objeto

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

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlement_characteristics.​type Tipo de característica de linha de contrato de serviço.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlement_characteristics.​value Obrigatório se o parâmetro entitlement_characteristics.type não for passado.
    Valor da característica.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​install_base_items_covered
    Lista de itens-base de instalação cobertos pela linha de contrato de serviço. 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

     "install_base_items_covered": [ 
  {
    "added": "String",
    "install_base": "String",
    "removed": "String"
  }
]
    service_contract_lines.​install_base_items_covered.​added
    Data em que o item-base de instalação associado foi adicionado à linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    service_contract_lines.​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
    service_contract_lines.​install_base_items_covered.​removed
    Data em que a linha do contrato de serviço associado termina a cobertura do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    service_contract_lines.​nome
    Nome da linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​product_model Sys_id do produto associado à linha do contrato de serviço. Localizado na tabela Modelo de Produto [cmdb_model].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​product_offering Sys_id do registro de oferta de produto associado à linha do contrato de serviço. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​sold_product Sys_id do registro do produto vendido associado à linha do contrato de serviço. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​sold_products_covered
    Lista de produtos cobertos pela linha de contrato de serviço.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "added": "String",
    "removed": "String",
    "sold_product": "String"
  }
]
    service_contract_lines.​sold_products_covered.​adicionado Data em que a linha do contrato de serviço associado começa a cobrir o produto associado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    service_contract_lines.​sold_products_covered.​removido Data em que a linha do contrato de serviço associado termina a cobertura do produto associado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    service_contract_lines.​sold_products_covered.​sold_product
    Sys_id de um produto associado à linha do contrato de serviço. Localizado na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​inícios Obrigatório.
    Data de início da linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    service_contract_lines.​estado Obrigatório.
    Estado atual da linha do contrato.
    Valores válidos: (diferencia maiúsculas de minúsculas)
    • ativo
    • cancelado(a)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: cadeia de caracteres
    short_description
    Breve descrição ou nome do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Padrão: nulo (cadeia de caracteres vazia)
    produtos_vendidos_cobertos Obrigatório se o parâmetro install_base_items_covered não for especificado.
    Lista de produtos cobertos pelo contrato de serviço. 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 contrato de serviço associado começa a cobrir o produto.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    produtos_vendidos_cobertos.removido
    Data em que o contrato de serviço associado termina a cobertura do produto associado.

    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 contrato de serviço. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres
    de início Obrigatório.
    Data em que o contrato de serviço começa.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    estado Obrigatório.
    Estado atual do contrato de serviço.
    Valores válidos: (diferencia maiúsculas de minúsculas)
    • ativo
    • cancelado(a)
    • rascunho
    • expirado

    Tipo de dados: cadeia de caracteres
    contrato_fornecedor Obrigatório.
    Identificador exclusivo para um contrato externo associado.

    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 16. 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 17. 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 18. 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 ou XML)

    Nome Descrição
    install_base_items_covered Lista de sys_ids dos itens-base de instalação cobertos pelo contrato de serviço.

    Tipo de dados: matriz de objetos

    "install_base_items_covered": [ 
  {
    "sys_id": "String"
  }
]
    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
    número Número do contrato de serviço gerado automaticamente.

    Tipo de dados: cadeia de caracteres
    linhas_de_contrato_de_serviço Lista de linhas de contrato de serviço associadas ao contrato de serviço.

    Tipo de dados: matriz de objetos

    "service_contract_lines": [
  {
    "child_contract_lines": [Array],
    "entitlements": [Array],
    "entitlement_characteristics": [Array],
    "install_base_items_covered": [Array],
    "name": "String",
    "sold_products_covered": [Array],
    "sys_id": "String"
  }
]
    service_contract_lines.​child_contract_lines Lista de objetos de linha de contrato de serviço secundários criados na linha de contrato de serviço.

    Tipo de dados: matriz de objetos

    "child_contract_lines": [
  {
    "child_contract_lines": [Array],
    "entitlements": [Array],
    "entitlement_characteristics": [Array],
    "install_base_items_covered": [Array],
    "name": "String",
    "sold_products_covered": [Array],
    "sys_id" "String"
  }
]
    service_contract_lines.​child_contract_lines.​child_contract_lines Lista de objetos de linha de contrato de serviço secundário criados na linha de contrato de serviço secundário. Os objetos nesta matriz têm os mesmos elementos que o parâmetro service_contract_lines.child_contract_lines.

    Tipo de dados: matriz de objetos
    service_contract_lines.​child_contract_lines.​direitos Lista de direitos associados à linha de contrato de serviço secundária.

    Tipo de dados: matriz de objetos

    "entitlements": [
  {
    "entitlement_name": "String",
    "entitlement_characteristics": [Array],
    "install_base_items_covered": [Array],
    "sold_products_covered": [Array],
    "sys_id": "String"
  }
]
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_name
    Nome do direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​direitos.​entitlement_characteristics Lista dos objetos de característica de direito criados sob o direito.

    Tipo de dados: matriz de objetos

    "entitlement_characteristics": [
  {
    "sys_id": "String"
  }
]
    service_contract_lines.​child_contract_lines.​entitlements.​entitlement_characteristics.​sys_id Sys_id de um registro de características de direito associado à linha de contrato de serviço secundária. Localizado na tabela Característica [sn_pss_core_entitlement_characteristic].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlements.​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"
  }
]
    service_contract_lines.​child_contract_lines.​entitlements.​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
    service_contract_lines.​child_contract_lines.​direitos.​sold_products_covered Lista de sys_ids dos produtos cobertos pelo direito.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "sys_id": "String"
  }
]
    service_contract_lines.​child_contract_lines.​entitlements.​sold_products_covered.​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
    service_contract_lines.​child_contract_lines.​entitlements.​sys_id Sys_id do registro de direito associado à linha do contrato de serviço secundário. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​entitlement_characteristics Lista de características associadas à linha de contrato do chile.

    Tipo de dados: matriz de objetos

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

    Tipo de dados: objeto

    "entitlement_usage": {
    "sys_id": "String"
}
    service_contract_lines.​child_contract_lines.​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
    service_contract_lines.​child_contract_lines.​entitlement_characteristics.​sys_id Sys_id de um registro de características de direito associado à linha de contrato de serviço secundária. Localizado na tabela Característica [sn_pss_core_entitlement_characteristic].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​install_base_items_covered Lista de sys_ids dos itens-base de instalação cobertos pela linha de contrato secundária.

    Tipo de dados: matriz de objetos

    "install_base_items_covered": [ 
  {
    "sys_id": "String"
  }
]
    service_contract_lines.​child_contract_lines.​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
    service_contract_lines.​child_contract_lines.​name Nome da linha do contrato de serviço secundário.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​sold_products_covered Lista de sys_ids dos produtos cobertos pela linha de contrato de serviço secundário.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "sys_id": "String"
  }
]
    service_contract_lines.​child_contract_lines.​sold_products_covered.​sys_id Sys_id de um produto coberto pela linha de contrato de serviço secundário. Localizado na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​child_contract_lines.​sys_id Sys_id de um registro de linha de contrato de serviço secundário. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​direitos Lista de direitos associados ao contrato de serviço.

    Tipo de dados: matriz de objetos

    "entitlements" [
  {
    "entitlement_name": "String",
    "entitlement_characteristics": [Array],
    "install_base_items_covered": [Array],
    "sold_products_covered": [Array],
    "sys_id": "String"
  }
]
    service_contract_lines.​entitlements.​entitlement_name
    Nome do direito.

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​entitlement_characteristics 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"
  }
]
    service_contract_lines.​entitlements.​entitlement_characteristics.​entitlement_usage Objeto de uso de direito inserido em entitlement_characteristic.

    Tipo de dados: objeto

    "entitlement_usage": {
    "sys_id": "String"
}
    service_contract_lines.​entitlements.​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
    service_contract_lines.​entitlements.​entitlement_characteristics.​sys_id Sys_id de um registro de características de direito associado à linha do contrato de serviço. Localizado na tabela Característica [sn_pss_core_entitlement_characteristic].

    Tipo de dados: cadeia de caracteres
    service_contract_lines.​entitlements.​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"
  }
]
    service_contract_lines.​entitlements.​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
    service_contract_lines.​entitlements.​sold_products_covered Lista de sys_ids dos produtos cobertos pelo direito.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "sys_id": "String"
  }
]
    service_contract_lines.​entitlements.​sold_products_covered.​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
    service_contract_lines.​entitlements.​sys_id Sys_id do registro de direito associado à linha do contrato de serviço. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    short_description
    Breve descrição ou nome do contrato de serviço.

    Tipo de dados: cadeia de caracteres
    produtos_vendidos_cobertos Lista de sys_ids dos produtos cobertos pelo contrato de serviço.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "sys_id": "String"
  }
]
    vendidos_produtos_cobertos.​sys_id Sys_id de um produto coberto pelo contrato de serviço. 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 do contrato de serviço. Localizado na tabela Contrato de serviço [sn_pss_core_service_contract].

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    A seguir está um exemplo de código que mostra como chamar este endpoint e criar um contrato de serviço com um registro coberto de produto vendido, um registro coberto de itens-base de instalação e duas linhas de contrato de serviço.

    curl "https://instance.servicenow.com/api/sn_pss_core/servicecontract" \
--request POST \
--header "Accept:application/json" \
--data
{
  "state": "active",
  "account": "4c325111d1f53110f8776589fa411f3d",
  "vendor_contract": "External Reference",
  "starts": "2022-12-03",
  "service_contract_lines": [
    {
      "state": "active",
      "name": "CLI",
      "starts": "2022-12-03",
      "child_contract_lines": [
        {
          "state": "active",
          "name": "Child CLI",
          "starts": "2022-12-03",
          "entitlements": [
            {
              "state": "active",
              "entitlement_name": "Child CLI - ENTL",
              "start_date": "2022-12-03"
            }
          ],
          "sold_products_covered": [
            {
              "sold_product": "8db4258949f14ef7b90d90822dfc5800",
              "added": "2023-12-03",
              "removed": "2023-12-03"
            }
          ],
          "install_base_items_covered": [
            {
              "install_base": "2f270832699b46e78aa899a5a5dc6682",
              "added": "2023-12-03",
              "removed": "2023-12-03"
            }
          ],
          "entitlement_characteristics": [
            {
              "characteristic": "63418db7539e61106bfcddeeff7b1238",
              "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
              "value": "20",
              "type": "coverage"
            }
          ]
        }
      ],
      "entitlements": [
        {
          "state": "active",
          "entitlement_name": "ENTL",
          "start_date": "2022-12-03",
          "sold_products_covered": [
            {
              "sold_product": "da23d151d1f53110f8776589fa411f27"
            }
          ],
          "install_base_items_covered": [
            {
              "install_base": "43739151d1f53110f8776589fa411fc1",
              "added": "2023-12-03",
              "removed": "2023-12-03"
            }
          ],
          "entitlement_characteristics": [
            {
              "characteristic": "63418db7539e61106bfcddeeff7b1238",
              "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
              "value": "20",
              "type": "coverage_and_usage",
              "entitlement_usage": {
                "used_units": "3"
              }
            }
          ]
        }
      ],
      "sold_products_covered": [
        {
          "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "install_base_items_covered": [
        {
          "install_base": "a1731551d1f53110f8776589fa411f8d",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage"
        }
      ]
    },
    {
      "state": "active",
      "name": "CLI 2",
      "starts": "2022-12-03",
      "sold_products_covered": [
        {
          "sold_product": "7f23995dd1b53110f8776589fa411f66",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "install_base_items_covered": [
        {
          "install_base": "a483d951d1f53110f8776589fa411fad",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage"
        }
      ]
    }
  ],
  "sold_products_covered": [
    {
      "sold_product": "0df21151d1f53110f8776589fa411f1b",
      "added": "2023-12-03",
      "removed": "2023-12-03"
    }
  ],
  "install_base_items_covered": [
    {
      "install_base": "e2639951d1f53110f8776589fa411f2b",
      "added": "2023-12-03",
      "removed": "2023-12-03"
    }
  ]
} 
--user "username":"password"

    Resposta:

    {
  "result": {
    "sys_id": "d8641151d1f53110f8776589fa411fde",
    "number": "CNTR0010004",
    "short_description": null,
    "service_contract_lines": [
      {
        "sys_id": "d4641d91d1f53110f8776589fa411fbb",
        "name": "CLI",
        "child_contract_lines": [
          {
            "sys_id": "3a39ecdc01154f4ab782da0169c9c922",
            "name": "Child CLI",
            "child_contract_lines": [],
            "entitlements": [
              {
                "sys_id": "7439fd84c2494ba6951e58f333cfe8d4",
                "entitlement_name": "Child CLI - ENTL",
                "sold_products_covered": [],
                "install_base_items_covered": [],
                "entitlement_characteristics": []
              }
            ],
            "sold_products_covered": [
              {
                "sys_id": "dfb62e9c4c6843009be02a68f65b9118"
              }
            ],
            "install_base_items_covered": [
              {
                "sys_id": "2583912e81964501b52a2e44d4797a28"
              }
            ],
            "entitlement_characteristics": [
              {
                "sys_id": "3a00c975bb49412cae169200c7f6236e",
                "entitlement_usage": {}
              }
            ]
          }
        ],
        "entitlements": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fc0",
            "entitlement_name": "ENTL",
            "sold_products_covered": [
              {
                "sys_id": "a0641d91d1f53110f8776589fa411fc2"
              }
            ],
            "install_base_items_covered": [
              {
                "sys_id": "e0641d91d1f53110f8776589fa411fc3"
              }
            ],
            "entitlement_characteristics": [
              {
                "sys_id": "a8641d91d1f53110f8776589fa411fd0",
                "entitlement_usage": {
                  "sys_id": "a8641d91d1f53110f8776589fa411fd1"
                }
              }
            ]
          }
        ],
        "sold_products_covered": [
          {
            "sys_id": "98641d91d1f53110f8776589fa411fbc"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "58641d91d1f53110f8776589fa411fbd"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "e0641d91d1f53110f8776589fa411fbf",
            "entitlement_usage": {}
          }
        ]
      },
      {
        "sys_id": "e4641d91d1f53110f8776589fa411fd2",
        "name": "CLI 2",
        "child_contract_lines": [],
        "entitlements": [],
        "sold_products_covered": [
          {
            "sys_id": "e8641d91d1f53110f8776589fa411fd3"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fd4"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fd5",
            "entitlement_usage": {}
          }
        ]
      }
    ],
    "sold_products_covered": [
      {
        "sys_id": "9c641d91d1f53110f8776589fa411fb9"
      }
    ],
    "install_base_items_covered": [
      {
        "sys_id": "d8641d91d1f53110f8776589fa411fba"
      }
    ]
  }
}

    Contrato de serviço - POST /sn_pss_core/servicecontract/contractline

    Cria um registro de linha de contrato e todas as entidades relacionadas.

    Este endpoint armazena dados nas seguintes tabelas ao processar a solicitação:
    • Característica [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.
    • Linha de contrato de serviço [sn_pss_core_service_contract_line]

    Formato da URL

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

    URL padrão: /api/sn_pss_core/servicecontract/contractline

    Parâmetros de solicitação compatíveis

    Tabela 19. 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 20. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 21. Parâmetros do corpo da solicitação (XML ou JSON)
    Nome Descrição
    child_contract_lines Lista de objetos de linha de contrato de serviço secundários criados na linha de contrato de serviço. Esses dados são inseridos no contrato de serviço [sn_pss_core_service_contract].

    Tipo de dados: matriz de objetos

    "child_contract_lines": [
  {
    "child_contract_lines": [Array],
    "contract": "String",
    "ends": "String",
    "entitlements": [Array],
    "entitlement_characteristics": [Array],
    "install_base_items_covered": [Array],
    "name": "String",
    "parent_contract_line": "String",
    "product_model": "String",
    "product_offering": "String",
    "sold_product": "String",
    "sold_products_covered": [Array],
    "starts": "String",
    "state": "String"
  }
]
    child_contract_lines.​child_contract_lines Lista de objetos de linha de contrato de serviço secundário a serem criados na linha de contrato de serviço secundário. Os objetos nesta matriz têm os mesmos elementos que os objetos no parâmetro child_contract_lines.

    Tipo de dados: matriz de objetos
    child_contract_lines.​Contract Sys_id do contrato de serviço associado à linha do contrato de serviço secundário. Localizado na tabela Contrato de serviço [sn_pss_core_service_contract].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​término Data em que a linha do contrato de serviço secundário termina.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: nunca termina até que seja removido manualmente.
    child_contract_lines.​direitos Lista de direitos associados à linha de contrato de serviço secundária. Esses direitos são inseridos na tabela Direito [service_entitlement].

    Tipo de dados: matriz de objetos

    "entitlements:" [
  {
    "account": "String",
    "consumer": "String",
    "end_date": "String",
    "entitlement_characteristics": [Array],
    "entitlement_name": "String",
    "household": "String",
    "install_base_items_covered": [Array],
    "product": "String",
    "product_offering": "String",
    "sold_entitlement": "String",
    "sold_products_covered": [Array],
    "start_date": "String",
    "state": "String"
  }
]
    child_contract_lines.​direitos.​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
    child_contract_lines.​direitos.​consumidor 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
    child_contract_lines.​direitos.​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.
    child_contract_lines.​entitlements.​entitlement_characteristics 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"
  }
]
    child_contract_lines.​direitos.​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
    child_contract_lines.​entitlements.​entitlement_characteristics.characterstic_option 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
    child_contract_lines.​entitlements.​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"
}
    child_contract_lines.​entitlements.​entitlement_characteristics.entitlement_usage.​used_units Uso da característica de direito associada.

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

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlements.​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
    child_contract_lines.​entitlements.​entitlement_name Obrigatório.
    Nome do direito.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​direitos.​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
    child_contract_lines.​entitlements.​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"
  }
]
    child_contract_lines.​entitlements.​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
    child_contract_lines.​entitlements.​install_base_items_covered.​install_base Sys_id do item-base de instalação coberto pelo direito. Localizado na tabela Item-base de instalação [sn_install_base_item].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlements.​install_base_items_covered.​removed 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
    child_contract_lines.​direitos.​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
    child_contract_lines.​direitos.​product_offering 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
    child_contract_lines.​entitlements.​sold_entitlement 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
    child_contract_lines.​entitlements.​sold_products_covered Lista de produtos vendidos cobertos pelo direito.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "added": "String",
    "removed": "String",
    "sold_product": "String"
  }
]
    child_contract_lines.​entitlements.​sold_products_covered.​added 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
    child_contract_lines.​entitlements.​sold_products_covered.​removed 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
    child_contract_lines.​entitlements.​sold_products_covered.​sold_product 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
    child_contract_lines.​direitos.​start_date Obrigatório.
    Data de início do direito.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    child_contract_lines.​direitos.​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
    child_contract_lines.​entitlement_characteristics 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"
  }
]
    child_contract_lines.​entitlement_characteristics.​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
    child_contract_lines.​entitlement_characteristics.​characteristic_option 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
    child_contract_lines.​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"
}
    child_contract_lines.​entitlement_characteristics.​entitlement_usage.​used_units Uso da característica de direito associada.

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

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlement_characteristics.​value
    Valor da característica.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​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"
  }
]
    child_contract_lines.​install_base_items_covered.​added Data em que o item-base de instalação associado foi adicionado à linha de contrato de serviço secundário.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    child_contract_lines.​install_base_items_covered.​install_base Sys_id do item-base de instalação coberto pela linha do contrato de serviço secundário. Localizado na tabela Item-base de instalação [sn_install_base_item].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​install_base_items_covered.​removed Data em que a linha de contrato de serviço secundária associada termina a cobertura do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    child_contract_lines.​nome Nome da linha do contrato de serviço secundário.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​parent_contract_lines Sys_id do registro de linha de contrato primário associado à linha de contrato de serviço secundária.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​product_model Sys_id do produto associado à linha de contrato de serviço secundário. Localizado na tabela Modelo de Produto [cmdb_model].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​product_offering Sys_id do registro de oferta de produto associado à linha de contrato de serviço secundária. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​sold_product Sys_id do registro do produto vendido associado à linha do contrato de serviço secundário. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​sold_products_covered Lista de produtos cobertos pela linha de contrato de serviço secundário.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "added": "String",
    "removed": "String",
    "sold_product": "String"
  }
]
    child_contract_lines.​sold_products_covered.​adicionado Data em que a linha de contrato de serviço secundária associada começa a cobrir o produto associado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    child_contract_lines.​sold_products_covered.​removido Data em que a linha do contrato de serviço secundário associado termina a cobertura do produto associado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    child_contract_lines.​sold_products_covered.​sold_product Sys_id de um produto associado à linha de contrato de serviço secundário. Localizado na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​inícios Data de início da linha de contrato de serviço secundário.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    child_contract_lines.​estado
    Estado atual da linha do contrato.
    Valores válidos: (diferencia maiúsculas de minúsculas)
    • ativo
    • cancelado(a)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: cadeia de caracteres
    contrato
    Sys_id do contrato de serviço associado à linha do contrato de serviço. Localizado na tabela Contrato de serviço [sn_pss_core_service_contract].

    Tipo de dados: cadeia de caracteres
    términos Data em que a linha do contrato de serviço termina.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: nunca termina até que seja removido manualmente.
    direitos Lista de direitos a serem associados à linha do contrato de serviço. Esses direitos são inseridos na tabela Direito [service_entitlement].

    Tipo de dados: matriz de objetos

    "entitlements:" [
  {
    "account": "String",
    "consumer": "String",
    "end_date": "String",
    "entitlement_characteristics": [Array],
    "entitlement_name": "String",
    "household": "String",
    "install_base_items_covered": [Array],
    "product": "String",
    "product_offering": "String",
    "sold_entitlement": "String",
    "sold_products_covered": [Array],
    "start_date": "String",
    "state": "String"
  }
]
    direitos.​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
    direitos.​consumidor 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
    direitos.​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.​direito_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"
  }
]
    direitos.​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
    direitos.​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
    direitos.​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"
}
    direitos.​entitlement_characteristics.entitlement_usage.​used_units Uso da característica de direito associada.

    Tipo de dados: cadeia de caracteres
    direitos.​direitos_características.tipo Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura_e_uso

    Tipo de dados: cadeia de caracteres
    direitos.​entitlement_características.valor 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
    direitos.​entitlement_name Obrigatório.
    Nome do direito.

    Tipo de dados: cadeia de caracteres
    direitos.​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
    direitos.​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"
  }
]
    direitos.​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
    direitos.​install_base_items_covered.​removed 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
    direitos.​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
    direitos.​product_offering 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
    direitos.​sold_entitlement 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
    direitos.​sold_products_covered Lista de produtos vendidos cobertos pelo direito.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "added": "String",
    "removed": "String",
    "sold_product": "String"
  }
]
    direitos.​sold_products_covered.​added 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
    direitos.​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
    direitos.​sold_products_covered.​sold_product 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
    direitos.​start_date Obrigatório.
    Data de início do direito.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    direitos.​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
    direitos_características Lista de características associadas à linha do contrato de serviço. 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 à linha do contrato de serviço. Localizado na tabela Característica [sn_prd_pm_characteristic].

    Tipo de dados: cadeia de caracteres
    direito_características.​característica_opção Obrigatório se o parâmetro input_type contido no registro especificado no parâmetro entitlement_characteristics.characteristic estiver definido como opção.
    Sys_id do registro de opção da característica associado à linha do contrato de serviço. 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 linha do contrato de serviço associada. Esses dados são inseridos na tabela Uso de direito [sn_pss_core_entitlement_usage].

    Tipo de dados: objeto

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

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​type Tipo de característica de linha de contrato de serviço.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: cadeia de caracteres
    entitlement_characteristics.​value Obrigatório se o parâmetro entitlement_characteristics.type não for passado.
    Valor da característica.

    Tipo de dados: cadeia de caracteres
    install_base_items_covered Obrigatório se o parâmetro sold_products_covered não for passado.
    Lista de itens-base de instalação cobertos pela linha de contrato de serviço. 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

     "install_base_items_covered": [ 
  {
    "added": "String",
    "install_base": "String",
    "removed": "String"
  }
]
    install_base_items_covered.​adicionado
    Data em que o item-base de instalação associado foi adicionado à linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    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 a linha do contrato de serviço associado termina a cobertura do item-base de instalação.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    nome Obrigatório.
    Nome da linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres
    parent_contract_line Sys_id da linha de contrato de serviço da qual a linha de contrato de serviço atual é secundária.

    Nulo para as linhas de contrato criadas em um contrato.

    Tipo de dados: cadeia de caracteres
    product_model Sys_id do produto associado à linha do contrato de serviço. 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 à linha do contrato de serviço. Localizado na tabela Oferta de produto [sn_prd_pm_product_offering].

    Tipo de dados: cadeia de caracteres
    produto_vendido Sys_id do registro do produto vendido associado à linha do contrato de serviço. Localizado na tabela Produto vendido [sn_install_base_sold_product].

    Tipo de dados: cadeia de caracteres
    produtos_vendidos_cobertos Obrigatório se o parâmetro install_base_items_covered não for passado.
    Lista de produtos cobertos pela linha de contrato de serviço.

    Tipo de dados: matriz de objetos

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

    Os dados são armazenados na tabela Produtos vendidos cobertos [sn_install_base_m2m_contract_sold_product].
    vendidos_produtos_cobertos.​adicionados Data em que a linha do contrato de serviço associado começa a cobrir o produto associado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: data atual
    vendidos_produtos_cobertos.​removido Data em que a linha do contrato de serviço associado termina a cobertura do produto associado.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd

    Padrão: sem data de término
    produtos_vendidos_cobertos.​produtos_vendidos
    Sys_id de um produto associado à linha do contrato de serviço. Localizado na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    Tipo de dados: cadeia de caracteres
    de início Obrigatório.
    Data de início da linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres

    Formato: aaaa-mm-dd
    estado Obrigatório.
    Estado atual da linha do contrato.
    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 22. 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 23. 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 24. 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 ou XML)

    Nome Descrição
    child_contract_lines Lista de objetos de linha de contrato de serviço secundários criados na linha de contrato de serviço.

    Tipo de dados: matriz de objetos

    "child_contract_lines": [
  {
    "child_contract_lines": [Array],
    "entitlements": [Array],
    "entitlement_characteristics": [Array],
    "install_base_items_covered": [Array],
    "name": "String",
    "sold_products_covered": [Array],
    "sys_id" "String"
  }
]
    child_contract_lines.​child_contract_lines Lista de objetos de linha de contrato de serviço secundário criados na linha de contrato de serviço secundário. Os objetos nesta matriz têm os mesmos elementos que o parâmetro child_contract_lines.

    Tipo de dados: matriz de objetos
    child_contract_lines.​direitos Lista de direitos associados à linha de contrato de serviço secundária.

    Tipo de dados: matriz de objetos

    "entitlements": [
  {
    "entitlement_name": "String",
    "entitlement_characteristics": [Array],
    "install_base_items_covered": [Array],
    "sold_products_covered": [Array],
    "sys_id": "String"
  }
]
    child_contract_lines.​entitlements.​entitlement_name
    Nome do direito.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlements.​entitlement_characteristics Lista dos objetos de característica de direito criados sob o direito.

    Tipo de dados: matriz de objetos

    "entitlement_characteristics": [
  {
    "sys_id": "String"
  }
]
    child_contract_lines.​entitlements.​entitlement_characteristics.​sys_id Sys_id de um registro de características de direito associado à linha de contrato de serviço secundária. Localizado na tabela Característica [sn_pss_core_entitlement_characteristic].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlements.​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"
  }
]
    child_contract_lines.​entitlements.​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
    child_contract_lines.​entitlements.​sold_products_covered Lista de sys_ids dos produtos cobertos pelo direito.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "sys_id": "String"
  }
]
    child_contract_lines.​entitlements.​sold_products_covered.​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
    child_contract_lines.​entitlements.​sys_id Sys_id do registro de direito associado à linha do contrato de serviço secundário. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​entitlement_characteristics Lista de características associadas à linha de contrato do chile.

    Tipo de dados: matriz de objetos

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

    Tipo de dados: objeto

    "entitlement_usage": {
    "sys_id": "String"
}
    child_contract_lines.​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
    child_contract_lines.​entitlement_characteristics.​sys_id Sys_id de um registro de características de direito associado à linha de contrato de serviço secundária. Localizado na tabela Característica [sn_pss_core_entitlement_characteristic].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​install_base_items_covered Lista de sys_ids dos itens-base de instalação cobertos pela linha de contrato de serviço secundário.

    Tipo de dados: matriz de objetos

    "install_base_items_covered": [ 
  {
    "sys_id": "String"
  }
]
    child_contract_lines.​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
    child_contract_lines.​nome Nome da linha do contrato de serviço secundário.

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​sold_products_covered Lista de sys_ids dos produtos cobertos pela linha de contrato de serviço secundário.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "sys_id": "String"
  }
]
    child_contract_lines.​sold_products_covered.​sys_id Sys_id de um produto coberto pela linha de contrato de serviço secundário. Localizado na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    Tipo de dados: cadeia de caracteres
    child_contract_lines.​sys_id Sys_id de um produto coberto pelo item do contrato secundário. Localizado na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    Tipo de dados: cadeia de caracteres
    direitos Lista de direitos associados à linha do contrato de serviço.

    Tipo de dados: matriz de objetos

    "entitlements": [
  {
    "entitlement_characteristics": [Array],
    "entitlement_name": "String",
    "install_base_items_covered": [Array],
    "sold_products_covered": [Array],
    "sys_id": "String"
  }
]
    direitos.​direito_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"
  }
]
    direitos.​entitlement_características.​entitlement_usage Objeto de uso de direito inserido em entitlement_characteristic.

    Tipo de dados: objeto

    "entitlement_usage": {
    "sys_id": "String"
}
    direitos.​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
    direitos.​entitlement_characteristics.​sys_id Sys_id do registro de características de direito.

    Tipo de dados: cadeia de caracteres
    direitos.​entitlement_name
    Nome do direito.

    Tipo de dados: cadeia de caracteres
    direitos.​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"
  }
]
    direitos.​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
    direitos.​sold_products_covered Lista de sys_ids dos produtos cobertos pelo direito.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "sys_id": "String"
  }
]
    direitos.​sold_products_covered.​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
    direitos.​sys_id Sys_id do registro de direito associado à linha do contrato de serviço. Localizado na tabela Direito [service_entitlement].

    Tipo de dados: cadeia de caracteres
    direitos_características Lista dos objetos de característica de direito criados na linha do contrato de serviço.

    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 do registro de características de direito.

    Tipo de dados: cadeia de caracteres
    install_base_items_covered Lista de sys_ids dos itens-base de instalação cobertos pela linha de contrato de serviço.

    Tipo de dados: matriz de objetos

    "install_base_items_covered": [ 
  {
    "sys_id": "String"
  }
]
    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
    nome
    Nome da linha do contrato de serviço.

    Tipo de dados: cadeia de caracteres
    produtos_vendidos_cobertos Lista de sys_ids dos produtos cobertos pela linha de contrato de serviço.

    Tipo de dados: matriz de objetos

    "sold_products_covered": [ 
  {
    "sys_id": "String"
  }
]
    vendidos_produtos_cobertos.​sys_id Sys_id de um produto coberto pela linha do contrato de serviço. Localizado na tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    Tipo de dados: cadeia de caracteres
    sys_id Sys_id de um registro de linha de contrato de serviço. Localizado na tabela Linha de contrato de serviço [sn_pss_core_service_contract_line].

    Tipo de dados: cadeia de caracteres

    Solicitação de cURL

    A seguir está um exemplo de código que mostra como chamar este endpoint e criar um registro de linha de contrato de serviço.

    curl "https://instance.servicenow.com/api/sn_pss_core/servicecontract/contractline" \
--request POST \
--header "Accept:application/json" \
--data
{
  "state": "active",
  "contract": "a4b415d1d1f53110f8776589fa411f20",
  "parent_contract_line": null,
  "name": "CLI",
  "starts": "2022-12-03",
  "child_contract_lines": [
    {
      "state": "active",
      "name": "Child CLI",
      "starts": "2022-12-03",
      "entitlements": [
        {
          "state": "active",
          "entitlement_name": "Child CLI - ENTL",
          "start_date": "2022-12-03"
        }
      ],
      "sold_products_covered": [
        {
          "sold_product": "8db4258949f14ef7b90d90822dfc5800",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "install_base_items_covered": [
        {
          "install_base": "2f270832699b46e78aa899a5a5dc6682",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage"
        }
      ]
    }
  ],
  "entitlements": [
    {
      "state": "active",
      "entitlement_name": "ENTL 1",
      "start_date": "2022-12-03",
      "sold_products_covered": [
        {
          "sold_product": "ec235d9dd1b53110f8776589fa411fe2"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage_and_usage",
          "entitlement_usage": {
            "used_units": "3"
          }
        }
      ]
    }
  ],
  "sold_products_covered": [
    {
      "sold_product": "0df21151d1f53110f8776589fa411f1b",
      "added": "2023-12-03",
      "removed": "2023-12-03"
    }
  ],
  "entitlement_characteristics": [
    {
      "characteristic": "63418db7539e61106bfcddeeff7b1238",
      "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
      "value": "tyfy6h",
      "type": "coverage"
    }
  ]
}

    Resposta:

    {
  "result": {
    "sys_id": "16e451d1d1f53110f8776589fa411f80",
    "name": "CLI",
    "child_contract_lines": [
      {
        "sys_id": "3a39ecdc01154f4ab782da0169c9c922",
        "name": "Child CLI",
        "child_contract_lines": [],
        "entitlements": [
          {
            "sys_id": "7439fd84c2494ba6951e58f333cfe8d4",
            "entitlement_name": "Child CLI - ENTL",
            "sold_products_covered": [],
            "install_base_items_covered": [],
            "entitlement_characteristics": []
          }
        ],
        "sold_products_covered": [
          {
            "sys_id": "dfb62e9c4c6843009be02a68f65b9118"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "2583912e81964501b52a2e44d4797a28"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "3a00c975bb49412cae169200c7f6236e",
            "entitlement_usage": {}
          }
        ]
      }
    ],
    "entitlements": [
      {
        "sys_id": "9ee451d1d1f53110f8776589fa411f83",
        "entitlement_name": "ENTL 1",
        "sold_products_covered": [
          {
            "sys_id": "92e451d1d1f53110f8776589fa411f85"
          }
        ],
        "install_base_items_covered": [],
        "entitlement_characteristics": [
          {
            "sys_id": "92e451d1d1f53110f8776589fa411f86",
            "entitlement_usage": {
              "sys_id": "dee451d1d1f53110f8776589fa411f86"
            }
          }
        ]
      }
    ],
    "sold_products_covered": [
      {
        "sys_id": "5ae451d1d1f53110f8776589fa411f81"
      }
    ],
    "install_base_items_covered": [],
    "entitlement_characteristics": [
      {
        "sys_id": "dae451d1d1f53110f8776589fa411f82",
        "entitlement_usage": {}
      }
    ]
  }
}