API de droit

L’API Entitlement fournit des points de terminaison permettant de créer et de récupérer des enregistrements d’autorisation à partir d’une instance.

Les vérifications des autorisations s’effectuent dans le cadre des services d’assistance après-vente destinés aux clients qui achètent un produit, tel qu’un appareil ou un ordinateur. Les vérifications des autorisations sont effectuées par des agents pour déterminer les services que les clients peuvent recevoir pour les produits qu’ils ont achetés. Utilisez l’API Entitlement pour définir et récupérer les droits.

Cette API accède aux données et les stocke dans les tables suivantes :

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

Pour accéder à cette API, les modules d’extension suivants doivent être activés sur l’instance associée :

• Contrats clients et droits (com.sn_pss_core)
• Customer Service Install Base Management (com.snc.install_base)
• Gestion du catalogue de produits Core (com.sn_prd_pm)

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

Droit : GET /sn_pss_core/entitlement/{id}

Retourne l’enregistrement d’autorisation spécifié, sa couverture associée et les détails de sa dernière utilisation.

Voici la liste des tables dans lesquelles les données d’autorisation sont stockées :

• Caractéristiques [sn_pss_core_entitlement_characteristic]
• Droit [service_entitlement]
• Utilisation du droit [sn_pss_core_entitlement_usage]
• Produit vendu couvert [sn_install_base_m2m_contract_sold_product] : ce tableau contient des informations sur les produits vendus couverts et les éléments de base d’installation couverts.

Format d'URL

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

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

Remarque :

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

Paramètres de demande pris en charge

Tableau 1. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
id	Sys_id de l’enregistrement d’autorisation à récupérer. Type de données : chaîne Table : Droit [service_entitlement]

Tableau 2. Paramètres de requête

Nom	Description
display_value	Type de données à renvoyer. Valeurs valides : faux : renvoie la valeur de tous les champs. Par exemple, « state » :"draft ». vrai : renvoie la display_value pour tous les champs. Par exemple, « state » : « Brouillon » all : renvoie toutes les informations pour tous les champs. Type de données : chaîne Valeur par défaut : false

Tableau 3. Paramètres du corps de la demande (JSON)

Nom	Description
Aucun

En-têtes

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

Tableau 4. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

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

En-tête	Description
Aucun

Codes d'état

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

Tableau 6. Codes d'état

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

Paramètres du corps de réponse

