API de contrat de service

Rversion finale: Washingtondc

Mis à jour 1 févr. 2024

62 minutes de lecture

L’API de contrat de service vous permet de créer et de récupérer des enregistrements de contrats de service.

Remarque :

Cette API permet de créer des données dans les tables de l’application Contrats clients et autorisations . 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 et autorisations clients (com.sn_pss_core)
Gestion de la base d’installation Customer Service (com.snc.install)
Gestion du catalogue de produits Core (com.sn_prd)

En outre, pour appeler cette API avec succès, 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 des données associé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]
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 dans les tables suivantes lors du traitement de la demande :

Caractéristique [sn_pss_core_entitlement_characteristic]
Autorisation [service_entitlement]
Utilisation de l’autorisation [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/v1/servicecontract/{id}

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

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. 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. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne

Tableau 2. Paramètres de requête
Nom	Description
display_value	Type de données à renvoyer. Valeurs valides : false : renvoie la `valeur` de tous les champs. Par exemple, `« état » : « brouillon ».` true : renvoie la `display_value` pour tous les champs. Par exemple, `« état » : « Brouillon »` all : renvoie toutes les informations pour tous les champs. `"state": { "name": "state", "label": "State", "value": "draft", "display_value": "Draft", "type": "string" }` 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 une 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 une 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 de corps de réponse (JSON ou XML)


Nom	Description
compte	Sys_id de l’enregistrement de compte auquel le contrat de service appartient. Situé dans la table Compte [customer_account]. Type de données : chaîne
consommateur	Sys_id de l’enregistrement consommateur auquel le contrat de service appartient. Situé dans la table Consommateur [csm_consumer]. Type de données : chaîne
fins	Date de fin du contrat de service. Type de données : chaîne
household	Sys_id du ménage associé au contrat de service. Situé dans le ménage [csm_household]. 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" } ]`
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
install_base_items_covered.Contrat	Sys_id de l’enregistrement du contrat de service associé à l’élément de base d’installation. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
install_base_items_covered.Droit	Sys_id de l’enregistrement d’autorisation associé à l’élément de base d’installation. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
install_base_items_covered.install_base	Sys_id de l’enregistrement d’élément de base d’installation associé. Situé dans la table Élément de base d’installation [sn_install_base_item]. Type de données : chaîne
install_base_items_covered.Enlevé	Date à laquelle le contrat de service associé termine 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. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
install_base_items_covered.sys_updated_by	Nom de l’utilisateur qui a mis à jour l’enregistrement de l’é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 dernière mise à jour de l’enregistrement de l’é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": [ { "contract": "String", "ends": "String", "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "product_model": "String", "product_offering": "String", "sold_product": "String", "sold_product_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.Contrat	Sys_id du contrat de service associé à la ligne de contrat de service. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
service_contract_lines.Extrémités	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 associées au contrat de service. Situé dans la table Autorisation [service_entitlement]. Type de données : tableau d’objets "entitlements": [ { "account": "String", "consumer": "String", "contract": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "entitlement_usages": [Array], "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "service_contract_line": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]
service_contract_lines.Droits.Compte	Sys_id de l’enregistrement de compte auquel l’autorisation appartient. Situé dans la table Compte [customer_account]. Type de données : chaîne
service_contract_lines.Droits.Consommateur	Sys_id de l’enregistrement de consommateur auquel l’autorisation appartient. Situé dans la table Consommateur [csm_consumer]. Type de données : chaîne
service_contract_lines.Droits.Contrat	Sys_id de l’enregistrement de contrat auquel l’autorisation appartient. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
service_contract_lines.Droits.end_date	Date de fin de l’autorisation. 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 à l’autorisation. Situé dans la table Caractéristique [sn_pss_core_entitlement_characteristic]. 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.Droits.entitlement_characteristics. Caractéristique	Sys_id de l’enregistrement de caractéristique associé à l’autorisation. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
service_contract_lines.Droits.entitlement_characteristics.option_caractéristique	Sys_id de l’enregistrement de l’option de caractéristique associée à l’autorisation. Situé dans la table Option de caractéristique [sn_prd_pm_characteristic_option]. Type de données : chaîne
service_contract_lines.Droits.entitlement_characteristics.Droit	Sys_id de l’enregistrement d’autorisation associé. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
service_contract_lines.Droits.entitlement_characteristics.service_contract_line	Sys_id de l’enregistrement de la ligne de contrat de service associé à la caractéristique d’autorisation. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
service_contract_lines.Droits.entitlement_characteristics.sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement des caractéristiques de l’autorisation. 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 de l’autorisation. Type de données : chaîne
service_contract_lines.Droits.entitlement_characteristics.sys_id	Sys_id de l’enregistrement des caractéristiques de l’autorisation. 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 d’autorisation pour la dernière fois. Type de données : chaîne
service_contract_lines.Droits.entitlement_characteristics.sys_updated_on	Date et heure de dernière mise à jour de l’enregistrement des caractéristiques d’autorisation. Type de données : chaîne
service_contract_lines.Droits.entitlement_characteristics.type	Type de caractéristique d’autorisation. Valeurs valides : Couverture Couverture et utilisation Type de données : chaîne
service_contract_lines.Droits.entitlement_characteristics.value	Valeur de la caractéristique. Type de données : chaîne
service_contract_lines.Droits.entitlement_name	Nom de l’autorisation. Type de données : chaîne
service_contract_lines.Droits.entitlement_usages	Liste des valeurs d’utilisation du produit associé. Type de données : tableau d’objets `"entitlement_usages": [ { "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_usages.Droit	Sys_id de l’enregistrement d’autorisation associé à l’utilisation de l’autorisation. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
service_contract_lines.Droits.entitlement_usages.entitlement_characteristic	Sys_id de l’enregistrement de la caractéristique d’autorisation associé à l’utilisation de l’autorisation. Situé dans la table Caractéristique [sn_pss_core_entitlement_characteristic]. Type de données : chaîne
service_contract_lines.Droits.entitlement_usages.period_end	Date de fin lorsque l’utilisation de l’autorisation n’est plus suivie. Type de données : chaîne Format : aaaa-mm-jj
service_contract_lines.Droits.entitlement_usages.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_usages.sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement d’utilisation d’autorisation. Type de données : chaîne
service_contract_lines.Droits.entitlement_usages.sys_created_on	Date et heure de création de l’enregistrement d’utilisation de l’autorisation. Type de données : chaîne
service_contract_lines.Droits.entitlement_usages.sys_id	Sys_id de l’enregistrement d’utilisation de l’autorisation. Situé dans la table Utilisation de l’autorisation [sn_pss_core_entitlement_usage]. Type de données : chaîne
service_contract_lines.Droits.entitlement_usages.sys_updated_by	Nom de l’utilisateur qui a mis à jour l’enregistrement d’utilisation d’autorisation pour la dernière fois. Type de données : chaîne
service_contract_lines.Droits.entitlement_usages.sys_updated_on	Date et heure de dernière mise à jour de l’enregistrement d’utilisation de l’autorisation. Type de données : chaîne
service_contract_lines.Droits.entitlement_usages.total_units	Nombre total d’unités achetées. Type de données : chaîne
service_contract_lines.Droits.entitlement_usages.used_units	Nombre d’unités utilisées. Type de données : chaîne
service_contract_lines.Droits.Ménage	Sys_id de l’enregistrement de ménage associé à l’autorisation. Situé dans la table Ménage [csm_household]. Type de données : chaîne
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.Ajouté	Date à laquelle l’élément de base d’installation associé a été ajouté à l’autorisation. 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. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
service_contract_lines.Droits.install_base_items_covered.Droit	Sys_id de l’enregistrement d’autorisation associé à l’élément de base d’installation. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
service_contract_lines.Droits.install_base_items_covered.install_base	Sys_id de l’enregistrement d’élément de base d’installation associé. Situé dans la table Élément de base d’installation [sn_install_base_item]. Type de données : chaîne
service_contract_lines.Droits.install_base_items_covered.Enlevé	Date à laquelle l’élément de base d’installation associé a été supprimé de l’autorisation. 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. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
service_contract_lines.Droits.install_base_items_covered.sys_updated_by	Nom de l’utilisateur qui a mis à jour l’enregistrement de l’é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 dernière mise à jour de l’enregistrement de l’é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. Situé dans la table Modèle de produit [cmdb_model]. Type de données : chaîne
service_contract_lines.Droits.product_offering	Sys_id de l’enregistrement de l’offre de produit associé à l’autorisation. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
service_contract_lines.Droits.service_contract_line	Sys_id de l’enregistrement de la ligne de contrat de service associé à l’autorisation. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
service_contract_lines.Droits.sold_entitlement	Sys_id de l’enregistrement du produit vendu associé à l’autorisation. Situé dans la table Produit vendu [sn_install_base_sold_product]. Type de données : chaîne
service_contract_lines.Droits.sold_products_covered	Liste des produits couverts. Situé 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", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
service_contract_lines.Droits.sold_products_covered.Ajouté	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. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
Droits.sold_products_covered.Droit	Sys_id de l’enregistrement d’autorisation associé au produit vendu couvert. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
service_contract_lines.Droits.sold_products_covered.supprimé	Date à laquelle le produit vendu associé a été supprimé 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. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
service_contract_lines.Droits.sold_products_covered.sold_product	Sys_id du produit couvert par l’autorisation. Situé dans la table Produit vendu [sn_install_base_sold_product]. Type de données : chaîne
service_contract_lines.Droits.sold_products_covered.sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement du produit vendu couvert. 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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
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 vendu couvert. Type de données : chaîne
service_contract_lines.Droits.start_date	Date de début de l’autorisation. Type de données : chaîne Format : aaaa-mm-jj
service_contract_lines.Droits.État	État actuel de l’autorisation. Valeurs valides : (sensible à la casse) Actif annulé brouillon Expiré 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 d’autorisation associé. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
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. Situé dans la table Caractéristique [sn_pss_core_entitlement_characteristic]. 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.entitlement_characteristics. Caractéristique	Sys_id de l’enregistrement de caractéristique associé à l’autorisation. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
service_contract_lines.entitlement_characteristics.option_caractéristique	Sys_id de l’enregistrement de l’option de caractéristique associée à l’autorisation. Situé dans la table Option de caractéristique [sn_prd_pm_characteristic_option]. Type de données : chaîne
service_contract_lines.entitlement_characteristics.Droit	Sys_id de l’enregistrement d’autorisation associé. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
service_contract_lines.entitlement_characteristics.service_contract_line	Sys_id de l’enregistrement de la ligne de contrat de service associé à la caractéristique d’autorisation. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
service_contract_lines.entitlement_characteristics.sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement des caractéristiques de l’autorisation. 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 de l’autorisation. Type de données : chaîne
service_contract_lines.entitlement_characteristics.sys_id	Sys_id de l’enregistrement des caractéristiques de l’autorisation. 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 d’autorisation pour la dernière fois. Type de données : chaîne
service_contract_lines.entitlement_characteristics.sys_updated_on	Date et heure de dernière mise à jour de l’enregistrement des caractéristiques d’autorisation. Type de données : chaîne
service_contract_lines.entitlement_characteristics.type	Type de caractéristique d’autorisation. Valeurs valides : Couverture Couverture et utilisation Type de données : chaîne
service_contract_lines.entitlement_characteristics.value	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. Situé 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", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
service_contract_lines.install_base_items_covered.Ajouté	Date à laquelle l’élément de base d’installation associé a été ajouté à la ligne du 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. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
service_contract_lines.install_base_items_covered.Droit	Sys_id de l’enregistrement d’autorisation associé à l’élément de base d’installation. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
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. Situé dans la table Élément de base d’installation [sn_install_base_item]. Type de données : chaîne
service_contract_lines.install_base_items_covered.Enlevé	Date à laquelle la ligne de contrat de service associée termine 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. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
service_contract_lines.install_base_items_covered.sys_updated_by	Nom de l’utilisateur qui a mis à jour l’enregistrement de l’é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 dernière mise à jour de l’enregistrement de l’é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.product_model	Sys_id du produit associé à la ligne de contrat de service. Situé dans la table Modèle de produit [cmdb_model]. Type de données : chaîne
service_contract_lines.product_offering	Sys_id de l’enregistrement de l’offre de produit associé à la ligne de contrat de service. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
service_contract_lines.sold_product	Sys_id de l’enregistrement du produit vendu associé à la ligne de contrat de service. Situé dans la table Produit vendu [sn_install_base_sold_product]. Type de données : chaîne
service_contract_lines.sold_products_covered	Liste des produits couverts. Situé 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", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
service_contract_lines.sold_products_covered.Ajouté	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 Par défaut : date actuelle
service_contract_lines.sold_products_covered.Contrat	Sys_id de l’enregistrement du contrat de service associé au produit vendu couvert. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
service_contract_lines.sold_products_covered.Droit	Sys_id de l’enregistrement d’autorisation associé au produit vendu couvert. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
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 Par défaut : aucune date de fin
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. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
service_contract_lines.sold_products_covered.sold_product	Sys_id du produit couvert par l’autorisation. Situé dans la table Produit vendu [sn_install_base_sold_product]. Type de données : chaîne
service_contract_lines.sold_products_covered.sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement du produit vendu couvert. 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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
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 vendu couvert. 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 de service. Valeurs valides : (sensible à la casse) Actif annulé brouillon Expiré 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’un enregistrement de ligne de contrat de service. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
service_contract_lines.sys_updated_by	Nom de l’utilisateur qui a mis à jour l’enregistrement de ligne de contrat de service pour la dernière fois. Type de données : chaîne
service_contract_lines.sys_updated_on	Date et heure de dernière mise à jour de l’enregistrement de la 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. Situé 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", "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" } ]`
sold_products_covered.Ajouté	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. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
sold_products_covered.Droit	Sys_id de l’enregistrement d’autorisation associé au produit vendu couvert. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
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. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
sold_products_covered.sold_product	Sys_id du produit couvert par le contrat de service. Situé dans la table Produit vendu [sn_install_base_sold_product]. Type de données : chaîne
sold_products_covered.sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement du produit vendu couvert. 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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
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 vendu couvert. 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 Par défaut : Démarre dès qu’elle est approuvée.
État	État actuel du contrat de service. Valeurs valides : (sensible à la casse) Actif annulé brouillon Expiré Suspendu Type de données : chaîne
sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement du 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. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
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 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",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "sold_product": null,
                "starts": "2022-12-03",
                "ends": "",
                "product_offering": null,
                "product_model": null,
                "entitlements": [
                    {
                        "sys_id": "a8641d91d1f53110f8776589fa411fc0",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "entitlement_name": "ENTL",
                        "account": "4c325111d1f53110f8776589fa411f3d",
                        "consumer": null,
                        "household": null,
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "state": "active",
                        "product_offering": null,
                        "sold_entitlement": null,
                        "product": null,
                        "start_date": "2022-12-03",
                        "end_date": "",
                        "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_usages": [
                            {
                                "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",
                                "entitlement_characteristic": "a8641d91d1f53110f8776589fa411fd0",
                                "period_start": "2022-12-03",
                                "period_end": "",
                                "total_units": "5",
                                "used_units": "3"
                            }
                        ],
                        "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"
                            }
                        ]
                    }
                ],
                "sold_products_covered": [
                    {
                        "sys_id": "98641d91d1f53110f8776589fa411fbc",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "entitlement": null,
                        "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
                        "added": "2023-12-03",
                        "removed": "2023-12-03"
                    }
                ],
                "install_base_items_covered": [
                    {
                        "sys_id": "58641d91d1f53110f8776589fa411fbd",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "entitlement": null,
                        "install_base": "a1731551d1f53110f8776589fa411f8d",
                        "added": "2023-12-03",
                        "removed": "2023-12-03"
                    }
                ],
                "entitlement_characteristics": [
                    {
                        "sys_id": "e0641d91d1f53110f8776589fa411fbf",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "entitlement": null,
                        "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
                        "value": "5",
                        "characteristic": "63418db7539e61106bfcddeeff7b1238",
                        "type": "coverage"
                    }
                ]
            },
            {
                "sys_id": "e4641d91d1f53110f8776589fa411fd2",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "name": "CLI 2",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "sold_product": null,
                "starts": "2022-12-03",
                "ends": "",
                "product_offering": null,
                "product_model": null,
                "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 un enregistrement de ligne de contrat de service spécifié.

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]
Autorisation [service_entitlement]
Utilisation de l’autorisation [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/v1/servicecontract/contractline/{id}

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

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. 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 la ligne de contrat de service à récupérer. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne

Tableau 8. Paramètres de requête
Nom	Description
display_value	Type de données à renvoyer. Valeurs valides : false : renvoie la `valeur` de tous les champs. Par exemple, `« état » : « brouillon ».` true : renvoie la `display_value` pour tous les champs. Par exemple, `« état » : « Brouillon »` all : renvoie toutes les informations pour tous les champs. `"state": { "name": "state", "label": "State", "value": "draft", "display_value": "Draft", "type": "string" }` 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

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 une 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 de corps de réponse (JSON ou XML)


Nom	Description
Contrat	Sys_id du contrat de service associé à la ligne de contrat de service. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
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 associées à la ligne de contrat de service. Situé dans la table Autorisation [service_entitlement]. Type de données : tableau d’objets "entitlements": [ { "account": "String", "consumer": "String", "contract": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "entitlement_usages": [Array], "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "service_contract_line": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]
Droits.Compte	Sys_id de l’enregistrement de compte auquel l’autorisation appartient. Situé dans la table Compte [customer_account]. Type de données : chaîne
Droits.Consommateur	Sys_id de l’enregistrement de consommateur auquel l’autorisation appartient. Situé dans la table Consommateur [csm_consumer]. Type de données : chaîne
Droits.Contrat	Sys_id de l’enregistrement de contrat auquel l’autorisation appartient. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
Droits.end_date	Date de fin de l’autorisation. 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 à l’autorisation. Situé dans la table Caractéristique [sn_pss_core_entitlement_characteristic]. 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" } ]`
Droits.entitlement_characteristics. Caractéristique	Sys_id de l’enregistrement de caractéristique associé à l’autorisation. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
Droits.entitlement_characteristics.option_caractéristique	Sys_id de l’enregistrement de l’option de caractéristique associée à l’autorisation. Situé dans la table Option de caractéristique [sn_prd_pm_characteristic_option]. Type de données : chaîne
Droits.entitlement_characteristics.Droit	Sys_id de l’enregistrement d’autorisation associé. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
Droits.entitlement_characteristics.service_contract_line	Sys_id de l’enregistrement de la ligne de contrat de service associé à la caractéristique d’autorisation. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
Droits.entitlement_characteristics.sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement des caractéristiques de l’autorisation. Type de données : chaîne
Droits.entitlement_characteristics.sys_created_on	Date et heure de création de l’enregistrement des caractéristiques de l’autorisation. Type de données : chaîne
Droits.entitlement_characteristics.sys_id	Sys_id de l’enregistrement des caractéristiques de l’autorisation. 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 d’autorisation pour la dernière fois. Type de données : chaîne
Droits.entitlement_characteristics.sys_updated_on	Date et heure de dernière mise à jour de l’enregistrement des caractéristiques d’autorisation. Type de données : chaîne
Droits.entitlement_characteristics.type	Type de caractéristique d’autorisation. Valeurs valides : Couverture Couverture et utilisation Type de données : chaîne
Droits.entitlement_characteristics.value	Valeur de la caractéristique. Type de données : chaîne
Droits.entitlement_name	Nom de l’autorisation. Type de données : chaîne
Droits.entitlement_usages	Liste des valeurs d’utilisation du produit associé. Type de données : tableau d’objets `"entitlement_usages": [ { "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" } ]`
Droits.entitlement_usages.Droit	Sys_id de l’enregistrement d’autorisation associé à l’utilisation de l’autorisation. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
Droits.entitlement_usages.entitlement_characteristic	Sys_id de l’enregistrement de la caractéristique d’autorisation associé à l’utilisation de l’autorisation. Situé dans la table Caractéristique [sn_pss_core_entitlement_characteristic]. Type de données : chaîne
Droits.entitlement_usages.period_end	Date de fin lorsque l’utilisation de l’autorisation n’est plus suivie. Type de données : chaîne Format : aaaa-mm-jj
Droits.entitlement_usages.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_usages.sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement d’utilisation d’autorisation. Type de données : chaîne
Droits.entitlement_usages.sys_created_on	Date et heure de création de l’enregistrement d’utilisation de l’autorisation. Type de données : chaîne
Droits.entitlement_usages.sys_id	Sys_id de l’enregistrement d’utilisation de l’autorisation. Situé dans la table Utilisation de l’autorisation [sn_pss_core_entitlement_usage]. Type de données : chaîne
Droits.entitlement_usages.sys_updated_by	Nom de l’utilisateur qui a mis à jour l’enregistrement d’utilisation d’autorisation pour la dernière fois. Type de données : chaîne
Droits.entitlement_usages.sys_updated_on	Date et heure de dernière mise à jour de l’enregistrement d’utilisation de l’autorisation. Type de données : chaîne
Droits.entitlement_usages.total_units	Nombre total d’unités achetées. Type de données : chaîne
Droits.entitlement_usages.used_units	Nombre d’unités utilisées. Type de données : chaîne
Droits.Ménage	Sys_id de l’enregistrement de ménage associé à l’autorisation. Situé dans la table Ménage [csm_household]. Type de données : chaîne
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.Ajouté	Date à laquelle l’élément de base d’installation associé a été ajouté à l’autorisation. 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. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
Droits.install_base_items_covered.Droit	Sys_id de l’enregistrement d’autorisation associé à l’élément de base d’installation. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
Droits.install_base_items_covered.install_base	Sys_id de l’enregistrement d’élément de base d’installation associé. Situé dans la table Élément de base d’installation [sn_install_base_item]. Type de données : chaîne
Droits.install_base_items_covered.Enlevé	Date à laquelle l’élément de base d’installation associé a été supprimé de l’autorisation. 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. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
Droits.install_base_items_covered.sys_updated_by	Nom de l’utilisateur qui a mis à jour l’enregistrement de l’é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 dernière mise à jour de l’enregistrement de l’é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. Situé dans la table Modèle de produit [cmdb_model]. Type de données : chaîne
Droits.product_offering	Sys_id de l’enregistrement de l’offre de produit associé à l’autorisation. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
Droits.service_contract_line	Sys_id de l’enregistrement de la ligne de contrat de service associé à l’autorisation. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
Droits.sold_entitlement	Sys_id de l’enregistrement du produit vendu associé à l’autorisation. Situé dans la table Produit vendu [sn_install_base_sold_product]. Type de données : chaîne
Droits.sold_products_covered	Liste des produits couverts. Situé 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", "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" } ]`
Droits.sold_products_covered.Ajouté	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. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
Droits.sold_products_covered.Droit	Sys_id de l’enregistrement d’autorisation associé au produit vendu couvert. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
Droits.sold_products_covered.supprimé	Date à laquelle le produit vendu associé a été supprimé 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. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
Droits.sold_products_covered.sold_product	Sys_id du produit couvert par l’autorisation. Situé dans la table Produit vendu [sn_install_base_sold_product]. Type de données : chaîne
Droits.sold_products_covered.sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement du produit vendu couvert. 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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
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 vendu couvert. Type de données : chaîne
Droits.start_date	Date de début de l’autorisation. Type de données : chaîne Format : aaaa-mm-jj
Droits.État	État actuel de l’autorisation. Valeurs valides : (sensible à la casse) Actif annulé brouillon Expiré 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 d’autorisation associé. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
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 d’autorisation associées à la ligne de contrat de service. Situé dans la table Caractéristique [sn_pss_core_entitlement_characteristic]. 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" } ]`
entitlement_characteristics.Caractéristique	Sys_id de l’enregistrement de caractéristique associé à l’autorisation. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
entitlement_characteristics.characteristic_option	Sys_id de l’enregistrement de l’option de caractéristique associée à l’autorisation. Situé dans la table Option de caractéristique [sn_prd_pm_characteristic_option]. Type de données : chaîne
entitlement_characteristics.Droit	Sys_id de l’enregistrement d’autorisation. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
entitlement_characteristics.service_contract_line	Sys_id de l’enregistrement de la ligne de contrat de service associé à la caractéristique d’autorisation. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
entitlement_characteristics.sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement des caractéristiques de l’autorisation. Type de données : chaîne
entitlement_characteristics.sys_created_on	Date et heure de création de l’enregistrement des caractéristiques de l’autorisation. Type de données : chaîne
entitlement_characteristics.sys_id	Sys_id de l’enregistrement des caractéristiques de l’autorisation. Type de données : chaîne
entitlement_characteristics.sys_updated_by	Nom de l’utilisateur qui a mis à jour l’enregistrement des caractéristiques d’autorisation pour la dernière fois. Type de données : chaîne
entitlement_characteristics.sys_updated_on	Date et heure de dernière mise à jour de l’enregistrement des caractéristiques d’autorisation. Type de données : chaîne
entitlement_characteristics.Type	Type de caractéristique d’autorisation. Valeurs valides : Couverture Couverture et utilisation 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. Situé 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", "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.Ajouté	Date à laquelle l’élément de base d’installation associé a été ajouté à la ligne du 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. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
install_base_items_covered.Droit	Sys_id de l’enregistrement d’autorisation associé à l’élément de base d’installation. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
install_base_items_covered.install_base	Sys_id de l’élément de base d’installation couvert par la ligne de contrat de service. Situé dans la table Élément de base d’installation [sn_install_base_item]. Type de données : chaîne
install_base_items_covered.Enlevé	Date à laquelle la ligne de contrat de service associée termine 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. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
install_base_items_covered.sys_updated_by	Nom de l’utilisateur qui a mis à jour l’enregistrement de l’é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 dernière mise à jour de l’enregistrement de l’é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
product_model	Sys_id du produit associé à la ligne de contrat de service. Situé dans la table Modèle de produit [cmdb_model]. Type de données : chaîne
product_offering	Sys_id de l’enregistrement de l’offre de produit associé à la ligne de contrat de service. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
sold_product	Sys_id de l’enregistrement du produit vendu associé à la ligne de contrat de service. Situé dans la table Produit vendu [sn_install_base_sold_product]. Type de données : chaîne
sold_products_covered	Liste des produits couverts. Situé 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", "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" } ]`
sold_products_covered.Ajouté	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 Par défaut : date actuelle
sold_products_covered.Contrat	Sys_id de l’enregistrement du contrat de service associé au produit vendu couvert. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
sold_products_covered.Droit	Sys_id de l’enregistrement d’autorisation associé au produit vendu couvert. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
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 Par défaut : aucune date de fin
sold_products_covered.service_contract_line	Sys_id de l’enregistrement de ligne de contrat de service associé au produit vendu couvert. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
sold_products_covered.sold_product	Sys_id du produit couvert par l’autorisation. Situé dans la table Produit vendu [sn_install_base_sold_product]. Type de données : chaîne
sold_products_covered.sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement du produit vendu couvert. 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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
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 vendu couvert. 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 de service. Valeurs valides : (sensible à la casse) Actif annulé brouillon Expiré 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’un enregistrement de ligne de contrat de service. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne
sys_updated_by	Nom de l’utilisateur qui a mis à jour l’enregistrement de ligne de contrat de service pour la dernière fois. Type de données : chaîne
sys_updated_on	Date et heure de dernière mise à jour de l’enregistrement de la 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",
    "contract": "a4b415d1d1f53110f8776589fa411f20",
    "sold_product": null,
    "starts": "2022-12-03",
    "ends": "",
    "product_offering": null,
    "product_model": null,
    "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"
      }
    ],
    "entitlements": [
      {
        "sys_id": "16e419d1d1f53110f8776589fa411f3c",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:48",
        "sys_updated_on": "2023-10-09 11:29:48",
        "entitlement_name": "ENTL 2",
        "account": "4c325111d1f53110f8776589fa411f3d",
        "consumer": null,
        "household": null,
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "state": "active",
        "product_offering": null,
        "sold_entitlement": null,
        "product": null,
        "start_date": "2022-12-03",
        "end_date": "",
        "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_usages": [
          {
            "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",
            "entitlement_characteristic": "1ae419d1d1f53110f8776589fa411f3e",
            "period_start": "2022-12-03",
            "period_end": "",
            "total_units": "5",
            "used_units": "2"
          }
        ],
        "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": []
      },
      {
        "sys_id": "9ee451d1d1f53110f8776589fa411f83",
        "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 1",
        "account": "4c325111d1f53110f8776589fa411f3d",
        "consumer": null,
        "household": null,
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "state": "active",
        "product_offering": null,
        "sold_entitlement": null,
        "product": null,
        "start_date": "2022-12-03",
        "end_date": "",
        "entitlement_characteristics": [
          {
            "sys_id": "92e451d1d1f53110f8776589fa411f86",
            "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": "9ee451d1d1f53110f8776589fa411f83",
            "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
            "value": "5",
            "characteristic": "63418db7539e61106bfcddeeff7b1238",
            "type": "coverage_and_usage"
          }
        ],
        "entitlement_usages": [
          {
            "sys_id": "dee451d1d1f53110f8776589fa411f86",
            "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": "9ee451d1d1f53110f8776589fa411f83",
            "entitlement_characteristic": "92e451d1d1f53110f8776589fa411f86",
            "period_start": "2022-12-03",
            "period_end": "",
            "total_units": "5",
            "used_units": "3"
          }
        ],
        "sold_products_covered": [
          {
            "sys_id": "92e451d1d1f53110f8776589fa411f85",
            "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": "9ee451d1d1f53110f8776589fa411f83",
            "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
            "added": "",
            "removed": ""
          }
        ],
        "install_base_items_covered": []
      }
    ]
  } 
}

