API de contrat de service

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 110 minutes de lecture
  • L’API de contrat de service fournit des points de terminaison pour créer et récupérer des enregistrements de contrats de service.

    Remarque :
    Cette API sert à créer des données dans les tables de l’application Customer Contracts and Entitlements . Il ne s’agit pas d’une API à usage général.
    Pour accéder à cette API, les modules d’extension suivants doivent être activés sur l’instance associée :
    • Contrats clients et droits (com.sn_pss_core)
    • Gestion de la base d’installation du Service clientèle (com.snc.install)
    • Gestion du catalogue de produits Core (com.sn_prd)

    En outre, pour appeler correctement cette API, vous devez disposer du rôle sn_pss_core.pss_integrator. Cette API s’exécute dans l’espace de noms sn_pss_core .

    Avant d’utiliser cette API, vous devez avoir associé des données dans les tables suivantes. Pour en savoir plus, consultez Create service contracts.

    • Compte [customer_account]
    • Consommateur [csm_consumer]
    • Ménage [csm_household]
    • Base d’installation [sn_install_base_item]
    • Spécification de produit [sn_prd_pm_product_specification]
    • Offre de produits [sn_prd_pm_product_offering]
    • Modèle de produit [cmdb_model]
    • Produit vendu [sn_install_base_sold_product]

    Contrat de service : GET /sn_pss_core/servicecontract/{id}

    Récupère un enregistrement de contrat de service spécifié.

    Ce point de terminaison récupère les données des tables suivantes lors du traitement de la demande :
    • Caractéristique [sn_pss_core_entitlement_characteristic]
    • Droit [service_entitlement]
    • Utilisation du droit [sn_pss_core_entitlement_usage]
    • Produit vendu couvert [sn_install_base_m2m_contract_sold_product] : ce tableau contient des informations sur les produits vendus couverts et les éléments de base d’installation couverts.
    • Contrat de service [sn_pss_core_service_contract]
    • Ligne de contrat de service [sn_pss_core_service_contract_line]

    Format d'URL

    URL versionnée : /api/sn_pss_core/{api_version}/servicecontract/{id}

    URL par défaut : /api/sn_pss_core/servicecontract/{id}

    Remarque :
    Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

    Paramètres de demande pris en charge

    Tableau 1. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne

    id Sys_id du contrat de service à récupérer.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    Tableau 2. Paramètres de requête
    Nom Description
    display_value Type de données à renvoyer.
    Valeurs valides :
    • faux : renvoie la valeur de tous les champs. Par exemple, « state » :"draft ».
    • vrai : renvoie la display_value pour tous les champs. Par exemple, « state » : « Brouillon »
    • all : renvoie toutes les informations pour tous les champs.

    Type de données : chaîne

    Valeur par défaut : false

    Tableau 3. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 4. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json

    Tableau 5. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 6. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur n’a pas l’autorisation d’accéder à l’API.
    404 Introuvable. L’élément demandé est introuvable.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres du corps de la réponse (JSON ou XML)

    Nom Description
    compte
    Sys_id de l’enregistrement du compte auquel le contrat de service appartient.

    Type de données : chaîne

    Table : Compte [customer_account]

    consommateur
    Sys_id de l’enregistrement de consommateur auquel le contrat de service appartient.

    Type de données : chaîne

    Table : Consommateur [csm_consumer]

    fins
    Date de fin du contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    household​
    Sys_id du ménage associé au contrat de service.

    Type de données : chaîne

    Tableau : Ménage [csm_household]

    install_base_items_covered Liste des éléments de base d’installation couverts par la ligne de contrat de service.

    Type de données : tableau d’objets

    "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.supplémentaire
    Date à laquelle le contrat de service associé commence à couvrir l’élément de base d’installation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    install_base_items_covered.contrat Sys_id de l’enregistrement du contrat de service associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    install_base_items_covered.droit Sys_id de l’enregistrement d’autorisation associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    install_base_items_covered.install_base Sys_id de l’enregistrement de l’élément de base d’installation associé.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    install_base_items_covered.Enlevé
    Date à laquelle le contrat de service associé met fin à la couverture de l’élément de base d’installation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    install_base_items_covered.service_contract_line Sys_id de l’enregistrement de la ligne de contrat de service associée.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    install_base_items_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    install_base_items_covered.sys_created_on Date et heure de création de l’enregistrement de l’élément de base d’installation.

    Type de données : chaîne

    install_base_items_covered.sys_id Sys_id de l’élément de base d’installation couvert.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    install_base_items_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’élément de base d’installation pour la dernière fois.

    Type de données : chaîne

    install_base_items_covered.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    Numéro Numéro de contrat de service généré automatiquement.

    Type de données : chaîne

    service_contract_lines Liste des lignes de contrat de service (services) associées au contrat de service.

    Type de données : tableau d’objets

    "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 Liste des lignes de contrat de service enfant associées à la ligne de contrat de service.

    Type de données : tableau d’objets

    "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 Liste des lignes de contrat de service enfant associées à la ligne de contrat de service enfant. Mêmes paramètres que dans .child_contract_lines

    Type de données : tableau

    service_contract_lines.child_contract_lines.contrat Sys_id du contrat de service associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    service_contract_lines.child_contract_lines.finit Date de fin de la ligne de contrat de service enfant.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    service_contract_lines.child_contract_lines.droits Liste des droits associés à la ligne de contrat de service enfant.

    Type de données : tableau d’objets

    "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.droits.compte
    Sys_id de l’enregistrement de compte auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Compte [customer_account]

    service_contract_lines.child_contract_lines.droits.consommateur
    Sys_id de l’enregistrement de consommateur auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Consommateur [csm_consumer]

    service_contract_lines.child_contract_lines.droits.contrat Sys_id de l’enregistrement du contrat auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    service_contract_lines.child_contract_lines.droits.end_date Date de fin du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics Liste des caractéristiques associées au droit.

    Type de données : tableau d’objets

    "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.droits.entitlement_characteristics.caractéristique
    Sys_id de l’enregistrement de caractéristique associé à l’autorisation.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.characteristic_option Sys_id de l’enregistrement de l’option de caractéristique associé au droit.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.droit Sys_id de l’enregistrement de l’autorisation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.entitlement_usage Liste de valeurs d’utilisation pour le produit associé.

    Type de données : tableau d’objets

    "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.droits.entitlement_characteristics.entitlement_usage.droit Sys_id de l’enregistrement d’autorisation associé à l’utilisation de l’autorisation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.entitlement_usage.entitlement_characteristic Sys_id de l’enregistrement des caractéristiques du droit associé à l’utilisation du droit.

    Type de données : chaîne

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.entitlement_usage.period_end Date de fin à laquelle l’utilisation du droit n’est plus suivie.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.entitlement_usage.period_start Date de début du suivi de l’utilisation de l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.entitlement_usage.service_contract_line Sys_id de la ligne de contrat de service à laquelle l’utilisation actuelle du droit appartient.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_created_on Date et heure de création de l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_id Sys_id de l’enregistrement de l’utilisation du droit.

    Type de données : chaîne

    Table : Utilisation du droit [sn_pss_core_entitlement_usage]

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’utilisation du droit pour la dernière fois.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.entitlement_usage.total_units Valeur totale de la couverture de la caractéristique du droit associée.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.entitlement_usage.used_units Nombre d’unités utilisées par le compte ou le consommateur entre le period_start et le period_end.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.service_contract_line Ligne de contrat enfant à laquelle appartient la caractéristique du droit actuel.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.sys_created_by Nom de l’utilisateur qui a créé la caractéristique du droit.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.sys_created_on Date et heure de création de la caractéristique du droit.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.sys_id Sys_id de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.sys_updated_by Nom de l’utilisateur qui a mis à jour pour la dernière fois la caractéristique du droit.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.sys_updated_on Date et heure auxquelles la caractéristique du droit a été mise à jour pour la dernière fois.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.type Type de caractéristique du droit.
    Valeurs valides :
    • couverture
    • coverage_and_usage

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.valeur
    Valeur de la caractéristique.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_name
    Nom du droit.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.ménage
    Sys_id de l’enregistrement du ménage associé à l’autorisation.

    Type de données : chaîne

    Tableau : Ménage [csm_household]

    service_contract_lines.child_contract_lines.droits.install_base_items_covered Liste des éléments de base d’installation couverts par la ligne de contrat de service enfant.
    Type de données : tableau d’objets
     "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"
      }
    ]

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.child_contract_lines.droits.install_base_items_covered.supplémentaire
    Date à laquelle l’élément de base d’installation associé a été ajouté à la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.child_contract_lines.droits.install_base_items_covered.contrat Sys_id de l’enregistrement du contrat de service associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    service_contract_lines.child_contract_lines.droits.install_base_items_covered.droit Sys_id de l’enregistrement d’autorisation associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    service_contract_lines.child_contract_lines.droits.install_base_items_covered.install_base Sys_id de l’enregistrement de l’élément de base d’installation associé.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    service_contract_lines.child_contract_lines.droits.install_base_items_covered.Enlevé
    Date à laquelle la ligne de contrat de service associée met fin à la couverture de l’élément de base d’installation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.child_contract_lines.droits.install_base_items_covered.service_contract_line Sys_id de l’enregistrement de la ligne de contrat de service associée.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.child_contract_lines.droits.install_base_items_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.install_base_items_covered.sys_created_on Date et heure de création de l’enregistrement de l’élément de base d’installation.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.install_base_items_covered.sys_id Sys_id de l’élément de base d’installation couvert.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.child_contract_lines.droits.install_base_items_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’élément de base d’installation pour la dernière fois.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.install_base_items_covered.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.produit Sys_id de l’enregistrement du modèle de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    service_contract_lines.child_contract_lines.droits.product_offering Sys_id de l’enregistrement d’offre de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    service_contract_lines.child_contract_lines.droits.product_specification Sys_id de l’enregistrement de spécification du produit associé à l’autorisation.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    service_contract_lines.child_contract_lines.droits.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé au droit.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.child_contract_lines.droits.sold_entitlement Sys_id de l’enregistrement du produit vendu associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    service_contract_lines.child_contract_lines.droits.sold_products_covered Liste des produits couverts.

    Type de données : tableau d’objets

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

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.child_contract_lines.droits.sold_products_covered.supplémentaire
    Date à laquelle le contrat de service associé commence à couvrir le produit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    service_contract_lines.child_contract_lines.droits.sold_products_covered.contrat Sys_id de l’enregistrement du contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    service_contract_lines.child_contract_lines.droits.sold_products_covered.droit Sys_id de l’enregistrement du droit associé au produit vendu couvert.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.child_contract_lines.droits.sold_products_covered.Enlevé
    Date à laquelle le contrat de service associé met fin à la couverture du produit associé.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    service_contract_lines.child_contract_lines.droits.sold_products_covered.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.child_contract_lines.droits.sold_products_covered.sold_product Sys_id du produit couvert par le contrat de service.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    service_contract_lines.child_contract_lines.droits.sold_products_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement couvert du produit vendu.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.sold_products_covered.sys_created_on Date et heure de création de l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.sold_products_covered.sys_id Sys_id du produit couvert par ce contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.child_contract_lines.droits.sold_products_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.sold_products_covered.sys_updated_on Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.start_date
    Date de début du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.child_contract_lines.droits.état
    État actuel du droit.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’autorisation.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.sys_created_on Date et heure de création de l’enregistrement d’autorisation.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.sys_id Sys_id de l’enregistrement de l’autorisation associé.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.child_contract_lines.droits.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’autorisation pour la dernière fois.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.sys_updated_on Date et heure de création de l’enregistrement d’autorisation.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.entitlement_characteristics Liste des caractéristiques associées au droit.

    Type de données : tableau d’objets

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement": "String",
        "entitlement_usage": [Array],
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
        "type": "String",
        "value": "String"
      }
    ]
    service_contract_lines.child_contract_lines.entitlement_characteristics.caractéristique
    Sys_id de l’enregistrement de caractéristique associé à l’autorisation.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    service_contract_lines.child_contract_lines.entitlement_characteristics.characteristic_option Sys_id de l’enregistrement de l’option de caractéristique associé au droit.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    service_contract_lines.child_contract_lines.entitlement_characteristics.droit Sys_id de l’enregistrement de l’autorisation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.child_contract_lines.entitlement_characteristics.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé à la caractéristique du droit.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.child_contract_lines.entitlement_characteristics.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.entitlement_characteristics.sys_created_on Date et heure de création de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.entitlement_characteristics.sys_id Sys_id de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.entitlement_characteristics.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement des caractéristiques du droit pour la dernière fois.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.entitlement_characteristics.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.entitlement_characteristics.type Type de caractéristique du droit.
    Valeurs valides :
    • couverture
    • coverage_and_usage

    Type de données : chaîne

    service_contract_lines.child_contract_lines.entitlement_characteristics.valeur
    Valeur de la caractéristique.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.install_base_items_covered Liste des éléments de base d’installation couverts par la ligne de contrat de service enfant.
    Type de données : tableau d’objets
     "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"
      }
    ]

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.child_contract_lines.install_base_items_covered.supplémentaire
    Date à laquelle l’élément de base d’installation associé a été ajouté à la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.child_contract_lines.install_base_items_covered.contrat Sys_id de l’enregistrement du contrat de service associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    service_contract_lines.child_contract_lines.install_base_items_covered.droit Sys_id de l’enregistrement d’autorisation associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    service_contract_lines.child_contract_lines.install_base_items_covered.install_base Sys_id de l’enregistrement de l’élément de base d’installation associé.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    service_contract_lines.child_contract_lines.install_base_items_covered.Enlevé
    Date à laquelle la ligne de contrat de service associée met fin à la couverture de l’élément de base d’installation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.child_contract_lines.install_base_items_covered.service_contract_line Sys_id de l’enregistrement de la ligne de contrat de service associée.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.child_contract_lines.install_base_items_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.install_base_items_covered.sys_created_on Date et heure de création de l’enregistrement de l’élément de base d’installation.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.install_base_items_covered.sys_id Sys_id de l’élément de base d’installation couvert.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.child_contract_lines.install_base_items_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’élément de base d’installation pour la dernière fois.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.install_base_items_covered.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.nom Nom de la ligne de contrat de service enfant.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.parent_contract_line Sys_id de l’enregistrement de la ligne de contrat parent associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.product_model Sys_id du produit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    service_contract_lines.child_contract_lines.product_offering Sys_id de l’enregistrement d’offre de produit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    service_contract_lines.child_contract_lines.sold_product Sys_id de l’enregistrement du produit vendu associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    service_contract_lines.child_contract_lines.sold_products_covered Liste des produits couverts.

    Type de données : tableau d’objets

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

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.child_contract_lines.sold_products_covered.supplémentaire
    Date à laquelle le contrat de service associé commence à couvrir le produit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    service_contract_lines.child_contract_lines.sold_products_covered.contrat Sys_id de l’enregistrement du contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    service_contract_lines.child_contract_lines.sold_products_covered.droit Sys_id de l’enregistrement du droit associé au produit vendu couvert.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.child_contract_lines.sold_products_covered.Enlevé
    Date à laquelle le contrat de service associé met fin à la couverture du produit associé.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    service_contract_lines.child_contract_lines.sold_products_covered.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.child_contract_lines.sold_products_covered.sold_product Sys_id du produit couvert par le contrat de service.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    service_contract_lines.child_contract_lines.sold_products_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement couvert du produit vendu.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.sold_products_covered.sys_created_on Date et heure de création de l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.sold_products_covered.sys_id Sys_id du produit couvert par ce contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.child_contract_lines.sold_products_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.sold_products_covered.sys_updated_on Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.Commence Date de début de la ligne de contrat de service enfant.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.child_contract_lines.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement de ligne de contrat de service enfant.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.sys_created_on Date et heure de création de l’enregistrement de ligne de contrat de service enfant.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.sys_id Sys_id d’un enregistrement de ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.child_contract_lines.sys_updated_by Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement de ligne de contrat de service enfant.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement de ligne de contrat de service enfant.

    Type de données : chaîne

    service_contract_lines.contrat
    Sys_id du contrat de service associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    service_contract_lines.finit Date de fin de la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    service_contract_lines.droits Liste des droits associés au contrat de service.

    Type de données : tableau d’objets

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

    Table : Droit [service_entitlement]

    service_contract_lines.droits.compte
    Sys_id de l’enregistrement de compte auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Compte [customer_account]

    service_contract_lines.droits.consommateur
    Sys_id de l’enregistrement de consommateur auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Consommateur [csm_consumer]

    service_contract_lines.droits.contrat Sys_id de l’enregistrement du contrat auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    service_contract_lines.droits.end_date Date de fin du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    service_contract_lines.droits.entitlement_characteristics Liste des caractéristiques associées au droit.

    Type de données : tableau d’objets

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

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    service_contract_lines.droits.entitlement_characteristics.caractéristique
    Sys_id de l’enregistrement de caractéristique associé à l’autorisation.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    service_contract_lines.droits.entitlement_characteristics.characteristic_option Sys_id de l’enregistrement de l’option de caractéristique associé au droit.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    service_contract_lines.droits.entitlement_characteristics.droit Sys_id de l’enregistrement de l’autorisation associé.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.droits.entitlement_characteristics.entitlement_usage Liste de valeurs d’utilisation pour le produit associé.

    Type de données : tableau d’objets

    "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.droits.entitlement_characteristics.entitlement_usage.droit Sys_id de l’enregistrement d’autorisation associé à l’utilisation de l’autorisation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.droits.entitlement_characteristics.entitlement_usage.entitlement_characteristic Sys_id de l’enregistrement des caractéristiques du droit associé à l’utilisation du droit.

    Type de données : chaîne

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    service_contract_lines.droits.entitlement_characteristics.entitlement_usage.period_end Date de fin à laquelle l’utilisation du droit n’est plus suivie.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.droits.entitlement_characteristics.entitlement_usage.period_start Date de début du suivi de l’utilisation de l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_created_on Date et heure de création de l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_id Sys_id de l’enregistrement de l’utilisation du droit.

    Type de données : chaîne

    Table : Utilisation du droit [sn_pss_core_entitlement_usage]

    service_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’utilisation du droit pour la dernière fois.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics.entitlement_usage.total_units Valeur totale de la couverture de la caractéristique du droit associée.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics.entitlement_usage.used_units Nombre d’unités utilisées par le compte ou le consommateur entre le period_start et le period_end.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé à la caractéristique du droit.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.droits.entitlement_characteristics.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics.sys_created_on Date et heure de création de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics.sys_id Sys_id de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement des caractéristiques du droit pour la dernière fois.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics.type Type de caractéristique du droit.
    Valeurs valides :
    • couverture
    • coverage_and_usage

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics.valeur
    Valeur de la caractéristique.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_name
    Nom du droit.

    Type de données : chaîne

    service_contract_lines.droits.ménage
    Sys_id de l’enregistrement du ménage associé à l’autorisation.

    Type de données : chaîne

    Tableau : Ménage [csm_household]

    service_contract_lines.droits.install_base_items_covered Liste des éléments de base d’installation couverts par la ligne de contrat de service.

    Type de données : tableau d’objets

    "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.droits.install_base_items_covered.supplémentaire Date à laquelle l’élément de base d’installation associé a été ajouté au droit.

    Type de données : chaîne

    service_contract_lines.droits.install_base_items_covered.contrat Sys_id de l’enregistrement du contrat de service associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    service_contract_lines.droits.install_base_items_covered.droit Sys_id de l’enregistrement d’autorisation associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.droits.install_base_items_covered.install_base Sys_id de l’enregistrement de l’élément de base d’installation associé.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    service_contract_lines.droits.install_base_items_covered.Enlevé Date à laquelle l’élément de base d’installation associé a été supprimé du droit.

    Type de données : chaîne

    service_contract_lines.droits.install_base_items_covered.service_contract_line Sys_id de l’enregistrement de la ligne de contrat de service associée.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.droits.install_base_items_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    service_contract_lines.droits.install_base_items_covered.sys_created_on Date et heure de création de l’enregistrement de l’élément de base d’installation.

    Type de données : chaîne

    service_contract_lines.droits.install_base_items_covered.sys_id Sys_id de l’élément de base d’installation couvert.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.droits.install_base_items_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’élément de base d’installation pour la dernière fois.

    Type de données : chaîne

    service_contract_lines.droits.install_base_items_covered.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    service_contract_lines.droits.produit Sys_id de l’enregistrement du modèle de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    service_contract_lines.droits.product_offering Sys_id de l’enregistrement d’offre de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    service_contract_lines.droits.product_specification Sys_id de l’enregistrement de spécification du produit associé à l’autorisation.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    service_contract_lines.droits.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé au droit.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.droits.sold_entitlement Sys_id de l’enregistrement du produit vendu associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    service_contract_lines.droits.sold_products_covered Liste des produits couverts.

    Type de données : tableau d’objets

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

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.droits.sold_products_covered.supplémentaire Date à laquelle le produit vendu associé a été ajouté à l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    service_contract_lines.droits.sold_products_covered.contrat Sys_id de l’enregistrement du contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    service_contract_lines.droits.sold_products_covered.droit Sys_id de l’enregistrement du droit associé au produit vendu couvert.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.droits.sold_products_covered.supprimé Date à laquelle le produit vendu associé a été retiré de l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    service_contract_lines.droits.sold_products_covered.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.droits.sold_products_covered.sold_product Sys_id du produit couvert par l’autorisation.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    service_contract_lines.droits.sold_products_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement couvert du produit vendu.

    Type de données : chaîne

    service_contract_lines.droits.sold_products_covered.sys_created_on Date et heure de création de l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    service_contract_lines.droits.sold_products_covered.sys_id Sys_id du produit couvert par ce contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.droits.sold_products_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    service_contract_lines.droits.sold_products_covered.sys_updated_on Date et heure de dernière mise à jour de l’enregistrement du produit couvert vendu.

    Type de données : chaîne

    service_contract_lines.droits.start_date
    Date de début du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.droits.état
    État actuel du droit.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    service_contract_lines.droits.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’autorisation.

    Type de données : chaîne

    service_contract_lines.droits.sys_created_on Date et heure de création de l’enregistrement d’autorisation.

    Type de données : chaîne

    service_contract_lines.droits.sys_id Sys_id de l’enregistrement de l’autorisation associé.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.droits.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’autorisation pour la dernière fois.

    Type de données : chaîne

    service_contract_lines.droits.sys_updated_on Date et heure de création de l’enregistrement d’autorisation.

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics Liste des caractéristiques associées à la ligne de contrat de service.

    Type de données : tableau d’objets

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

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    service_contract_lines.entitlement_characteristics.caractéristique
    Sys_id de l’enregistrement de caractéristique associé à l’autorisation.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    service_contract_lines.entitlement_characteristics.characteristic_option Sys_id de l’enregistrement de l’option de caractéristique associé au droit.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    service_contract_lines.entitlement_characteristics.droit Sys_id de l’enregistrement de l’autorisation associé.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.entitlement_characteristics.entitlement_usage Liste de valeurs d’utilisation pour le produit associé.

    Type de données : tableau d’objets

    "entitlement_usage": [
      {
        "entitlement": "String",
        "entitlement_characteristic": "String",
        "period_end": "String",
        "period_start": "String",
        "service_contract_line": "String", 
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_update_on": "String",
        "total_units": "String",
        "used_units": "String"
      }
    ]
    service_contract_lines.entitlement_characteristics.entitlement_usage.droit Sys_id de l’enregistrement d’autorisation associé à l’utilisation de l’autorisation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.entitlement_characteristics.entitlement_usage.entitlement_characteristic Sys_id de l’enregistrement des caractéristiques du droit associé à l’utilisation du droit.

    Type de données : chaîne

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    service_contract_lines.entitlement_characteristics.entitlement_usage.period_end Date de fin à laquelle l’utilisation du droit n’est plus suivie.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.entitlement_characteristics.entitlement_usage.period_start Date de début du suivi de l’utilisation de l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.entitlement_characteristics.entitlement_usage.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics.entitlement_usage.sys_created_on Date et heure de création de l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics.entitlement_usage.sys_id Sys_id de l’enregistrement de l’utilisation du droit.

    Type de données : chaîne

    Table : Utilisation du droit [sn_pss_core_entitlement_usage]

    service_contract_lines.entitlement_characteristics.entitlement_usage.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’utilisation du droit pour la dernière fois.

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics.entitlement_usage.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics.entitlement_usage.total_units Nombre total d’unités achetées.

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics.entitlement_usage.used_units Nombre d’unités qui ont été utilisées.

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé à la caractéristique du droit.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.entitlement_characteristics.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics.sys_created_on Date et heure de création de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics.sys_id Sys_id de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement des caractéristiques du droit pour la dernière fois.

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics.type Type de caractéristique du droit.
    Valeurs valides :
    • couverture
    • coverage_and_usage

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics.valeur
    Valeur de la caractéristique.

    Type de données : chaîne

    service_contract_lines.install_base_items_covered Liste des éléments de base d’installation couverts par la ligne de contrat de service.

    Type de données : tableau d’objets

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

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.install_base_items_covered.supplémentaire
    Date à laquelle l’élément de base d’installation associé a été ajouté à la ligne de contrat de service.

    Type de données : chaîne

    service_contract_lines.install_base_items_covered.contrat Sys_id de l’enregistrement du contrat de service associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    service_contract_lines.install_base_items_covered.droit Sys_id de l’enregistrement d’autorisation associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.install_base_items_covered.install_base Sys_id de l’élément de base d’installation couvert par la ligne de contrat de service.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    service_contract_lines.install_base_items_covered.Enlevé
    Date à laquelle la ligne de contrat de service associée met fin à la couverture de l’élément de base d’installation.

    Type de données : chaîne

    service_contract_lines.install_base_items_covered.service_contract_line Sys_id de l’enregistrement de la ligne de contrat de service associée.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.install_base_items_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    service_contract_lines.install_base_items_covered.sys_created_on Date et heure de création de l’enregistrement de l’élément de base d’installation.

    Type de données : chaîne

    service_contract_lines.install_base_items_covered.sys_id Sys_id de l’élément de base d’installation couvert.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.install_base_items_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’élément de base d’installation pour la dernière fois.

    Type de données : chaîne

    service_contract_lines.install_base_items_covered.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    service_contract_lines.nom
    Nom de la ligne de contrat de service.

    Type de données : chaîne

    service_contract_lines.nombre Numéro unique de la ligne de contrat de service. Généré automatiquement par le point de terminaison. Par exemple : CTRL9812347.

    Type de données : chaîne

    service_contract_lines.parent_contract_line Sys_id de la ligne de contrat de service dont la ligne de contrat de service actuelle est enfant.

    Nul pour les lignes de contrat créées dans le cadre d’un contrat.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.product_model Sys_id du produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    service_contract_lines.product_offering Sys_id de l’enregistrement d’offre de produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    service_contract_lines.product_specification Sys_id de l’enregistrement de spécification du produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    service_contract_lines.sold_product Sys_id de l’enregistrement du produit vendu associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    service_contract_lines.sold_products_covered Liste des produits couverts.

    Type de données : tableau d’objets

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

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.sold_products_covered.supplémentaire Date à laquelle le produit vendu associé a été ajouté à la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.sold_products_covered.contrat Sys_id de l’enregistrement du contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    service_contract_lines.sold_products_covered.droit Sys_id de l’enregistrement du droit associé au produit vendu couvert.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.sold_products_covered.supprimé Date à laquelle le produit vendu associé a été supprimé de la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.sold_products_covered.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.sold_products_covered.sold_product Sys_id du produit couvert par l’autorisation.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    service_contract_lines.sold_products_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement couvert du produit vendu.

    Type de données : chaîne

    service_contract_lines.sold_products_covered.sys_created_on Date et heure de création de l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    service_contract_lines.sold_products_covered.sys_id Sys_id du produit couvert par ce contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.sold_products_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    service_contract_lines.sold_products_covered.sys_updated_on Date et heure de dernière mise à jour de l’enregistrement du produit couvert vendu.

    Type de données : chaîne

    service_contract_lines.Commence
    Date de début de la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.état
    État actuel de la ligne de contrat.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    service_contract_lines.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement de ligne de contrat de service.

    Type de données : chaîne

    service_contract_lines.sys_created_on Date et heure de création de l’enregistrement de ligne de contrat de service.

    Type de données : chaîne

    service_contract_lines.sys_id Sys_id d’enregistrement d’une ligne de contrat de service.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.sys_updated_by Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement de ligne du contrat de service.

    Type de données : chaîne

    service_contract_lines.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement de ligne de contrat de service.

    Type de données : chaîne

    short_description
    Brève description ou nom du contrat de service.

    Type de données : chaîne

    sold_products_covered Liste des produits couverts.

    Type de données : tableau d’objets

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

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    sold_products_covered.supplémentaire Date à laquelle le produit vendu associé a été ajouté au contrat.

    Type de données : chaîne

    sold_products_covered.contrat Sys_id de l’enregistrement du contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    sold_products_covered.droit Sys_id de l’enregistrement du droit associé au produit vendu couvert.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    sold_products_covered.Enlevé Date à laquelle le produit vendu associé a été retiré du contrat.

    Type de données : chaîne

    sold_products_covered.service_line_contract Sys_id de l’enregistrement de ligne de contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    sold_products_covered.sold_product Sys_id du produit couvert par le contrat de service.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    sold_products_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement couvert du produit vendu.

    Type de données : chaîne

    sold_products_covered.sys_created_on Date et heure de création de l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    sold_products_covered.sys_id Sys_id du produit couvert par ce contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    sold_products_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    sold_products_covered.sys_updated_on Date et heure de dernière mise à jour de l’enregistrement du produit couvert vendu.

    Type de données : chaîne

    démarrages
    Date de début du contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Valeur par défaut : commence dès qu’elle est approuvée.

    État
    État actuel du contrat de service.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé

    Type de données : chaîne

    sys_created_by Nom de l’utilisateur qui a créé l’enregistrement de contrat de service.

    Type de données : chaîne

    sys_created_on Enregistrement de la date et de l’heure de création du contrat de service.

    Type de données : chaîne

    sys_id Sys_id de l’enregistrement du contrat de service.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement du contrat de service pour la dernière fois.

    Type de données : chaîne

    sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement du contrat de service.

    Type de données : chaîne

    vendor_contract
    Identificateur unique d’un contrat externe associé.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison.

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

    Réponse :

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

    Contrat de service : GET /sn_pss_core/servicecontract/contractline/{id}

    Récupère les détails d’un enregistrement de ligne de contrat de service spécifié et de ses entités connexes.

    Ce point de terminaison récupère les données dans les tables suivantes lors du traitement de la demande :
    • Caractéristique [sn_pss_core_entitlement_characteristic]
    • Droit [service_entitlement]
    • Utilisation du droit [sn_pss_core_entitlement_usage]
    • Produit vendu couvert [sn_install_base_m2m_contract_sold_product] : ce tableau contient des informations sur les produits vendus couverts et les éléments de base d’installation couverts.
    • Ligne de contrat de service [sn_pss_core_service_contract_line]

    Format d'URL

    URL versionnée : /api/sn_pss_core/{api_version}/servicecontract/contractline/{id}

    URL par défaut : /api/sn_pss_core/servicecontract/contractline/{id}

    Remarque :
    Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

    Paramètres de demande pris en charge

    Tableau 7. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne

    id Sys_id de l’enregistrement de ligne de contrat de service à récupérer.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    Tableau 8. Paramètres de requête
    Nom Description
    display_value Type de données à renvoyer.
    Valeurs valides :
    • faux : renvoie la valeur de tous les champs. Par exemple, « state » :"draft ».
    • vrai : renvoie la display_value pour tous les champs. Par exemple, « state » : « Brouillon »
    • all : renvoie toutes les informations pour tous les champs.

    Type de données : chaîne

    Valeur par défaut : false

    Tableau 9. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 10. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json

    Tableau 11. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 12. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur n’a pas l’autorisation d’accéder à l’API.
    404 Introuvable. L’élément demandé est introuvable.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres du corps de la réponse (JSON ou XML)

    Nom Description
    child_contract_lines Liste des lignes de contrat de service enfant associées à la ligne de contrat de service.

    Type de données : tableau d’objets

    "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 Liste des objets de ligne de contrat de service enfant créés sous la ligne de contrat de service enfant. Les objets de ce tableau ont les mêmes éléments que les objets du child_contract_lines paramètre.

    Type de données : tableau d’objets

    child_contract_lines.contrat Sys_id du contrat de service associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    child_contract_lines.finit Date de fin de la ligne de contrat de service enfant.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    child_contract_lines.droits Liste des droits associés à la ligne de contrat de service enfant.

    Type de données : tableau d’objets

    "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.droits.compte
    Sys_id de l’enregistrement de compte auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Compte [customer_account]

    child_contract_lines.droits.consommateur
    Sys_id de l’enregistrement de consommateur auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Consommateur [csm_consumer]

    child_contract_lines.droits.contrat Sys_id de l’enregistrement du contrat auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    child_contract_lines.droits.end_date Date de fin du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    child_contract_lines.droits.entitlement_characteristics Liste des caractéristiques associées au droit.

    Type de données : tableau d’objets

    "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.droits.entitlement_characteristics.caractéristique
    Sys_id de l’enregistrement de caractéristique associé à l’autorisation.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    child_contract_lines.droits.entitlement_characteristics.characteristic_option Sys_id de l’enregistrement de l’option de caractéristique associé au droit.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    child_contract_lines.droits.entitlement_characteristics.droit Sys_id de l’enregistrement de l’autorisation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    child_contract_lines.droits.entitlement_characteristics.entitlement_usage Liste des utilisations de droit associées à la caractéristique du droit.

    Type de données : tableau d’objets

    "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.droits.entitlement_characteristics.entitlement_usage.droit Sys_id de l’enregistrement d’autorisation associé à l’utilisation de l’autorisation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    child_contract_lines.droits.entitlement_characteristics.entitlement_usage.entitlement_characteristic Sys_id de l’enregistrement des caractéristiques du droit associé à l’utilisation du droit.

    Type de données : chaîne

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    cchild_contract_lines.droits.entitlement_characteristics.entitlement_usage.period_end Date de fin à laquelle l’utilisation du droit n’est plus suivie.

    Type de données : chaîne

    Format : aaaa-mm-jj

    child_contract_lines.droits.entitlement_characteristics.entitlement_usage.period_start Date de début du suivi de l’utilisation de l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    child_contract_lines.droits.entitlement_characteristics.entitlement_usage.service_contract_line Sys_id de la ligne de contrat de service à laquelle l’utilisation actuelle du droit appartient.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    child_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    child_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_created_on Date et heure de création de l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    child_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_id Sys_id de l’enregistrement de l’utilisation du droit.

    Type de données : chaîne

    Table : Utilisation du droit [sn_pss_core_entitlement_usage]

    child_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’utilisation du droit pour la dernière fois.

    Type de données : chaîne

    child_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    child_contract_lines.droits.entitlement_characteristics.entitlement_usage.total_units Valeur totale de la couverture de la caractéristique du droit associée.

    Type de données : chaîne

    child_contract_lines.droits.entitlement_characteristics.entitlement_usage.used_units Nombre d’unités utilisées par le compte ou le consommateur entre le period_start et le period_end.

    Type de données : chaîne

    child_contract_lines.droits.entitlement_characteristics.type Type de caractéristique du droit.
    Valeurs valides :
    • couverture
    • coverage_and_usage

    Type de données : chaîne

    child_contract_lines.droits.entitlement_characteristics.valeur
    Valeur de la caractéristique.

    Type de données : chaîne

    child_contract_lines.droits.entitlement_name
    Nom du droit.

    Type de données : chaîne

    child_contract_lines.droits.ménage
    Sys_id de l’enregistrement du ménage associé à l’autorisation.

    Type de données : chaîne

    Tableau : Ménage [csm_household]

    child_contract_lines.droits.install_base_items_covered Liste des éléments de base d’installation couverts par la ligne de contrat de service enfant.
    Type de données : tableau d’objets
     "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"
      }
    ]

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    child_contract_lines.droits.install_base_items_covered.supplémentaire
    Date à laquelle l’élément de base d’installation associé a été ajouté à la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    child_contract_lines.droits.install_base_items_covered.contrat Sys_id de l’enregistrement du contrat de service associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    child_contract_lines.droits.install_base_items_covered.droit Sys_id de l’enregistrement d’autorisation associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    child_contract_lines.droits.install_base_items_covered.install_base Sys_id de l’enregistrement de l’élément de base d’installation associé.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    child_contract_lines.droits.install_base_items_covered.Enlevé
    Date à laquelle la ligne de contrat de service associée met fin à la couverture de l’élément de base d’installation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    child_contract_lines.droits.install_base_items_covered.service_contract_line Sys_id de l’enregistrement de la ligne de contrat de service associée.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    child_contract_lines.droits.install_base_items_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    child_contract_lines.droits.install_base_items_covered.sys_created_on Date et heure de création de l’enregistrement de l’élément de base d’installation.

    Type de données : chaîne

    child_contract_lines.droits.install_base_items_covered.sys_id Sys_id de l’élément de base d’installation couvert.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    child_contract_lines.droits.install_base_items_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’élément de base d’installation pour la dernière fois.

    Type de données : chaîne

    child_contract_lines.droits.install_base_items_covered.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    child_contract_lines.droits.produit Sys_id de l’enregistrement du modèle de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    child_contract_lines.droits.product_offering Sys_id de l’enregistrement d’offre de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    child_contract_lines.droits.product_specification Sys_id de l’enregistrement de spécification du produit associé à l’autorisation.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    child_contract_lines.droits.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé au droit.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    child_contract_lines.droits.sold_entitlement Sys_id de l’enregistrement du produit vendu associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    child_contract_lines.droits.sold_products_covered Liste des produits couverts.

    Type de données : tableau d’objets

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

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    child_contract_lines.droits.sold_products_covered.supplémentaire
    Date à laquelle le contrat de service associé commence à couvrir le produit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    child_contract_lines.droits.sold_products_covered.contrat Sys_id de l’enregistrement du contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    child_contract_lines.droits.sold_products_covered.droit Sys_id de l’enregistrement du droit associé au produit vendu couvert.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    child_contract_lines.droits.sold_products_covered.Enlevé
    Date à laquelle le contrat de service associé met fin à la couverture du produit associé.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    child_contract_lines.droits.sold_products_covered.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    child_contract_lines.droits.sold_products_covered.sold_product Sys_id du produit couvert par le contrat de service.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    child_contract_lines.droits.sold_products_coveredsys_created_by Nom de l’utilisateur qui a créé l’enregistrement couvert du produit vendu.

    Type de données : chaîne

    child_contract_lines.droits.sold_products_covered.sys_created_on Date et heure de création de l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    child_contract_lines.droits.sold_products_covered.sys_id Sys_id du produit couvert par ce contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    child_contract_lines.droits.sold_products_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    child_contract_lines.droits.sold_products_covered.sys_updated_on Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    child_contract_lines.droits.start_date
    Date de début du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    child_contract_lines.droits.état
    État actuel du droit.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    child_contract_lines.droits.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’autorisation.

    Type de données : chaîne

    child_contract_lines.droits.sys_created_on Date et heure de création de l’enregistrement d’autorisation.

    Type de données : chaîne

    child_contract_lines.droits.sys_id Sys_id de l’enregistrement de l’autorisation associé.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    child_contract_lines.droits.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’autorisation pour la dernière fois.

    Type de données : chaîne

    child_contract_lines.droits.sys_updated_on Date et heure de création de l’enregistrement d’autorisation.

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics Liste des caractéristiques associées au droit.

    Type de données : tableau d’objets

    "entitlement_characteristics": [
      {
        "characteristic": "String",
        "characteristic_option": "String",
        "entitlement": "String",
        "entitlement_usage": [Array],
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String"
        "type": "String",
        "value": "String"
      }
    ]
    child_contract_lines.entitlement_characteristics.caractéristique
    Sys_id de l’enregistrement de caractéristique associé à l’autorisation.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    child_contract_lines.entitlement_characteristics.characteristic_option Sys_id de l’enregistrement de l’option de caractéristique associé au droit.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    child_contract_lines.entitlement_characteristics.droit Sys_id de l’enregistrement de l’autorisation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    child_contract_lines.entitlement_characteristics.entitlement_usage Liste des utilisations de droit associées à la caractéristique du droit.

    Type de données : tableau d’objets

    "entitlement_usage": [
      {
        "entitlement": "String",
        "entitlement_characteristic": "String",
        "period_end": "String",
        "period_start": "String",
        "service_contract_line": "String",
        "sys_created_by": "String",
        "sys_created_on": "String",
        "sys_id": "String",
        "sys_updated_by": "String",
        "sys_updated_on": "String",
        "total_units": "String",
        "used_units": "String"
      }
    ]
    child_contract_lines.entitlement_characteristics.entitlement_usage.droit Sys_id de l’enregistrement d’autorisation associé à l’utilisation de l’autorisation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    child_contract_lines.entitlement_characteristics.entitlement_usage.entitlement_characteristic Sys_id de l’enregistrement des caractéristiques du droit associé à l’utilisation du droit.

    Type de données : chaîne

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    child_contract_lines.entitlement_characteristics.entitlement_usage.period_end Date de fin à laquelle l’utilisation du droit n’est plus suivie.

    Type de données : chaîne

    Format : aaaa-mm-jj

    child_contract_lines.entitlement_characteristics.entitlement_usage.period_start Date de début du suivi de l’utilisation de l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    child_contract_lines.entitlement_characteristics.entitlement_usage.service_contract_line Sys_id de la ligne de contrat de service à laquelle l’utilisation actuelle du droit appartient.

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.entitlement_usage.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.entitlement_usage.sys_created_on Date et heure de création de l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.entitlement_usage.sys_id Sys_id de l’enregistrement de l’utilisation du droit.

    Type de données : chaîne

    Table : Utilisation du droit [sn_pss_core_entitlement_usage]

    child_contract_lines.entitlement_characteristics.entitlement_usage.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’utilisation du droit pour la dernière fois.

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.entitlement_usage.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.entitlement_usage.total_units Valeur totale de la couverture de la caractéristique du droit associée.

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.entitlement_usage.used_units Nombre d’unités utilisées par le compte ou le consommateur entre le period_start et le period_end.

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé à la caractéristique du droit.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    child_contract_lines.entitlement_characteristics.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.sys_created_on Date et heure de création de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.sys_id Sys_id de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement des caractéristiques du droit pour la dernière fois.

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.type Type de caractéristique du droit.
    Valeurs valides :
    • couverture
    • coverage_and_usage

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.valeur
    Valeur de la caractéristique.

    Type de données : chaîne

    child_contract_lines.install_base_items_covered Liste des éléments de base d’installation couverts par la ligne de contrat de service enfant.
    Type de données : tableau d’objets
     "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"
      }
    ]

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    child_contract_lines.install_base_items_covered.supplémentaire
    Date à laquelle l’élément de base d’installation associé a été ajouté à la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    child_contract_lines.install_base_items_covered.contrat Sys_id de l’enregistrement du contrat de service associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    child_contract_lines.install_base_items_covered.droit Sys_id de l’enregistrement d’autorisation associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    child_contract_lines.install_base_items_covered.install_base Sys_id de l’enregistrement de l’élément de base d’installation associé.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    child_contract_lines.install_base_items_covered.Enlevé
    Date à laquelle la ligne de contrat de service associée met fin à la couverture de l’élément de base d’installation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    child_contract_lines.install_base_items_covered.service_contract_line Sys_id de l’enregistrement de la ligne de contrat de service associée.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    child_contract_lines.install_base_items_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    child_contract_lines.install_base_items_covered.sys_created_on Date et heure de création de l’enregistrement de l’élément de base d’installation.

    Type de données : chaîne

    child_contract_lines.install_base_items_covered.sys_id Sys_id de l’élément de base d’installation couvert.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    child_contract_lines.install_base_items_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’élément de base d’installation pour la dernière fois.

    Type de données : chaîne

    child_contract_lines.install_base_items_covered.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    child_contract_lines.nom Nom de la ligne de contrat de service enfant.

    Type de données : chaîne

    child_contract_lines.nombre Numéro unique de la ligne de contrat de service. Généré automatiquement par le point de terminaison. Par exemple : CTRL000001.

    Type de données : chaîne

    child_contract_lines.parent_contract_line Sys_id de l’enregistrement de la ligne de contrat parent associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    child_contract_lines.product_model Sys_id du produit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    child_contract_lines.product_offering Sys_id de l’enregistrement d’offre de produit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    child_contract_lines.product_specification Sys_id de l’enregistrement de spécification du produit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    child_contract_lines.sold_product Sys_id de l’enregistrement du produit vendu associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    child_contract_lines.sold_products_covered Liste des produits couverts.

    Type de données : tableau d’objets

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

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    child_contract_lines.sold_products_covered.supplémentaire
    Date à laquelle le contrat de service associé commence à couvrir le produit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    child_contract_lines.sold_products_covered.contrat Sys_id de l’enregistrement du contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    child_contract_lines.sold_products_covered.droit Sys_id de l’enregistrement du droit associé au produit vendu couvert.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    child_contract_lines.sold_products_covered.Enlevé
    Date à laquelle le contrat de service associé met fin à la couverture du produit associé.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    child_contract_lines.sold_products_covered.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    child_contract_lines.sold_products_covered.sold_product Sys_id du produit couvert par le contrat de service.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    child_contract_lines.sold_products_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement couvert du produit vendu.

    Type de données : chaîne

    child_contract_lines.sold_products_covered.sys_created_on Date et heure de création de l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    child_contract_lines.sold_products_covered.sys_id Sys_id du produit couvert par ce contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    child_contract_lines.sold_products_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    child_contract_lines.sold_products_covered.sys_updated_on Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    child_contract_lines.Commence Date de début de la ligne de contrat de service enfant.

    Type de données : chaîne

    Format : aaaa-mm-jj

    child_contract_lines.état
    État actuel de la ligne de contrat.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    child_contract_lines.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement de ligne de contrat de service enfant.

    Type de données : chaîne

    child_contract_lines.sys_created_on Date et heure de création de l’enregistrement de ligne de contrat de service enfant.

    Type de données : chaîne

    child_contract_lines.sys_id Sys_id d’un enregistrement de ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    child_contract_lines.sys_updated_by Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement de ligne de contrat de service enfant.

    Type de données : chaîne

    child_contract_lines.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement de ligne de contrat de service enfant.

    Type de données : chaîne

    contrat
    Sys_id du contrat de service associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    fins Date de fin de la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    droits Liste des droits associés à la ligne de contrat de service.

    Type de données : tableau d’objets

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

    Table : Droit [service_entitlement]

    droits.compte
    Sys_id de l’enregistrement de compte auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Compte [customer_account]

    droits.consommateur
    Sys_id de l’enregistrement de consommateur auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Consommateur [csm_consumer]

    droits.contrat Sys_id de l’enregistrement du contrat auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    droits.end_date Date de fin du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    droits.entitlement_characteristics Liste des caractéristiques associées au droit.

    Type de données : tableau d’objets

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

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    droits.entitlement_characteristics.caractéristique
    Sys_id de l’enregistrement de caractéristique associé à l’autorisation.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    droits.entitlement_characteristics.characteristic_option Sys_id de l’enregistrement de l’option de caractéristique associé au droit.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    droits.entitlement_characteristics.droit Sys_id de l’enregistrement de l’autorisation associé.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    droits.entitlement_characteristics.entitlement_usage Détails de l’utilisation du droit.

    Type de données : tableau d’objets

    "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"
      }
    ]
    droits.entitlement_characteristics.entitlement_usage.droit Sys_id de l’enregistrement d’autorisation associé à l’utilisation de l’autorisation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    droits.entitlement_characteristics.entitlement_usage.entitlement_characteristic Sys_id de l’enregistrement des caractéristiques du droit associé à l’utilisation du droit.

    Type de données : chaîne

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    droits.entitlement_characteristics.entitlement_usage.period_end Date de fin à laquelle l’utilisation du droit n’est plus suivie.

    Type de données : chaîne

    Format : aaaa-mm-jj

    droits.entitlement_characteristics.entitlement_usage.period_start Date de début du suivi de l’utilisation de l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    droits.entitlement_characteristics.entitlement_usage.service_contract_line Ligne de contrat de service à laquelle l’utilisation actuelle du droit appartient.

    Type de données : chaîne

    droits.entitlement_characteristics.entitlement_usage.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    droits.entitlement_characteristics.entitlement_usage.sys_created_on Date et heure de création de l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    droits.entitlement_characteristics.entitlement_usage.sys_id Sys_id de l’enregistrement de l’utilisation du droit.

    Type de données : chaîne

    Table : Utilisation du droit [sn_pss_core_entitlement_usage]

    droits.entitlement_characteristics.entitlement_usage.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’utilisation du droit pour la dernière fois.

    Type de données : chaîne

    droits.entitlement_characteristics.entitlement_usage.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’utilisation du droit.

    Type de données : chaîne

    droits.entitlement_characteristics.entitlement_usage.total_units Valeur totale de la couverture de la caractéristique du droit associée.

    Type de données : chaîne

    droits.entitlement_characteristics.entitlement_usage.used_units Nombre d’unités utilisées par le compte ou le consommateur entre le period_start et le period_end.

    Type de données : chaîne

    droits.entitlement_characteristics.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé à la caractéristique du droit.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    droits.entitlement_characteristics.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    droits.entitlement_characteristics.sys_created_on Date et heure de création de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    droits.entitlement_characteristics.sys_id Sys_id de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    droits.entitlement_characteristics.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement des caractéristiques du droit pour la dernière fois.

    Type de données : chaîne

    droits.entitlement_characteristics.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    droits.entitlement_characteristics.type Type de caractéristique du droit.
    Valeurs valides :
    • couverture
    • coverage_and_usage

    Type de données : chaîne

    droits.entitlement_characteristics.valeur
    Valeur de la caractéristique.

    Type de données : chaîne

    droits.entitlement_name
    Nom du droit.

    Type de données : chaîne

    droits.ménage
    Sys_id de l’enregistrement du ménage associé à l’autorisation.

    Type de données : chaîne

    Tableau : Ménage [csm_household]

    droits.install_base_items_covered Liste des éléments de base d’installation couverts par la ligne de contrat de service.

    Type de données : tableau d’objets

    "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"
      }
    ]
    droits.install_base_items_covered.supplémentaire Date à laquelle l’élément de base d’installation associé a été ajouté au droit.

    Type de données : chaîne

    droits.install_base_items_covered.contrat Sys_id de l’enregistrement du contrat de service associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    droits.install_base_items_covered.droit Sys_id de l’enregistrement d’autorisation associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    droits.install_base_items_covered.install_base Sys_id de l’enregistrement de l’élément de base d’installation associé.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    droits.install_base_items_covered.Enlevé Date à laquelle l’élément de base d’installation associé a été supprimé du droit.

    Type de données : chaîne

    droits.install_base_items_covered.service_contract_line Sys_id de l’enregistrement de la ligne de contrat de service associée.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    droits.install_base_items_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    droits.install_base_items_covered.sys_created_on Date et heure de création de l’enregistrement de l’élément de base d’installation.

    Type de données : chaîne

    droits.install_base_items_covered.sys_id Sys_id de l’élément de base d’installation couvert.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    droits.install_base_items_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’élément de base d’installation pour la dernière fois.

    Type de données : chaîne

    droits.install_base_items_covered.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    droits.produit Sys_id de l’enregistrement du modèle de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    droits.product_offering Sys_id de l’enregistrement d’offre de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    droits.product_specification Sys_id de l’enregistrement de spécification du produit associé à l’autorisation.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    droits.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé au droit.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    droits.sold_entitlement Sys_id de l’enregistrement du produit vendu associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    droits.sold_products_covered Liste des produits couverts.

    Type de données : tableau d’objets

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

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    droits.sold_products_covered.supplémentaire Date à laquelle le produit vendu associé a été ajouté à l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    droits.sold_products_covered.contrat Sys_id de l’enregistrement du contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    droits.sold_products_covered.droit Sys_id de l’enregistrement du droit associé au produit vendu couvert.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    droits.sold_products_covered.supprimé Date à laquelle le produit vendu associé a été retiré de l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    droits.sold_products_covered.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    droits.sold_products_covered.sold_product Sys_id du produit couvert par l’autorisation.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    droits.sold_products_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement couvert du produit vendu.

    Type de données : chaîne

    droits.sold_products_covered.sys_created_on Date et heure de création de l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    droits.sold_products_covered.sys_id Sys_id du produit couvert par ce contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    droits.sold_products_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    droits.sold_products_covered.sys_updated_on Date et heure de dernière mise à jour de l’enregistrement du produit couvert vendu.

    Type de données : chaîne

    droits.start_date
    Date de début du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    droits.état
    État actuel du droit.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    droits.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’autorisation.

    Type de données : chaîne

    droits.sys_created_on Date et heure de création de l’enregistrement d’autorisation.

    Type de données : chaîne

    droits.sys_id Sys_id de l’enregistrement de l’autorisation associé.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    droits.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’autorisation pour la dernière fois.

    Type de données : chaîne

    droits.sys_updated_on Date et heure de création de l’enregistrement d’autorisation.

    Type de données : chaîne

    entitlement_characteristics Liste des caractéristiques du droit associées à la ligne de contrat de service.

    Type de données : tableau d’objets

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

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    entitlement_characteristics.caractéristique
    Sys_id de l’enregistrement de caractéristique associé à l’autorisation.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    entitlement_characteristics.characteristic_option Sys_id de l’enregistrement de l’option de caractéristique associé au droit.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    entitlement_characteristics.droit Sys_id de l’enregistrement de l’autorisation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    entitlement_characteristics.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé à la caractéristique du droit.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    entitlement_characteristics.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    entitlement_characteristics.sys_created_on Date et heure de création de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    entitlement_characteristics.sys_id Sys_id de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    entitlement_characteristics.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement des caractéristiques du droit pour la dernière fois.

    Type de données : chaîne

    entitlement_characteristics.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    entitlement_characteristics.type Type de caractéristique du droit.
    Valeurs valides :
    • couverture
    • coverage_and_usage

    Type de données : chaîne

    entitlement_characteristics.valeur
    Valeur de la caractéristique.

    Type de données : chaîne

    install_base_items_covered Liste des éléments de base d’installation couverts par la ligne de contrat de service.

    Type de données : tableau d’objets

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

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    install_base_items_covered.supplémentaire
    Date à laquelle l’élément de base d’installation associé a été ajouté à la ligne de contrat de service.

    Type de données : chaîne

    install_base_items_covered.contrat Sys_id de l’enregistrement du contrat de service associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    install_base_items_covered.droit Sys_id de l’enregistrement d’autorisation associé à l’élément de base d’installation.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    install_base_items_covered.install_base Sys_id de l’élément de base d’installation couvert par la ligne de contrat de service.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    install_base_items_covered.Enlevé
    Date à laquelle la ligne de contrat de service associée met fin à la couverture de l’élément de base d’installation.

    Type de données : chaîne

    install_base_items_covered.service_contract_line Sys_id de l’enregistrement de la ligne de contrat de service associée.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    install_base_items_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    install_base_items_covered.sys_created_on Date et heure de création de l’enregistrement de l’élément de base d’installation.

    Type de données : chaîne

    install_base_items_covered.sys_id Sys_id de l’élément de base d’installation couvert.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    install_base_items_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour l’enregistrement d’élément de base d’installation pour la dernière fois.

    Type de données : chaîne

    install_base_items_covered.sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement d’élément de base d’installation.

    Type de données : chaîne

    nom
    Nom de la ligne de contrat de service.

    Type de données : chaîne

    Numéro Numéro unique de la ligne de contrat de service. Généré automatiquement par le point de terminaison. Par exemple : CTRL9812347.

    Type de données : chaîne

    parent_contract_line Sys_id de la ligne de contrat de service dont la ligne de contrat de service actuelle est enfant.

    Nul pour les lignes de contrat créées dans le cadre d’un contrat.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    product_model Sys_id du produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    product_offering Sys_id de l’enregistrement d’offre de produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    product_specification Sys_id de l’enregistrement de spécification du produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    sold_product Sys_id de l’enregistrement du produit vendu associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    sold_products_covered Liste des produits couverts.

    Type de données : tableau d’objets

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

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    sold_products_covered.supplémentaire Date à laquelle le produit vendu associé a été ajouté à la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    sold_products_covered.contrat Sys_id de l’enregistrement du contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    sold_products_covered.droit Sys_id de l’enregistrement du droit associé au produit vendu couvert.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    sold_products_covered.supprimé Date à laquelle le produit vendu associé a été supprimé de la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    sold_products_covered.service_contract_line Sys_id de l’enregistrement de ligne de contrat de service associé au produit vendu couvert.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    sold_products_covered.sold_product Sys_id du produit couvert par l’autorisation.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    sold_products_covered.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement couvert du produit vendu.

    Type de données : chaîne

    sold_products_covered.sys_created_on Date et heure de création de l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    sold_products_covered.sys_id Sys_id du produit couvert par ce contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    sold_products_covered.sys_updated_by Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement du produit vendu couvert.

    Type de données : chaîne

    sold_products_covered.sys_updated_on Date et heure de dernière mise à jour de l’enregistrement du produit couvert vendu.

    Type de données : chaîne

    démarrages
    Date de début de la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    État
    État actuel de la ligne de contrat.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    sys_created_by Nom de l’utilisateur qui a créé l’enregistrement de ligne de contrat de service.

    Type de données : chaîne

    sys_created_on Date et heure de création de l’enregistrement de ligne de contrat de service.

    Type de données : chaîne

    sys_id Sys_id d’enregistrement d’une ligne de contrat de service.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    sys_updated_by Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement de ligne du contrat de service.

    Type de données : chaîne

    sys_updated_on Date et heure de la dernière mise à jour de l’enregistrement de ligne de contrat de service.

    Type de données : chaîne

    Demande cURL

    L’exemple de code suivant montre comment appeler ce point de terminaison.

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

    Réponse :

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

    Contrat de service : POST /sn_pss_core/servicecontract

    Crée un enregistrement de contrat de service et toutes ses entités connexes à partir d’une charge utile spécifiée.

    L’API Contrat de service stocke les données dans différentes tables. Voici la liste des tables dans lesquelles des enregistrements sont créés par ce point de terminaison lors de la création d’un contrat de service :
    • Caractéristique [sn_pss_core_entitlement_characteristic]
    • Droit [service_entitlement]
    • Utilisation du droit [sn_pss_core_entitlement_usage]
    • Produit vendu couvert [sn_install_base_m2m_contract_sold_product] : ce tableau contient des informations sur les produits vendus couverts et les éléments de base d’installation couverts.
    • Contrat de service [sn_pss_core_service_contract]
    • Ligne de contrat de service [sn_pss_core_service_contract_line]

    Le corps de la demande de ce point de terminaison fait référence aux champs dans les tables suivantes. Ces informations doivent être ajoutées à votre instance avant d’utiliser cette API. Pour en savoir plus, consultez Create service contracts.

    • Compte [customer_account]
    • Option de la caractéristique [sn_prd_pm_characteristic_option]
    • Consommateur [csm_consumer]
    • Ménage [csm_household]

    Format d'URL

    URL versionnée : /api/sn_pss_core/{api_version}/servicecontract

    URL par défaut : /api/sn_pss_core/servicecontract

    Remarque :
    Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

    Paramètres de demande pris en charge

    Tableau 13. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne

    Tableau 14. Paramètres de requête
    Nom Description
    Néant
    Tableau 15. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    compte Requis si le paramètre n’est consumer pas spécifié.
    Sys_id de l’enregistrement du compte auquel le contrat de service appartient.

    Type de données : chaîne

    Table : Compte [customer_account]

    consommateur Requis si le paramètre n’est account pas spécifié.
    Sys_id de l’enregistrement de consommateur auquel le contrat de service appartient.

    Type de données : chaîne

    Table : Consommateur [csm_consumer]

    fins
    Date de fin du contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    household​ Valable uniquement pour les contrats de service consommateur.
    Sys_id du ménage associé au contrat de service.

    Type de données : chaîne

    Tableau : Ménage [csm_household]

    Valeur par défaut : nul (aucun ménage)

    install_base_items_covered Liste des éléments de base d’installation couverts par le contrat de service.

    Pour plus d’informations sur les éléments Configure install basede base d’installation .

    Type de données : tableau d’objets

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

    Stocké dans : La table Produit vendu couvert [sn_install_base_m2m_contract_sold_product].

    install_base_items_covered. ajouté
    Date à laquelle le contrat de service associé commence à couvrir l’élément de base d’installation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    install_base_items_covered.install_base Sys_id de l’enregistrement de l’élément de base d’installation associé.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    install_base_items_covered.Enlevé
    Date à laquelle le contrat de service associé met fin à la couverture de l’élément de base d’installation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    service_contract_lines Liste des lignes de contrat de service associées au contrat de service.

    Type de données : tableau d’objets

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

    Stocké dans : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.child_contract_lines Liste des lignes de contrat de service enfant sous la ligne de contrat de service.

    Type de données : tableau d’objets

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

    Stocké dans : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.child_contract_lines.child_contract_lines Liste des objets de ligne de contrat de service enfant à créer sous la ligne de contrat de service enfant. Les objets de ce tableau ont les mêmes éléments que les objets du service_contract_lines.child_contract_lines paramètre.

    Type de données : tableau d’objets

    service_contract_lines.child_contract_lines.finit Date de fin de la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    service_contract_lines.child_contract_lines.droits Liste des autorisations à associer à la ligne de contrat de service enfant.

    Type de données : tableau d’objets

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

    Stocké dans : Droit [service_entitlement]

    service_contract_lines.child_contract_lines.droits.compte
    Sys_id de l’enregistrement de compte auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Compte [customer_account]

    service_contract_lines.child_contract_lines.droits.consommateur
    Sys_id de l’enregistrement de consommateur auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Consommateur [csm_consumer]

    service_contract_lines.child_contract_lines.droits.end_date Date de fin du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics Liste des caractéristiques associées au droit.

    Type de données : tableau d’objets

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

    Stocké dans : Caractéristique [sn_pss_core_entitlement_characteristic]

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.caractéristique Requis.
    Sys_id de l’enregistrement de caractéristique associé à l’autorisation.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.characteristic_option Sys_id de l’enregistrement de l’option de caractéristique associé au droit.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.entitlement_usage Valeur d’unité utilisée pour la caractéristique du droit associée.

    Ne transmettez ce paramètre que si les entitlement_characteristics sont sous le droit.

    Type de données : objet

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

    Stocké dans : Utilisation du droit [sn_pss_core_entitlement_usage]

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.entitlement_usage.used_units Utilisation de la caractéristique de droit associée.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.type Type de caractéristique du droit.
    Valeurs valides :
    • couverture
    • coverage_and_usage

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.valeur Requis si le input_type paramètre contenu dans l’enregistrement spécifié dans le paramètre n’est entitlement_characteristics.characteristic pas un choix.
    Valeur de la caractéristique.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_name Requis.
    Nom du droit.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.ménage Transmis uniquement lorsque les modules d’extension du ménage sont actifs et que le consumer paramètre est transmis.
    Sys_id de l’enregistrement du ménage associé à l’autorisation.

    Type de données : chaîne

    Tableau : Ménage [csm_household]

    service_contract_lines.child_contract_lines.droits.install_base_items_covered
    Liste des éléments de base d’installation couverts par l’autorisation. Les informations de ce tableau sont insérées dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product].

    Type de données : tableau d’objets

    "install_base_items_covered": [ 
      {
        "added": "String",
        "install_base": "String",
        "removed": "String"
      }
    ]
    service_contract_lines.child_contract_lines.droits.install_base_items_covered.supplémentaire Date à laquelle l’élément de base d’installation associé a été ajouté au droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    service_contract_lines.child_contract_lines.droits.install_base_items_covered.install_base Sys_id de l’élément de base d’installation couvert par l’autorisation.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    service_contract_lines.child_contract_lines.droits.install_base_items_covered.Enlevé Date à laquelle l’élément de base d’installation associé a été supprimé du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    service_contract_lines.child_contract_lines.droits.produit Sys_id de l’enregistrement du modèle de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    service_contract_lines.child_contract_lines.droits.product_offering Sys_id de l’enregistrement d’offre de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    service_contract_lines.child_contract_lines.droits.product_specification Sys_id de l’enregistrement de spécification du produit associé à l’autorisation.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    service_contract_lines.child_contract_lines.droits.sold_entitlement Sys_id de l’enregistrement du produit vendu associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    service_contract_lines.child_contract_lines.droits.sold_products_covered Liste des produits vendus couverts par l’autorisation.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "added": "String",
        "removed": "String",
        "sold_product": "String"
      }
    ]
    service_contract_lines.child_contract_lines.droits.sold_products_covered.supplémentaire Date à laquelle le produit vendu associé a été ajouté à l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    service_contract_lines.child_contract_lines.droits.sold_products_covered.Enlevé Date à laquelle le produit vendu associé a été retiré de l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    service_contract_lines.child_contract_lines.droits.start_date Requis.
    Date de début du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.child_contract_lines.droits.état Requis.
    État actuel du droit.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    service_contract_lines.child_contract_lines.entitlement_characteristics Liste des caractéristiques associées à la ligne de contrat de service.

    Type de données : tableau d’objets

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

    Stocké dans : Caractéristique [sn_pss_core_entitlement_characteristic]

    service_contract_lines.child_contract_lines.entitlement_characteristics.caractéristique Requis.
    Sys_id de l’enregistrement de caractéristique associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    service_contract_lines.child_contract_lines.entitlement_characteristics.characteristic_option
    Sys_id de l’enregistrement de l’option de caractéristique associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    service_contract_lines.child_contract_lines.entitlement_characteristics.entitlement_usage Valeur d’unité utilisée pour la caractéristique de ligne de contrat de service associée.

    Type de données : objet

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

    Stocké dans : Utilisation du droit [sn_pss_core_entitlement_usage]

    service_contract_lines.child_contract_lines.entitlement_characteristics.entitlement_usage.usage_units Utilisation de la caractéristique de droit associée.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.entitlement_characteristics.type Caractéristique du type de ligne de contrat de service.
    Valeurs valides :
    • couverture
    • _and_usage de couverture

    Type de données : chaîne

    service_contract_lines.child_contract_lines.entitlement_characteristics.valeur Requis si le paramètre n’est entitlement_characteristics.type pas transmis.
    Valeur de la caractéristique.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.install_base_items_covered
    Liste des éléments de base d’installation couverts par la ligne de contrat de service.

    Type de données : tableau d’objets

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

    Stocké dans : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.child_contract_lines.install_base_items_covered.supplémentaire
    Date à laquelle l’élément de base d’installation associé a été ajouté à la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    service_contract_lines.child_contract_lines.install_base_items_covered.install_base Sys_id de l’élément de base d’installation couvert par la ligne de contrat de service.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    service_contract_lines.child_contract_lines.install_base_items_covered.Enlevé
    Date à laquelle la ligne de contrat de service associée met fin à la couverture de l’élément de base d’installation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    service_contract_lines.child_contract_lines.nom
    Nom de la ligne de contrat de service.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.product_model Sys_id du produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    service_contract_lines.child_contract_lines.product_offering Sys_id de l’enregistrement d’offre de produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    service_contract_lines.child_contract_lines.product_specification Sys_id de l’enregistrement de spécification du produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    service_contract_lines.child_contract_lines.sold_product Sys_id de l’enregistrement du produit vendu associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    service_contract_lines.child_contract_lines.sold_products_covered
    Liste des produits couverts par la ligne de contrat de service.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "added": "String",
        "removed": "String",
        "sold_product": "String"
      }
    ]
    service_contract_lines.child_contract_lines..sold_products_covered.supplémentaire Date à laquelle la ligne de contrat de service associée commence à couvrir le produit associé.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    service_contract_lines.child_contract_lines.sold_products_covered.Enlevé Date à laquelle la ligne de contrat de service associé met fin à la couverture du produit associé.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    service_contract_lines.child_contract_lines.sold_products_covered.sold_product
    Sys_id d’un produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.child_contract_lines.Commence Requis.
    Date de début de la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.child_contract_lines.état Requis.
    État actuel de la ligne de contrat.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    service_contract_lines.fins Date de fin de la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    service_contract_lines.droits Liste des autorisations à associer à la ligne de contrat de service. Ces autorisations sont insérées dans la table Droit [service_entitlement].

    Type de données : tableau d’objets

    "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.droits.compte
    Sys_id de l’enregistrement de compte auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Compte [customer_account]

    service_contract_lines.droits.consommateur
    Sys_id de l’enregistrement de consommateur auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Consommateur [csm_consumer]

    service_contract_lines.droits.end_date Date de fin du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    service_contract_lines.droits.entitlement_characteristics Liste des caractéristiques associées au droit.

    Type de données : tableau d’objets

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

    Stocké dans : Caractéristique [sn_pss_core_entitlement_characteristic]

    service_contract_lines.droits.entitlement_characteristics.caractéristique Requis.
    Sys_id de l’enregistrement de caractéristique associé à l’autorisation.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    service_contract_lines.droits.entitlement_characteristics.characteristic_option Sys_id de l’enregistrement de l’option de caractéristique associé au droit.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    service_contract_lines.droits.entitlement_characteristics.entitlement_usage Valeur d’unité utilisée pour la caractéristique du droit associée.

    Ne transmettez ce paramètre que si les entitlement_characteristics sont sous le droit.

    Type de données : objet

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

    Stocké dans : Utilisation du droit [sn_pss_core_entitlement_usage]

    service_contract_lines.droits.entitlement_characteristics.entitlement_usage.usage_units Utilisation de la caractéristique de droit associée.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics.type Type de caractéristique du droit.
    Valeurs valides :
    • couverture
    • coverage_and_usage

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics.valeur Requis si le input_type paramètre contenu dans l’enregistrement spécifié dans le paramètre n’est entitlement_characteristics.characteristic pas un choix.
    Valeur de la caractéristique.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_name Requis.
    Nom du droit.

    Type de données : chaîne

    service_contract_lines.droits.ménage Transmis uniquement lorsque les modules d’extension du ménage sont actifs et que le consumer paramètre est transmis.
    Sys_id de l’enregistrement du ménage associé à l’autorisation.

    Type de données : chaîne

    Tableau : Ménage [csm_household]

    service_contract_lines.droits.install_base_items_covered
    Liste des éléments de base d’installation couverts par l’autorisation. Les informations de ce tableau sont insérées dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product].

    Type de données : tableau d’objets

    "install_base_items_covered": [ 
      {
        "added": "String",
        "install_base": "String",
        "removed": "String"
      }
    ]
    service_contract_lines.droits.install_base_items_covered.supplémentaire Date à laquelle l’élément de base d’installation associé a été ajouté au droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    service_contract_lines.droits.install_base_items_covered.install_base Sys_id de l’élément de base d’installation couvert par l’autorisation.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    service_contract_lines.droits.install_base_items_covered.Enlevé Date à laquelle l’élément de base d’installation associé a été supprimé du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    service_contract_lines.droits.produit Sys_id de l’enregistrement du modèle de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    service_contract_lines.droits.product_offering Sys_id de l’enregistrement d’offre de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    service_contract_lines.droits.product_specification Sys_id de l’enregistrement de spécification du produit associé à l’autorisation.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    service_contract_lines.droits.sold_entitlement Sys_id de l’enregistrement du produit vendu associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    service_contract_lines.droits.sold_products_covered Liste des produits vendus couverts par l’autorisation.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "added": "String",
        "removed": "String",
        "sold_product": "String"
      }
    ]
    service_contract_lines.droits.sold_products_covered.supplémentaire Date à laquelle le produit vendu associé a été ajouté à l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    service_contract_lines.droits.sold_products_covered.Enlevé Date à laquelle le produit vendu associé a été retiré de l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    service_contract_lines.droits.sold_products_covered.sold_product Sys_id d’un produit associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.droits.start_date Requis.
    Date de début du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.droits.état Requis.
    État actuel du droit.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics Liste des caractéristiques associées à la ligne de contrat de service.

    Type de données : tableau d’objets

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

    Stocké dans : Caractéristique [sn_pss_core_entitlement_characteristic]

    service_contract_lines.entitlement_characteristics.caractéristique Requis.
    Sys_id de l’enregistrement de caractéristique associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    service_contract_lines.entitlement_characteristics.characteristic_option
    Sys_id de l’enregistrement de l’option de caractéristique associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    service_contract_lines.entitlement_characteristics.entitlement_usage Valeur d’unité utilisée pour la caractéristique de ligne de contrat de service associée.

    Type de données : objet

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

    Stocké dans : Utilisation du droit [sn_pss_core_entitlement_usage]

    service_contract_lines.entitlement_characteristics.entitlement_usage.usage_units Utilisation de la caractéristique de droit associée.

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics.type Caractéristique du type de ligne de contrat de service.
    Valeurs valides :
    • couverture
    • _and_usage de couverture

    Type de données : chaîne

    service_contract_lines.entitlement_characteristics.valeur Requis si le paramètre n’est entitlement_characteristics.type pas transmis.
    Valeur de la caractéristique.

    Type de données : chaîne

    service_contract_lines.install_base_items_covered
    Liste des éléments de base d’installation couverts par la ligne de contrat de service.

    Type de données : tableau d’objets

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

    Stocké dans : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.install_base_items_covered.supplémentaire
    Date à laquelle l’élément de base d’installation associé a été ajouté à la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    service_contract_lines.install_base_items_covered.install_base Sys_id de l’élément de base d’installation couvert par la ligne de contrat de service.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    service_contract_lines.install_base_items_covered.Enlevé
    Date à laquelle la ligne de contrat de service associée met fin à la couverture de l’élément de base d’installation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    service_contract_lines.nom
    Nom de la ligne de contrat de service.

    Type de données : chaîne

    service_contract_lines.product_model Sys_id du produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    service_contract_lines.product_offering Sys_id de l’enregistrement d’offre de produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    service_contract_lines.product_specification Sys_id de l’enregistrement de spécification du produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    service_contract_lines.sold_product Sys_id de l’enregistrement du produit vendu associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    service_contract_lines.sold_products_covered
    Liste des produits couverts par la ligne de contrat de service.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "added": "String",
        "removed": "String",
        "sold_product": "String"
      }
    ]
    service_contract_lines.sold_products_covered.supplémentaire Date à laquelle la ligne de contrat de service associée commence à couvrir le produit associé.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    service_contract_lines.sold_products_covered.Enlevé Date à laquelle la ligne de contrat de service associé met fin à la couverture du produit associé.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    service_contract_lines.sold_products_covered.sold_product
    Sys_id d’un produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.Commence Requis.
    Date de début de la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    service_contract_lines.état Requis.
    État actuel de la ligne de contrat.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    short_description
    Brève description ou nom du contrat de service.

    Type de données : chaîne

    Valeur par défaut : null (chaîne vide)

    sold_products_covered Requis si le paramètre n’est install_base_items_covered pas spécifié.
    Liste des produits couverts par le contrat de service. Les données de ce paramètre sont insérées dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product].

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "added": "String",
        "removed": "String",
        "sold_product": "String"
      }
    ]
    sold_products_covered.ajouté
    Date à laquelle le contrat de service associé commence à couvrir le produit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    sold_products_covered.supprimé
    Date à laquelle le contrat de service associé met fin à la couverture du produit associé.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    sold_products_covered.produit_vendu Sys_id du produit couvert par le contrat de service.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    démarrages Requis.
    Date de début du contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    État Requis.
    État actuel du contrat de service.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé

    Type de données : chaîne

    vendor_contract Requis.
    Identificateur unique d’un contrat externe associé.

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 16. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json

    Content-Type Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json

    Tableau 17. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 18. Codes d'état
    Code d'état Description
    201 Réussi. La demande a été traitée avec succès et les enregistrements ont été créés.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur n’a pas l’autorisation d’accéder à l’API.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres du corps de la réponse (JSON ou XML)

    Nom Description
    install_base_items_covered Liste des sys_ids des éléments de base d’installation couverts par le contrat de service.

    Type de données : tableau d’objets

    "install_base_items_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    install_base_items_covered.sys_id Sys_id de l’élément de base d’installation couvert.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    Numéro Numéro de contrat de service généré automatiquement.

    Type de données : chaîne

    service_contract_lines Liste des lignes de contrat de service associées au contrat de service.

    Type de données : tableau d’objets

    "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 Liste des objets de ligne de contrat de service enfant créés sous la ligne de contrat de service.

    Type de données : tableau d’objets

    "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 Liste des objets de ligne de contrat de service enfant créés sous la ligne de contrat de service enfant. Les objets de ce tableau ont les mêmes éléments que le service_contract_lines.child_contract_lines paramètre.

    Type de données : tableau d’objets

    service_contract_lines.child_contract_lines.droits Liste des droits associés à la ligne de contrat de service enfant.

    Type de données : tableau d’objets

    "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.droits.entitlement_name
    Nom du droit.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.droits.entitlement_characteristics Liste des objets de caractéristiques de droit créés en vertu du droit.

    Type de données : tableau d’objets

    "entitlement_characteristics": [
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines.child_contract_lines.droits.entitlement_characteristics.sys_id Sys_id d’un enregistrement des caractéristiques du droit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    service_contract_lines.child_contract_lines.droits.install_base_items_covered Liste des sys_ids des éléments de base d’installation couverts par l’autorisation.

    Type de données : tableau d’objets

    "install_base_items_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines.child_contract_lines.droits.install_base_items_covered.sys_id Sys_id d’éléments de base d’installation couverts par l’autorisation.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.child_contract_lines.droits.sold_products_covered Liste des sys_ids des produits couverts par le droit.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines.child_contract_lines.droits.sold_products_covered.sys_id Sys_id d’un produit associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.child_contract_lines.droits.sys_id Sys_id de l’enregistrement du droit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.child_contract_lines.entitlement_characteristics Liste des caractéristiques associées à la ligne de contrat chilienne.

    Type de données : tableau d’objets

    "entitlement_characteristics": [
      {
        "entitlement_usage": {Object},
        "sys_id": "String"
      }
    ]
    service_contract_lines.child_contract_lines.entitlement_characteristics.entitlement_usage Objet d’utilisation du droit inséré sous le entitlement_characteristic.

    Type de données : objet

    "entitlement_usage": {
        "sys_id": "String"
    }
    service_contract_lines.child_contract_lines.entitlement_characteristics.entitlement_usage.sys_id Sys_id de l’enregistrement de l’utilisation du droit.

    Type de données : chaîne

    Table : Utilisation du droit [sn_pss_core_entitlement_usage]

    service_contract_lines.child_contract_lines.entitlement_characteristics.sys_id Sys_id d’un enregistrement des caractéristiques du droit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    service_contract_lines.child_contract_lines.install_base_items_covered Liste des sys_ids des éléments de base d’installation couverts sous la ligne de contrat enfant.

    Type de données : tableau d’objets

    "install_base_items_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines.child_contract_lines.install_base_items_covered.sys_id Sys_id de l’élément de base d’installation couvert.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.child_contract_lines.nom Nom de la ligne de contrat de service enfant.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.nombre Numéro unique de la ligne de contrat de service. Généré automatiquement par le point de terminaison. Par exemple : CTRL000001.

    Type de données : chaîne

    service_contract_lines.child_contract_lines.sold_products_covered Liste des sys_ids des produits couverts par la ligne de contrat de service enfant.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines.child_contract_lines.sold_products_covered.sys_id Sys_id d’un produit couvert par la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.child_contract_lines.sys_id Sys_id d’un enregistrement de ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    service_contract_lines.droits Liste des droits associés au contrat de service.

    Type de données : tableau d’objets

    "entitlements" [
      {
        "entitlement_name": "String",
        "entitlement_characteristics": [Array],
        "install_base_items_covered": [Array],
        "sold_products_covered": [Array],
        "sys_id": "String"
      }
    ]
    service_contract_lines.droits.entitlement_name
    Nom du droit.

    Type de données : chaîne

    service_contract_lines.droits.entitlement_characteristics Liste des objets de caractéristiques de droit créés en vertu du droit.

    Type de données : tableau d’objets

    "entitlement_characteristics" [
      {
        "entitlement_usage": {Object},
        "sys_id": "String"
      }
    ]
    service_contract_lines.droits.entitlement_characteristics.entitlement_usage Objet d’utilisation du droit inséré sous le entitlement_characteristic.

    Type de données : objet

    "entitlement_usage": {
        "sys_id": "String"
    }
    service_contract_lines.droits.entitlement_characteristics.entitlement_usage.sys_id Sys_id de l’enregistrement de l’utilisation du droit.

    Type de données : chaîne

    Table : Utilisation du droit [sn_pss_core_entitlement_usage]

    service_contract_lines.droits.entitlement_characteristics.sys_id Sys_id d’un enregistrement des caractéristiques du droit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    service_contract_lines.droits.install_base_items_covered Liste des sys_ids des éléments de base d’installation couverts par l’autorisation.

    Type de données : tableau d’objets

    "install_base_items_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines.droits.install_base_items_covered.sys_id Sys_id d’éléments de base d’installation couverts par l’autorisation.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.droits.sold_products_covered Liste des sys_ids des produits couverts par le droit.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines.droits.sold_products_covered.sys_id Sys_id d’un produit associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.droits.sys_id Sys_id de l’enregistrement du droit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    service_contract_lines.entitlement_characteristics Liste des caractéristiques associées à la ligne de contrat chilienne.

    Type de données : tableau d’objets

    "entitlement_characteristics": [
      {
        "entitlement_usage": {Object},
        "sys_id": "String"
      }
    ]
    service_contract_lines.entitlement_characteristics.entitlement_usage Objet d’utilisation du droit inséré sous le entitlement_characteristic.

    Type de données : objet

    "entitlement_usage": {
        "sys_id": "String"
    }
    service_contract_lines.entitlement_characteristics.entitlement_usage.sys_id Sys_id de l’enregistrement de l’utilisation du droit.

    Type de données : chaîne

    Table : Utilisation du droit [sn_pss_core_entitlement_usage]

    service_contract_lines.entitlement_characteristics.sys_id Sys_id d’un enregistrement des caractéristiques du droit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    service_contract_lines.install_base_items_covered Liste des sys_ids des éléments de base d’installation couverts sous la ligne de contrat enfant.

    Type de données : tableau d’objets

    "install_base_items_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines.install_base_items_covered.sys_id Sys_id de l’élément de base d’installation couvert.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.nom Nom de la ligne de contrat de service enfant.

    Type de données : chaîne

    service_contract_lines.nombre Numéro unique de la ligne de contrat de service. Généré automatiquement par le point de terminaison. Par exemple : CTRL000001.

    Type de données : chaîne

    service_contract_lines.sold_products_covered Liste des sys_ids des produits couverts par la ligne de contrat de service.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    service_contract_lines.sold_products_covered.sys_id Sys_id d’un produit couvert par la ligne de contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    service_contract_lines.sys_id Sys_id d’enregistrement d’une ligne de contrat de service.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    short_description
    Brève description ou nom du contrat de service.

    Type de données : chaîne

    sold_products_covered Liste des sys_ids des produits couverts par le contrat de service.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    sold_products_covered.sys_id Sys_id d’un produit couvert par le contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    sys_id Sys_id de l’enregistrement du contrat de service.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    Demande cURL

    Voici un exemple de code qui montre comment appeler ce point de terminaison et créer un contrat de service avec un enregistrement de produit vendu couvert, un enregistrement d’éléments de base d’installation couverts et deux lignes de contrat de service.

    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"

    Réponse :

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

    Contrat de service : POST /sn_pss_core/servicecontract/contractline

    Crée un enregistrement de ligne de contrat et toutes ses entités connexes.

    Ce point de terminaison stocke les données dans les tables suivantes lors du traitement de la demande :
    • Caractéristique [sn_pss_core_entitlement_characteristic]
    • Droit [service_entitlement]
    • Utilisation du droit [sn_pss_core_entitlement_usage]
    • Produit vendu couvert [sn_install_base_m2m_contract_sold_product] : ce tableau contient des informations sur les produits vendus couverts et les éléments de base d’installation couverts.
    • Ligne de contrat de service [sn_pss_core_service_contract_line]

    Format d'URL

    URL versionnée : /api/sn_pss_core/{api_version}/servicecontract/contractline

    URL par défaut : /api/sn_pss_core/servicecontract/contractline

    Remarque :
    Les versions disponibles sont spécifiées dans l’explorateur d’API REST. Pour les API REST basées sur un script, des informations de version supplémentaires sont disponibles sur le formulaire Service REST scripté.

    Paramètres de demande pris en charge

    Tableau 19. Paramètres de chemin d'accès
    Nom Description
    api_version Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière.

    Type de données : chaîne

    Tableau 20. Paramètres de requête
    Nom Description
    Néant
    Tableau 21. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    child_contract_lines Liste des objets de ligne de contrat de service enfant créés sous la ligne de contrat de service.

    Type de données : tableau d’objets

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

    Stockée dans : Contrat de service [sn_pss_core_service_contract]

    child_contract_lines.child_contract_lines Liste des objets de ligne de contrat de service enfant à créer sous la ligne de contrat de service enfant. Les objets de ce tableau ont les mêmes éléments que les objets du child_contract_lines paramètre.

    Type de données : tableau d’objets

    child_contract_lines.contrat Sys_id du contrat de service associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    child_contract_lines.finit Date de fin de la ligne de contrat de service enfant.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    child_contract_lines.droits Liste des droits associés à la ligne de contrat de service enfant.

    Type de données : tableau d’objets

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

    Stocké dans : Droit [service_entitlement]

    child_contract_lines.droits.compte Requis si le paramètre n’est consumer pas transmis.
    Sys_id de l’enregistrement de compte auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Compte [customer_account]

    child_contract_lines.droits.consommateur Requis si le paramètre n’est account pas transmis.
    Sys_id de l’enregistrement de consommateur auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Consommateur [csm_consumer]

    child_contract_lines.droits.end_date Date de fin du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    child_contract_lines.droits.entitlement_characteristics Liste des caractéristiques associées au droit.

    Type de données : tableau d’objets

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

    Stocké dans : Caractéristique [sn_pss_core_entitlement_characteristic]

    child_contract_lines.droits.entitlement_characteristics.caractéristique Requis.
    Sys_id de l’enregistrement de caractéristique associé à l’autorisation.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    child_contract_lines.droits.entitlement_characteristics.characteristic_option Sys_id de l’enregistrement de l’option de caractéristique associé au droit.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    child_contract_lines.droits.entitlement_characteristics.entitlement_usage Valeur d’unité utilisée pour la caractéristique du droit associée.

    Ne transmettez ce paramètre que si les entitlement_characteristics sont sous le droit.

    Type de données : objet

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

    Stocké dans : Utilisation du droit [sn_pss_core_entitlement_usage]

    child_contract_lines.droits.entitlement_characteristics.entitlement_usage.used_units Utilisation de la caractéristique de droit associée.

    Type de données : chaîne

    child_contract_lines.droits.entitlement_characteristics.type Type de caractéristique du droit.
    Valeurs valides :
    • couverture
    • coverage_and_usage

    Type de données : chaîne

    child_contract_lines.droits.entitlement_characteristics.valeur Requis si le input_type paramètre contenu dans l’enregistrement spécifié dans le paramètre n’est entitlement_characteristics.characteristic pas un choix.
    Valeur de la caractéristique.

    Type de données : chaîne

    child_contract_lines.droits.entitlement_name Requis.
    Nom du droit.

    Type de données : chaîne

    child_contract_lines.droits.ménage Transmis uniquement lorsque les modules d’extension du ménage sont actifs et que le consumer paramètre est transmis.
    Sys_id de l’enregistrement du ménage associé à l’autorisation.

    Type de données : chaîne

    Tableau : Ménage [csm_household]

    child_contract_lines.droits.install_base_items_covered
    Liste des éléments de base d’installation couverts par l’autorisation. Les informations de ce tableau sont insérées dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product].

    Type de données : tableau d’objets

    "install_base_items_covered": [ 
      {
        "added": "String",
        "install_base": "String",
        "removed": "String"
      }
    ]
    child_contract_lines.droits.install_base_items_covered.supplémentaire Date à laquelle l’élément de base d’installation associé a été ajouté au droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    child_contract_lines.droits.install_base_items_covered.install_base Sys_id de l’élément de base d’installation couvert par l’autorisation.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    child_contract_lines.droits.install_base_items_covered.Enlevé Date à laquelle l’élément de base d’installation associé a été supprimé du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    child_contract_lines.droits.produit Sys_id de l’enregistrement du modèle de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    child_contract_lines.droits.product_offering Sys_id de l’enregistrement d’offre de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    child_contract_lines.droits.product_specification Sys_id de l’enregistrement de spécification du produit associé à l’autorisation.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    child_contract_lines.droits.sold_entitlement Sys_id de l’enregistrement du produit vendu associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    child_contract_lines.droits.sold_products_covered Liste des produits vendus couverts par l’autorisation.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "added": "String",
        "removed": "String",
        "sold_product": "String"
      }
    ]
    child_contract_lines.droits.sold_products_covered.supplémentaire Date à laquelle le produit vendu associé a été ajouté à l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    child_contract_lines.droits.sold_products_covered.Enlevé Date à laquelle le produit vendu associé a été retiré de l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    child_contract_lines.droits.sold_products_covered.sold_product Sys_id d’un produit associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    child_contract_lines.droits.start_date Requis.
    Date de début du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    child_contract_lines.droits.état Requis.
    État actuel du droit.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics Liste des caractéristiques associées au droit.

    Type de données : tableau d’objets

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

    Stocké dans : Caractéristique [sn_pss_core_entitlement_characteristic]

    child_contract_lines.entitlement_characteristics.caractéristique
    Sys_id de l’enregistrement de caractéristique associé à l’autorisation.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    child_contract_lines.entitlement_characteristics.characteristic_option Sys_id de l’enregistrement de l’option de caractéristique associé au droit.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    child_contract_lines.entitlement_characteristics.entitlement_usage Valeur d’unité utilisée pour la caractéristique du droit associée.

    Ne transmettez ce paramètre que si les entitlement_characteristics sont sous le droit.

    Type de données : objet

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

    Stocké dans : Utilisation du droit [sn_pss_core_entitlement_usage]

    child_contract_lines.entitlement_characteristics.entitlement_usage.used_units Utilisation de la caractéristique de droit associée.

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.type Type de caractéristique du droit.
    Valeurs valides :
    • couverture
    • coverage_and_usage

    Type de données : chaîne

    child_contract_lines.entitlement_characteristics.valeur
    Valeur de la caractéristique.

    Type de données : chaîne

    child_contract_lines.install_base_items_covered
    Liste des éléments de base d’installation couverts par l’autorisation. Les informations de ce tableau sont insérées dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product].

    Type de données : tableau d’objets

    "install_base_items_covered": [ 
      {
        "added": "String",
        "install_base": "String",
        "removed": "String"
      }
    ]
    child_contract_lines.install_base_items_covered.supplémentaire Date à laquelle l’élément de base d’installation associé a été ajouté à la ligne de contrat de service enfant.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    child_contract_lines.install_base_items_covered.install_base Sys_id de l’élément de base d’installation couvert par la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    child_contract_lines.install_base_items_covered.Enlevé Date à laquelle la ligne de contrat de service enfant associée met fin à la couverture de l’élément de base d’installation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    child_contract_lines.nom Nom de la ligne de contrat de service enfant.

    Type de données : chaîne

    child_contract_lines.parent_contract_line Sys_id de l’enregistrement de la ligne de contrat parent associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    child_contract_lines.product_model Sys_id du produit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    child_contract_lines.product_offering Sys_id de l’enregistrement d’offre de produit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    child_contract_lines.product_specification Sys_id de l’enregistrement de spécification du produit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    child_contract_lines.sold_product Sys_id de l’enregistrement du produit vendu associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    child_contract_lines.sold_products_covered Liste des produits couverts par la ligne de contrat de service enfant.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "added": "String",
        "removed": "String",
        "sold_product": "String"
      }
    ]
    child_contract_lines.sold_products_covered.supplémentaire Date à laquelle la ligne de contrat de service enfant associée commence à couvrir le produit associé.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    child_contract_lines.sold_products_covered.Enlevé Date à laquelle la ligne de contrat de service enfant associée met fin à la couverture du produit associé.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    child_contract_lines.sold_products_covered.sold_product Sys_id d’un produit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    child_contract_lines.Commence Date de début de la ligne de contrat de service enfant.

    Type de données : chaîne

    Format : aaaa-mm-jj

    child_contract_lines.état
    État actuel de la ligne de contrat.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    contrat
    Sys_id du contrat de service associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Contrat de service [sn_pss_core_service_contract]

    fins Date de fin de la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    droits Liste des autorisations à associer à la ligne de contrat de service. Ces autorisations sont insérées dans la table Droit [service_entitlement].

    Type de données : tableau d’objets

    "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"
      }
    ]
    droits.compte Requis si le paramètre n’est consumer pas transmis.
    Sys_id de l’enregistrement de compte auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Compte [customer_account]

    droits.consommateur Requis si le paramètre n’est account pas transmis.
    Sys_id de l’enregistrement de consommateur auquel l’autorisation appartient.

    Type de données : chaîne

    Table : Consommateur [csm_consumer]

    droits.end_date Date de fin du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.

    droits.entitlement_characteristics Liste des caractéristiques associées au droit.

    Type de données : tableau d’objets

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

    Stocké dans : Caractéristique [sn_pss_core_entitlement_characteristic]

    droits.entitlement_characteristics.caractéristique Requis.
    Sys_id de l’enregistrement de caractéristique associé à l’autorisation.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    droits.entitlement_characteristics.characteristic_option Sys_id de l’enregistrement de l’option de caractéristique associé au droit.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    droits.entitlement_characteristics.entitlement_usage Valeur d’unité utilisée pour la caractéristique du droit associée.

    Ne transmettez ce paramètre que si les entitlement_characteristics sont sous le droit.

    Type de données : objet

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

    Stocké dans : Utilisation du droit [sn_pss_core_entitlement_usage]

    droits.entitlement_characteristics.entitlement_usage.used_units Utilisation de la caractéristique de droit associée.

    Type de données : chaîne

    droits.entitlement_characteristics.type Type de caractéristique du droit.
    Valeurs valides :
    • couverture
    • coverage_and_usage

    Type de données : chaîne

    droits.entitlement_characteristics.valeur Requis si le input_type paramètre contenu dans l’enregistrement spécifié dans le paramètre n’est entitlement_characteristics.characteristic pas un choix.
    Valeur de la caractéristique.

    Type de données : chaîne

    droits.entitlement_name Requis.
    Nom du droit.

    Type de données : chaîne

    droits.ménage Transmis uniquement lorsque les modules d’extension du ménage sont actifs et que le consumer paramètre est transmis.
    Sys_id de l’enregistrement du ménage associé à l’autorisation.

    Type de données : chaîne

    Tableau : Ménage [csm_household]

    droits.install_base_items_covered
    Liste des éléments de base d’installation couverts par l’autorisation. Les informations de ce tableau sont insérées dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product].

    Type de données : tableau d’objets

    "install_base_items_covered": [ 
      {
        "added": "String",
        "install_base": "String",
        "removed": "String"
      }
    ]
    droits.install_base_items_covered.supplémentaire Date à laquelle l’élément de base d’installation associé a été ajouté au droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    droits.install_base_items_covered.Enlevé Date à laquelle l’élément de base d’installation associé a été supprimé du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    droits.produit Sys_id de l’enregistrement du modèle de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    droits.product_offering Sys_id de l’enregistrement d’offre de produit associé à l’autorisation.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    droits.product_specification Sys_id de l’enregistrement de spécification du produit associé à l’autorisation.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    droits.sold_entitlement Sys_id de l’enregistrement du produit vendu associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    droits.sold_products_covered Liste des produits vendus couverts par l’autorisation.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "added": "String",
        "removed": "String",
        "sold_product": "String"
      }
    ]
    droits.sold_products_covered.supplémentaire Date à laquelle le produit vendu associé a été ajouté à l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    droits.sold_products_covered.Enlevé Date à laquelle le produit vendu associé a été retiré de l’autorisation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    droits.sold_products_covered.sold_product Sys_id d’un produit associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    droits.start_date Requis.
    Date de début du droit.

    Type de données : chaîne

    Format : aaaa-mm-jj

    droits.état Requis.
    État actuel du droit.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    entitlement_characteristics Liste des caractéristiques associées à la ligne de contrat de service.

    Type de données : tableau d’objets

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

    Stocké dans : Caractéristique [sn_pss_core_entitlement_characteristic]

    entitlement_characteristics.caractéristique Requis.
    Sys_id de l’enregistrement de caractéristique associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Caractéristique [sn_prd_pm_characteristic]

    entitlement_characteristics.characteristic_option Requis si le input_type paramètre contenu dans l’enregistrement spécifié dans le entitlement_characteristics.characteristic paramètre est défini sur choix.
    Sys_id de l’enregistrement de l’option de caractéristique associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Option de la caractéristique [sn_prd_pm_characteristic_option]

    entitlement_characteristics.entitlement_usage Valeur d’unité utilisée pour la caractéristique de ligne de contrat de service associée.

    Type de données : objet

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

    Stocké dans : Utilisation du droit [sn_pss_core_entitlement_usage]

    entitlement_characteristics.entitlement_usage.used_units Utilisation de la caractéristique de droit associée.

    Type de données : chaîne

    entitlement_characteristics.type Caractéristique du type de ligne de contrat de service.
    Valeurs valides :
    • couverture
    • _and_usage de couverture

    Type de données : chaîne

    entitlement_characteristics.valeur Requis si le paramètre n’est entitlement_characteristics.type pas transmis.
    Valeur de la caractéristique.

    Type de données : chaîne

    install_base_items_covered Requis si le paramètre n’est sold_products_covered pas transmis.
    Liste des éléments de base d’installation couverts par la ligne de contrat de service.

    Type de données : tableau d’objets

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

    Stocké dans : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    install_base_items_covered.supplémentaire
    Date à laquelle l’élément de base d’installation associé a été ajouté à la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    install_base_items_covered.install_base Sys_id de l’élément de base d’installation couvert par la ligne de contrat de service.

    Type de données : chaîne

    Table : Élément de base d’installation [sn_install_base_item]

    install_base_items_covered.Enlevé
    Date à laquelle la ligne de contrat de service associée met fin à la couverture de l’élément de base d’installation.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    nom Requis.
    Nom de la ligne de contrat de service.

    Type de données : chaîne

    parent_contract_line Sys_id de la ligne de contrat de service dont la ligne de contrat de service actuelle est enfant.

    Nul pour les lignes de contrat créées dans le cadre d’un contrat.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    product_model Sys_id du produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Modèle de produit [cmdb_model]

    product_offering Sys_id de l’enregistrement d’offre de produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]

    product_specification Sys_id de l’enregistrement de spécification du produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Tableau : Spécification de produit [sn_prd_pm_product_specification]

    sold_product Sys_id de l’enregistrement du produit vendu associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Produit vendu [sn_install_base_sold_product]

    sold_products_covered Requis si le paramètre n’est install_base_items_covered pas transmis.
    Liste des produits couverts par la ligne de contrat de service.

    Type de données : tableau d’objets

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

    Les données sont stockées dans la table des produits vendus couverts [sn_install_base_m2m_contract_sold_product].

    sold_products_covered.supplémentaire Date à laquelle la ligne de contrat de service associée commence à couvrir le produit associé.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : date actuelle

    sold_products_covered.Enlevé Date à laquelle la ligne de contrat de service associé met fin à la couverture du produit associé.

    Type de données : chaîne

    Format : aaaa-mm-jj

    Par défaut : aucune date de fin

    sold_products_covered.sold_product
    Sys_id d’un produit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    démarrages Requis.
    Date de début de la ligne de contrat de service.

    Type de données : chaîne

    Format : aaaa-mm-jj

    État Requis.
    État actuel de la ligne de contrat.
    Valeurs valides : (sensibles à la casse)
    • actif
    • annulé
    • brouillon
    • périmé
    • suspendu

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 22. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json

    Content-Type Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json

    Tableau 23. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 24. Codes d'état
    Code d'état Description
    201 Réussi. La demande a été traitée avec succès et les enregistrements ont été créés.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    403 Interdit. L’utilisateur n’a pas l’autorisation d’accéder à l’API.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres du corps de la réponse (JSON ou XML)

    Nom Description
    child_contract_lines Liste des objets de ligne de contrat de service enfant créés sous la ligne de contrat de service.

    Type de données : tableau d’objets

    "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 Liste des objets de ligne de contrat de service enfant créés sous la ligne de contrat de service enfant. Les objets de ce tableau ont les mêmes éléments que le child_contract_lines paramètre.

    Type de données : tableau d’objets

    child_contract_lines.droits Liste des droits associés à la ligne de contrat de service enfant.

    Type de données : tableau d’objets

    "entitlements": [
      {
        "entitlement_name": "String",
        "entitlement_characteristics": [Array],
        "install_base_items_covered": [Array],
        "sold_products_covered": [Array],
        "sys_id": "String"
      }
    ]
    child_contract_lines.droits.entitlement_name
    Nom du droit.

    Type de données : chaîne

    child_contract_lines.droits.entitlement_characteristics Liste des objets de caractéristiques de droit créés en vertu du droit.

    Type de données : tableau d’objets

    "entitlement_characteristics": [
      {
        "sys_id": "String"
      }
    ]
    child_contract_lines.droits.entitlement_characteristics.sys_id Sys_id d’un enregistrement des caractéristiques du droit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    child_contract_lines.droits.install_base_items_covered Liste des sys_ids des éléments de base d’installation couverts par l’autorisation.

    Type de données : tableau d’objets

    "install_base_items_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    child_contract_lines.droits.install_base_items_covered.sys_id Sys_id d’éléments de base d’installation couverts par l’autorisation.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    child_contract_lines.droits.sold_products_covered Liste des sys_ids des produits couverts par le droit.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    child_contract_lines.droits.sold_products_covered.sys_id Sys_id d’un produit associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    child_contract_lines.droits.sys_id Sys_id de l’enregistrement du droit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    child_contract_lines.entitlement_characteristics Liste des caractéristiques associées à la ligne de contrat chilienne.

    Type de données : tableau d’objets

    "entitlement_characteristics": [
      {
        "entitlement_usage": {Object},
        "sys_id": "String"
      }
    ]
    child_contract_lines.entitlement_characteristics.entitlement_usage Objet d’utilisation du droit inséré sous le entitlement_characteristic.

    Type de données : objet

    "entitlement_usage": {
        "sys_id": "String"
    }
    child_contract_lines.entitlement_characteristics.entitlement_usage.sys_id Sys_id de l’enregistrement de l’utilisation du droit.

    Type de données : chaîne

    Table : Utilisation du droit [sn_pss_core_entitlement_usage]

    child_contract_lines.entitlement_characteristics.sys_id Sys_id d’un enregistrement des caractéristiques du droit associé à la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Caractéristique [sn_pss_core_entitlement_characteristic]

    child_contract_lines.install_base_items_covered Liste des sys_ids des éléments de base d’installation couverts par la ligne de contrat de service enfant.

    Type de données : tableau d’objets

    "install_base_items_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    child_contract_lines.install_base_items_covered.sys_id Sys_id de l’élément de base d’installation couvert.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    child_contract_lines.nom Nom de la ligne de contrat de service enfant.

    Type de données : chaîne

    child_contract_lines.nombre Numéro unique de la ligne de contrat de service. Généré automatiquement par le point de terminaison. Par exemple : CTRL9812347.

    Type de données : chaîne

    child_contract_lines.sold_products_covered Liste des sys_ids des produits couverts par la ligne de contrat de service enfant.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    child_contract_lines.sold_products_covered.sys_id Sys_id d’un produit couvert par la ligne de contrat de service enfant.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    child_contract_lines.sys_id Sys_id d’un produit couvert par l’élément de contrat enfant.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    droits Liste des droits associés à la ligne de contrat de service.

    Type de données : tableau d’objets

    "entitlements": [
      {
        "entitlement_characteristics": [Array],
        "entitlement_name": "String",
        "install_base_items_covered": [Array],
        "sold_products_covered": [Array],
        "sys_id": "String"
      }
    ]
    droits.entitlement_characteristics Liste des objets de caractéristiques de droit créés en vertu du droit.

    Type de données : tableau d’objets

    "entitlement_characteristics" [
      {
        "entitlement_usage": {Object},
        "sys_id": "String"
      }
    ]
    droits.entitlement_characteristics.entitlement_usage Objet d’utilisation du droit inséré sous le entitlement_characteristic.

    Type de données : objet

    "entitlement_usage": {
        "sys_id": "String"
    }
    droits.entitlement_characteristics.entitlement_usage.sys_id Sys_id de l’enregistrement de l’utilisation du droit.

    Type de données : chaîne

    Table : Utilisation du droit [sn_pss_core_entitlement_usage]

    droits.entitlement_characteristics.sys_id Sys_id de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    droits.entitlement_name
    Nom du droit.

    Type de données : chaîne

    droits.install_base_items_covered Liste des sys_ids des éléments de base d’installation couverts par l’autorisation.

    Type de données : tableau d’objets

    "install_base_items_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    droits.install_base_items_covered.sys_id Sys_id d’éléments de base d’installation couverts par l’autorisation.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    droits.sold_products_covered Liste des sys_ids des produits couverts par le droit.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    droits.sold_products_covered.sys_id Sys_id d’un produit associé à l’autorisation.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    droits.sys_id Sys_id de l’enregistrement du droit associé à la ligne de contrat de service.

    Type de données : chaîne

    Table : Droit [service_entitlement]

    entitlement_characteristics Liste des objets de caractéristique du droit créés sous la ligne de contrat de service.

    Type de données : tableau d’objets

    "entitlement_characteristics" [
      {
        "entitlement_usage": {Object},
        "sys_id": "String"
      }
    ]
    entitlement_characteristics.entitlement_usage Objet d’utilisation du droit inséré sous le entitlement_characteristic.

    Type de données : objet

    "entitlement_usage": {
        "sys_id": "String"
    }
    entitlement_characteristics.entitlement_usage.sys_id Sys_id de l’enregistrement de l’utilisation du droit.

    Type de données : chaîne

    Table : Utilisation du droit [sn_pss_core_entitlement_usage]

    entitlement_characteristics.sys_id Sys_id de l’enregistrement des caractéristiques du droit.

    Type de données : chaîne

    install_base_items_covered Liste des sys_ids des éléments de base d’installation couverts par la ligne de contrat de service.

    Type de données : tableau d’objets

    "install_base_items_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    install_base_items_covered.sys_id Sys_id de l’élément de base d’installation couvert.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    nom
    Nom de la ligne de contrat de service.

    Type de données : chaîne

    Numéro Numéro unique de la ligne de contrat de service. Généré automatiquement par le point de terminaison. Par exemple : CTRL9812347.

    Type de données : chaîne

    sold_products_covered Liste des sys_ids des produits couverts par la ligne de contrat de service.

    Type de données : tableau d’objets

    "sold_products_covered": [ 
      {
        "sys_id": "String"
      }
    ]
    sold_products_covered.sys_id Sys_id d’un produit couvert par la ligne de contrat de service.

    Type de données : chaîne

    Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]

    sys_id Sys_id d’enregistrement d’une ligne de contrat de service.

    Type de données : chaîne

    Table : Ligne de contrat de service [sn_pss_core_service_contract_line]

    Demande cURL

    L’exemple de code qui suit montre comment appeler ce point de terminaison et créer un enregistrement de ligne de contrat de service.

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

    Réponse :

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