Nom	Description
compte	Sys_id de l’enregistrement de compte auquel l’autorisation appartient. Type de données : chaîne Table : Compte [customer_account]
consommateur	Sys_id de l’enregistrement de consommateur auquel l’autorisation appartient. Type de données : chaîne Table : Consommateur [csm_consumer]
contrat	Sys_id de l’enregistrement du contrat auquel l’autorisation appartient. Type de données : chaîne Table : Contrat de service [sn_pss_core_service_contract]
end_date	Date de fin du droit. Type de données : chaîne Format : aaaa-mm-jj Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.
entitlement_characteristics	Liste des caractéristiques associées au droit. Type de données : tableau d’objets "entitlement_characteristics" [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "entitlement_usage": [Array], "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "type": "String", "value": "String" } ] Stocké dans : Caractéristique [sn_pss_core_entitlement_characteristic]
entitlement_characteristics.caractéristique	Sys_id de l’enregistrement de caractéristique associé à l’autorisation. Type de données : chaîne Table : Caractéristique [sn_prd_pm_characteristic]
entitlement_characteristics.characteristic_option	Sys_id de l’enregistrement de l’option de caractéristique associé au droit. Type de données : chaîne Table : Option de la caractéristique [sn_prd_pm_characteristic_option]
entitlement_characteristics.droit	Sys_id de l’enregistrement de l’autorisation associé. Type de données : chaîne Table : Droit [service_entitlement]
entitlement_characteristics.entitlement_usage	Liste des utilisations de droit associées à la caractéristique du droit. Type de données : tableau d’objets "entitlement_usage": [ { "entitlement": "String", "entitlement_characteristic": "String", "period_end": "String", "period_start": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "total_units": "String", "used_units": "String" } ]
entitlement_characteristics.entitlement_usage.droit	Sys_id de l’enregistrement d’autorisation associé à l’utilisation de l’autorisation. Type de données : chaîne Table : Droit [service_entitlement]
entitlement_characteristics.entitlement_usage.entitlement_characteristic	Sys_id de l’enregistrement des caractéristiques du droit associé à l’utilisation du droit. Type de données : chaîne Table : Caractéristique [sn_pss_core_entitlement_characteristic]
entitlement_characteristics.entitlement_usage.period_end	Date de fin à laquelle l’utilisation du droit n’est plus suivie. Type de données : chaîne Format : aaaa-mm-jj
entitlement_characteristics.entitlement_usage.period_start	Date de début du suivi de l’utilisation de l’autorisation. Type de données : chaîne Format : aaaa-mm-jj
entitlement_characteristics.entitlement_usage.service_contract_line	Sys_id de la ligne de contrat de service à laquelle l’utilisation actuelle du droit appartient. Type de données : chaîne
entitlement_characteristics.entitlement_usage.sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement d’utilisation du droit. Type de données : chaîne
entitlement_characteristics.entitlement_usage.sys_created_on	Date et heure de création de l’enregistrement d’utilisation du droit. Type de données : chaîne
entitlement_characteristics.entitlement_usage.sys_id	Sys_id de l’enregistrement de l’utilisation du droit. Type de données : chaîne Table : Utilisation du droit [sn_pss_core_entitlement_usage]
entitlement_characteristics.entitlement_usage.sys_updated_by	Nom de l’utilisateur qui a mis à jour l’enregistrement d’utilisation du droit pour la dernière fois. Type de données : chaîne
entitlement_characteristics.entitlement_usage.sys_updated_on	Date et heure de la dernière mise à jour de l’enregistrement d’utilisation du droit. Type de données : chaîne
entitlement_characteristics.entitlement_usage.total_units	Valeur totale de la couverture de la caractéristique du droit associée. Type de données : chaîne
entitlement_characteristics.entitlement_usage.used_units	Nombre d’unités utilisées par le compte ou le consommateur entre le period_start et le period_end. Type de données : chaîne
entitlement_characteristics.type	Type de caractéristique du droit. Valeurs valides : couverture coverage_and_usage Type de données : chaîne
entitlement_characteristics.valeur	Valeur de la caractéristique. Type de données : chaîne
entitlement_name	Nom du droit. Type de données : chaîne
household​	Sys_id de l’enregistrement du ménage associé à l’autorisation. Type de données : chaîne Tableau : Ménage [csm_household]
install_base_items_covered	Liste des éléments de base d’installation couverts par l’autorisation. Type de données : tableau d’objets "install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ] Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]
install_base_items_covered.supplémentaire	Date à laquelle l’élément de base d’installation associé a été ajouté au droit. Type de données : chaîne
install_base_items_covered.contrat	Sys_id de l’enregistrement du contrat de service associé à l’élément de base d’installation. Type de données : chaîne Table : Contrat de service [sn_pss_core_service_contract]
install_base_items_covered.install_base	Sys_id de l’élément de base d’installation couvert par la ligne de contrat de service. Type de données : chaîne Table : Élément de base d’installation [sn_install_base_item]
install_base_items_covered.Enlevé	Date à laquelle l’élément de base d’installation associé a été supprimé du droit. 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. Type de données : chaîne Table : Droit [service_entitlement]
install_base_items_covered.service_contract_line	Sys_id de l’enregistrement de la ligne de contrat de service associée. Type de données : chaîne Table : Ligne de contrat de service [sn_pss_core_service_contract_line]
install_base_items_covered.sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement d’élément de base d’installation. Type de données : chaîne
install_base_items_covered.sys_created_on	Date et heure de création de l’enregistrement de l’élément de base d’installation. Type de données : chaîne
install_base_items_covered.sys_id	Sys_id de l’élément de base d’installation couvert. Type de données : chaîne Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]
install_base_items_covered.sys_updated_by	Nom de l’utilisateur qui a mis à jour l’enregistrement d’élément de base d’installation pour la dernière fois. Type de données : chaîne
install_base_items_covered.sys_updated_on	Date et heure de la dernière mise à jour de l’enregistrement d’élément de base d’installation. Type de données : chaîne
produit	Sys_id de l’enregistrement du modèle de produit associé à l’autorisation. Type de données : chaîne Table : Modèle de produit [cmdb_model]
product_offering	Sys_id de l’enregistrement d’offre de produit associé à l’autorisation. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
sold_entitlement	Sys_id de l’enregistrement du produit vendu associé à l’autorisation. Type de données : chaîne Table : Produit vendu [sn_install_base_sold_product]
sold_products_covered	Liste des produits couverts. Type de données : tableau d’objets "sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ] Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]
sold_products_covered.supplémentaire	Date à laquelle le produit vendu associé a été ajouté à l’autorisation. 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. Type de données : chaîne Table : Contrat de service [sn_pss_core_service_contract]
sold_products_covered.droit	Sys_id de l’enregistrement du droit associé au produit vendu couvert. Type de données : chaîne Table : Droit [service_entitlement]
sold_products_covered.supprimé	Date à laquelle le produit vendu associé a été retiré de l’autorisation. 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. Type de données : chaîne Table : Ligne de contrat de service [sn_pss_core_service_contract_line]
sold_products_covered.sold_product	Sys_id du produit couvert par l’autorisation. Type de données : chaîne Table : Produit vendu [sn_install_base_sold_product]
sold_products_covered.sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement couvert du produit vendu. Type de données : chaîne
sold_products_covered.sys_created_on	Date et heure de création de l’enregistrement du produit vendu couvert. Type de données : chaîne
sold_products_covered.sys_id	Sys_id du produit couvert par ce contrat de service. Type de données : chaîne Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]
sold_products_covered.sys_updated_by	Nom de l’utilisateur qui a mis à jour pour la dernière fois l’enregistrement du produit vendu couvert. Type de données : chaîne
sold_products_covered.sys_updated_on	Date et heure de dernière mise à jour de l’enregistrement du produit couvert vendu. Type de données : chaîne
start_date	Date de début du droit. Type de données : chaîne Format : aaaa-mm-jj
État	État actuel du droit. Valeurs valides : (sensibles à la casse) actif annulé brouillon périmé suspendu Type de données : chaîne
sys_created_by	Nom de l’utilisateur qui a créé l’enregistrement d’autorisation. Type de données : chaîne
sys_created_on	Date et heure de création de l’enregistrement d’autorisation. Type de données : chaîne
sys_id	Sys_id de l’enregistrement de l’autorisation associé. Type de données : chaîne Table : Droit [service_entitlement]
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
sys_updated_on	Date et heure de création de l’enregistrement d’autorisation. Type de données : chaîne

