API d’autorisation

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 15 minutes de lecture

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

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

    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 autorisations (com.sn_pss_core)
    • Customer Service Install Base Management (com.snc.install_base)
    • Gestion du catalogue de produits Core (com.sn_prd_pm)

    De plus, 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 .

    Autorisation : GET /sn_pss_core/entitlement/{id}

    Renvoie 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]
    • 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.

    Format d'URL

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

    URL par défaut : /api/sn_pss_core/entitlement/{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 de l’enregistrement d’autorisation à récupérer. Situé dans la table Autorisation [service_entitlement].

    Type de données : chaîne
    Tableau 2. Paramètres de requête
    Nom Description
    display_value Type de données à renvoyer.
    Valeurs valides :
    • faux : renvoie la valeur pour tous les champs. Par exemple, « état » : « brouillon ».
    • vrai : renvoie les display_value pour tous les champs. Par exemple, « state » :« Draft »
    • 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 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 possède pas les 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. Situé dans la table Compte [customer_account].

    Type de données : chaîne
    consommateur
    Sys_id de l’enregistrement de consommateur auquel appartient l’autorisation. Situé dans la table Consommateur [csm_consumer].

    Type de données : chaîne
    contrat Sys_id de l’enregistrement de contrat auquel appartient l’autorisation. Situé dans la table Contrat de service [sn_pss_core_service_contract].

    Type de données : chaîne
    end_date Date de fin de l’autorisation.

    Type de données : chaîne

    Format : jj-mm-aaaa

    Par défaut : ne se termine jamais tant qu’il n’est pas supprimé manuellement.
    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": "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"
  }
]
    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é à 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 associé. Situé dans la table Autorisation [service_entitlement].

    Type de données : chaîne
    entitlement_characteristics.entitlement_usage Liste des utilisations d’autorisation associées à la caractéristique d’autorisation.

    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. Situé dans la table Autorisation [service_entitlement].

    Type de données : chaîne
    entitlement_characteristics.entitlement_usage.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
    entitlement_characteristics.entitlement_usage.period_end Date de fin à laquelle l’utilisation de l’autorisation n’est plus suivie.

    Type de données : chaîne

    Format : jj-mm-aaaa
    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 : jj-mm-aaaa
    entitlement_characteristics.entitlement_usage.service_contract_line Sys_id de la ligne de contrat de service à laquelle appartient l’utilisation actuelle de l’autorisation.

    Type de données : chaîne
    entitlement_characteristics.entitlement_usage.sys_created_by Nom de l’utilisateur qui a créé l’enregistrement d’utilisation d’autorisation.

    Type de données : chaîne
    entitlement_characteristics.entitlement_usage.sys_created_on Date et heure de création de l’enregistrement d’utilisation de l’autorisation.

    Type de données : chaîne
    entitlement_characteristics.entitlement_usage.sys_id Sys_id de l’enregistrement d’utilisation de l’autorisation. Situé dans la table Utilisation des autorisations [sn_pss_core_entitlement_usage].

    Type de données : chaîne
    entitlement_characteristics.entitlement_usage.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
    entitlement_characteristics.entitlement_usage.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
    entitlement_characteristics.entitlement_usage.total_units Valeur totale de la couverture de la caractéristique d’autorisation 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 d’autorisation.
    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 de l’autorisation.

    Type de données : chaîne
    household​
    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
    install_base_items_covered Liste des é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 : tableau d’objets

     "install_base_items_covered": [ 
  {
    "added": "String",
    "contract": "String",
    "entitlement": "String",
    "install_base": "String",
    "removed": "String",
    "service_contract_line": "String",
    "sys_created_by": "String",
    "sys_created_on": "String",
    "sys_id": "String",
    "sys_updated_by": "String",
    "sys_updated_on": "String"
  }
]
    install_base_items_covered.supplémentaire Date à laquelle l’élément de base d’installation associé a été ajouté à l’autorisation.

    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.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 l’élément de base d’installation associé a été supprimé de l’autorisation.

    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.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
    Produit Sys_id de l’enregistrement de modèle de produit associé à l’autorisation. Situé dans la table Modèle de produit [cmdb_model].

    Type de données : chaîne
    product_offering Sys_id de l’enregistrement d’offre de produit associé à l’autorisation. Situé dans la table Offre de produits [sn_prd_pm_product_offering].

    Type de données : chaîne
    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
    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.supplémentaire Date à laquelle le produit vendu associé a été ajouté à l’autorisation.

    Type de données : chaîne

    Format : jj-mm-aaaa

    Par défaut : date actuelle
    sold_products_covered.contrat Sys_id de l’enregistrement de 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 l’autorisation.

    Type de données : chaîne

    Format : jj-mm-aaaa

    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
    start_date
    Date de début de l’autorisation.

    Type de données : chaîne

    Format : jj-mm-aaaa
    État
    État actuel de l’autorisation.
    Valeurs valides : (sensible à 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 d’autorisation associé. Situé dans la table Autorisation [service_entitlement].

    Type de données : chaîne
    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"
          }
        ]
      }
    ]
  }
}

    Autorisation : POST /sn_pss_core/autorisation

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

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

    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
    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. Situé dans la table Compte [customer_account].

    Type de données : chaîne
    consommateur Requis si le paramètre n’est account pas transmis.
    Sys_id de l’enregistrement de consommateur auquel appartient l’autorisation. Situé dans la table Consommateur [csm_consumer].

    Type de données : chaîne
    end_date Date de fin de l’autorisation.

    Type de données : chaîne

    Format : jj-mm-aaaa

    Par défaut : ne se termine jamais tant qu’il n’est pas supprimé manuellement.
    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"
  }
]
    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
    entitlement_characteristics.characteristic_option Sys_id de l’enregistrement de l’option de caractéristique associé à l’autorisation. 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 d’autorisation associée. Ces données sont insérées dans la table Utilisation des autorisations [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": {
    "used_units": "String"
}
    entitlement_characteristics.entitlement_usage.usage_units Utilisation de la caractéristique d’autorisation associée.

    Type de données : chaîne
    entitlement_characteristics.type Type de caractéristique d’autorisation.
    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 entitlement_characteristics.characteristic paramètre n’est pas un choix.
    Valeur de la caractéristique.

    Type de données : chaîne
    entitlement_name Requis.
    Nom de l’autorisation.

    Type de données : chaîne
    household​ Uniquement transmis 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
    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 basede base d’installation .
    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 : jj-mm-aaaa

    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 l’élément de base d’installation associé a été supprimé de l’autorisation.

    Type de données : chaîne

    Format : jj-mm-aaaa

    Par défaut : aucune date de fin
    Produit Sys_id de l’enregistrement de modèle de produit associé à l’autorisation. Situé dans la table Modèle de produit [cmdb_model].

    Type de données : chaîne
    product_offering Sys_id de l’enregistrement d’offre de produit associé à l’autorisation. Situé dans la table Offre de produits [sn_prd_pm_product_offering].

    Type de données : chaîne
    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
    sold_products_covered Liste des produits couverts par l’autorisation. 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 produit vendu associé a été ajouté à l’autorisation.

    Type de données : chaîne

    Format : jj-mm-aaaa

    Par défaut : date actuelle
    sold_products_covered.supprimé Date à laquelle le produit vendu associé a été supprimé de l’autorisation.

    Type de données : chaîne

    Format : jj-mm-aaaa

    Par défaut : aucune date de fin
    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
    start_date Requis.
    Date de début de l’autorisation.

    Type de données : chaîne

    Format : jj-mm-aaaa
    État Requis.
    État actuel de l’autorisation.
    Valeurs valides : (sensible à 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
    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 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éristique d’autorisation créés en vertu de l’autorisation.

    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 des autorisations [sn_pss_core_entitlement_usage].

    Type de données : chaîne
    entitlement_characteristics.sys_id Sys_id d’un enregistrement des caractéristiques d’autorisation qui lui est associé. Situé dans la table Caractéristique [sn_pss_core_entitlement_characteristic].

    Type de données : chaîne
    entitlement_name
    Nom 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 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. Situé dans la table Produit vendu couvert [sn_install_base_m2m_contract_sold_product].

    Type de données : chaîne
    sold_prodocts_covered Liste des sys_ids des produits couverts par l’autorisation.

    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. 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 d’autorisation associé. Situé dans la table Autorisation [service_entitlement].

    Type de données : chaîne

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