Contrat de service - POST /sn_pss_core/servicecontract

Crée un enregistrement de contrat de service à partir d’une charge utile spécifiée.

L’API Service Contract stocke les données dans différentes tables. Voici la liste des tables dans lesquelles les 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]
Autorisation [service_entitlement]
Utilisation de l’autorisation [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 des 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/v1/servicecontract

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

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. 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 consumer paramètre n’est pas spécifié. Sys_id de l’enregistrement de compte auquel le contrat de service appartient. Situé dans la table Compte [customer_account]. Type de données : chaîne
consommateur	Requis si le account paramètre n’est pas spécifié. Sys_id de l’enregistrement consommateur auquel le contrat de service appartient. Situé dans la table Consommateur [csm_consumer]. Type de données : chaîne
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. Situé dans le ménage [csm_household]. Type de données : chaîne Valeur par défaut : null (aucun ménage)
install_base_items_covered	Liste des éléments de base d’installation 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]. 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" } ]`
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 d’élément de base d’installation associé. Situé dans la table Élément de base d’installation [sn_install_base_item]. Type de données : chaîne
install_base_items_covered.Enlevé	Date à laquelle le contrat de service associé termine 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. Ces données sont insérées dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : tableau d’objets `"service_contract_lines": [ { "ends": "String", "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "product_model": "String", "product_offering": "String", "sold_product": "String", "sold_products_covered": [Array], "starts": "String", "state": "String" } ]`
service_contract_lines.Fin	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. Autorisations	Liste des autorisations à associer au contrat de service. Ces autorisations sont insérées dans la table Autorisation [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", "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. Situé dans la table Compte [customer_account]. Type de données : chaîne
service_contract_lines.Droits.Consommateur	Sys_id de l’enregistrement de consommateur auquel l’autorisation appartient. Situé dans la table Consommateur [csm_consumer]. Type de données : chaîne
service_contract_lines.Droits.end_date	Date de fin de l’autorisation. 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 à l’autorisation. Les données de ce tableau sont insérées dans la table Caractéristique [sn_pss_core_entitlement_characteristic]. Type de données : tableau d’objets `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]`
service_contract_lines.Droits.entitlement_characteristics. Caractéristique	Requis. Sys_id de l’enregistrement de caractéristique associé à l’autorisation. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
service_contract_lines.Droits.entitlement_characteristics.option_caractéristique	Sys_id de l’enregistrement de l’option de caractéristique associée à l’autorisation. Situé dans la table Option de caractéristique [sn_prd_pm_characteristic_option]. Type de données : chaîne
service_contract_lines.Droits.entitlement_characteristics.entitlement_usage	Valeur d’unité utilisée pour la caractéristique d’autorisation associée. Ces données sont insérées dans la table Utilisation de l’autorisation [sn_pss_core_entitlement_usage]. Ne transmettez ce paramètre que si les entitlement_characteristics sont soumis à l’autorisation. Type de données : objet `"entitlement_usage": { "usage_units": "String" }`
service_contract_lines.Droits.entitlement_characteristics.entitlement_usage.usage_units	Utilisation de la caractéristique d’autorisation associée. Type de données : chaîne
service_contract_lines.Droits.entitlement_characteristics.type	Type de caractéristique d’autorisation. Valeurs valides : Couverture Couverture et utilisation Type de données : chaîne
service_contract_lines.Droits.entitlement_characteristics.value	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 de l’autorisation. Type de données : chaîne
service_contract_lines.Droits.Ménage	Transmis uniquement lorsque les modules d’extension de ménage sont actifs et que le consumer paramètre est transmis. Sys_id de l’enregistrement de ménage associé à l’autorisation. Situé dans la table Ménage [csm_household]. Type de données : chaîne
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", "removed": "String" } ]`
service_contract_lines.Droits.install_base_items_covered.Ajouté	Date à laquelle l’élément de base d’installation 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.install_base_items_covered.Enlevé	Date à laquelle l’élément de base d’installation associé a été supprimé de l’autorisation. 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. Situé dans la table Modèle de produit [cmdb_model]. Type de données : chaîne
service_contract_lines.Droits.product_offering	Sys_id de l’enregistrement de l’offre de produit associé à l’autorisation. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
service_contract_lines.Droits.sold_entitlement	Sys_id de l’enregistrement du produit vendu associé à l’autorisation. Situé dans la table Produit vendu [sn_install_base_sold_product]. Type de données : chaîne
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" } ]`
service_contract_lines.Droits.sold_products_covered.Ajouté	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é supprimé de l’autorisation. Type de données : chaîne Format : aaaa-mm-jj Par défaut : aucune date de fin
service_contract_lines.Droits.start_date	Requis. Date de début de l’autorisation. Type de données : chaîne Format : aaaa-mm-jj
service_contract_lines.Droits.État	Requis. État actuel de l’autorisation. Valeurs valides : (sensible à la casse) Actif annulé brouillon Expiré Suspendu Type de données : chaîne
service_contract_lines.entitlement_characteristics	Liste des caractéristiques associées à la ligne de contrat de service. Les données de ce tableau sont insérées dans la table Caractéristique [sn_pss_core_entitlement_characteristic]. Type de données : tableau d’objets `"entitlement_characteristics" [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]`
service_contract_lines.entitlement_characteristics. Caractéristique	Requis. Sys_id de l’enregistrement caractéristique associé à la ligne de contrat de service. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
service_contract_lines.entitlement_characteristics.option_caractéristique	Sys_id de l’enregistrement de l’option de caractéristique associée à la ligne de contrat de service. Situé dans la table Option de caractéristique [sn_prd_pm_characteristic_option]. Type de données : chaîne
service_contract_lines.entitlement_characteristics.entitlement_usage	Valeur d’unité utilisée pour la caractéristique de ligne de contrat de service associée. Ces données sont insérées dans la table Utilisation de l’autorisation [sn_pss_core_entitlement_usage]. Type de données : objet `"entitlement_usage": { "usage_units": "String" }`
service_contract_lines.entitlement_characteristics.entitlement_usage.usage_units	Utilisation de la caractéristique d’autorisation associée. Type de données : chaîne
service_contract_lines.entitlement_characteristics.type	Type de caractéristique de la ligne de contrat de service. Valeurs valides : Couverture Couverture et utilisation Type de données : chaîne
service_contract_lines.entitlement_characteristics.value	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. 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 `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]`
service_contract_lines.install_base_items_covered.Ajouté	Date à laquelle l’élément de base d’installation associé a été ajouté à la ligne du 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. Situé dans la table Élément de base d’installation [sn_install_base_item]. Type de données : chaîne
service_contract_lines.install_base_items_covered.Enlevé	Date à laquelle la ligne de contrat de service associée termine 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. Situé dans la table Modèle de produit [cmdb_model]. Type de données : chaîne
service_contract_lines.product_offering	Sys_id de l’enregistrement de l’offre de produit associé à la ligne de contrat de service. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
service_contract_lines.sold_product	Sys_id de l’enregistrement du produit vendu associé à la ligne de contrat de service. Situé dans la table Produit vendu [sn_install_base_sold_product]. Type de données : chaîne
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.Ajouté	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ée termine 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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
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 de service. Valeurs valides : (sensible à la casse) Actif annulé brouillon Expiré 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 install_base_items_covered paramètre n’est 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é termine 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_soldé	Sys_id du produit couvert par le contrat de service. Situé dans la table Produit vendu [sn_install_base_sold_product]. Type de données : chaîne
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 : (sensible à la casse) Actif annulé brouillon Expiré Suspendu 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

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 une 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 de corps de 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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. 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 associées au contrat de service. Type de données : tableau d’objets `"service_contract_lines": [ { "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "sold_products_covered": [Array], "sys_id": "String" } ]`
service_contract_lines.Droits	Liste des autorisations associées 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 de l’autorisation. Type de données : chaîne
service_contract_lines.Droits.entitlement_characteristics	Liste des objets de caractéristique de l’autorisation créés en vertu de l’autorisation. 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 de l’autorisation 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 d’utilisation de l’autorisation. Situé dans la table Utilisation de l’autorisation [sn_pss_core_entitlement_usage]. Type de données : chaîne
service_contract_lines.Droits.entitlement_characteristics.sys_id	Sys_id d’un enregistrement des caractéristiques de l’autorisation associé à la ligne de contrat de service. Situé dans la table Caractéristique [sn_pss_core_entitlement_characteristic]. Type de données : chaîne
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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
service_contract_lines.Droits.sold_products_covered	Liste des sys_ids des produits couverts par l’autorisation. 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 couvert par l’autorisation. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
service_contract_lines.Droits.sys_id	Sys_id de l’enregistrement d’autorisation associé à la ligne de contrat de service. Situé dans la table Autorisation [service_entitlement]. 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 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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
sys_id	Sys_id de l’enregistrement du contrat de service. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne

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",
  "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"
    }
  ],
  "service_contract_lines": [
    {
      "state": "active",
      "name": "CLI",
      "starts": "2022-12-03",
      "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"
        }
      ],
      "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"
              }
            }
          ]
        }
      ],
      "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"
        }
      ]
    }
  ]
} 
--user "username":"password"