Demande cURL

L’exemple suivant montre comment appeler ce point de terminaison pour récupérer un modèle d’autorisation.

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

Réponse :

{
  "result": {
    "sys_id": "5a651515d1f53110f8776589fa411f7b",
    "sys_created_by": "admin",
    "sys_updated_by": "admin",
    "sys_created_on": "2023-10-09 11:31:59",
    "sys_updated_on": "2023-10-09 11:31:59",
    "entitlement_name": "indep entl",
    "account": "4c325111d1f53110f8776589fa411f3d",
    "consumer": null,
    "household": null,
    "contract": null,
    "service_contract_line": null,
    "state": "active",
    "product_offering": null,
    "sold_entitlement": null,
    "product": null,
    "start_date": "2023-10-03",
    "end_date": "2024-12-03",
    "sold_products_covered": [
      {
        "sys_id": "d6651515d1f53110f8776589fa411f7c",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:31:59",
        "sys_updated_on": "2023-10-09 11:31:59",
        "contract": null,
        "service_contract_line": null,
        "entitlement": "5a651515d1f53110f8776589fa411f7b",
        "sold_product": "0df21151d1f53110f8776589fa411f1b",
        "added": "",
        "removed": ""
      }
    ],
    "install_base_items_covered": [
      {
        "sys_id": "12651515d1f53110f8776589fa411f7d",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:31:59",
        "sys_updated_on": "2023-10-09 11:31:59",
        "contract": null,
        "service_contract_line": null,
        "entitlement": "5a651515d1f53110f8776589fa411f7b",
        "install_base": "e2639951d1f53110f8776589fa411f2b",
        "added": "",
        "removed": ""
      }
    ],
    "entitlement_characteristics": [
      {
        "sys_id": "12651515d1f53110f8776589fa411f7e",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:31:59",
        "sys_updated_on": "2023-10-09 11:31:59",
        "service_contract_line": null,
        "entitlement": "5a651515d1f53110f8776589fa411f7b",
        "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
        "value": "5",
        "characteristic": "63418db7539e61106bfcddeeff7b1238",
        "type": "coverage_and_usage",
        "entitlement_usage": [
          {
            "sys_id": "de651515d1f53110f8776589fa411f7e",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:31:59",
            "sys_updated_on": "2023-10-09 11:31:59",
            "entitlement": "5a651515d1f53110f8776589fa411f7b",
            "service_contract_line": null,
            "entitlement_characteristic": "12651515d1f53110f8776589fa411f7e",
            "period_start": "2023-10-03",
            "period_end": "2024-12-03",
            "total_units": "5",
            "used_units": "25"
          }
        ]
      }
    ]
  }
}

