API de contrato de serviço

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 120 min. de leitura
  • . Contrato de serviço A API fornece endpoints para criar e recuperar registros de contratos de serviço.

    Nota:
    Esta API serve para criar dados nas tabelas do Contratos e direitos do cliente aplicação. Não é uma API de finalidade geral.
    Para acessar esta API, os seguintes plug-ins devem ser ativados na instância associada:
    • Direitos e contratos do cliente (com.sn_pss_core)
    • Gestão da base de instalação do Atendimento ao cliente (com.snc.install)
    • Gestão de catálogo de produtos Core (com.sn_prd)

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

    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]
    • Especificação do produto [sn_prd_pm_product_specification]
    • Oferta de produto [sn_prd_pm_product_offering]
    • Modelo do produto [cmdb_model]
    • Produto vendido [sn_install_base_sold_product]

    Contrato de serviço - OBTENHA /sn_pss_core/servicecontract/

    Recupera um registro de contrato de serviço especificado.

    Este endpoint recupera dados das seguintes tabelas ao processar a solicitação:
    • Característica [sn_pss_core_entitlement_characteric]
    • Direito [service_entitlement]
    • Uso de direito [sn_pss_core_entitlement_usage]
    • Produto vendido coberto [sn_install_base_m2m_contract_sold_product] - Esta tabela contém informações sobre os produtos vendidos cobertos e os itens-base de instalação cobertos.
    • Contrato de serviço [sn_pss_core_service_contract]
    • Linha de contrato de serviço [sn_pss_core_service_contract_line]

    Formato de URL

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

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

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

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: Cadeia de caracteres

    id Sys_id do contrato de serviço a ser recuperado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

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

    Tipo de dados: Cadeia de caracteres

    Padrão: falso

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

    Cabeçalhos

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

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

    Padrão: application/json

    Tabela 5. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

    Tabela 6. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    403 Proibido. O usuário não tem permissão para acessar a API.
    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 da conta ao qual o contrato de serviço pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conta [customer_account]

    cliente
    Sys_id do registro do consumidor ao qual o contrato de serviço pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Consumidor [csm_consumer]

    términos
    Data em que o contrato de serviço termina.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    residência
    Sys_id da residência associada ao contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Residência [csm_household]

    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

    Formato: aaaa-MM-dd

    install_base_items_covered. ​contrato Sys_id do registro do contrato de serviço associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    install_base_items_covered. ​direito Sys_id do registro de direito associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    install_base_items_covered. ​removido
    Data em que o contrato de serviço associado encerra a cobertura do item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    install_base_items_covered. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    install_base_items_covered. ​sys_created_by Nome do usuário que criou o registro do item-base de instalação.

    Tipo de dados: Cadeia de caracteres

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

    Tipo de dados: Cadeia de caracteres

    install_base_items_covered. ​sys_id Sys_id do item-base de instalação coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

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

    Tipo de dados: Cadeia de caracteres

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

    Tipo de dados: Cadeia de caracteres

    número Número do contrato de serviço gerado automaticamente.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines 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",
        "number": "String",
        "parent_contract_line": "String",
        "product_model": "String",
        "product_offering": "String",
        "product_specification": "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",
        "number": "String",
        "parent_contract_line": "String",
        "product_model": "String",
        "product_offering": "String",
        "product_specification": "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árias associadas à linha de contrato de serviço secundário. Os mesmos parâmetros de em child_contract_lines.

    Tipo de dados: Matriz

    service_contract_lines. ​child_contract_lines. ​contrato Sys_id do contrato de serviço associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    service_contract_lines. ​child_contract_lines. ​termina 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 do contrato de serviço secundário.

    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",
        "product_specification": "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 da conta ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conta [customer_account]

    service_contract_lines. ​child_contract_lines. ​direitos. ​consumidor
    Sys_id do registro do consumidor ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Consumidor [csm_consumer]

    service_contract_lines. ​child_contract_lines. ​direitos. ​contrato Sys_id do registro do contrato ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    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_characterísticas 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_characterísticas. ​característica
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​characteric_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​direito Sys_id do registro de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage Lista de valores de uso do 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. ​entitlement_characterísticas. ​entitlement_usage. ​direito Sys_id do registro de direito associado ao uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​entitlement_characteric Sys_id do registro de característica de direito associado ao uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​period_end Data de término em que o uso de direito não é mais rastreado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​period_start Data de início de quando o uso de direito é rastreado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​service_contract_line Sys_id da linha do contrato de serviço à qual o uso de direito atual pertence.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_created_by Nome do usuário que criou o registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_created_on Data e hora em que o registro de uso de direito foi criado.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_id Sys_id do registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Uso de direito [sn_pss_core_entitlement_usage]

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_updated_by Nome do usuário que atualizou o registro de uso de direito pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_updated_on Data e hora em que o registro de uso de direito foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​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. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​used_units Número de unidades usadas pela conta ou consumidor entre period_starte o. period_end.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​service_contract_line Linha do contrato secundário à qual a característica de direito atual pertence.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​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. ​direitos. ​entitlement_characterísticas. ​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. ​direitos. ​entitlement_characterísticas. ​sys_id Sys_id do registro de característica de direito.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​sys_updated_by Nome do usuário que atualizou a característica de direito pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​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_characterísticas. ​tipo Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​valor
    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. ​residência
    Sys_id do registro de residência associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Residência [csm_household]

    service_contract_lines. ​child_contract_lines. ​direitos. ​install_base_items_covered Lista de 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": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "install_base": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​child_contract_lines. ​direitos. ​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

    service_contract_lines. ​child_contract_lines. ​direitos. ​install_base_items_covered. ​contrato Sys_id do registro do contrato de serviço associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    service_contract_lines. ​child_contract_lines. ​direitos. ​install_base_items_covered. ​install_base Sys_id do registro do item-base de instalação associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    service_contract_lines. ​child_contract_lines. ​direitos. ​install_base_items_covered. ​removido
    Data em que a linha de contrato de serviço associada encerra a cobertura do item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    service_contract_lines. ​child_contract_lines. ​direitos. ​install_base_items_covered. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​child_contract_lines. ​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

    service_contract_lines. ​child_contract_lines. ​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

    service_contract_lines. ​child_contract_lines. ​direitos. ​install_base_items_covered. ​sys_id Sys_id do item-base de instalação coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​child_contract_lines. ​direitos. ​install_base_items_covered. ​sys_updated_by Nome do usuário que atualizou o registro do item-base de instalação pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​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

    service_contract_lines. ​child_contract_lines. ​direitos. ​produto Sys_id do registro do modelo de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    service_contract_lines. ​child_contract_lines. ​direitos. ​product_offering Sys_id do registro de oferta de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    service_contract_lines. ​child_contract_lines. ​direitos. ​product_specification Sys_id do registro de especificação do produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    service_contract_lines. ​child_contract_lines. ​direitos. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​child_contract_lines. ​direitos. ​sold_entitlement Sys_id do registro de produto vendido associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    service_contract_lines. ​child_contract_lines. ​direitos. ​sold_products_covered Lista de produtos cobertos.

    Tipo de dados: Matriz de objetos

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

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​child_contract_lines. ​direitos. ​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

    service_contract_lines. ​child_contract_lines. ​direitos. ​sold_products_covered. ​contrato Sys_id do registro do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    service_contract_lines. ​child_contract_lines. ​direitos. ​sold_products_covered. ​direito Sys_id do registro de direito associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​child_contract_lines. ​direitos. ​sold_products_covered. ​removido
    Data em que o contrato de serviço associado encerra 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. ​direitos. ​sold_products_covered. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​child_contract_lines. ​direitos. ​sold_products_covered. ​sold_product Sys_id do produto coberto pelo contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    service_contract_lines. ​child_contract_lines. ​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

    service_contract_lines. ​child_contract_lines. ​sold_products_covered. ​sys_created_on Data e hora em que o registro coberto pelo produto vendido foi criado.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​direitos. ​sold_products_covered. ​sys_id Sys_id do produto coberto por este contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​child_contract_lines. ​direitos. ​sold_products_covered. ​sys_updated_by Nome do usuário que atualizou o registro coberto pelo produto vendido pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​direitos. ​sold_products_covered. ​sys_updated_on Nome do usuário que atualizou o registro coberto pelo produto vendido pela última vez.

    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
    • Cancelados(as)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​direitos. ​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. ​direitos. ​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. ​direitos. ​sys_id Sys_id do registro de direito associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​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

    service_contract_lines. ​child_contract_lines. ​direitos. ​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_characterísticas Lista de características associadas ao direito.

    Tipo de dados: Matriz de objetos

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement": "String",
        "entitlement_usage": [Array],
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
        "type": "String",
        "value": "String"
      }
    ]
    service_contract_lines. ​child_contract_lines. ​entitlement_characterísticas. ​característica
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    service_contract_lines. ​child_contract_lines. ​entitlement_characterísticas. ​characteric_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    service_contract_lines. ​child_contract_lines. ​entitlement_characterísticas. ​direito Sys_id do registro de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​child_contract_lines. ​entitlement_characterísticas. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado à característica de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​child_contract_lines. ​entitlement_characterísticas. ​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_characterísticas. ​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_characterísticas. ​sys_id Sys_id do registro de características de direito.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​entitlement_characterísticas. ​sys_updated_by Nome do usuário que atualizou o registro de características de direito pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​entitlement_characterísticas. ​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_characterísticas. ​tipo Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​entitlement_characterísticas. ​valor
    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.
    Tipo de dados: Matriz de objetos
     "install_base_items_covered": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "install_base": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​child_contract_lines. ​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

    service_contract_lines. ​child_contract_lines. ​install_base_items_covered. ​contrato Sys_id do registro do contrato de serviço associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    service_contract_lines. ​child_contract_lines. ​install_base_items_covered. ​direito Sys_id do registro de direito associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    service_contract_lines. ​child_contract_lines. ​install_base_items_covered. ​install_base Sys_id do registro do item-base de instalação associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    service_contract_lines. ​child_contract_lines. ​install_base_items_covered. ​removido
    Data em que a linha de contrato de serviço associada encerra a cobertura do item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​child_contract_lines. ​install_base_items_covered. ​sys_updated_by Nome do usuário que atualizou o registro do item-base de instalação pela última vez.

    Tipo de dados: Cadeia de caracteres

    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ário.

    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 secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    service_contract_lines. ​child_contract_lines. ​product_offering Sys_id do registro de oferta de produto associado à linha de contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    service_contract_lines. ​child_contract_lines. ​sold_product Sys_id do registro do produto vendido associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    service_contract_lines. ​child_contract_lines. ​sold_products_covered Lista de produtos cobertos.

    Tipo de dados: Matriz de objetos

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

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​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

    service_contract_lines. ​child_contract_lines. ​sold_products_covered. ​contrato Sys_id do registro do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    service_contract_lines. ​child_contract_lines. ​sold_products_covered. ​direito Sys_id do registro de direito associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​child_contract_lines. ​sold_products_covered. ​removido
    Data em que o contrato de serviço associado encerra 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​child_contract_lines. ​sold_products_covered. ​sold_product Sys_id do produto coberto pelo contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​child_contract_lines. ​sold_products_covered. ​sys_updated_by Nome do usuário que atualizou o registro coberto pelo produto vendido pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​sold_products_covered. ​sys_updated_on Nome do usuário que atualizou o registro coberto pelo produto vendido pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​inicia Data de início da linha do 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 do 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​child_contract_lines. ​sys_updated_by Nome do usuário que atualizou pela última vez o registro de linha do 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 de linha do contrato de serviço secundário foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​contrato
    Sys_id do contrato de serviço associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    service_contract_lines. ​termina 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.

    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",
        "product_specification": "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"
      }
    ]

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​direitos. ​conta
    Sys_id do registro da conta ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conta [customer_account]

    service_contract_lines. ​direitos. ​consumidor
    Sys_id do registro do consumidor ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Consumidor [csm_consumer]

    service_contract_lines. ​direitos. ​contrato Sys_id do registro do contrato ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    service_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. ​direitos. ​entitlement_characterísticas Lista de características associadas ao direito.

    Tipo de dados: Matriz de objetos

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

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    service_contract_lines. ​direitos. ​entitlement_characteristics.characteristic
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    service_contract_lines. ​direitos. ​entitlement_characteristics.characteristic_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​direito Sys_id do registro de direito associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage Lista de valores de uso do 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. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​direito Sys_id do registro de direito associado ao uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​entitlement_characteric Sys_id do registro de característica de direito associado ao uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​period_end Data de término em que o uso de direito não é mais rastreado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​period_start Data de início de quando o uso de direito é rastreado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_created_by Nome do usuário que criou o registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_created_on Data e hora em que o registro de uso de direito foi criado.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_id Sys_id do registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Uso de direito [sn_pss_core_entitlement_usage]

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_updated_by Nome do usuário que atualizou o registro de uso de direito pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_updated_on Data e hora em que o registro de uso de direito foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​total_units Valor de cobertura total da característica de direito associada.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​used_units Número de unidades usadas pela conta ou consumidor entre period_starte o. period_end.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado à característica de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​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. ​direitos. ​entitlement_characterísticas. ​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. ​direitos. ​entitlement_characterísticas. ​sys_id Sys_id do registro de características de direito.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​sys_updated_by Nome do usuário que atualizou o registro de características de direito pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​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. ​direitos. ​entitlement_characteristics.type Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​valor
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​entitlement_name
    Nome do direito.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​residência
    Sys_id do registro de residência associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Residência [csm_household]

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

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​install_base_items_covered. ​contrato Sys_id do registro do contrato de serviço associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    service_contract_lines. ​direitos. ​install_base_items_covered. ​direito Sys_id do registro de direito associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​direitos. ​install_base_items_covered. ​install_base Sys_id do registro do item-base de instalação associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    service_contract_lines. ​direitos. ​install_base_items_covered. ​removido Data em que o item-base de instalação associado foi removido do direito.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​install_base_items_covered. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​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

    service_contract_lines. ​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

    service_contract_lines. ​direitos. ​install_base_items_covered. ​sys_id Sys_id do item-base de instalação coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​direitos. ​install_base_items_covered. ​sys_updated_by Nome do usuário que atualizou o registro do item-base de instalação pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​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

    service_contract_lines. ​direitos. ​produto Sys_id do registro do modelo de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    service_contract_lines. ​direitos. ​product_offering Sys_id do registro de oferta de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    service_contract_lines. ​direitos. ​product_specification Sys_id do registro de especificação do produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    service_contract_lines. ​direitos. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​direitos. ​sold_entitlement Sys_id do registro de produto vendido associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    service_contract_lines. ​direitos. ​sold_products_covered Lista de produtos cobertos.

    Tipo de dados: Matriz de objetos

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

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​direitos. ​sold_products_covered. ​adicionado Data em que o produto vendido associado foi adicionado ao direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Data atual

    service_contract_lines. ​direitos. ​sold_products_covered. ​contrato Sys_id do registro do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    service_contract_lines. ​direitos. ​sold_products_covered. ​direito Sys_id do registro de direito associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​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

    service_contract_lines. ​direitos. ​sold_products_covered. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​direitos. ​sold_products_covered. ​sold_product Sys_id do produto coberto pelo direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    service_contract_lines. ​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

    service_contract_lines. ​direitos. ​sold_products_covered. ​sys_created_on Data e hora em que o registro coberto pelo produto vendido foi criado.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​sold_products_covered. ​sys_id Sys_id do produto coberto por este contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​direitos. ​sold_products_covered. ​sys_updated_by Nome do usuário que atualizou o registro coberto pelo produto vendido pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​sold_products_covered. ​sys_updated_on Data e hora em que o registro coberto pelo produto vendido foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​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
    • Cancelados(as)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​sys_created_by Nome do usuário que criou o registro de direito.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​sys_created_on Data e hora em que o registro de direito foi criado.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​sys_id Sys_id do registro de direito associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_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

    service_contract_lines. ​direitos. ​sys_updated_on Data e hora em que o registro de direito foi criado.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​entitlement_characterísticas Lista de características associadas à linha do contrato de serviço.

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

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    service_contract_lines. ​entitlement_characteristics.characteristic
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    service_contract_lines. ​entitlement_characteristics.characteristic_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    service_contract_lines. ​entitlement_characterísticas. ​direito Sys_id do registro de direito associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​entitlement_characterísticas. ​entitlement_usage Lista de valores de uso do 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_characterísticas. ​entitlement_usage. ​direito Sys_id do registro de direito associado ao uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​entitlement_characteric Sys_id do registro de característica de direito associado ao uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    service_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​period_end Data de término em que o uso de direito não é mais rastreado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    service_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​period_start Data de início de quando o uso de direito é rastreado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    service_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​sys_created_by Nome do usuário que criou o registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​sys_created_on Data e hora em que o registro de uso de direito foi criado.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​sys_id Sys_id do registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Uso de direito [sn_pss_core_entitlement_usage]

    service_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​sys_updated_by Nome do usuário que atualizou o registro de uso de direito pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​sys_updated_on Data e hora em que o registro de uso de direito foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​total_units Número total de unidades compradas.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​used_units Número de unidades que foram usadas.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​entitlement_characterísticas. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado à característica de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​entitlement_characterísticas. ​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_characterísticas. ​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_characterísticas. ​sys_id Sys_id do registro de características de direito.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​entitlement_characterísticas. ​sys_updated_by Nome do usuário que atualizou o registro de características de direito pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​entitlement_characterísticas. ​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 _and_usage

    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.

    Tipo de dados: Matriz de objetos

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

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​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

    service_contract_lines. ​install_base_items_covered. ​contrato Sys_id do registro do contrato de serviço associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    service_contract_lines. ​install_base_items_covered. ​direito Sys_id do registro de direito associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​install_base_items_covered. ​install_base Sys_id do item-base de instalação coberto pela linha de contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    service_contract_lines. ​install_base_items_covered. ​removido
    Data em que a linha de contrato de serviço associada encerra 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

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

    Tipo de dados: Cadeia de caracteres

    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. ​número Número exclusivo da linha do contrato de serviço. Gerado automaticamente pelo endpoint. Por exemplo: CTRL9812347.

    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

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​product_model Sys_id do produto associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    service_contract_lines. ​product_offering Sys_id do registro de oferta de produto associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    service_contract_lines. ​product_specification Sys_id do registro de especificação do produto associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    service_contract_lines. ​sold_product Sys_id do registro do produto vendido associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    service_contract_lines. ​sold_products_covered Lista de produtos cobertos.

    Tipo de dados: Matriz de objetos

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

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    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

    service_contract_lines. ​sold_products_covered. ​contrato Sys_id do registro do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    service_contract_lines. ​sold_products_covered. ​direito Sys_id do registro de direito associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​sold_products_covered.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

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​sold_products_covered. ​sold_product Sys_id do produto coberto pelo direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​sold_products_covered. ​sys_updated_by Nome do usuário que atualizou o registro coberto pelo produto vendido pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​sold_products_covered. ​sys_updated_on Data e hora em que o registro coberto pelo produto vendido foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​inicia
    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
    • Cancelados(as)
    • 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 de 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

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

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​sys_updated_on Data e hora em que o registro de 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

    sold_products_covered Lista de produtos cobertos.

    Tipo de dados: Matriz de objetos

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

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    sold_products_covered. ​adicionado Data em que o produto vendido associado foi adicionado ao contrato.

    Tipo de dados: Cadeia de caracteres

    sold_products_covered. ​contrato Sys_id do registro do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    sold_products_covered. ​direito Sys_id do registro de direito associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    sold_products_covered. ​removido Data em que o produto vendido associado foi removido do contrato.

    Tipo de dados: Cadeia de caracteres

    sold_products_covered. ​service_line_contract Sys_id do registro de linha do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    sold_products_covered. ​sold_product Sys_id do produto coberto pelo contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    sold_products_covered. ​sys_created_by Nome do usuário que criou o registro coberto pelo produto vendido.

    Tipo de dados: Cadeia de caracteres

    sold_products_covered. ​sys_created_on Data e hora em que o registro coberto pelo produto vendido foi criado.

    Tipo de dados: Cadeia de caracteres

    sold_products_covered. ​sys_id Sys_id do produto coberto por este contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    sold_products_covered. ​sys_updated_by Nome do usuário que atualizou o registro coberto pelo produto vendido pela última vez.

    Tipo de dados: Cadeia de caracteres

    sold_products_covered. ​sys_updated_on Data e hora em que o registro coberto pelo produto vendido foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres

    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: Começa assim que aprovado.

    estado
    Estado atual do contrato de serviço.
    Valores válidos: (Diferencia maiúsculas de minúsculas)
    • ativo
    • Cancelados(as)
    • 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 Registro de 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    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

    vendor_contract
    Identificador exclusivo de 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",
            "number": "CNTRL0000001",
            "contract": "d8641151d1f53110f8776589fa411fde",
            "parent_contract_line": null,
            "sold_product": null,
            "starts": "2022-12-03",
            "ends": "",
            "product_offering": null,
            "product_specification": 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",
                "number": "CNTRL0000002",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "parent_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                "sold_product": null,
                "starts": "2022-12-03",
                "ends": "",
                "product_offering": null,
                "product_specification": 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,
                    "product_specification": 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,
                "product_specification": 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",
            "number": "CNTRL0000003”,
            "contract": "d8641151d1f53110f8776589fa411fde",
            "parent_contract_line": null,
            "sold_product": null,
            "starts": "2022-12-03",
            "ends": "",
            "product_offering": null,
            "product_specification": 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 - OBTER /sn_pss_core/servicecontract/contractline/

    Recupera os detalhes de um registro de linha de contrato de serviço especificado e suas entidades relacionadas.

    Este endpoint recupera dados nas seguintes tabelas ao processar a solicitação:
    • Característica [sn_pss_core_entitlement_characteric]
    • Direito [service_entitlement]
    • Uso de direito [sn_pss_core_entitlement_usage]
    • Produto vendido coberto [sn_install_base_m2m_contract_sold_product] - Esta tabela contém informações sobre os produtos vendidos cobertos e os itens-base de instalação cobertos.
    • Linha de contrato de serviço [sn_pss_core_service_contract_line]

    Formato de URL

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

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

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

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: Cadeia de caracteres

    id Sys_id do registro de linha do contrato de serviço a ser recuperado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

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

    Tipo de dados: Cadeia de caracteres

    Padrão: falso

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

    Cabeçalhos

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

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

    Padrão: application/json

    Tabela 11. Cabeçalhos de resposta
    Cabeçalho Descrição
    Nenhum(a)

    Códigos de status

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

    Tabela 12. Códigos de status
    Código do status Descrição
    200 Bem-sucedido. A solicitação foi processada com sucesso.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    403 Proibido. O usuário não tem permissão para acessar a API.
    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",
        "number": "String",
        "parent_contract_line": "String",
        "product_model": "String",
        "product_offering": "String",
        "product_specification": "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 do contrato de serviço secundário criados na linha do contrato de serviço secundário. Os objetos nesta matriz têm os mesmos elementos que os objetos em child_contract_linesparâmetro.

    Tipo de dados: Matriz de objetos

    child_contract_lines. ​contrato Sys_id do contrato de serviço associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    child_contract_lines. ​termina 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 do contrato de serviço secundário.

    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",
        "product_specification": "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 da conta ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conta [customer_account]

    child_contract_lines. ​direitos. ​consumidor
    Sys_id do registro do consumidor ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Consumidor [csm_consumer]

    child_contract_lines. ​direitos. ​contrato Sys_id do registro do contrato ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    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. ​direitos. ​entitlement_characterísticas Lista de características associadas ao direito.

    Tipo de dados: Matriz de objetos

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement": "String",
        "entitlement_usage": [Array],
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
        "type": "String",
        "value": "String"
      }
    ]
    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​característica
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​characteric_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​direito Sys_id do registro de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage Lista de usos de direito associados à característica de direito.

    Tipo de dados: Matriz de objetos

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​entitlement_characteric Sys_id do registro de característica de direito associado ao uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    ccild_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​period_end Data de término em que o uso de direito não é mais rastreado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​period_start Data de início de quando o uso de direito é rastreado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​service_contract_line Sys_id da linha do contrato de serviço à qual o uso de direito atual pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_created_by Nome do usuário que criou o registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_created_on Data e hora em que o registro de uso de direito foi criado.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_id Sys_id do registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Uso de direito [sn_pss_core_entitlement_usage]

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_updated_by Nome do usuário que atualizou o registro de uso de direito pela última vez.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_updated_on Data e hora em que o registro de uso de direito foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​total_units Valor de cobertura total da característica de direito associada.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​entitlement_usage. ​used_units Número de unidades usadas pela conta ou consumidor entre period_starte o. period_end.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​tipo Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​valor
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​entitlement_name
    Nome do direito.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​residência
    Sys_id do registro de residência associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Residência [csm_household]

    child_contract_lines. ​direitos. ​install_base_items_covered Lista de 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": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "install_base": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    child_contract_lines. ​direitos. ​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

    child_contract_lines. ​direitos. ​install_base_items_covered. ​contrato Sys_id do registro do contrato de serviço associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    child_contract_lines. ​direitos. ​install_base_items_covered. ​direito Sys_id do registro de direito associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    child_contract_lines. ​direitos. ​install_base_items_covered. ​install_base Sys_id do registro do item-base de instalação associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    child_contract_lines. ​direitos. ​install_base_items_covered. ​removido
    Data em que a linha de contrato de serviço associada encerra a cobertura do item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    child_contract_lines. ​direitos. ​install_base_items_covered. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    child_contract_lines. ​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

    child_contract_lines. ​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

    child_contract_lines. ​direitos. ​install_base_items_covered. ​sys_id Sys_id do item-base de instalação coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    child_contract_lines. ​direitos. ​install_base_items_covered. ​sys_updated_by Nome do usuário que atualizou o registro do item-base de instalação pela última vez.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​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

    child_contract_lines. ​direitos. ​produto Sys_id do registro do modelo de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    child_contract_lines. ​direitos. ​product_offering Sys_id do registro de oferta de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    child_contract_lines. ​direitos. ​product_specification Sys_id do registro de especificação do produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    child_contract_lines. ​direitos. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    child_contract_lines. ​direitos. ​sold_entitlement Sys_id do registro de produto vendido associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    child_contract_lines. ​direitos. ​sold_products_covered Lista de produtos cobertos.

    Tipo de dados: Matriz de objetos

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

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    child_contract_lines. ​direitos. ​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. ​direitos. ​sold_products_covered. ​contrato Sys_id do registro do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    child_contract_lines. ​direitos. ​sold_products_covered. ​direito Sys_id do registro de direito associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    child_contract_lines. ​direitos. ​sold_products_covered. ​removido
    Data em que o contrato de serviço associado encerra 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. ​direitos. ​sold_products_covered. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    child_contract_lines. ​direitos. ​sold_products_covered. ​sold_product Sys_id do produto coberto pelo contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    child_contract_lines. ​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

    child_contract_lines. ​direitos. ​sold_products_covered. ​sys_created_on Data e hora em que o registro coberto pelo produto vendido foi criado.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​sold_products_covered. ​sys_id Sys_id do produto coberto por este contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    child_contract_lines. ​direitos. ​sold_products_covered. ​sys_updated_by Nome do usuário que atualizou o registro coberto pelo produto vendido pela última vez.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​sold_products_covered. ​sys_updated_on Nome do usuário que atualizou o registro coberto pelo produto vendido pela última vez.

    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
    • Cancelados(as)
    • 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. ​direitos. ​sys_id Sys_id do registro de direito associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    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_characterísticas Lista de características associadas ao direito.

    Tipo de dados: Matriz de objetos

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement": "String",
        "entitlement_usage": [Array],
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
        "type": "String",
        "value": "String"
      }
    ]
    child_contract_lines. ​entitlement_characterísticas. ​característica
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    child_contract_lines. ​entitlement_characterísticas. ​characteric_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    child_contract_lines. ​entitlement_characterísticas. ​direito Sys_id do registro de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    child_contract_lines. ​entitlement_characterísticas. ​entitlement_usage Lista de usos de direito associados à característica de direito.

    Tipo de dados: Matriz de objetos

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    child_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​entitlement_characteric Sys_id do registro de característica de direito associado ao uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    child_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​period_end Data de término em que o uso de direito não é mais rastreado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    child_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​period_start Data de início de quando o uso de direito é rastreado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    child_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​service_contract_line Sys_id da linha do contrato de serviço à qual o uso de direito atual pertence.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​sys_created_by Nome do usuário que criou o registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​sys_created_on Data e hora em que o registro de uso de direito foi criado.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​sys_id Sys_id do registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Uso de direito [sn_pss_core_entitlement_usage]

    child_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​sys_updated_by Nome do usuário que atualizou o registro de uso de direito pela última vez.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​sys_updated_on Data e hora em que o registro de uso de direito foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​total_units Valor de cobertura total da característica de direito associada.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​used_units Número de unidades usadas pela conta ou consumidor entre period_starte o. period_end.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​entitlement_characterísticas. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado à característica de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    child_contract_lines. ​entitlement_characterísticas. ​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_characterísticas. ​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_characterísticas. ​sys_id Sys_id do registro de características de direito.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​entitlement_characterísticas. ​sys_updated_by Nome do usuário que atualizou o registro de características de direito pela última vez.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​entitlement_characterísticas. ​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_characterísticas. ​tipo Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​entitlement_characterísticas. ​valor
    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.
    Tipo de dados: Matriz de objetos
     "install_base_items_covered": [ 
      {
        "added": "String",
        "contract": "String",
        "entitlement": "String",
        "install_base": "String",
        "removed": "String",
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
      }
    ]

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    child_contract_lines. ​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

    child_contract_lines. ​install_base_items_covered. ​contrato Sys_id do registro do contrato de serviço associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    child_contract_lines. ​install_base_items_covered. ​direito Sys_id do registro de direito associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    child_contract_lines. ​install_base_items_covered. ​install_base Sys_id do registro do item-base de instalação associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    child_contract_lines. ​install_base_items_covered. ​removido
    Data em que a linha de contrato de serviço associada encerra a cobertura do item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    child_contract_lines. ​install_base_items_covered. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

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

    Tipo de dados: Cadeia de caracteres

    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. ​número Número exclusivo da linha do contrato de serviço. Gerado automaticamente pelo endpoint. Por exemplo: CTRL000001.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​parent_contract_line Sys_id do registro de linha de contrato primário associado à linha de contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​product_model Sys_id do produto associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    child_contract_lines. ​product_offering Sys_id do registro de oferta de produto associado à linha de contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    child_contract_lines. ​product_specification Sys_id do registro de especificação do produto associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    child_contract_lines. ​sold_product Sys_id do registro do produto vendido associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    child_contract_lines. ​sold_products_covered Lista de produtos cobertos.

    Tipo de dados: Matriz de objetos

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

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    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. ​contrato Sys_id do registro do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    child_contract_lines. ​sold_products_covered. ​direito Sys_id do registro de direito associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    child_contract_lines. ​sold_products_covered. ​removido
    Data em que o contrato de serviço associado encerra 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    child_contract_lines. ​sold_products_covered. ​sold_product Sys_id do produto coberto pelo contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    child_contract_lines. ​sold_products_covered. ​sys_updated_by Nome do usuário que atualizou o registro coberto pelo produto vendido pela última vez.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​sold_products_covered. ​sys_updated_on Nome do usuário que atualizou o registro coberto pelo produto vendido pela última vez.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​inicia Data de início da linha do 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
    • Cancelados(as)
    • 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 do 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    child_contract_lines. ​sys_updated_by Nome do usuário que atualizou pela última vez o registro de linha do 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 de 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    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.

    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",
        "product_specification": "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"
      }
    ]

    Tabela: Direito [service_entitlement]

    direitos. ​conta
    Sys_id do registro da conta ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conta [customer_account]

    direitos. ​consumidor
    Sys_id do registro do consumidor ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Consumidor [csm_consumer]

    direitos. ​contrato Sys_id do registro do contrato ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    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. ​entitlement_characterísticas Lista de características associadas ao direito.

    Tipo de dados: Matriz de objetos

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

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    direitos. ​entitlement_characteristics.characteristic
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    direitos. ​entitlement_characteristics.characteristic_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    direitos. ​entitlement_characterísticas. ​direito Sys_id do registro de direito associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    direitos. ​entitlement_characterísticas. ​entitlement_usage Detalhes de uso de direito.

    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. ​entitlement_characterísticas. ​entitlement_usage. ​direito Sys_id do registro de direito associado ao uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    direitos. ​entitlement_characterísticas. ​entitlement_usage. ​entitlement_characteric Sys_id do registro de característica de direito associado ao uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    direitos. ​entitlement_characterísticas. ​entitlement_usage. ​period_end Data de término em que o uso de direito não é mais rastreado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    direitos. ​entitlement_characterísticas. ​entitlement_usage. ​period_start Data de início de quando o uso de direito é rastreado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    direitos. ​entitlement_characterísticas. ​entitlement_usage. ​service_contract_line Linha do contrato de serviço à qual o uso de direito atual pertence.

    Tipo de dados: Cadeia de caracteres

    direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_created_by Nome do usuário que criou o registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_created_on Data e hora em que o registro de uso de direito foi criado.

    Tipo de dados: Cadeia de caracteres

    direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_id Sys_id do registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Uso de direito [sn_pss_core_entitlement_usage]

    direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_updated_by Nome do usuário que atualizou o registro de uso de direito pela última vez.

    Tipo de dados: Cadeia de caracteres

    direitos. ​entitlement_characterísticas. ​entitlement_usage. ​sys_updated_on Data e hora em que o registro de uso de direito foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres

    direitos. ​entitlement_characterísticas. ​entitlement_usage. ​total_units Valor de cobertura total da característica de direito associada.

    Tipo de dados: Cadeia de caracteres

    direitos. ​entitlement_characterísticas. ​entitlement_usage. ​used_units Número de unidades usadas pela conta ou consumidor entre period_starte o. period_end.

    Tipo de dados: Cadeia de caracteres

    direitos. ​entitlement_characterísticas. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado à característica de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    direitos. ​entitlement_characterísticas. ​sys_created_by Nome do usuário que criou o registro de características de direito.

    Tipo de dados: Cadeia de caracteres

    direitos. ​entitlement_characterísticas. ​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_characterísticas. ​sys_id Sys_id do registro de características de direito.

    Tipo de dados: Cadeia de caracteres

    direitos. ​entitlement_characterísticas. ​sys_updated_by Nome do usuário que atualizou o registro de características de direito pela última vez.

    Tipo de dados: Cadeia de caracteres

    direitos. ​entitlement_characterísticas. ​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. ​entitlement_characteristics.type Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: Cadeia de caracteres

    direitos. ​entitlement_characteristics.value
    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 de residência associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Residência [csm_household]

    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. ​adicionado 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. ​contrato Sys_id do registro do contrato de serviço associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    direitos. ​install_base_items_covered. ​direito Sys_id do registro de direito associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    direitos. ​install_base_items_covered. ​install_base Sys_id do registro do item-base de instalação associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    direitos. ​install_base_items_covered. ​removido Data em que o item-base de instalação associado foi removido do direito.

    Tipo de dados: Cadeia de caracteres

    direitos. ​install_base_items_covered. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

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

    Tipo de dados: Cadeia de caracteres

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    direitos. ​product_offering Sys_id do registro de oferta de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    direitos. ​product_specification Sys_id do registro de especificação do produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    direitos. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    direitos. ​sold_entitlement Sys_id do registro de produto vendido associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    direitos. ​sold_products_covered Lista de produtos cobertos.

    Tipo de dados: Matriz de objetos

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

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    direitos. ​sold_products_covered. ​adicionado Data em que o produto vendido associado foi adicionado ao direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Data atual

    direitos. ​sold_products_covered. ​contrato Sys_id do registro do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    direitos. ​sold_products_covered. ​direito Sys_id do registro de direito associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    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. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    direitos. ​sold_products_covered. ​sold_product Sys_id do produto coberto pelo direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    direitos. ​sold_products_covered. ​sys_updated_by Nome do usuário que atualizou o registro coberto pelo produto vendido pela última vez.

    Tipo de dados: Cadeia de caracteres

    direitos. ​sold_products_covered. ​sys_updated_on Data e hora em que o registro coberto pelo produto vendido foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres

    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
    • Cancelados(as)
    • 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    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

    entitlement_characterísticas Lista de características de direito associadas à linha do contrato de serviço.

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

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    entitlement_characterísticas. ​característica
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    entitlement_characterísticas. ​characteric_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    entitlement_characterísticas. ​direito Sys_id do registro de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    entitlement_characterísticas. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado à característica de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    entitlement_characterísticas. ​sys_created_by Nome do usuário que criou o registro de características de direito.

    Tipo de dados: Cadeia de caracteres

    entitlement_characterísticas. ​sys_created_on Data e hora em que o registro de características de direito foi criado.

    Tipo de dados: Cadeia de caracteres

    entitlement_characterísticas. ​sys_id Sys_id do registro de características de direito.

    Tipo de dados: Cadeia de caracteres

    entitlement_characterísticas. ​sys_updated_by Nome do usuário que atualizou o registro de características de direito pela última vez.

    Tipo de dados: Cadeia de caracteres

    entitlement_characterísticas. ​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_characterísticas. ​tipo Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: Cadeia de caracteres

    entitlement_characterísticas. ​valor
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

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

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    install_base_items_covered. ​adicionado
    Data em que o item-base de instalação associado foi adicionado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    install_base_items_covered. ​contrato Sys_id do registro do contrato de serviço associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    install_base_items_covered. ​direito Sys_id do registro de direito associado ao item-base de instalação.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    install_base_items_covered. ​install_base Sys_id do item-base de instalação coberto pela linha de contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    install_base_items_covered. ​removido
    Data em que a linha de contrato de serviço associada encerra 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    install_base_items_covered. ​sys_created_by Nome do usuário que criou o registro do item-base de instalação.

    Tipo de dados: Cadeia de caracteres

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

    Tipo de dados: Cadeia de caracteres

    install_base_items_covered. ​sys_id Sys_id do item-base de instalação coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

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

    Tipo de dados: Cadeia de caracteres

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

    Tipo de dados: Cadeia de caracteres

    nome
    Nome da linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    número Número exclusivo da linha do contrato de serviço. Gerado automaticamente pelo endpoint. Por exemplo: CTRL9812347.

    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

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    product_model Sys_id do produto associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    product_offering Sys_id do registro de oferta de produto associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    product_specification Sys_id do registro de especificação do produto associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    sold_product Sys_id do registro do produto vendido associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    sold_products_covered Lista de produtos cobertos.

    Tipo de dados: Matriz de objetos

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

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    sold_products_covered. ​adicionado Data em que o produto vendido associado foi adicionado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    sold_products_covered. ​contrato Sys_id do registro do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    sold_products_covered. ​direito Sys_id do registro de direito associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    sold_products_covered.removido Data em que o produto vendido associado foi removido da linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    sold_products_covered. ​service_contract_line Sys_id do registro de linha do contrato de serviço associado ao produto vendido coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    sold_products_covered. ​sold_product Sys_id do produto coberto pelo direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    sold_products_covered. ​sys_created_by Nome do usuário que criou o registro coberto pelo produto vendido.

    Tipo de dados: Cadeia de caracteres

    sold_products_covered. ​sys_created_on Data e hora em que o registro coberto pelo produto vendido foi criado.

    Tipo de dados: Cadeia de caracteres

    sold_products_covered. ​sys_id Sys_id do produto coberto por este contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    sold_products_covered. ​sys_updated_by Nome do usuário que atualizou o registro coberto pelo produto vendido pela última vez.

    Tipo de dados: Cadeia de caracteres

    sold_products_covered. ​sys_updated_on Data e hora em que o registro coberto pelo produto vendido foi atualizado pela última vez.

    Tipo de dados: Cadeia de caracteres

    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
    • Cancelados(as)
    • 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 de 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

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

    Tipo de dados: Cadeia de caracteres

    sys_updated_on Data e hora em que o registro de 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",
        "number": "CTRL0000001",
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "parent_contract_line": null,
        "sold_product": null,
        "starts": "2022-12-03",
        "ends": "",
        "product_offering": null,
        "product_specification": 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",
            "number": "CTRL0000002",
            "contract": "a4b415d1d1f53110f8776589fa411f20",
            "parent_contract_line": "16e451d1d1f53110f8776589fa411f80",
            "sold_product": null,
            "starts": "2022-12-03",
            "ends": "",
            "product_offering": null,
            "product_model": null,
            "product_specification": 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,
                "product_specification": 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,
            "product_specification": 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 suas entidades relacionadas a partir de uma carga especificada.

    . Contrato de serviço A API armazena dados em várias tabelas. 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_characteric]
    • Direito [service_entitlement]
    • Uso de direito [sn_pss_core_entitlement_usage]
    • Produto vendido coberto [sn_install_base_m2m_contract_sold_product] - Esta tabela contém informações sobre os produtos vendidos cobertos e os itens-base de instalação cobertos.
    • 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 utilizar 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 de URL

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

    URL padrão: /api/sn_pss_core/servicecontract

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

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: Cadeia de caracteres

    Tabela 14. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 15. Solicitar parâmetros do corpo (XML ou JSON)
    Nome Descrição
    conta Necessário se consumero parâmetro não foi especificado.
    Sys_id do registro da conta ao qual o contrato de serviço pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conta [customer_account]

    cliente Necessário se accounto parâmetro não foi especificado.
    Sys_id do registro do consumidor ao qual o contrato de serviço pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Consumidor [csm_consumer]

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Residência [csm_household]

    Padrão: Nulo (sem residência)

    install_base_items_covered Lista de itens-base de instalação cobertos pelo contrato de serviço.

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

    Armazenado em: A tabela Produto vendido coberto [sn_install_base_m2m_contract_sold_product].

    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

    Formato: aaaa-MM-dd

    Padrão: Data atual

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    install_base_items_covered. ​removido
    Data em que o contrato de serviço associado encerra 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 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],
        "ends": "String",
        "entitlements": [Array],
        "entitlement_characteristics": [Array],
        "install_base_items_covered": [Array],
        "name": "String",
        "number": "String",
        "product_model": "String",
        "product_offering": "String",
        "product_specification": "String",
        "sold_product": "String",
        "sold_products_covered": [Array],
        "starts": "String",
        "state": "String"
      }
    ]

    Armazenado em: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​child_contract_lines Lista de linhas de contrato de serviço secundárias na linha de contrato de serviço.

    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",
        "product_specification": "String",
        "sold_product": "String",
        "sold_products_covered": [Array],
        "starts": "String",
        "state": "String"
      }
    ]

    Armazenado em: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    service_contract_lines. ​child_contract_lines. ​child_contract_lines Lista de objetos de linha do contrato de serviço secundário a serem criados na linha do contrato de serviço secundário. Os objetos nesta matriz têm os mesmos elementos que os objetos em service_contract_lines.child_contract_linesparâmetro.

    Tipo de dados: Matriz de objetos

    service_contract_lines. ​child_contract_lines. ​termina 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 do contrato de serviço secundário.

    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",
        "product_specification": "String",
        "sold_entitlement": "String",
        "sold_products_covered": [Array],
        "start_date": "String",
        "state": "String"
      }
    ]

    Armazenado em: Direito [service_entitlement]

    service_contract_lines. ​child_contract_lines. ​direitos. ​conta
    Sys_id do registro da conta ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conta [customer_account]

    service_contract_lines. ​child_contract_lines. ​direitos. ​consumidor
    Sys_id do registro do consumidor ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Consumidor [csm_consumer]

    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_characterísticas Lista de características associadas ao direito.

    Tipo de dados: Matriz de objetos

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

    Armazenado em: Característica [sn_pss_core_entitlement_characteric]

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characteristics.characteristic Obrigatório.
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characteristics.characteristic_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas.entitlement_usage Valor unitário usado para a característica de direito associada.

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

    Tipo de dados: Objeto

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

    Armazenado em: Uso de direito [sn_pss_core_entitlement_usage]

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characteristics.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 _and_usage

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characteristics.value Necessário se input_typeparâmetro contido no registro especificado em entitlement_characteristics.characteristicparâmetro, não é opção .
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    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. ​residência Aprovado somente quando os plug-ins domésticos estão ativos e consumero parâmetro foi passado.
    Sys_id do registro de residência associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Residência [csm_household]

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

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Data atual

    service_contract_lines. ​child_contract_lines. ​direitos. ​install_base_items_covered. ​install_base Sys_id do item-base de instalação coberto pelo direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    service_contract_lines. ​child_contract_lines. ​direitos. ​install_base_items_covered. ​removido Data em que o item-base de instalação associado foi removido do direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Sem data de término

    service_contract_lines. ​child_contract_lines. ​direitos. ​produto Sys_id do registro do modelo de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    service_contract_lines. ​child_contract_lines. ​direitos. ​product_offering Sys_id do registro de oferta de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    service_contract_lines. ​child_contract_lines. ​direitos. ​product_specification Sys_id do registro de especificação do produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    service_contract_lines. ​child_contract_lines. ​direitos. ​sold_entitlement Sys_id do registro de produto vendido associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    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. ​adicionado Data em que o produto vendido associado foi adicionado ao direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Data atual

    service_contract_lines. ​child_contract_lines. ​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

    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
    • Cancelados(as)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​entitlement_characterísticas Lista de características associadas à linha do contrato de serviço.

    Tipo de dados: Matriz de objetos

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

    Armazenado em: Característica [sn_pss_core_entitlement_characteric]

    service_contract_lines. ​child_contract_lines. ​entitlement_characteristics.characteristic Obrigatório.
    Sys_id do registro de característica associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    service_contract_lines. ​child_contract_lines. ​entitlement_characteristics.characteristic_option
    Sys_id do registro de opção de característica associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    service_contract_lines. ​child_contract_lines. ​entitlement_characterísticas.entitlement_usage Valor unitário usado para a característica de linha do contrato de serviço associada.

    Tipo de dados: Objeto

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

    Armazenado em: Uso de direito [sn_pss_core_entitlement_usage]

    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 da linha do contrato de serviço.
    Valores válidos:
    • cobertura
    • coverage_and_usage

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​child_contract_lines. ​entitlement_characteristics.value Necessário se entitlement_characteristics.typeo parâmetro não foi 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.

    Tipo de dados: Matriz de objetos

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

    Vendido coberto em: Produto vendido [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​child_contract_lines. ​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

    service_contract_lines. ​child_contract_lines. ​install_base_items_covered. ​install_base Sys_id do item-base de instalação coberto pela linha de contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    service_contract_lines. ​child_contract_lines. ​install_base_items_covered. ​removido
    Data em que a linha de contrato de serviço associada encerra 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. ​nome
    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    service_contract_lines. ​child_contract_lines. ​product_offering Sys_id do registro de oferta de produto associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    service_contract_lines. ​child_contract_lines. ​product_specification Sys_id do registro de especificação do produto associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    service_contract_lines. ​child_contract_lines. ​sold_product Sys_id do registro do produto vendido associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    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. ​adicionado Data em que a linha de contrato de serviço associada 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. ​removido Data em que a linha de contrato de serviço associada encerra 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​child_contract_lines. ​inicia 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
    • Cancelados(as)
    • 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",
        "product_specification": "String",
        "sold_entitlement": "String",
        "sold_products_covered": [Array],
        "start_date": "String",
        "state": "String"
      }
    ]
    service_contract_lines. ​direitos. ​conta
    Sys_id do registro da conta ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conta [customer_account]

    service_contract_lines. ​direitos. ​consumidor
    Sys_id do registro do consumidor ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Consumidor [csm_consumer]

    service_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. ​direitos. ​entitlement_characterísticas Lista de características associadas ao direito.

    Tipo de dados: Matriz de objetos

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

    Armazenado em: Característica [sn_pss_core_entitlement_characteric]

    service_contract_lines. ​direitos. ​entitlement_characteristics.characteristic Obrigatório.
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    service_contract_lines. ​direitos. ​entitlement_characteristics.characteristic_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    service_contract_lines. ​direitos. ​entitlement_characterísticas.entitlement_usage Valor unitário usado para a característica de direito associada.

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

    Tipo de dados: Objeto

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

    Armazenado em: Uso de direito [sn_pss_core_entitlement_usage]

    service_contract_lines. ​direitos. ​entitlement_characteristics.entitlement​_usage. usage_units Uso da característica de direito associada.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​entitlement_characteristics.type Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​entitlement_characteristics.value Necessário se input_typeparâmetro contido no registro especificado em entitlement_characteristics.characteristicparâmetro, não é opção .
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​entitlement_name Obrigatório.
    Nome do direito.

    Tipo de dados: Cadeia de caracteres

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Residência [csm_household]

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

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Data atual

    service_contract_lines. ​direitos. ​install_base_items_covered. ​install_base Sys_id do item-base de instalação coberto pelo direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    service_contract_lines. ​direitos. ​install_base_items_covered. ​removido Data em que o item-base de instalação associado foi removido do direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Sem data de término

    service_contract_lines. ​direitos. ​produto Sys_id do registro do modelo de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    service_contract_lines. ​direitos. ​product_offering Sys_id do registro de oferta de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    service_contract_lines. ​direitos. ​product_specification Sys_id do registro de especificação do produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    service_contract_lines. ​direitos. ​sold_entitlement Sys_id do registro de produto vendido associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    service_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. ​direitos. ​sold_products_covered. ​adicionado Data em que o produto vendido associado foi adicionado ao direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Data atual

    service_contract_lines. ​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

    service_contract_lines. ​direitos. ​sold_products_covered. ​sold_product Sys_id de um produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_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. ​direitos. ​estado Obrigatório.
    Estado atual do direito.
    Valores válidos: (Diferencia maiúsculas de minúsculas)
    • ativo
    • Cancelados(as)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​entitlement_characterísticas Lista de características associadas à linha do contrato de serviço.

    Tipo de dados: Matriz de objetos

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

    Armazenado em: Característica [sn_pss_core_entitlement_characteric]

    service_contract_lines. ​entitlement_characterísticas. ​característica Obrigatório.
    Sys_id do registro de característica associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    service_contract_lines. ​entitlement_characterísticas. ​characteric_option
    Sys_id do registro de opção de característica associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    service_contract_lines. ​entitlement_characterísticas. ​entitlement_usage Valor unitário usado para a característica de linha do contrato de serviço associada.

    Tipo de dados: Objeto

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

    Armazenado em: Uso de direito [sn_pss_core_entitlement_usage]

    service_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​usage_units Uso da característica de direito associada.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​entitlement_characterísticas. ​tipo Tipo de característica da linha do contrato de serviço.
    Valores válidos:
    • cobertura
    • coverage_and_usage

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​entitlement_characterísticas. ​valor Necessário se entitlement_characteristics.typeo parâmetro não foi 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.

    Tipo de dados: Matriz de objetos

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

    Vendido coberto em: Produto vendido [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​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

    service_contract_lines. ​install_base_items_covered. ​install_base Sys_id do item-base de instalação coberto pela linha de contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    service_contract_lines. ​install_base_items_covered. ​removido
    Data em que a linha de contrato de serviço associada encerra 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    service_contract_lines. ​product_offering Sys_id do registro de oferta de produto associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    service_contract_lines. ​product_specification Sys_id do registro de especificação do produto associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    service_contract_lines. ​sold_product Sys_id do registro do produto vendido associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    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 de contrato de serviço associada 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 de contrato de serviço associada encerra 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​inicia 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
    • Cancelados(as)
    • 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)

    sold_products_covered Necessário se install_base_items_coveredo parâmetro não foi 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"
      }
    ]
    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

    sold_products_covered.removido
    Data em que o contrato de serviço associado encerra a cobertura do produto associado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Sem data de término

    sold_products_covered.sold_product Sys_id do produto coberto pelo contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    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
    • Cancelados(as)
    • rascunho
    • expirado

    Tipo de dados: Cadeia de caracteres

    vendor_contract Obrigatório.
    Identificador exclusivo de 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/jsonou application/xml.

    Padrão: application/json

    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json

    Tabela 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 18. Códigos de status
    Código do status Descrição
    201 Bem-sucedido. A solicitação foi processada com sucesso e os registros foram criados.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    403 Proibido. O usuário não tem permissão para acessar a API.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    número Número do contrato de serviço gerado automaticamente.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines 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",
        "number": "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",
        "number": "String",
        "sold_products_covered": [Array],
        "sys_id" "String"
      }
    ]
    service_contract_lines. ​child_contract_lines. ​child_contract_lines Lista de objetos de linha do contrato de serviço secundário criados na linha do contrato de serviço secundário. Os objetos nesta matriz têm os mesmos elementos que service_contract_lines.child_contract_linesparâmetro.

    Tipo de dados: Matriz de objetos

    service_contract_lines. ​child_contract_lines. ​direitos Lista de direitos associados à linha do contrato de serviço secundário.

    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_characterísticas Lista de objetos de característica de direito criados no direito.

    Tipo de dados: Matriz de objetos

    "entitlement_characteristics": [
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines. ​child_contract_lines. ​direitos. ​entitlement_characterísticas. ​sys_id Sys_id de um registro de características de direito associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    service_contract_lines. ​child_contract_lines. ​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"
      }
    ]
    service_contract_lines. ​child_contract_lines. ​direitos. ​install_base_items_covered. ​sys_id Sys_id de itens-base de instalação cobertos pelo direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    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. ​direitos. ​sold_products_covered. ​sys_id Sys_id de um produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​child_contract_lines. ​direitos. ​sys_id Sys_id do registro de direito associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​child_contract_lines. ​entitlement_characterísticas 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_characterísticas. ​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_characterísticas. ​entitlement_usage. ​sys_id Sys_id do registro de uso de direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Uso de direito [sn_pss_core_entitlement_usage]

    service_contract_lines. ​child_contract_lines. ​entitlement_characterísticas. ​sys_id Sys_id de um registro de características de direito associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    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ário.

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    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. ​número Número exclusivo da linha do contrato de serviço. Gerado automaticamente pelo endpoint. Por exemplo: CTRL000001.

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​child_contract_lines. ​sys_id Sys_id de um registro de linha de contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    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. ​direitos. ​entitlement_name
    Nome do direito.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​direitos. ​entitlement_characterísticas Lista de objetos de característica de direito criados no direito.

    Tipo de dados: Matriz de objetos

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

    Tipo de dados: Objeto

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Uso de direito [sn_pss_core_entitlement_usage]

    service_contract_lines. ​direitos. ​entitlement_characterísticas. ​sys_id Sys_id de um registro de características de direito associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    service_contract_lines. ​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"
      }
    ]
    service_contract_lines. ​direitos. ​install_base_items_covered. ​sys_id Sys_id de itens-base de instalação cobertos pelo direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_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. ​direitos. ​sold_products_covered. ​sys_id Sys_id de um produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​direitos. ​sys_id Sys_id do registro de direito associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    service_contract_lines. ​entitlement_characterísticas 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. ​entitlement_characterísticas. ​entitlement_usage Objeto de uso de direito inserido em entitlement_characteristic.

    Tipo de dados: Objeto

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Uso de direito [sn_pss_core_entitlement_usage]

    service_contract_lines. ​entitlement_characterísticas. ​sys_id Sys_id de um registro de características de direito associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    service_contract_lines. ​install_base_items_covered Lista de sys_ids dos itens-base de instalação cobertos pela linha de contrato secundário.

    Tipo de dados: Matriz de objetos

    "install_base_items_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines. ​install_base_items_covered. ​sys_id Sys_id do item-base de instalação coberto.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​nome Nome da linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​número Número exclusivo da linha do contrato de serviço. Gerado automaticamente pelo endpoint. Por exemplo: CTRL000001.

    Tipo de dados: Cadeia de caracteres

    service_contract_lines. ​sold_products_covered 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"
      }
    ]
    service_contract_lines. ​sold_products_covered. ​sys_id Sys_id de um produto coberto pela linha de contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    service_contract_lines. ​sys_id Sys_id de um registro de linha de contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    short_description
    Breve descrição ou nome do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    sold_products_covered Lista de sys_ids dos produtos cobertos pelo contrato de serviço.

    Tipo de dados: Matriz de objetos

    "sold_products_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    sold_products_covered. ​sys_id Sys_id de um produto coberto pelo contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    sys_id Sys_id do registro do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    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 por produto vendido, um registro coberto por itens de 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",
            "number": "CTRL0000001,                                                                                                 
            "child_contract_lines": [
              {
                "sys_id": "3a39ecdc01154f4ab782da0169c9c922",
                "name": "Child CLI",
                "number": "CTRL0000002",
                "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",
            "number": "CTRL0000003",
            "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_characteric]
    • Direito [service_entitlement]
    • Uso de direito [sn_pss_core_entitlement_usage]
    • Produto vendido coberto [sn_install_base_m2m_contract_sold_product] - Esta tabela contém informações sobre os produtos vendidos cobertos e os itens-base de instalação cobertos.
    • Linha de contrato de serviço [sn_pss_core_service_contract_line]

    Formato de URL

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

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

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

    Parâmetros de solicitação compatíveis

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

    Tipo de dados: Cadeia de caracteres

    Tabela 20. Parâmetros de consulta
    Nome Descrição
    Nenhum(a)
    Tabela 21. Solicitar parâmetros do corpo (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.

    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",
        "product_specification": "String",
        "sold_product": "String",
        "sold_products_covered": [Array],
        "starts": "String",
        "state": "String"
      }
    ]

    Armazenado em: Contrato de serviço [sn_pss_core_service_contract]

    child_contract_lines. ​child_contract_lines Lista de objetos de linha do contrato de serviço secundário a serem criados na linha do contrato de serviço secundário. Os objetos nesta matriz têm os mesmos elementos que os objetos em child_contract_linesparâmetro.

    Tipo de dados: Matriz de objetos

    child_contract_lines. ​contrato Sys_id do contrato de serviço associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    child_contract_lines. ​termina 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 do contrato de serviço secundário.

    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",
        "product_specification": "String",
        "sold_entitlement": "String",
        "sold_products_covered": [Array],
        "start_date": "String",
        "state": "String"
      }
    ]

    Armazenado em: Direito [service_entitlement]

    child_contract_lines. ​direitos. ​conta Necessário se consumero parâmetro não foi passado.
    Sys_id do registro da conta ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conta [customer_account]

    child_contract_lines. ​direitos. ​consumidor Necessário se accounto parâmetro não foi passado.
    Sys_id do registro do consumidor ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Consumidor [csm_consumer]

    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. ​direitos. ​entitlement_characterísticas Lista de características associadas ao direito.

    Tipo de dados: Matriz de objetos

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

    Armazenado em: Característica [sn_pss_core_entitlement_characteric]

    child_contract_lines. ​direitos. ​entitlement_characteristics.characteristic Obrigatório.
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    child_contract_lines. ​direitos. ​entitlement_characteristics.characteristic_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    child_contract_lines. ​direitos. ​entitlement_characterísticas.entitlement_usage Valor unitário usado para a característica de direito associada.

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

    Tipo de dados: Objeto

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

    Armazenado em: Uso de direito [sn_pss_core_entitlement_usage]

    child_contract_lines. ​direitos. ​entitlement_characteristics.entitlement_usage.​used_units Uso da característica de direito associada.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​entitlement_characteristics.type Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​entitlement_characteristics.value Necessário se input_typeparâmetro contido no registro especificado em entitlement_characteristics.characteristicparâmetro, não é opção .
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​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 domésticos estão ativos e consumero parâmetro foi passado.
    Sys_id do registro de residência associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Residência [csm_household]

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

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Data atual

    child_contract_lines. ​direitos. ​install_base_items_covered. ​install_base Sys_id do item-base de instalação coberto pelo direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    child_contract_lines. ​direitos. ​install_base_items_covered. ​removido Data em que o item-base de instalação associado foi removido do direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Sem data de término

    child_contract_lines. ​direitos. ​produto Sys_id do registro do modelo de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    child_contract_lines. ​direitos. ​product_offering Sys_id do registro de oferta de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    child_contract_lines. ​direitos. ​product_specification Sys_id do registro de especificação do produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    child_contract_lines. ​direitos. ​sold_entitlement Sys_id do registro de produto vendido associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    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"
      }
    ]
    child_contract_lines. ​direitos. ​sold_products_covered. ​adicionado Data em que o produto vendido associado foi adicionado ao direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Data atual

    child_contract_lines. ​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

    child_contract_lines. ​direitos. ​sold_products_covered. ​sold_product Sys_id de um produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    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
    • Cancelados(as)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​entitlement_characterísticas Lista de características associadas ao direito.

    Tipo de dados: Matriz de objetos

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

    Armazenado em: Característica [sn_pss_core_entitlement_characteric]

    child_contract_lines. ​entitlement_characterísticas. ​característica
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    child_contract_lines. ​entitlement_characterísticas. ​characteric_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    child_contract_lines. ​entitlement_characterísticas. ​entitlement_usage Valor unitário usado para a característica de direito associada.

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

    Tipo de dados: Objeto

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

    Armazenado em: Uso de direito [sn_pss_core_entitlement_usage]

    child_contract_lines. ​entitlement_characterísticas. ​entitlement_usage. ​used_units Uso da característica de direito associada.

    Tipo de dados: Cadeia de caracteres

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

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​entitlement_characterísticas. ​valor
    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. ​adicionado Data em que o item-base de instalação associado foi adicionado à linha do 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 de contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    child_contract_lines. ​install_base_items_covered. ​removido Data em que a linha de contrato de serviço secundário associada encerra 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_line Sys_id do registro de linha de contrato primário associado à linha de contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​product_model Sys_id do produto associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    child_contract_lines. ​product_offering Sys_id do registro de oferta de produto associado à linha de contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    child_contract_lines. ​product_specification Sys_id do registro de especificação do produto associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    child_contract_lines. ​sold_product Sys_id do registro do produto vendido associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    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 do contrato de serviço secundário 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 associada encerra 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    child_contract_lines. ​inicia Data de início da linha do 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
    • Cancelados(as)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: Cadeia de caracteres

    contrato
    Sys_id do contrato de serviço associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Contrato de serviço [sn_pss_core_service_contract]

    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",
        "product_specification": "String",
        "sold_entitlement": "String",
        "sold_products_covered": [Array],
        "start_date": "String",
        "state": "String"
      }
    ]
    direitos. ​conta Necessário se consumero parâmetro não foi passado.
    Sys_id do registro da conta ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Conta [customer_account]

    direitos. ​consumidor Necessário se accounto parâmetro não foi passado.
    Sys_id do registro do consumidor ao qual o direito pertence.

    Tipo de dados: Cadeia de caracteres

    Tabela: Consumidor [csm_consumer]

    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. ​entitlement_characterísticas Lista de características associadas ao direito.

    Tipo de dados: Matriz de objetos

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

    Armazenado em: Característica [sn_pss_core_entitlement_characteric]

    direitos. ​entitlement_characteristics.characteristic Obrigatório.
    Sys_id do registro de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    direitos. ​entitlement_characteristics.characteristic_option Sys_id do registro de opção de característica associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    direitos. ​entitlement_characterísticas.entitlement_usage Valor unitário usado para a característica de direito associada.

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

    Tipo de dados: Objeto

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

    Armazenado em: Uso de direito [sn_pss_core_entitlement_usage]

    direitos. ​entitlement_characteristics.entitlement_usage.​used_units Uso da característica de direito associada.

    Tipo de dados: Cadeia de caracteres

    direitos. ​entitlement_characteristics.type Tipo de característica de direito.
    Valores válidos:
    • cobertura
    • cobertura _and_usage

    Tipo de dados: Cadeia de caracteres

    direitos. ​entitlement_characteristics.value Necessário se input_typeparâmetro contido no registro especificado em entitlement_characteristics.characteristicparâmetro, não é opção .
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    direitos. ​entitlement_name Obrigatório.
    Nome do direito.

    Tipo de dados: Cadeia de caracteres

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Residência [csm_household]

    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. ​adicionado Data em que o item-base de instalação associado foi adicionado ao direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Data atual

    direitos. ​install_base_items_covered. ​removido Data em que o item-base de instalação associado foi removido do direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Sem data de término

    direitos. ​produto Sys_id do registro do modelo de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    direitos. ​product_offering Sys_id do registro de oferta de produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    direitos. ​product_specification Sys_id do registro de especificação do produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    direitos. ​sold_entitlement Sys_id do registro de produto vendido associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    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. ​adicionado Data em que o produto vendido associado foi adicionado ao direito.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Data atual

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    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
    • Cancelados(as)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: Cadeia de caracteres

    entitlement_characterísticas Lista de características associadas à linha do contrato de serviço.

    Tipo de dados: Matriz de objetos

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

    Armazenado em: Característica [sn_pss_core_entitlement_characteric]

    entitlement_characterísticas. ​característica Obrigatório.
    Sys_id do registro de característica associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_prd_pm_characteric]

    entitlement_characterísticas. ​characteric_option Necessário se input_typeparâmetro contido no registro especificado em entitlement_characteristics.characteristicparâmetro, está definido como opção .
    Sys_id do registro de opção de característica associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Opção de característica [sn_prd_pm_characteric_option]

    entitlement_characterísticas. ​entitlement_usage Valor unitário usado para a característica de linha do contrato de serviço associada.

    Tipo de dados: Objeto

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

    Armazenado em: Uso de direito [sn_pss_core_entitlement_usage]

    entitlement_characterísticas. ​entitlement_usage. ​used_units Uso da característica de direito associada.

    Tipo de dados: Cadeia de caracteres

    entitlement_characterísticas. ​tipo Tipo de característica da linha do contrato de serviço.
    Valores válidos:
    • cobertura
    • coverage_and_usage

    Tipo de dados: Cadeia de caracteres

    entitlement_characterísticas. ​valor Necessário se entitlement_characteristics.typeo parâmetro não foi passado.
    Valor da característica.

    Tipo de dados: Cadeia de caracteres

    install_base_items_covered Necessário se sold_products_coveredo parâmetro não foi passado.
    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",
        "install_base": "String",
        "removed": "String"
      }
    ]

    Vendido coberto em: Produto vendido [sn_install_base_m2m_contract_sold_product]

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Item-base de instalação [sn_install_base_item]

    install_base_items_covered. ​removido
    Data em que a linha de contrato de serviço associada encerra 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

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    product_model Sys_id do produto associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Modelo de produto [cmdb_model]

    product_offering   Sys_id do registro de oferta de produto associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Oferta de produto [sn_prd_pm_product_offering]

    product_specification Sys_id do registro de especificação do produto associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Especificação do produto [sn_prd_pm_product_specification]

    sold_product Sys_id do registro do produto vendido associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido [sn_install_base_sold_product]

    sold_products_covered Necessário se install_base_items_coveredo parâmetro não foi 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].

    sold_products_covered. ​adicionado Data em que a linha de contrato de serviço associada começa a cobrir o produto associado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Data atual

    sold_products_covered. ​removido Data em que a linha de contrato de serviço associada encerra a cobertura do produto associado.

    Tipo de dados: Cadeia de caracteres

    Formato: aaaa-MM-dd

    Padrão: Sem data de término

    sold_products_covered. ​sold_product
    Sys_id de um produto associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    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
    • Cancelados(as)
    • rascunho
    • expirado
    • suspenso

    Tipo de dados: Cadeia de caracteres

    Cabeçalhos

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

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

    Padrão: application/json

    Tipo de conteúdo Formato de dados do corpo da solicitação. Tipos compatíveis: application/jsonou application/xml.

    Padrão: application/json

    Tabela 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 possíveis códigos de status usados na REST API, consulte Códigos de resposta HTTP da REST API .

    Tabela 24. Códigos de status
    Código do status Descrição
    201 Bem-sucedido. A solicitação foi processada com sucesso e os registros foram criados.
    400 Solicitação Incorreta. Um tipo de solicitação incorreto ou uma solicitação malformada foi detectada.
    403 Proibido. O usuário não tem permissão para acessar a API.
    500 Erro interno do servidor. Ocorreu um erro inesperado ao processar a solicitação. A resposta contém informações adicionais sobre o erro.

    Parâmetros do corpo da resposta (JSON 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",
        "number": "String",
        "sold_products_covered": [Array],
        "sys_id" "String"
      }
    ]
    child_contract_lines. ​child_contract_lines Lista de objetos de linha do contrato de serviço secundário criados na linha do contrato de serviço secundário. Os objetos nesta matriz têm os mesmos elementos que child_contract_linesparâmetro.

    Tipo de dados: Matriz de objetos

    child_contract_lines. ​direitos Lista de direitos associados à linha do contrato de serviço secundário.

    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. ​direitos. ​entitlement_name
    Nome do direito.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​direitos. ​entitlement_characterísticas Lista de objetos de característica de direito criados no direito.

    Tipo de dados: Matriz de objetos

    "entitlement_characteristics": [
      {
        "sys_id": "String"
      }
    ]
    child_contract_lines. ​direitos. ​entitlement_characterísticas. ​sys_id Sys_id de um registro de características de direito associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    child_contract_lines. ​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"
      }
    ]
    child_contract_lines. ​direitos. ​install_base_items_covered. ​sys_id Sys_id de itens-base de instalação cobertos pelo direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    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"
      }
    ]
    child_contract_lines. ​direitos. ​sold_products_covered. ​sys_id Sys_id de um produto associado ao direito.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    child_contract_lines. ​direitos. ​sys_id Sys_id do registro de direito associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    child_contract_lines. ​entitlement_characterísticas 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_characterísticas. ​entitlement_usage Objeto de uso de direito inserido em entitlement_characteristic.

    Tipo de dados: Objeto

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Uso de direito [sn_pss_core_entitlement_usage]

    child_contract_lines. ​entitlement_characterísticas. ​sys_id Sys_id de um registro de características de direito associado à linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Característica [sn_pss_core_entitlement_characteristic]

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    child_contract_lines. ​nome Nome da linha do contrato de serviço secundário.

    Tipo de dados: Cadeia de caracteres

    child_contract_lines. ​número Número exclusivo da linha do contrato de serviço. Gerado automaticamente pelo endpoint. Por exemplo: CTRL9812347.

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    child_contract_lines. ​sys_id Sys_id de um produto coberto pelo item do contrato secundário.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    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. ​entitlement_characterísticas Lista de objetos de característica de direito criados no direito.

    Tipo de dados: Matriz de objetos

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

    Tipo de dados: Objeto

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Uso de direito [sn_pss_core_entitlement_usage]

    direitos. ​entitlement_characterísticas. ​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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    direitos. ​sys_id Sys_id do registro de direito associado à linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Direito [service_entitlement]

    entitlement_characterísticas Lista de 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_characterísticas. ​entitlement_usage Objeto de uso de direito inserido em entitlement_characteristic.

    Tipo de dados: Objeto

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

    Tipo de dados: Cadeia de caracteres

    Tabela: Uso de direito [sn_pss_core_entitlement_usage]

    entitlement_characterísticas. ​sys_id Sys_id 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.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    nome
    Nome da linha do contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    número Número exclusivo da linha do contrato de serviço. Gerado automaticamente pelo endpoint. Por exemplo: CTRL9812347.

    Tipo de dados: Cadeia de caracteres

    sold_products_covered 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"
      }
    ]
    sold_products_covered. ​sys_id Sys_id de um produto coberto pela linha de contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Produto vendido coberto [sn_install_base_m2m_contract_sold_product]

    sys_id Sys_id de um registro de linha de contrato de serviço.

    Tipo de dados: Cadeia de caracteres

    Tabela: Linha de contrato de serviço [sn_pss_core_service_contract_line]

    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",
        "number": "CTRL00000001",
        "child_contract_lines": [
          {
            "sys_id": "3a39ecdc01154f4ab782da0169c9c922",
            "name": "Child CLI",
            "number": "CTRL00000001",
            "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": {}
          }
        ]
      }
    }