Réponse :

{ 
  "result": {
    "sys_id": "d8641151d1f53110f8776589fa411fde",
    "number": "CNTR0010004",
    "short_description": null,
    "sold_products_covered": [
      {
        "sys_id": "9c641d91d1f53110f8776589fa411fb9"
      }
    ], 
    "install_base_items_covered": [
      {
        "sys_id": "d8641d91d1f53110f8776589fa411fba"
      }
    ],
    "service_contract_lines": [
      {
        "sys_id": "d4641d91d1f53110f8776589fa411fbb",
        "name": "CLI",
        "sold_products_covered": [
          {
            "sys_id": "98641d91d1f53110f8776589fa411fbc"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "58641d91d1f53110f8776589fa411fbd"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "e0641d91d1f53110f8776589fa411fbf",
            "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"
                }
              }
            ]
          }
        ]
      },
      {
        "sys_id": "e4641d91d1f53110f8776589fa411fd2",
        "name": "CLI 2",
        "sold_products_covered": [
          {
            "sys_id": "e8641d91d1f53110f8776589fa411fd3"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fd4"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fd5",
            "entitlement_usage": {}
          }
        ],
        "entitlements": []
      }
    ]
  }
}

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]
Autorisation [service_entitlement]
Utilisation de l’autorisation [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/v1/servicecontract/contractline

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

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. 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
Contrat	Requis. Sys_id du contrat de service associé à la ligne de contrat de service. Situé dans la table Contrat de service [sn_pss_core_service_contract]. Type de données : chaîne
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 au contrat de service. Ces autorisations sont insérées dans la table Autorisation [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", "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. Situé dans la table Compte [customer_account]. Type de données : chaîne
Droits.Consommateur	Requis si le paramètre n’est account pas transmis. Sys_id de l’enregistrement de consommateur auquel l’autorisation appartient. Situé dans la table Consommateur [csm_consumer]. Type de données : chaîne
Droits.end_date	Date de fin de l’autorisation. 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 à l’autorisation. Les données de ce tableau sont insérées dans la table Caractéristique [sn_pss_core_entitlement_characteristic]. Type de données : tableau d’objets `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]`
Droits.entitlement_characteristics. Caractéristique	Requis. Sys_id de l’enregistrement de caractéristique associé à l’autorisation. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
Droits.entitlement_characteristics.option_caractéristique	Sys_id de l’enregistrement de l’option de caractéristique associée à l’autorisation. Situé dans la table Option de caractéristique [sn_prd_pm_characteristic_option]. Type de données : chaîne
Droits.entitlement_characteristics.entitlement_usage	Valeur d’unité utilisée pour la caractéristique d’autorisation associée. Ces données sont insérées dans la table Utilisation de l’autorisation [sn_pss_core_entitlement_usage]. Ne transmettez ce paramètre que si les entitlement_characteristics sont soumis à l’autorisation. Type de données : objet `"entitlement_usage": { "usage_units": "String" }`
Droits.entitlement_characteristics.entitlement_usage.usage_units	Utilisation de la caractéristique d’autorisation associée. Type de données : chaîne
Droits.entitlement_characteristics.type	Type de caractéristique d’autorisation. Valeurs valides : Couverture Couverture et utilisation Type de données : chaîne
Droits.entitlement_characteristics.value	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 de l’autorisation. Type de données : chaîne
Droits.Ménage	Transmis uniquement lorsque les modules d’extension de ménage sont actifs et que le consumer paramètre est transmis. Sys_id de l’enregistrement de ménage associé à l’autorisation. Situé dans la table Ménage [csm_household]. Type de données : chaîne
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", "removed": "String" } ]`
Droits.install_base_items_covered.Ajouté	Date à laquelle l’élément de base d’installation associé a été ajouté à l’autorisation. 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é de l’autorisation. 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. Situé dans la table Modèle de produit [cmdb_model]. Type de données : chaîne
Droits.product_offering	Sys_id de l’enregistrement de l’offre de produit associé à l’autorisation. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
Droits.sold_entitlement	Sys_id de l’enregistrement du produit vendu associé à l’autorisation. Situé dans la table Produit vendu [sn_install_base_sold_product]. Type de données : chaîne
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" } ]`
Droits.sold_products_covered.Ajouté	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é supprimé de l’autorisation. Type de données : chaîne Format : aaaa-mm-jj Par défaut : aucune date de fin
Droits.start_date	Requis. Date de début de l’autorisation. Type de données : chaîne Format : aaaa-mm-jj
Droits.État	Requis. État actuel de l’autorisation. Valeurs valides : (sensible à la casse) Actif annulé brouillon Expiré Suspendu Type de données : chaîne
entitlement_characteristics	Liste des caractéristiques associées à la ligne de contrat de service. Les données de ce tableau sont insérées dans la table Caractéristique [sn_pss_core_entitlement_characteristic]. Type de données : tableau d’objets `"entitlement_characteristics" [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]`
entitlement_characteristics.Caractéristique	Requis. Sys_id de l’enregistrement caractéristique associé à la ligne de contrat de service. Situé dans la table Caractéristique [sn_prd_pm_characteristic]. Type de données : chaîne
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 `choice`. Sys_id de l’enregistrement de l’option de caractéristique associée à la ligne de contrat de service. Situé dans la table Option de caractéristique [sn_prd_pm_characteristic_option]. Type de données : chaîne
entitlement_characteristics.entitlement_usage	Valeur d’unité utilisée pour la caractéristique de ligne de contrat de service associée. Ces données sont insérées dans la table Utilisation de l’autorisation [sn_pss_core_entitlement_usage]. Type de données : objet `"entitlement_usage": { "usage_units": "String" }`
entitlement_characteristics.entitlement_usage.used_units	Utilisation de la caractéristique d’autorisation associée. Type de données : chaîne
entitlement_characteristics.Type	Type de caractéristique de la ligne de contrat de service. Valeurs valides : Couverture Couverture et utilisation 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. 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 `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]`
install_base_items_covered.Ajouté	Date à laquelle l’élément de base d’installation associé a été ajouté à la ligne du 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. Situé dans la table Élément de base d’installation [sn_install_base_item]. Type de données : chaîne
install_base_items_covered.Enlevé	Date à laquelle la ligne de contrat de service associée termine 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
product_model	Sys_id du produit associé à la ligne de contrat de service. Situé dans la table Modèle de produit [cmdb_model]. Type de données : chaîne
product_offering	Sys_id de l’enregistrement de l’offre de produit associé à la ligne de contrat de service. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
sold_product	Sys_id de l’enregistrement du produit vendu associé à la ligne de contrat de service. Situé dans la table Produit vendu [sn_install_base_sold_product]. Type de données : chaîne
sold_product_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 Produits vendus couverts [sn_install_base_m2m_contract_sold_product].
sold_product_covered.Ajouté	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_product_covered.Enlevé	Date à laquelle la ligne de contrat de service associée termine la couverture du produit associé. Type de données : chaîne Format : aaaa-mm-jj Par défaut : aucune date de fin
sold_product_covered.sold_product	Sys_id d’un produit associé à la ligne de contrat de service. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
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 de service. Valeurs valides : (sensible à la casse) Actif annulé brouillon Expiré Suspendu Type de données : chaîne

En-têtes

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 une 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 de corps de réponse (JSON ou XML)


Nom	Description
Droits	Liste des autorisations associées à 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éristique de l’autorisation créés en vertu de l’autorisation. Type de données : tableau d’objets `"entitlement_characteristics" [ { "entitlement_usage": {Object}, "sys_id": "String" } ]`
Droits.entitlement_characteristics.entitlement_usage	Objet d’utilisation de l’autorisation 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 d’utilisation de l’autorisation. Situé dans la table Utilisation de l’autorisation [sn_pss_core_entitlement_usage]. Type de données : chaîne
Droits.entitlement_characteristics.sys_id	Sys_id de l’enregistrement des caractéristiques de l’autorisation. Type de données : chaîne
Droits.entitlement_name	Nom de l’autorisation. 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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
Droits.sold_products_covered	Liste des sys_ids des produits couverts par l’autorisation. Type de données : tableau d’objets `"sold_products_covered": [ { "sys_id": "String" } ]`
Droits.sold_products_covered.sys_id	Sys_id d’un produit couvert par l’autorisation. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
Droits.sys_id	Sys_id de l’enregistrement d’autorisation associé à la ligne de contrat de service. Situé dans la table Autorisation [service_entitlement]. Type de données : chaîne
entitlement_characteristics	Liste des objets de caractéristique d’autorisation 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 de l’autorisation 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 d’utilisation de l’autorisation. Situé dans la table Utilisation de l’autorisation [sn_pss_core_entitlement_usage]. Type de données : chaîne
entitlement_characteristics.sys_id	Sys_id de l’enregistrement des caractéristiques de l’autorisation. 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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
nom	Nom de la ligne de contrat de service. 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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : chaîne
sys_id	Sys_id d’un enregistrement de ligne de contrat de service. Situé dans la table Ligne de contrat de service [sn_pss_core_service_contract_line]. Type de données : chaîne

Demande cURL

Voici un exemple de code qui 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",
  "name": "CLI",
  "starts": "2022-12-03",
  "sold_products_covered": [
    {
      "sold_product": "0df21151d1f53110f8776589fa411f1b",
      "added": "2023-12-03",
      "removed": "2023-12-03"
    }
  ],
  "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"
          }
        }
      ]
    },
    {
      "state": "active",
      "entitlement_name": "ENTL 2",
      "start_date": "2022-12-03",
      "sold_products_covered": [
        {
          "sold_product": "da23d151d1f53110f8776589fa411f27"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage_and_usage",
          "entitlement_usage": {
            "used_units": "2"
          }
        }
      ]
    }
  ],
  "entitlement_characteristics": [
    {
      "characteristic": "63418db7539e61106bfcddeeff7b1238",
      "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
      "value": "tyfy6h",
      "type": "coverage"
    }
  ]
}

Réponse :

{
  "result": {
    "sys_id": "16e451d1d1f53110f8776589fa411f80",
    "name": "CLI",
    "sold_products_covered": [
      {
        "sys_id": "5ae451d1d1f53110f8776589fa411f81"
      }
    ],
    "install_base_items_covered": [],
    "entitlement_characteristics": [
      {
        "sys_id": "dae451d1d1f53110f8776589fa411f82",
        "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" 
            }
          }
        ]
      },
      {
        "sys_id": "16e419d1d1f53110f8776589fa411f3c",
        "entitlement_name": "ENTL 2",
        "sold_products_covered": [
          {
            "sys_id": "1ae419d1d1f53110f8776589fa411f3d"
          }
        ],
        "install_base_items_covered": [],
        "entitlement_characteristics": [
          {
            "sys_id": "1ae419d1d1f53110f8776589fa411f3e", 
            "entitlement_usage": {
              "sys_id": "56e419d1d1f53110f8776589fa411f3f"
            }
          }
        ]
      }
    ]
  } 
}