Droit : POST /sn_pss_core/entitlement

Crée un enregistrement d’autorisation et tous ses enregistrements de détails connexes.

Voici la liste des tables dans lesquelles les données d’autorisation sont stockées :

• Caractéristique [sn_pss_core_entitlement_characteristic]
• Droit [service_entitlement]
• Utilisation du droit [sn_pss_core_entitlement_usage]
• Produits vendus couverts [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.

Format d'URL

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

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

Remarque :

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

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne

Tableau 8. Paramètres de requête

Nom	Description
Aucun

Tableau 9. Paramètres du corps de la demande (JSON)

Nom	Description
compte	Requis si le paramètre n’est consumer pas transmis. Sys_id de l’enregistrement de compte auquel l’autorisation appartient. Type de données : chaîne Table : Compte [customer_account]
consommateur	Requis si le paramètre n’est account pas transmis. Sys_id de l’enregistrement de consommateur auquel l’autorisation appartient. Type de données : chaîne Table : Consommateur [csm_consumer]
end_date	Date de fin du droit. Type de données : chaîne Format : aaaa-mm-jj Par défaut : ne se termine jamais tant qu’il n’a pas été supprimé manuellement.
entitlement_characteristics	Liste des caractéristiques associées au droit. Type de données : tableau d’objets "entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ] Stocké dans : Caractéristique [sn_pss_core_entitlement_characteristic]
entitlement_characteristics.caractéristique	Requis. Sys_id de l’enregistrement de caractéristique associé à l’autorisation. Type de données : chaîne Table : Caractéristique [sn_prd_pm_characteristic]
entitlement_characteristics.characteristic_option	Sys_id de l’enregistrement de l’option de caractéristique associé au droit. Type de données : chaîne Table : Option de la caractéristique [sn_prd_pm_characteristic_option]
entitlement_characteristics.entitlement_usage	Valeur d’unité utilisée pour la caractéristique du droit associée. Ne transmettez ce paramètre que si les entitlement_characteristics sont sous le droit. Type de données : objet "entitlement_usage": { "used_units": "String" } Stocké dans : Utilisation du droit [sn_pss_core_entitlement_usage]
entitlement_characteristics.entitlement_usage.usage_units	Utilisation de la caractéristique de droit associée. Type de données : chaîne
entitlement_characteristics.type	Type de caractéristique du droit. Valeurs valides : couverture coverage_and_usage Type de données : chaîne
entitlement_characteristics.valeur	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
entitlement_name	Requis. Nom du droit. Type de données : chaîne
household​	Transmis uniquement lorsque les modules d’extension du ménage sont actifs et que le consumer paramètre est transmis. Sys_id de l’enregistrement du ménage associé à l’autorisation. Type de données : chaîne Tableau : Ménage [csm_household]
install_base_items_covered	Liste des éléments de base d’installation couverts par l’autorisation. Les informations de ce tableau sont insérées dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product]. Type de données : tableau d’objets "install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ] Pour plus d’informations sur les éléments Configure Install base de base d’installation .
install_base_items_covered. ajouté	Date à laquelle l’élément de base d’installation associé a été ajouté au droit. Type de données : chaîne Format : aaaa-mm-jj Par défaut : date actuelle
install_base_items_covered.install_base	Sys_id de l’enregistrement de l’élément de base d’installation associé. Type de données : chaîne Table : Élément de base d’installation [sn_install_base_item]
install_base_items_covered.Enlevé	Date à laquelle l’élément de base d’installation associé a été supprimé du droit. Type de données : chaîne Format : aaaa-mm-jj Par défaut : aucune date de fin
produit	Sys_id de l’enregistrement du modèle de produit associé à l’autorisation. Type de données : chaîne Table : Modèle de produit [cmdb_model]
product_offering	Sys_id de l’enregistrement d’offre de produit associé à l’autorisation. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]
sold_entitlement	Sys_id de l’enregistrement du produit vendu associé à l’autorisation. Type de données : chaîne Table : Produit vendu [sn_install_base_sold_product]
sold_products_covered	Liste des produits couverts par l’autorisation. Type de données : tableau d’objets "sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ] Stocké dans : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]
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
sold_products_covered.supprimé	Date à laquelle le produit vendu associé a été retiré de l’autorisation. Type de données : chaîne Format : aaaa-mm-jj Par défaut : aucune date de fin
sold_products_covered.produit_vendu	Sys_id du produit couvert par l’autorisation. Type de données : chaîne Table : Produit vendu [sn_install_base_sold_product]
start_date	Requis. Date de début du droit. Type de données : chaîne Format : aaaa-mm-jj
État	Requis. État actuel du droit. Valeurs valides : (sensibles à la casse) actif annulé brouillon périmé suspendu Type de données : chaîne

En-têtes

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

Tableau 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
Type de contenu	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 11. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

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

Tableau 12. Codes d'état

Code d'état	Description
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)

Nom	Description
entitlement_characteristics	Liste des objets de caractéristiques de droit créés en vertu du droit. Type de données : tableau d’objets "entitlement_characteristics" [ { "entitlement_usage": {Object}, "sys_id": "String" } ]
entitlement_characteristics.entitlement_usage	Objet d’utilisation du droit inséré sous le entitlement_characteristic. Type de données : objet "entitlement_usage": { "sys_id": "String" }
entitlement_characteristics.entitlement_usage.sys_id	Sys_id de l’enregistrement de l’utilisation du droit. Type de données : chaîne Table : Utilisation du droit [sn_pss_core_entitlement_usage]
entitlement_characteristics.sys_id	Sys_id d’un enregistrement des caractéristiques du droit associé au droit. Type de données : chaîne Table : Caractéristique [sn_pss_core_entitlement_characteristic]
entitlement_name	Nom du droit. Type de données : chaîne
install_base_items_covered	Liste des sys_ids des éléments de base d’installation couverts par l’autorisation. Type de données : tableau d’objets "install_base_items_covered": [ { "sys_id": "String" } ]
install_base_items_covered.sys_id	Sys_id d’éléments de base d’installation couverts par l’autorisation. Type de données : chaîne Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]
sold_prodocts_covered	Liste des sys_ids des produits couverts par le droit. Type de données : tableau d’objets "sold_products_covered": [ { "sys_id": "String" } ]
sold_products_covered.sys_id	Sys_id d’un produit associé à l’autorisation. Type de données : chaîne Table : Produit vendu couvert [sn_install_base_m2m_contract_sold_product]
sys_id	Sys_id de l’enregistrement de l’autorisation associé. Type de données : chaîne Table : Droit [service_entitlement]

Demande cURL

L’exemple suivant montre comment créer un modèle d’autorisation.

curl "https://instance.servicenow.com/api/sn_pss_core/entitlement" \
--request POST \
--header "Accept:application/json" \
--data
{
  "state": "active",
  "entitlement_name": "indep entl",
  "account": "4c325111d1f53110f8776589fa411f3d",
  "start_date": "2023-10-03",
  "end_date": "2024-12-03",
  "sold_products_covered": [
    {
      "sold_product": "0df21151d1f53110f8776589fa411f1b"
    }
  ], 
  "install_base_items_covered": [
    {
      "install_base": "e2639951d1f53110f8776589fa411f2b"
    }
  ],
  "entitlement_characteristics": [
    {
      "characteristic": "63418db7539e61106bfcddeeff7b1238",
      "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
      "value": "20",
      "type": "coverage_and_usage",
      "entitlement_usage": {
        "used_units": "25"
      } 
    }
  ]
}

Réponse :

{
  "result": {
    "sys_id": "5a651515d1f53110f8776589fa411f7b",
    "entitlement_name": "indep entl",
    "sold_products_covered": [
      {
        "sys_id": "d6651515d1f53110f8776589fa411f7c"
      }
    ],
    "install_base_items_covered": [
      {
        "sys_id": "12651515d1f53110f8776589fa411f7d"
      }
    ],
    "entitlement_characteristics": [
      {
        "sys_id": "12651515d1f53110f8776589fa411f7e",
        "entitlement_usage": {
          "sys_id": "de651515d1f53110f8776589fa411f7e"
        }
      }
    ]
  }
}