API de Catalogue de services

L’API Service Catalog fournit des points de terminaison qui accèdent à Catalogue de services la configuration et aux actions à partir d’un Portail de services.

Catalogue de services - SUPPRIMER /sn_sc/servicecatalog/cart/{cart_item_id}

Supprime l’élément spécifié du panier actuel.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/cart/{cart_item_id}

URL par défaut : /api/sn_sc/servicecatalog/cart/{cart_item_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
cart_item_id	Sys_id de l’élément à supprimer du panier en cours. Type de données : chaîne

Tableau 2. Paramètres de requête

Nom	Description
Aucun

Tableau 3. Paramètres de corps de demande (XML ou 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
Aucun

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
204	Indique que la demande s’est terminée avec succès et que l’élément spécifié a été supprimé du panier.
400	Indique que la valeur spécifiée cart_item_id n’est pas valide ou que l’utilisateur n’a pas accès à l’élément du panier.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
Aucun

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/cart/1f4cc597db21120064301150f0b8f5fc" \
--request DELETE \
--user "username":"password"

None

Catalogue de services : SUPPRIMER /sn_sc/servicecatalog/cart/{sys_id}/empty

Supprime un panier spécifié et son contenu.

Les options de ce qu’un utilisateur peut supprimer (éléments et/ou panier) dépendent du rôle qu’il utilise pour s’authentifier.

Rôles d’utilisateur nécessaires pour supprimer le panier et son contenu :

• admin/catalog_admin : peut vider n’importe quel panier utilisateur.
• admin : peut supprimer le panier une fois que tout le contenu du panier a été supprimé.
• catalog_admin : peut supprimer tous les éléments du panier.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/cart/{sys_id}/empty

URL par défaut : /api/sn_sc/servicecatalog/cart/{sys_id}/empty

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
sys_id	Sys_id du panier à vider et à supprimer. Type de données : chaîne

Tableau 8. Paramètres de requête

Nom	Description
Aucun

Tableau 9. Paramètres de corps de demande (XML ou 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 10. En-têtes de demandes

En-tête	Description
Aucun

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
204	Demande terminée avec succès, qui vide et supprime le panier.
400	Indique une erreur pour l’une des raisons suivantes : cartId non valide. L’utilisateur n’a pas de rôle administrateur/catalog_admin ou essaie de vider le panier d’un autre utilisateur.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
Aucun

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/dde34ad713426300027879d96144b072/empty" \
--request DELETE \
--user 'username':'password'

None

Catalogue de services : GET /sn_sc/servicecatalog/cart

Récupère les détails des éléments dans le panier de l’utilisateur connecté.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/cart

URL par défaut : /api/sn_sc/servicecatalog/cart

Remarque :

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

Paramètres de demande pris en charge

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

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

Tableau 14. Paramètres de requête

Nom	Description
Aucun

Tableau 15. Paramètres de corps de demande (XML ou 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 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

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

En-tête	Description
Aucun

Codes d'état

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

Tableau 18. Codes d'état

Code d'état	Description
200	Indique que la demande s’est terminée avec succès. S’il n’y a pas d’élément dans le panier, il renvoie les informations de base du panier et le prix pour l’utilisateur. Si le panier contient des articles, les informations sur les articles et leur prix individuel sont également incluses.
400	Indique que le panier est vide et ne peut pas payer.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Paramètre	Description
cart_id	Sys_id du chariot. Type de données : chaîne
<recurring_frequency>	Liste des éléments du panier ayant une fréquence récurrente spécifique. Les valeurs possibles sont les suivantes : quotidien mensuel annuel Aucun (aucuns frais récurrents) Type de données : objet "<recurring_frequency>": { "frequency_label": "String", "items": [Array], "show_subtotal_price": "String", "subtotal_price": "String", "subtotal_recurring_frequency": "String", "subtotal_recurring_price": "String", "subtotal_title": "String", "total_title": "String"
<recurring_frequency>.frequency_label	Fréquence des frais récurrents associés. Type de données : chaîne Valeur par défaut : nul
<recurring_frequency>.éléments	Liste d’objets contenant les détails de chaque élément associé à la catégorie de fréquence récurrente spécifiée. Type de données : tableau "items": [{ "cart_item_id": "String", "catalog_item_id": "String", "created.by": "String", "created_on": "String", "delivery_time": "String", "item_id": "String", "item_name": "String", "localized_price": "String", "localized_recurring_price": "String", "name": "String", "order_guide": "String", "picture": "String", "price": "String", "quantity": "String", "recurring_frequency": "String", "recurring_price": "String", "recurring_subtotal": Number, "recurring_subtotal_price": "String", "short_description": "String", "show_price": Boolean, "show_quantity": Boolean, "show_recurring_price": Boolean, "subtotal": Number, "subtotal_price": "String", "sys_class_name": "String", "sys_id": "String", "updated_by": "String", "updated_on": "String", "variables": {Object} }]
<recurring_frequency>.items.cart_item_id	Sys_id de l’élément dans ce panier. Type de données : chaîne
<recurring_frequency>.items.catalog_item_id	Sys_id de catalogue associé à l’élément. Type de données : chaîne
<recurring_frequency>.items.created.by	Utilisateur ayant initialement placé l’élément dans le panier. Type de données : chaîne
<recurring_frequency>.items.created_on	Date à laquelle l’élément a été initialement placé dans le panier. Type de données : chaîne
<recurring_frequency>.items.delivery_time	Temps nécessaire à la livraison de l’élément spécifié. Type de données : chaîne
<recurring_frequency>.items.item_id	sys_id catalogue de l’élément. Type de données : chaîne
<recurring_frequency>.items.item_name	Nom de l’élément spécifié. Type de données : chaîne
<recurring_frequency>.items.localized_price	Prix de l’élément dans la devise locale. Type de données : chaîne
<recurring_frequency>.items.localized_recurring_price	Frais récurrents pour l’élément spécifié dans la devise locale. Type de données : chaîne
<recurring_frequency>.items.name	Nom de l’élément. Type de données : chaîne
<recurring_frequency>.items.order_guide	Nom du guide de commande auquel cet élément est associé. Type de données : chaîne
<recurring_frequency>.éléments.image	Nom de fichier de l’image de l’élément. Type de données : chaîne
<recurring_frequency>.éléments.prix	Prix de l'élément. Type de données : chaîne
<recurring_frequency>.éléments.quantité	Numéro de l’élément spécifié dans le panier. Type de données : chaîne
<recurring_frequency>.items.recurring_frequency	Fréquence à laquelle les frais récurrents sont facturés pour l’élément spécifié. Type de données : chaîne Valeur par défaut : nul
<recurring_frequency>.items.recurring_price	Frais récurrents pour l’élément spécifié. Type de données : chaîne
<recurring_frequency>.items.recurring_subtotal	Sous-total des frais récurrents de l’élément (recurring_price x quantity). Type de données : nombre
<recurring_frequency>.items.recurring_subtotal_price	Sous-total des frais récurrents de l’élément. Type de données : chaîne
<recurring_frequency>.items.short_description	Brève description de l’élément. Type de données : chaîne
<recurring_frequency>.items.show_price	Marqueur indiquant si le prix de l’élément est affiché dans le panier. Valeurs possibles : true : affiche le prix de l’élément dans le panier. faux : n’affiche pas le prix de l’élément dans le panier. Type de données : booléennes
<recurring_frequency>.items.show_quantity	Marqueur indiquant s’il faut afficher la quantité de l’élément dans le panier. Valeurs possibles : vrai : afficher la quantité d’éléments dans le panier. faux : n’affiche pas la quantité d’articles dans le panier. Type de données : booléennes
<recurring_frequency>.items.show_recurring_price	Marqueur indiquant si les frais récurrents doivent apparaître dans le panier. Valeurs possibles : true : affiche les frais récurrents dans le panier. false : n’affiche pas les frais récurrents dans le panier. Type de données : booléennes
<recurring_frequency>.éléments.sous-total	Nombre de sous-total d’éléments. Type de données : nombre
<recurring_frequency>.items.subtotal_price	Sous-total de l’élément (price x quantity). Type de données : chaîne
nom_classe_<recurring_frequency>.items.sys	Nom de classification du système de l’élément. Type de données : chaîne
<recurring_frequency>.items.sys_id	Sys_id de l’enregistrement de l’élément. Type de données : chaîne
<recurring_frequency>.items.updated_by	Utilisateur qui a mis à jour l’élément après qu’il ait été initialement placé dans le panier. Type de données : chaîne
<recurring_frequency>.items.updated_on	Dernière date/heure à laquelle l’élément a été initialement placé dans le panier ou mis à jour. Type de données : chaîne
<recurring_frequency>.éléments.variables	Liste des paires nom/valeur des variables d’élément. Type de données : objet
<recurring_frequency>.show_subtotal_price	Marqueur indiquant s’il faut afficher un sous-total pour la catégorie de frais récurrents associée. Valeurs possibles : true : affiche les sous-totaux dans le panier. false : n’affiche pas de sous-totaux dans le panier. Type de données : booléennes
<recurring_frequency>.subtotal_price	Sous-total du coût de tous les éléments pour la catégorie de fréquence récurrente associée. Type de données : chaîne
<recurring_frequency>.subtotal_recurring_frequency	Type de fréquence de récurrence de sous-total, par exemple quotidienne, mensuelle, etc. Identique à subtotal_recurring_frequency. Type de données : chaîne
<recurring_frequency>.subtotal_recurring_price	Sous-total des frais récurrents des éléments dans la catégorie de fréquence récurrente associée. Type de données : chaîne
<recurring_frequency>.subtotal_title	Si la show_subtotal_price est définie sur vrai, le texte à afficher dans le panier pour le sous-titre associé. Type de données : chaîne
<recurring_frequency>.total_title	Texte à afficher pour le titre total pour la catégorie de fréquence récurrente associée. Type de données : chaîne
show_subtotal_price	Marqueur indiquant s’il faut afficher le prix du sous-total dans le panier. Valeurs possibles : true : affiche les sous-totaux dans le panier. false : n’affiche pas de sous-totaux dans le panier. Type de données : chaîne
subtotal_price	Sous-total de tous les articles dans le panier en dollars entiers. Type de données : chaîne
subtotal_recurring_frequency	Type de fréquence de récurrence de sous-total, par exemple quotidienne, mensuelle, etc. Identique à <recurring_frequency>.subtotal_recurring_frequency. Type de données : chaîne
subtotal_recurring_price	Sous-total des frais de fréquence récurrente pour tous les éléments du panier. Type de données : chaîne
subtotal_title	Texte à afficher dans le panier pour le titre du champ de sous-total. Type de données : chaîne
total_title	Texte à afficher dans le panier pour le titre total du champ Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "cart_id": "6d88bc29137d2300027879d96144b04b",
    "subtotal_price": "$1,598.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "none": {
      "subtotal_price": "$1,598.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
      {
        "updated_on": "2018-11-15 14:24:00",
        "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
        "short_description": "Apple iPhone 7 ",
        "recurring_subtotal_price": "$0.00",
        "delivery_time": "2 Days",
        "sys_class_name": "sc_cat_item",
        "sys_id": "1f88bc29137d2300027879d96144b056",
        "price": "$799.00",
        "recurring_frequency": null,
        "subtotal_price": "$799.00",
        "variables": {},
        "quantity": "1",
        "item_id": "07f1666b0bf00300eba42da0d5673ab0",
        "recurring_price": "$0.00",
        "show_price": true,
        "item_name": "Apple iPhone7",
        "cart_item_id": "1f88bc29137d2300027879d96144b056",
        "recurring_subtotal": 0,
        "show_quantity": true,
        "created_by": "admin",
        "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
        "created_on": "2018-11-15 14:24:00",
        "localized_price": "$799.00",
        "subtotal": 799,
        "show_recurring_price": false,
        "name": "Apple iPhone7",
        "updated_by": "admin",
        "localized_recurring_price": "$0.00",
        "order_guide": ""
      },
    ],
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
   },
   "show_subtotal_price": "true",
   "subtotal_title": "Subtotal"
 }
}

Catalogue de services : GET /sn_sc/servicecatalog/cart/delivery_address/{user_id}

Récupère l’adresse d’expédition de l’utilisateur spécifié en fonction de la glide.sc.req_for.roles propriété et du comportement par défaut configurés dans le glide.sc.req_for.roles.defaultproperty.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/cart/delivery_address/{user_id}

URL par défaut : /api/sn_sc/servicecatalog/cart/delivery_address/{user_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 19. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne
user_id	Sys_id de l’utilisateur dont l’adresse d’expédition doit être récupérée. Type de données : chaîne Table : Utilisateur [sys_user]

Tableau 20. Paramètres de requête

Nom	Description
Aucun

Tableau 21. Paramètres de corps de demande (XML ou 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 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

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

En-tête	Description
Aucun

Codes d'état

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

Tableau 24. Codes d'état

Code d'état	Description
200	Demande terminée avec succès ; Renvoie l’adresse d’expédition de l’utilisateur spécifié.
400	Le sys_id de l’utilisateur n’est pas valide.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
résultat	Adresse de l’utilisateur spécifié. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/delivery_address/62826bf03710200044e0bfc8bcbe5df1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
'result': '25 New Chardon Street, Boston\nBoston, MA, 02114-1801\nUSA'
}

Catalogue de services : GET /sn_sc/servicecatalog/catalogs

Récupère une liste de catalogues auxquels l’utilisateur a accès en fonction des paramètres transmis.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/catalogs

URL par défaut : /api/sn_sc/servicecatalog/catalogs

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 25. 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 26. Paramètres de requête

Nom	Description
sysparm_limit	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d'enregistrements, utilisez le paramètre sysparm_offset pour paginer la récupération d'enregistrements. Cette limite est appliquée avant l'évaluation de l'ACL. Si aucun enregistrement n'est renvoyé (notamment ceux auxquels vous avez accès), réorganisez l'ordre des enregistrements pour que ceux auxquels vous avez accès soient renvoyés en premier. Remarque : Des valeurs sysparm_limit anormalement élevées peuvent avoir un impact sur les performances du système. Type de données : nombre Par défaut : 20 Maximum : 100
sysparm_text	Mot clé à rechercher dans le champ « titre » des catalogues de services disponibles. Type de données : chaîne
sysparm_view	Appareil sur lequel l’élément peut s’afficher : desktop: sur le bureau. mobile: sur un équipement mobile. both: à la fois sur un ordinateur de bureau et sur un équipement mobile. Type de données : chaîne

Tableau 27. Paramètres de corps de demande (XML ou 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 28. 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 29. 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 30. Codes d'état

Code d'état	Description
200	Indique que la demande s’est terminée avec succès. Si une requête valide ne renvoie aucun résultat, le corps de la réponse contient uniquement un tableau de résultats vide.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
description	Description du catalogue. Type de données : chaîne
desktop_image	Image affichée sur le bureau pour ce catalogue. Type de données : chaîne
has_categories	Marqueur indiquant si le catalogue contient des catégories. Valeurs possibles : vrai : le catalogue contient des catégories. false : le catalogue ne contient pas de catégories. Type de données : booléennes
has_items	Marqueur indiquant si le catalogue contient des éléments. Valeurs possibles : vrai : le catalogue contient des éléments. faux : le catalogue ne contient pas d’éléments. Type de données : booléennes
sys_id	Sys_id du catalogue. Type de données : chaîne
Titre	Titre du catalogue. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/catalogs?sysparm_limit=10" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": [
    {
      "title": "Technical Catalog",
      "sys_id": "742ce428d7211100f2d224837e61036d",
      "has_categories": true,
      "has_items": true,
      "description": "Products and services for the IT department",
      "desktop_image": "7a7c8271475211002ee987e8dee4906d.iix"
    },
    {
      "title": "Service Catalog",
      "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
      "has_categories": true,
      "has_items": true,
      "description": "Service Catalog - IT Now",
      "desktop_image": "adbcc271475211002ee987e8dee49001.iix"
    }
  ]
}

Catalogue de services : GET /sn_sc/servicecatalog/catalogs/{sys_id}/categories

Récupère la liste des catégories disponibles pour le catalogue spécifié.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/catalogs/{sys_id}/categories

URL par défaut : /api/sn_sc/servicecatalog/catalogs/{sys_id}/categories

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 31. 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
sys_id	Sys_id du catalogue dont les catégories sont demandées. Type de données : chaîne

Tableau 32. Paramètres de requête

Nom	Description
sysparm_limit	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d'enregistrements, utilisez le paramètre sysparm_offset pour paginer la récupération d'enregistrements. Cette limite est appliquée avant l'évaluation de l'ACL. Si aucun enregistrement n'est renvoyé (notamment ceux auxquels vous avez accès), réorganisez l'ordre des enregistrements pour que ceux auxquels vous avez accès soient renvoyés en premier. Remarque : Des valeurs sysparm_limit anormalement élevées peuvent avoir un impact sur les performances du système. Type de données : nombre Par défaut : 20 Maximum : 100
sysparm_offset	Index de début des enregistrements pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Par exemple, lors du premier appel de ce point de terminaison, sysparm_offset est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez le paramètre sysparm_offset=sysparm_offset+sysparm_limit, jusqu'à atteindre la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le sysparm_offset paramètre. Type de données : nombre Par défaut : 0
sysparm_top_level_only	Renvoyer uniquement les catégories dont le parent est un catalogue. Valeurs valides : vrai : renvoie uniquement les catégories dont le parent est un catalogue. faux : renvoyer toutes les catégories. Type de données : booléennes
sysparm_view	Vue de l'interface utilisateur pour laquelle afficher les données. Détermine les champs renvoyés dans la réponse. Valeurs valides : desktop mobile les deux Si vous spécifiez également le paramètre sysparm_fields, il est prioritaire. Type de données : chaîne

Tableau 33. Paramètres de corps de demande (XML ou 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 34. 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 35. 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 36. Codes d'état

Code d'état	Description
200	Renvoie une liste de catégories dans un catalogue. S’il n’y a aucun résultat de requête, un tableau vide est renvoyé.
400	Indique que la demande ou la sys_id de catalogue n’est pas valide.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
compter	Nombre d’éléments dans la catégorie. Type de données : nombre
description	Brève description de la catégorie. Type de données : chaîne
_description complet	Description détaillée de la catégorie. Type de données : chaîne
header_icon	Icône utilisée sur les en-têtes de catégorie. Type de données : chaîne
homepage_image	Image qui s’affiche pour cette catégorie sur la page d’accueil de la catégorie. Type de données : chaîne
icône	Icône à utiliser pour représenter cette catégorie. Type de données : chaîne
Sous-catégories	Liste des sous-catégories au sein de la catégorie. Type de données : tableau "subcategories": [ "sys_id": "String", "title": "String ]
subcategories.sys_id	Sys_id de la sous-catégorie. Type de données : chaîne
sous-catégories.titre	Titre de la sous-catégorie. Type de données : chaîne
sys_id	Sys_id de la catégorie. Type de données : chaîne
Titre	Titre de catégorie. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/catalogs/e0d08b13c3330100c8b837659bba8fb4/categories?sysparm_limit=2 \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": [
    {
      "title": "Can We Help You?",
      "description": "Your IT gateway. Report issues and submit requests.\n\t\t",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "29f8ffa9471211002ee987e8dee4905e.iix",
      "count": 14,
      "subcategories": [],
      "sys_id": "e15706fc0a0a0aa7007fc21e1ab70c2f"
    },
    {
      "title": "Departmental Services",
      "description": "Services offered by different departments in the organization",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "6fb4a1d95f2211001c9b2572f2b47748.iix",
      "count": 1,
      "subcategories": [],
      "sys_id": "95fc11615f1211001c9b2572f2b477c6"
    },
    {
      "title": "Desktops",
      "description": "Desktop computers for your work area.",
      "full_description": null,
      "icon": "",
      "header_icon": "",
      "homepage_image": "1bface31475211002ee987e8dee49095.iix",
      "count": 1,
      "subcategories": [],
      "sys_id": "900682363731300054b6a3549dbe5d5f"
    }
  ]
}

Catalogue de services : GET /sn_sc/servicecatalog/catalogs/{sys_id}

Récupère les informations disponibles pour un catalogue spécifié.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/catalogs/{sys_id}

URL par défaut : /api/sn_sc/servicecatalog/catalogs/{sys_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 37. 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
sys_id	Sys_id du catalogue à récupérer. Type de données : chaîne

Tableau 38. Paramètres de requête

Nom	Description
sysparm_view	Appareil sur lequel l’élément peut s’afficher : desktop: sur le bureau. mobile: sur un équipement mobile. both: à la fois sur un ordinateur de bureau et sur un équipement mobile. Type de données : chaîne

Tableau 39. Paramètres de corps de demande (XML ou 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 40. 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 41. 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 42. Codes d'état

Code d'état	Description
200	Indique que la demande s’est terminée avec succès et renvoie les informations disponibles pour le catalogue spécifié.
400	Indique que la demande n’est pas valide pour l’une des raisons suivantes : L’utilisateur n’a pas accès au catalogue. sys_id non valide.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
catégories	Liste des objets qui décrivent des catégories dans le catalogue. Type de données : tableau "categories": [ "description": "String", "header_image": "String", "sys_id": "String", "title": "String ]
catégories.description	Description de la catégorie. Type de données : chaîne
categories.header_image	Image d’en-tête de catégorie. Type de données : chaîne
categories.sys_id	Identificateur de catégorie unique (sys_id). Type de données : chaîne
catégories.titre	Titre de catégorie. Type de données : chaîne
description	Description du catalogue. Type de données : chaîne
desktop_image	Source de l’image qui s’affiche avec le catalogue dans la vue de bureau. Type de données : chaîne
has_categories	Marqueur indiquant si le catalogue comporte des catégories. Valeurs possibles : vrai : le catalogue comporte des catégories. faux : le catalogue n’a pas de catégories. Type de données : booléennes
has_items	Marqueur indiquant s’il existe des éléments dans la catégorie. Valeurs possibles : vrai : éléments du catalogue lui sont associés. faux : aucun élément n’est associé au catalogue. Type de données : booléennes
sys_id	sys_id de catalogue unique. Type de données : chaîne
Titre	Titre du catalogue. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.comaqsw" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "title": "Customer Service",
    "sys_id": "65bcd377c3011200b12d9f2974d3aea0",
    "has_categories": true,
    "categories": [
      {
        "header_image": "",
        "sys_id": "4cb69d19c3921200b0449f2974d3ae69",
        "description": null,
        "title": "Services"
      },
      {
        "header_image": "",
        "sys_id": "1b8611d5c3921200b0449f2974d3ae12",
        "description": null,
        "title": "Support"
      }
    ],
    "has_items": true,
    "description": "Customer Service",
    "desktop_image": ""
  }
}

Catalogue de services : GET /sn_sc/servicecatalog/categories/{sys_id}

Récupère les informations disponibles pour une catégorie spécifiée.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/categories/{sys_id}

URL par défaut : /api/sn_sc/servicecatalog/categories/{sys_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 43. 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
sys_id	Sys_id de la catégorie pour laquelle renvoyer des informations. Type de données : chaîne

Tableau 44. Paramètres de requête

Nom	Description
sysparm_view	Vue de l'interface utilisateur pour laquelle afficher les données. Détermine les champs renvoyés dans la réponse. Valeurs valides : desktop mobile les deux Si vous spécifiez également le paramètre sysparm_fields, il est prioritaire. Type de données : chaîne

Tableau 45. Paramètres de corps de demande (XML ou 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 46. 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 47. 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 48. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Indique que la demande n’est pas valide pour l’une des raisons suivantes : L’utilisateur n’a pas accès à la catégorie. sys_id non valide.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
child_categories	Liste des objets qui décrivent les catégories enfants appartenant à cette catégorie. Type de données : tableau "child_categories": [ "count": Number, "isParentCategory": "String", "parent": "String", "subcategories": [Array], "sys_id": "String", "title": "String" ]
child_categories.count	Nombre d’éléments dans la catégorie enfant. Type de données : nombre
child_categories.isParentCategory	Marqueur indiquant s’il s’agit d’une catégorie parente. Valeurs possibles : true : catégorie parente. false : pas la catégorie parente. Type de données : booléennes
child_categories.parent	Sys_id du parent de la catégorie enfant. Type de données : chaîne
child_categories.sous-catégories	Liste des objets qui décrivent les sous-catégories de cette catégorie enfant. Type de données : tableau "subcategories": [ "sys_id": "String", "title": "String" ]
child_categories.subcategories.sys_id	Sys_id de la sous-catégorie enfant. Type de données : chaîne
child_categories.sous-catégories.titre	Titre de sous-catégorie enfant. Type de données : chaîne
child_categories.sys_id	Sys_id de la catégorie enfant. Type de données : chaîne
child_categories.title	Titre de catégorie enfant. Type de données : chaîne
description	Description brève de la catégorie. Type de données : chaîne
full_description	Description détaillée de la catégorie. Type de données : chaîne
header_icon	Source de l’icône affichée à côté de l’en-tête de catégorie lorsque la catégorie est répertoriée dans la catégorie de niveau supérieur. Type de données : chaîne
homepage_image	Source de l’image de la page d’accueil de la catégorie. Type de données : chaîne
icône	Source de la petite icône affichée à côté du nom de la catégorie lorsque celle-ci est répertoriée en tant que sous-catégorie. Type de données : chaîne
sys_id	Sys_id de la catégorie. Type de données : chaîne
Titre	Titre de catégorie. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/categories/b0fdfb01932002009ca87a75e57ffbe9" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "title": "Office",
    "description": "Office services such as printing, supplies requisition\n\t\t\tand document shipping and delivery.\n\t\t",
    "full_description": null,
    "icon": "",
    "header_icon": "",
    "homepage_image": "498b0271475211002ee987e8dee490ea.iix",
    "sys_id": "109cdff8c6112276003b17991a09ad65",
    "child_categories": [
      {
        "sys_id": "109f0438c6112276003ae8ac13e7009d",
        "title": "Services",
        "count": 16,
        "parent": "109cdff8c6112276003b17991a09ad65",
        "subcategories": [],
        "isParentCategory": false
      }
    ]
  }
}

Catalogue de services : GET /sn_sc/servicecatalog/items

Récupère une liste d’éléments de catalogue en fonction des paramètres spécifiés.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/items

URL par défaut : /api/sn_sc/servicecatalog/items

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 49. 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 50. Paramètres de requête

Nom	Description
sysparm_catalog	sys_id catalogue de l’élément. Utilisez ce paramètre pour localiser des éléments dans un catalogue spécifique. Type de données : chaîne
sysparm_category	Catégorie sys_id de l’élément. Utilisez ce paramètre pour localiser les éléments de catalogue dans une catégorie spécifique. Type de données : chaîne
sysparm_limit	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d'enregistrements, utilisez le paramètre sysparm_offset pour paginer la récupération d'enregistrements. Cette limite est appliquée avant l'évaluation de l'ACL. Si aucun enregistrement n'est renvoyé (notamment ceux auxquels vous avez accès), réorganisez l'ordre des enregistrements pour que ceux auxquels vous avez accès soient renvoyés en premier. Remarque : Des valeurs sysparm_limit anormalement élevées peuvent avoir un impact sur les performances du système. Type de données : nombre Par défaut : 20 Maximum : 100
sysparm_offset	Index de début des enregistrements pour lequel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Par exemple, lors du premier appel de ce point de terminaison, sysparm_offset est défini sur « 0 ». Pour parcourir simplement tous les enregistrements disponibles, utilisez le paramètre sysparm_offset=sysparm_offset+sysparm_limit, jusqu'à atteindre la fin de tous les enregistrements. Ne transmettez pas de nombre négatif dans le sysparm_offset paramètre. Type de données : nombre Par défaut : 0
sysparm_text	Texte spécifique à rechercher dans les éléments de catégorie. Par exemple, sysparm_text="iPhone » ou sysparm_text="Appareils mobiles ». Type de données : chaîne
sysparm_type	Type d’élément. Valeurs de recherche valides : Créateur d'enregistrement Guide de commande Si une autre valeur est transmise, les informations sont ignorées. Type de données : chaîne
sysparm_view	Vue de l'interface utilisateur pour laquelle afficher les données. Détermine les champs renvoyés dans la réponse. Valeurs valides : desktop mobile les deux Si vous spécifiez également le paramètre sysparm_fields, il est prioritaire. Type de données : chaîne

Tableau 51. Paramètres de corps de demande (XML ou 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 52. 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 53. 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 54. Codes d'état

Code d'état	Description
200	Renvoie une liste de catalogues et d’éléments en fonction des paramètres spécifiés. Si une requête valide ne donne aucun élément, le corps de la réponse contient uniquement un tableau de résultats vide.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Paramètre	Description
Catalogues	Liste des objets qui décrivent les catalogues qui contiennent cet élément. Type de données : tableau "catalogs": [{ "sys_id": "String", "title": "String" }]
catalogs.sys_id	Sys_id du catalogue. Type de données : chaîne
catalogues.titre	Titre du catalogue. Type de données : chaîne
catégorie	Décrit la catégorie qui contient cet élément. Type de données : objet "catalogs": { "sys_id": "String", "title": "String" }
category.sys_id	Sys_id de la catégorie. Type de données : chaîne
catégorie.titre	Titre de catégorie Type de données : chaîne
content_type	Type de contenu. Type de données : chaîne
description	Description détaillée de l'élément. Type de données : chaîne
icône	Source de la petite icône affichée en regard du nom de l’élément. Type de données : chaîne
kb_article	Article basé sur la base de connaissances associé à l’élément. Type de données : chaîne
local_currency	Code de devise du pays pour la devise locale. Type de données : chaîne
localized_price	Prix de l’article, exprimé dans la devise définie par local_currency. Type de données : chaîne
localized_recurring_price	Prix des frais récurrents, exprimé dans la devise définie par local_currency. Type de données : chaîne
nom	Nom de l’élément. Type de données : chaîne
order	Ordre prédéfini auquel l’élément appartient. Type de données : nombre
image	Chemin vers l’image à afficher pour l’élément. Type de données : chaîne
prix	Prix de l’élément exprimé dans la devise définie par price_currency. Type de données : chaîne
price_currency	Code de devise du pays pour lequel le prix de l’élément est exprimé. Type de données : chaîne
recurring_frequency	Fréquence à laquelle les frais récurrents sont appliqués, par exemple quotidienne, mensuelle ou annuelle ; nul s’il n’y a pas de frais pour l’élément. Type de données : chaîne
recurring_price	Montant des frais récurrents associés à l’élément. Type de données : chaîne
recurring_price_currency	Code de la devise du pays pour lequel les frais récurrents sont exprimés. Type de données : chaîne
short_description	Brève description de l'élément. Type de données : chaîne
show_price	Marqueur indiquant s’il faut afficher le prix de l’élément dans le panier. Valeurs possibles : vrai : les paires nom-valeur sont renvoyées dans les paramètres de réponse. faux : les paires nom-valeur ne sont pas renvoyées dans les paramètres de réponse. Type de données : booléennes
show_quantity	Marqueur indiquant s’il faut afficher la quantité de l’élément dans le panier. Valeurs possibles : true : affiche la quantité d’éléments dans le panier. faux : n’affiche pas la quantité d’éléments dans le panier. Type de données : booléennes
sys_class_name	Table à laquelle appartient l’enregistrement, telle que sc_cat_item_producer. Type de données : chaîne
sys_id	Sys_id de l’élément. Type de données : chaîne
type	Type d’élément. Type de données : chaîne
URL	URL de l’élément. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items?sysparm_catalog=e0d08b13c3330100c8b837659bba8fb4&sysparm_limit=2" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": [
    {
      "short_description": null,
      "kb_article": "",
      "icon": "images/icons/catalog_item.gifx",
      "description": "<p class=\"p1\"><font size=\"2\"><span class=\"s1\">Request an existing Standard Change Template is made unavailable when it is no longer required or no longer acceptable as a Standard Change.  This will be confirmed by your Change Management team.</span></font></p>",
      "show_price": false,
      "type": "record_producer",
      "show_quantity": true,
      "sys_class_name": "sc_cat_item_producer",
      "picture": "",
      "url": "",
      "sys_id": "011f117a9f3002002920bde8132e7020",
      "content_type": "",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Retire a Standard Change Template",
      "category": {
        "sys_id": "00728916937002002dcef157b67ffb6d",
        "title": "Template Management"
      },
      "order": 30
    },
    {
      "short_description": null,
      "kb_article": "",
      "icon": "4cc3ec3d471211002ee987e8dee490d0.iix",
      "description": "<p><font size=\"3\" color=\"#808080\" face=\"arial,helvetica,sans-serif\">A role delegator may delegate any role they have to any member of the specified group</font></p>",
      "show_price": false,
      "type": "record_producer",
      "show_quantity": true,
      "sys_class_name": "sc_cat_item_producer",
      "picture": "ed44b5804f889200086eeed18110c7ca.iix",
      "url": "",
      "sys_id": "01205b180a0a0b3000b6efd641d24b75",
      "content_type": "",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Grant role delegation rights within a group",
      "category": {
        "sys_id": "496a3a7e0a0a0bc00089b39df14eb56e",
        "title": "Role Delegation"
      },
      "order": 100
    }
  ]
}

Catalogue de services : GET /sn_sc/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}

Vérifie si l’utilisateur délégué spécifié dispose des droits d’acquisition sur l’élément de catalogue de services spécifié.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/items/{item_sys_id}/delegation/{user_sys_id}

URL par défaut : /api/sn_sc/servicecatalog/items/{item_sys_id}/delegation/{user_sys_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 55. 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
item_sys_id	Sys_id de l’élément de catalogue de services pour vérifier si l’utilisateur spécifié dispose des droits d’acquisition. Type de données : chaîne Table : Catalogue de services [sc_catalog]
user_sys_id	Sys_id de l’utilisateur afin de vérifier s’il dispose des droits d’acquisition sur l’élément de catalogue de services spécifié. Type de données : chaîne Table : utilisateurs [sys_users]

Tableau 56. Paramètres de requête

Nom	Description
Aucun

Tableau 57. Paramètres de corps de demande (XML ou 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 58. 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 59. 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 60. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
résultat	Marqueur indiquant si l’utilisateur spécifié dispose des droits d’acquisition sur l’élément de catalogue de services spécifié. Valeurs valides : true : l’utilisateur dispose de droits d’acquisition. faux : l’utilisateur ne dispose pas de droits d’acquisition.

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/5c7e9fd20f1010108af26b198b767eb8/delegation/62826bf03710200044e0bfc8bcbe5df1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "result": true
  }
}

Catalogue de services : GET /sn_sc/servicecatalog/items/{sys_id}

Récupère un élément de catalogue spécifié.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}

URL par défaut : /api/sn_sc/servicecatalog/items/{sys_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 61. 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
sys_id	Sys_id de l’élément de catalogue à renvoyer. Type de données : chaîne

Tableau 62. Paramètres de requête

Nom	Description
sysparm_view	Vue de l'interface utilisateur pour laquelle afficher les données. Détermine les champs renvoyés dans la réponse. Valeurs valides : desktop mobile les deux Si vous spécifiez également le paramètre sysparm_fields, il est prioritaire. Type de données : chaîne

Tableau 63. Paramètres de corps de demande (XML ou 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 64. 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 65. 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 66. Codes d'état

Code d'état	Description
200	Indique que la demande s’est terminée avec succès et renvoie les détails de l’élément de catalogue.
400	Indique que la demande n’est pas valide pour l’une des raisons suivantes : L’utilisateur n’a pas accès à l’élément de catalogue. sys_id non valide.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
Catalogues	Liste des objets qui décrivent les catalogues qui contiennent cet élément. Type de données : tableau "catalogs": [{ "sys_id": "String", "title": "String" }]
catalogs.sys_id	Sys_id du catalogue. Type de données : chaîne
catalogues.titre	Titre du catalogue. Type de données : chaîne
catégories	Liste des objets qui décrivent les catégories qui contient cet élément. Type de données : tableau "categories": [{ "active": Boolean, "category": {Object}, "sys_id": "String", "title": "String" }]
catégories.actives	Marqueur indiquant si la catégorie est active. Valeurs possibles : vrai : la catégorie est active. faux : la catégorie est inactive. Type de données : booléennes
catégories.catégorie	Décrit la catégorie associée. Type de données : objet "category": { "active": Boolean, "sys_id": "String", "title": "String" }
categories.category.active	Marqueur indiquant si la catégorie est active. Valeurs possibles : vrai : la catégorie est active. faux : la catégorie est inactive. Type de données : booléennes
categories.category.sys_id	Sys_id de la catégorie. Type de données : chaîne
catégories.catégorie.titre	Titre de catégorie. Type de données : chaîne
categories.sys_id	Catégorie parente de la catégorie spécifiée dans categories.category. Type de données : chaîne
catégorie	Catégorie primaire à laquelle l’élément appartient. Type de données : objet "category": { "sys_id": "String", "title": "String" }
category.sys_id	Sys_id de la catégorie primaire. Type de données : chaîne
catégorie.titre	Titre de la catégorie primaire. Type de données : chaîne
client_script	Liste de tous les scripts clients de catalogue définis sur l’élément de catalogue. Type de données : objet "client_script": { "onChange": [Array], "onLoad": [Array], "onSubmit": [Array] }
client_script.onChange	Liste des scripts clients onChange associés à l’élément. Type de données : tableau
client_script.onSubmit	Liste des scripts clients onSubmit associés à l’élément. Type de données : tableau
client_script.onLoad	Liste des scripts clients onLoad associés à l’élément. Type de données : tableau
content_type	Type de contenu. Type de données : chaîne
data_lookup	Liste des recherches de données définies sur l’élément de catalogue. Type de données : tableau
description	Description détaillée de l'élément. Type de données : chaîne
icône	Source de la petite icône affichée en regard du nom de l’élément. Type de données : chaîne
kb_article	Article basé sur la base de connaissances associé à l’élément. Type de données : chaîne
local_currency	Code de devise du pays pour la devise locale. Type de données : chaîne
localized_price	Prix de l’article, exprimé dans la devise définie par local_currency. Type de données : chaîne
localized_recurring_price	Prix des frais récurrents, exprimé dans la devise définie par local_currency. Type de données : chaîne
nom	Nom de l’élément. Type de données : chaîne
order	Nombre de commandes pour l’élément. Type de données : nombre
image	Nom de fichier de l’image à afficher pour l’élément. Type de données : chaîne
prix	Prix de l’élément exprimé dans la devise définie par price_currency. Type de données : chaîne
price_currency	Code de devise du pays pour lequel le prix de l’élément est exprimé. Type de données : chaîne
recurring_frequency	Fréquence à laquelle les frais récurrents sont appliqués, par exemple quotidienne, mensuelle ou annuelle. Type de données : chaîne
recurring_price	Montant des frais récurrents associés à l’élément Type de données : chaîne
recurring_price_currency	Code de la devise du pays pour lequel les frais récurrents sont exprimés. Type de données : chaîne
short_description	Brève description de l'élément. Type de données : chaîne
show_price	Marqueur indiquant s’il faut afficher le prix de l’élément dans le panier. Valeurs possibles : vrai : les paires nom/valeur de tarification sont renvoyées dans les paramètres de réponse. false : les paires nom/valeur de tarification ne sont pas renvoyées dans les paramètres de réponse. Type de données : booléennes
show_quantity	Marqueur indiquant s’il faut afficher la quantité de l’élément dans le panier. Valeurs possibles : true : affiche la quantité d’éléments dans le panier. faux : n’affiche pas la quantité d’éléments dans le panier. Type de données : booléennes
sys_class_name	Nom de la table à laquelle cet enregistrement appartient. Type de données : chaîne
sys_id	Sys_id de l’élément. Type de données : chaîne
type	Type d’élément. Type de données : chaîne
ui_policy	Liste des politiques d’interface utilisateur associées à l’élément. Type de données : tableau
URL	URL de l’image de l’élément. Type de données : chaîne
variables	Liste des variables disponibles associées à l’élément. Type de données : tableau

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/0cf7477237153000158bbfc8bcbe5dec" \
  --request GET \
  --header "Accept:application/json" \
  --user "username":"password"

{
  "result": {
    "short_description": "Apple iPad 3",
    "kb_article": "",
    "icon": "e6b3bc0647311200e0ef563dbb9a71fc.iix",
    "description": "\n\t\t\t<p>\n\t\t\t\t<font size=\"3\">\n\t\t\t\t\t<span style=\"color: gray;\">\n\t\t\t\t\t\tiPad with Retina display Wi-Fi 16GB - Black </span>\n\t\t\t\t</font>\n\t\t\t</p>\n\t\t\t<p>\n\t\t\t\t<span style=\"color: gray;\">Key Features:</span>\n\t\t\t</p>\n\t\t\t<ul><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Retina display (2048x1536 resolution)</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">16GB storage</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Wi-Fi enabled</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Built-in speaker, microphone and camera</span>\n\t\t\t\t</li><li style=\"color: gray;\">\n\t\t\t\t\t<span style=\"font-size: 10.0pt;\">Up to 10 hours battery life</span>\n\t\t\t\t</li></ul>",
    "show_price": true,
    "recurring_price": "$0.00",
    "type": "catalog_item",
    "show_quantity": true,
    "local_currency": "USD",
    "sys_class_name": "pc_hardware_cat_item",
    "picture": "5b977690cb921200f2de77a4634c9c6a.iix",
    "url": "",
    "sys_id": "060f3afa3731300054b6a3549dbe5d3e",
    "recurring_price_currency": "USD",
    "content_type": "",
    "localized_price": "$600.00",
    "price": "$600.00",
    "catalogs": [
      {
        "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
         "title": "Service Catalog"
      }
    ],
    "recurring_frequency": null,
    "name": "Apple iPad 3",
    "localized_recurring_price": "$0.00",
    "category": {
      "sys_id": "b06546f23731300054b6a3549dbe5dd8",
      "title": "Tablets"
    },
    "price_currency": "USD",
    "order": 0,
    "categories": [
      {
        "sys_id": "d258b953c611227a0146101fb1be7c31",
        "active": true,
        "category": {
          "sys_id": "b06546f23731300054b6a3549dbe5dd8",
          "active": true,
          "title": "Tablets"
        },
        "title": "Hardware"
      }
    ],
    "variables": [],
    "ui_policy": [],
    "client_script": {
      "onChange": [],
      "onSubmit": [],
      "onLoad": []
    },
    "data_lookup": []
  }
}

Catalogue de services : GET /sn_sc/servicecatalog/wishlist

Récupère la liste des éléments figurant dans la liste de souhaits de l’utilisateur connecté.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/wishlist

URL par défaut : /api/sn_sc/servicecatalog/wishlist

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 67. 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 68. Paramètres de requête

Nom	Description
Aucun

Tableau 69. Paramètres de corps de demande (XML ou 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 70. 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 71. 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 72. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
cart_id	Sys_id du panier de la liste de souhaits. Type de données : chaîne
Éléments	Liste des objets qui décrivent les articles dans le panier de la liste de souhaits. Type de données : tableau "items": [{ "cart_item_id": "String", "catalog_item_id": "String", "created_by": "String", "created_on": "String", "delivery_time": "String", "item_id": "String", "item_name": "String", "localized_price": "String", "localized_recurring_price": "String", "name": "String", "order_guide": "String", "picture": "String", "price": "String", "quantity": "String", "recurring_frequency": "String", "recurring_price": "String", "recurring_subtotal": Number, "recurring_subtotal_price": "String", "short_descriptions": "String", "show_price": Boolean, "show_quantity": Boolean, "show_recurring_price": Boolean, "subtotal": Number, "subtotal_price": "String", "sys_class_name": "String", "sys_id": "String", "updated_by": "String", "updated_on": "String", "variables": {Object} }]
items.cart_item_id	Sys_id de l’élément. Identique à items.sys_id. Type de données : chaîne
items.catalog_item_id	Sys_id de l’identificateur de catalogue pour cet élément dans le panier de la liste de souhaits. Identique à items.item_id. Type de données : chaîne
items.created_by	Utilisateur qui a initialement placé l’élément dans le panier de la liste de souhaits. Type de données : chaîne
items.created_on	Date et heure auxquelles l’article a été initialement placé dans le panier de la liste de souhaits. Type de données : chaîne
items.delivery_time	Durée nécessaire pour livrer l’élément. Type de données : chaîne
items.item_id	Identificateur de catalogue unique pour cet élément dans le panier de la liste de souhaits (sys_id). Identique à items.catalog_item_id. Type de données : chaîne
items.item_name	Nom de l’élément. Type de données : chaîne
items.localized_price	Prix de l’article exprimé dans la devise locale. Type de données : chaîne
items.localized_recurring_price	Prix des frais récurrents exprimé dans la devise locale. Type de données : chaîne
items.name	Nom de l’élément. Type de données : chaîne
items.order_guide	Guide de commande auquel l’élément est associé. Type de données : chaîne
éléments.image	Chemin vers l’image à afficher pour l’élément. Type de données : chaîne
items.price	Prix de l’élément. Type de données : chaîne
items.quantity	Numéro de cet élément dans le panier de la liste de souhaits. Type de données : chaîne
items.recurring_frequency	Fréquence à laquelle les frais récurrents sont appliqués, par exemple quotidienne, mensuelle ou annuelle. nul si aucun frais récurrent n’est appliqué à cet élément. Type de données : chaîne
items.recurring_price	Montant des frais récurrents associés à l’élément. Type de données : chaîne
items.recurring_subtotal	Sous-total des frais récurrents de cet élément (recurring_price x quantité). Type de données : nombre
items.recurring_subtotal_price	Sous-total des frais récurrents de cet élément (recurring_price x quantité). Type de données : chaîne
items.short_description	Brève description de l'élément. Type de données : chaîne
items.show_price	Marqueur indiquant s’il faut afficher le prix de l’élément dans le panier. Si ce paramètre est défini sur « faux », les paires nom/valeur de tarification ne sont pas renvoyées dans les paramètres de réponse. Type de données : booléennes
items.show_quantity	Marqueur indiquant s’il faut afficher la quantité de l’élément dans le panier. Type de données : booléennes
items.show_recurring_price	Marqueur indiquant s’il faut afficher les frais récurrents dans le panier. Type de données : booléennes
éléments.sous-total	Sous-total de cet article - sans compter les centimes (prix x quantité). Type de données : nombre
items.subtotal_price	Sous-total de cet article, y compris les centimes (prix x quantité). Type de données : chaîne
nom_classe_items.sys	Classe enfant à laquelle appartient l’enregistrement de l’élément associé. Type de données : chaîne
items.sys_id	Identificateur unique de l’élément (sys_id). Identique à items.cart_item_id. Type de données : chaîne
items.updated_by	Utilisateur ayant mis à jour cet élément dans le panier de la liste de souhaits. Type de données : chaîne
items.updated_on	Date et heure auxquelles l’article a été mis sur la liste de souhaits. Type de données : chaîne
éléments.variables	Paires nom-valeur de variables associées à l’élément. Type de données : objet

Demande cURL

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/wishlist" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

{
  "result": {
    "cart_id": "3a68c46013f12300027879d96144b0ce",
    "items": [
      {
        "updated_on": "2018-11-16 05:54:41",
        "catalog_item_id": "774906834fbb4200086eeed18110c737",
        "short_description": "Macbook Pro",
        "recurring_subtotal_price": "$100.00",
        "delivery_time": "5 Days 0 seconds",
        "sys_class_name": "sc_cat_item",
        "sys_id": "3b8d887113b5a300027879d96144b0c2",
        "price": "$1,499.00",
        "recurring_frequency": "Annually",
        "subtotal_price": "$1,499.00",
        "variables": {
          "Adobe Photoshop": "false",
          "Adobe Acrobat": "false",
          "Optional Software": "true",
          "Additional software requirements": "",
          "Eclipse IDE": "true"
        },
        "quantity": "1",
        "item_id": "774906834fbb4200086eeed18110c737",
        "recurring_price": "$100.00",
        "show_price": true,
        "item_name": "Developer Laptop (Mac)",
        "cart_item_id": "3b8d887113b5a300027879d96144b0c2",
        "recurring_subtotal": 100,
        "show_quantity": true,
        "created_by": "admin",
        "picture": "4e4efd444f889200086eeed18110c7e6.iix",
        "created_on": "2018-11-16 05:54:41",
        "localized_price": "$1,499.00",
        "subtotal": 1499,
        "show_recurring_price": true,
        "name": "Developer Laptop (Mac)",
        "updated_by": "admin",
        "localized_recurring_price": "$100.00",
        "order_guide": ""
      }
    ]
  }
}

Catalogue de services : GET /sn_sc/servicecatalog/wishlist/{cart_item_id}

Récupère les détails de l’élément spécifié stockés dans le panier de la liste de souhaits.

Format d'URL

URL versionnée : /api/sn_sc/v1/servicecatalog/wishlist/{cart_item_id}

URL par défaut : /api/sn_sc/servicecatalog/wishlist/{cart_item_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 73. Paramètres de chemin d'accès

Nom	Description
cart_item_id	Sys_id de l’élément du panier de la liste de souhaits à récupérer. Type de données : chaîne

Tableau 74. Paramètres de requête

Nom	Description
Aucun

Tableau 75. Paramètres de corps de demande (XML ou 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 76. 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 77. 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 78. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
404	Indique un échec de la demande. ID d’élément du panier incorrect ou l’article n’existe pas dans le panier de la liste de souhaits.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
cart_item_id	Sys_id de l’élément. Type de données : chaîne
catalog_item_id	Sys_id de l’identificateur de catalogue pour cet élément dans le panier de la liste de souhaits. Type de données : chaîne
delivery_time	Durée nécessaire pour livrer l’élément. Type de données : chaîne
item_name	Nom de l’élément. Type de données : chaîne
localized_price	Prix de l’article exprimé dans la devise locale. Type de données : chaîne
localized_recurring_price	Prix des frais récurrents exprimé dans la devise locale. Type de données : chaîne
prix	Prix de l’élément. Type de données : chaîne
quantité	Numéro de cet élément dans le panier de la liste de souhaits. Type de données : chaîne
recurring_frequency	Fréquence à laquelle les frais récurrents sont appliqués, par exemple quotidienne, mensuelle ou annuelle. nul si aucun frais récurrent n’est appliqué à cet élément. Type de données : chaîne
recurring_price	Montant des frais récurrents associés à l’élément. Type de données : chaîne
variables	Paires nom-valeur des variables associées à l’élément. Type de données : objet

Demande cURL

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/wishlist/774906834fbb4200086eeed18110c737" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
    "variables": {
      "Adobe Photoshop": "",
      "Adobe Acrobat": "",
      "Optional Software": "",
      "Additional software requirements": ""
    },
    "quantity": "1",
    "localized_price": "$1,100.00",
    "price": "$1,100.00",
    "recurring_frequency": "Annually",
    "localized_recurring_price": "$100.00",
    "recurring_price": "$100.00",
    "item_name": "Standard Laptop &",
    "cart_item_id": "d31be364c3012200d68d3b0ac3d3aecf",
    "delivery_time": "5 Days"
  }
}

Catalogue de services : POST /sn_sc/servicecatalog/cart/checkout

Récupère et traite le paiement du panier actuel selon que le processus de paiement en deux étapes est activé ou non.

Dans le cas d’une validation en une étape, la méthode extrait (enregistre) le panier et renvoie le numéro de demande et l’ID de commande de la demande. En cas de validation en deux étapes, la méthode renvoie l’état de la commande du panier et toutes les informations requises pour la validation en deux étapes.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/cart/checkout

URL par défaut : /api/sn_sc/servicecatalog/cart/checkout

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 79. 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 80. Paramètres de requête

Nom	Description
Aucun

Tableau 81. Paramètres de corps de demande (XML ou 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 82. 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 83. 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 84. Codes d'état

Code d'état	Description
200	Indique que la demande s’est terminée avec succès. Renvoie le total et le sous-total des informations et des informations sur les éléments du panier. Dans le cas d’une validation en une étape, la méthode extrait (enregistre) le panier et renvoie le numéro de demande et l’ID de commande de la demande. En cas de validation en deux étapes, la méthode renvoie l’état de la commande du panier et toutes les informations requises pour la validation en deux étapes.
400	Indique que le panier est vide et ne peut pas payer.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Paramètre	Description
cart_id	Sys_id du chariot. Type de données : chaîne
delivery_address	Adresse à laquelle livrer les éléments du panier. Type de données : chaîne
<recurring_frequency>	Liste des éléments du panier ayant une fréquence récurrente spécifique. Les valeurs possibles sont les suivantes : quotidien mensuel annuel Aucun (aucuns frais récurrents) Type de données : objet "<recurring_frequency>": { "frequency_label": "String", "items": [Array], "show_subtotal_price": "String", "subtotal_price": "String", "subtotal_recurring_frequency": "String", "subtotal_recurring_price": "String", "subtotal_title": "String", "total_title": "String" }
<recurring_frequency>.frequency_label	Fréquence des frais récurrents associés. S’il n’y a pas de frais récurrents pour l’élément, ce paramètre contient « null ». Type de données : chaîne
<recurring_frequency>.éléments	Tableau d’objets contenant les détails de chaque élément associé à la catégorie de fréquence récurrente spécifiée. Type de données : tableau "items": [{ "cart_item_id": "String", "catalog_item_id": "String", "created.by": "String", "created_on": "String", "delivery_time": "String", "item_id": "String", "item_name": "String", "localized_price": "String", "localized_recurring_price": "String", "name": "String", "order_guide": "String", "picture": "String", "price": "String", "quantity": "String", "recurring_frequency": "String", "recurring_price": "String", "recurring_subtotal": Number, "recurring_subtotal_price": "String", "short_description": "String", "show_price": Boolean, "show_quantity": Boolean, "show_recurring_price": Boolean, "subtotal": Number, "subtotal_price": "String", "sys_class_name": "String", "sys_id": "String", "updated_by": "String", "updated_on": "String", "variables": {Object} }]
<recurring_frequency>.items.cart_item_id	Sys_id de l’élément dans ce panier. Type de données : chaîne
<recurring_frequency>.items.catalog_item_id	sys_id catalogue de l’élément. Type de données : chaîne
<recurring_frequency>.items.created.by	Utilisateur ayant initialement placé l’élément dans le panier. Type de données : chaîne
<recurring_frequency>.items.created_on	Date à laquelle l’élément a été initialement placé dans le panier. Type de données : chaîne
<recurring_frequency>.items.delivery_time	Temps nécessaire à la livraison de l’élément spécifié. Type de données : chaîne
<recurring_frequency>.items.item_id	Sys_id de l’élément. Type de données : chaîne
<recurring_frequency>.items.item_name	Nom de l’élément spécifié. Type de données : chaîne
<recurring_frequency>.items.localized_price	Prix de l’élément dans la devise locale. Type de données : chaîne
<recurring_frequency>.items.localized_recurring_price	Frais récurrents pour l’élément spécifié dans la devise locale. Type de données : chaîne
<recurring_frequency>.items.name	Nom de l’élément. Type de données : chaîne
<recurring_frequency>.items.order_guide	Nom du guide de commande auquel cet élément est associé. Si cet élément n’est pas associé à un guide de commande, ce paramètre contient une chaîne vide. Type de données : chaîne
<recurring_frequency>.éléments.image	Nom de fichier de l’image de l’élément. Type de données : chaîne
<recurring_frequency>.éléments.prix	Prix de l'élément. Type de données : chaîne
<recurring_frequency>.éléments.quantité	Numéro de l’élément spécifié dans le panier. Type de données : chaîne
<recurring_frequency>.items.recurring_frequency	Fréquence à laquelle les frais récurrents sont facturés pour l’élément spécifié. S’il n’y a pas de frais récurrents pour l’élément, ce paramètre contient « null ». Type de données : chaîne
<recurring_frequency>.items.recurring_price	Frais récurrents pour l’élément spécifié. Type de données : chaîne
<recurring_frequency>.items.recurring_subtotal	Sous-total des frais récurrents de l’élément (recurring_price x quantity). Type de données : nombre
<recurring_frequency>.items.recurring_subtotal_price	Sous-total des frais récurrents de l’élément. Type de données : chaîne
<recurring_frequency>.items.short_description	Brève description de l’élément. Type de données : chaîne
<recurring_frequency>.items.show_price	Marqueur indiquant si le prix de l’élément est affiché dans le panier. Valeurs possibles : true : affiche le prix de l’élément dans le panier. faux : n’affiche pas le prix de l’élément dans le panier. Type de données : booléennes
<recurring_frequency>.items.show_quantity	Marqueur indiquant s’il faut afficher la quantité de l’élément dans le panier. Valeurs possibles : vrai : afficher la quantité d’éléments dans le panier. faux : n’affiche pas la quantité d’articles dans le panier. Type de données : booléennes
<recurring_frequency>.items.show_recurring_price	Marqueur indiquant si les frais récurrents doivent apparaître dans le panier. Valeurs possibles : true : affiche les frais récurrents dans le panier. false : n’affiche pas les frais récurrents dans le panier. Type de données : booléennes
<recurring_frequency>.éléments.sous-total	Nombre de sous-total d’éléments. Type de données : nombre
<recurring_frequency>.items.subtotal_price	Sous-total de l’élément (price x quantity). Type de données : chaîne
nom_classe_<recurring_frequency>.items.sys	Nom de classification du système de l’élément. Type de données : chaîne
<recurring_frequency>.items.sys_id	Sys_id de l’enregistrement de l’élément. Type de données : chaîne
<recurring_frequency>.items.updated_by	Utilisateur qui a mis à jour l’élément après qu’il ait été initialement placé dans le panier. Type de données : chaîne
<recurring_frequency>.items.updated_on	Dernière date/heure à laquelle l’élément a été initialement placé dans le panier ou mis à jour. Type de données : chaîne
<recurring_frequency>.éléments.variables	Liste des paires nom-valeur des variables d’élément. Type de données : objet
<recurring_frequency>.show_subtotal_price	Marqueur indiquant s’il faut afficher un sous-total pour la catégorie de frais récurrents associée. Valeurs possibles : true : affiche les sous-totaux dans le panier. false : n’affiche pas de sous-totaux dans le panier. Type de données : booléennes
<recurring_frequency>.subtotal_price	Sous-total du coût de tous les éléments pour la catégorie de fréquence récurrente associée. Type de données : chaîne
<recurring_frequency>.subtotal_recurring_frequency	Type de fréquence de récurrence de sous-total, par exemple quotidienne, mensuelle, etc. Identique à subtotal_recurring_frequency. Type de données : chaîne
<recurring_frequency>.subtotal_recurring_price	Sous-total des frais récurrents des éléments dans la catégorie de fréquence récurrente associée. Type de données : chaîne
<recurring_frequency>.subtotal_title	Si la show_subtotal_price est définie sur vrai, le texte à afficher dans le panier pour le sous-titre associé. Type de données : chaîne
<recurring_frequency>.total_title	Texte à afficher pour le titre total pour la catégorie de fréquence récurrente associée. Type de données : chaîne
requested_for	Sys_id de l’utilisateur pour lequel l’élément a été commandé. Type de données : chaîne
requested_for_user	Utilisateur qui a demandé l’élément au nom de quelqu’un d’autre. Type de données : chaîne
show_subtotal_price	Marqueur indiquant s’il faut afficher le prix du sous-total dans le panier. Valeurs possibles : true : affiche les sous-totaux dans le panier. false : n’affiche pas de sous-totaux dans le panier. Type de données : chaîne
special_instructions	Toute instruction donnée par le client sur l’élément. Type de données : chaîne
subtotal_price	Sous-total de tous les articles dans le panier en dollars entiers. Type de données : chaîne
subtotal_recurring_frequency	Type de fréquence de récurrence de sous-total, par exemple quotidienne, mensuelle, etc. Identique à <recurring_frequency>.subtotal_recurring_frequency. Type de données : chaîne
subtotal_recurring_price	Sous-total des frais de fréquence récurrente pour tous les éléments du panier. Type de données : chaîne
subtotal_title	Texte à afficher dans le panier pour le titre du champ de sous-total. Type de données : chaîne
total_title	Texte à afficher dans le panier pour le titre total du champ Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/cart/checkout" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "cart_id": "0830db8413a56300397533e2e144b0ba",
    "subtotal_price": "$1,598.00",
    "subtotal_recurring_frequency": "",
    "delivery_address": "",
    "special_instructions": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "requested_for_user": "System Administrator",
    "none": {
      "subtotal_price": "$1,598.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
        {
          "updated_on": "2018-11-06 17:01:21",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "a846872a1369e300027879d96144b07e",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "a846872a1369e300027879d96144b07e",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 17:01:21",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        },
        {
          "updated_on": "2018-11-06 17:34:15",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "7d138fa21329e300027879d96144b065",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "7d138fa21329e300027879d96144b065",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 16:47:30",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "requested_for": "6816f79cc0a8016401c5a33be04be441",
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

Catalogue de services : POST /sn_sc/servicecatalog/cart/submit_order

Extrait le panier de l’utilisateur, en fonction du type de sortie actuel (une étape ou deux étapes).

Dans le cas d’une validation en une étape, la méthode extrait (enregistre) le panier et renvoie le numéro de demande et l’ID de commande de la demande. En cas de validation en deux étapes, la méthode renvoie l’état de la commande du panier et toutes les informations requises pour la validation en deux étapes.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/cart/submit_order

URL par défaut : /api/sn_sc/servicecatalog/cart/submit_order

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 85. 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 86. Paramètres de requête

Nom	Description
Aucun

Tableau 87. Paramètres de corps de demande (XML ou 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 88. 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 89. 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 90. Codes d'état

Code d'état	Description
200	Indique que la demande s’est terminée avec succès et que les éléments du panier ont été extraits avec succès. Dans le cas d’une validation en une étape, la méthode extrait (enregistre) le panier et renvoie le numéro de demande et l’ID de commande de la demande. En cas de validation en deux étapes, la méthode renvoie l’état de la commande du panier et toutes les informations requises pour la validation en deux étapes.
400	Indique que le panier de l’utilisateur est vide.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
parent_id	Le cas échéant, sys_id de l’enregistrement parent à partir duquel la demande est créée. Pour plus d’informations, consultez Configurer un mappage parent pour une demande. Type de données : chaîne
parent_table	Nom de la table parente. Type de données : chaîne
request_id	Sys_id de la demande de commande générée. Type de données : chaîne
request_number	Numéro de la demande générée. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com /api/sn_sc/v1/servicecatalog/cart/submit_order " \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "request_number": "REQ0010010",
    "request_id": "f89ed597db21120064301150f0b8f5ff"
  }
}

Catalogue de services : POST /sn_sc/servicecatalog/items/{sys_id}/add_to_cart

Ajoute l’élément spécifié au panier de l’utilisateur actuel.

Format d'URL

URL avec version : /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/add_to_cart

URL par défaut : /api/sn_sc/servicecatalog/items/{sys_id}/add_to_cart

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 91. 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
sys_id	Sys_id de l’élément à ajouter au panier actuel. Type de données : chaîne

Tableau 92. Paramètres de requête

Nom	Description
Aucun

Tableau 93. Paramètres de corps de demande (XML ou JSON)

Nom	Description
sysparm_also_request_for	Chaîne d’sys_ids d’utilisateurs séparés par des virgules d’autres utilisateurs pour lesquels commander l’élément spécifié. Vous ne pouvez pas spécifier plus de 50 utilisateurs supplémentaires pour recevoir l’élément. Si une personne de la liste n’est pas admissible à l’élément, l’ensemble de la demande est rejeté. Si l’élément associé ne possède pas le jeu de requested_for variables, la demande est rejetée. Si l’élément associé possède le requested_for jeu de variables, mais que la variable Activer la demande pour n’est pas configurée ou que l’utilisateur appelant ne dispose pas des rôles appropriés, la demande est rejetée. Table : Utilisateur [sys_user]
sysparm_quantity	Requis. Quantité de l’élément. Ne peut pas être un nombre négatif. Type de données : nombre
sysparm_requested_for	Sys_id de l’utilisateur pour lequel commander l’élément spécifié. Type de données : chaîne Table : Utilisateur [sys_user]
variables	Paires nom-valeur de toutes les variables obligatoires d’élément du panier. Les variables obligatoires sont définies sur le formulaire associé. Type de données : chaîne

En-têtes

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

Tableau 94. En-têtes de demandes

En-tête	Description
Aucun

Tableau 95. 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 96. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Les erreurs suivantes peuvent se produire : Valeur de quantité non valide : Indique que le paramètre n’est pas fourni ou qu’il sysparm_quantity contient une valeur non valide. Des contraintes de sécurité empêchent de commander l’élément : Indique que l’élément du panier sys_id spécifié dans les paramètres de chemin d’accès n’est pas valide ou que l’utilisateur n’a pas accès à l’élément. Des variables obligatoires sont requises : Indique qu’une ou plusieurs des variables obligatoires ne sont pas fournies dans la demande.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
cart_id	Panier sys_id. Type de données : chaîne
Éléments	Détails de tous les éléments dans le panier. Type de données : tableau "items":[ { "cart_item_id":"String", "catalog_item_id":"String", "item_name":"String", "localized_recurring_price":"String", "localized_price":"String", "price":"String", "quantity":"String", "recurring_frequency":"String", "recurring_price":"String" } ]
items.cart_item_id	Sys_id de l’élément. Type de données : chaîne
items.catalog_item_id	sys_id catalogue de l’élément. Type de données : chaîne
items.item_name	Nom de l’élément. Type de données : chaîne
items.localized_price	Prix de l’élément, dans la devise locale de l’utilisateur. Type de données : chaîne
items.localized_recurring_price	Prix récurrent de l’élément, dans la devise locale de l’utilisateur. Type de données : chaîne
items.price	Prix de base. Type de données : chaîne
items.quantity	Quantité de l’élément dans le panier. Type de données : chaîne
items.recurring_frequency	Fréquence à laquelle le prix récurrent est appliqué. Type de données : chaîne
items.recurring_price	Prix récurrent. Type de données : chaîne
subtotal	Sous-total des articles dans le panier. Type de données : chaîne

Exemple de demande et de réponse cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/0d08837237153000158bbfc8bcbe5d02/add_to_cart" \
--request POST \
--header "Accept:application/json" \
--data "{ 'sysparm_quantity' : '1',
  'variables' : {
    'acrobat' : 'true'
  }
}" \
--user "username":"password"

{
  "result": {
    "cart_id": "0951c597db21120064301150f0b8f5cf",
    "subtotal": "$1,599.98",
    "items": [
      {
        "catalog_item_id": "0d08837237153000158bbfc8bcbe5d02",
        "quantity": "1",
        "localized_price": "$799.99",
        "price": "$799.99",
        "recurring_frequency": "Monthly",
        "localized_recurring_price": "$30.00",
        "recurring_price": "$29.00",
        "item_name": "Apple iPhone 5",
        "cart_item_id": "ac61c597db21120064301150f0b8f5f9"
      }
    ]
  }
}

Catalogue de services : POST /sn_sc/servicecatalog/items/{sys_id}/add_to_wishlist

Ajoute l’élément spécifié au panier de la liste de souhaits.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/add_to_wishlist

URL par défaut : /api/sn_sc/ servicecatalog/items/{sys_id}/add_to_wishlist

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 97. 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
sys_id	Sys_id de l’élément à ajouter à la liste de souhaits. Type de données : chaîne

Tableau 98. Paramètres de requête

Nom	Description
Aucun

Tableau 99. Paramètres de corps de demande (XML ou 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 100. 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 101. 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 102. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Indique un échec de la demande. Données de demande non valides ou l’utilisateur ne peut pas ajouter l’élément à la liste de souhaits.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
Aucun

Demande cURL

curl "http://instance.servicenow.com/api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/add_to_wishlist" \
 --request POST \
 --header "Accept:application/json" \
 --header "Content-Type:application/json" \
 --data "{\"sysparm_quantity\":\"1\"}" \
 --user "username":"password"

{
  "result": {
    "cart_id": "02a559a7c3b02200d68d3b0ac3d3ae5d",
    "items": [
      {
        "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
        "variables": {
          "Adobe Photoshop": "",
          "Adobe Acrobat": "",
          "Optional Software": "",
          "Additional software requirements": ""
        },
        "quantity": "1",
        "localized_price": "$1,100.00",
        "price": "$1,100.00",
        "recurring_frequency": "Annually",
        "localized_recurring_price": "$100.00",
        "recurring_price": "$100.00",
        "item_name": "Standard Laptop &",
        "cart_item_id": "d31be364c3012200d68d3b0ac3d3aecf",
        "delivery_time": "5 Days"
      }
    ]
  }
}

Catalogue de services : POST /sn_sc/servicecatalog/items/{sys_id}/checkout_guide

Récupère un tableau de contenus demandés pour la validation.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/checkout_guide

URL par défaut : /api/sn_sc/servicecatalog/items/{sys_id}/checkout_guide

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 103. 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
sys_id	Sys_id du guide de paiement pour lequel renvoyer les informations. Type de données : chaîne

Tableau 104. Paramètres de requête

Nom	Description
Aucun

Tableau 105. Paramètres de corps de demande (XML ou JSON)

Nom	Description
Éléments	Liste des objets décrivant les éléments demandés pour la validation. Type de données : tableau "items": [{ "sys_id": "String", "sysparm_quantity": "String", "variables": {Object} }]
items.sys_id	Requis. Sys_id de l’élément de catalogue. Type de données : chaîne
items.sysparm_quantity	Nombre d’éléments. Type de données : chaîne Valeur par défaut : 1
éléments.variables	Paires nom-valeur de variables associées à l’élément. Type de données : objet Par défaut : aucune variable

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 106. 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 107. 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 108. Codes d'état

Code d'état	Description
200	Indique que la demande s’est terminée avec succès. N’est pas en deux étapes : Les articles sont ajoutés au panier et le contenu du panier est renvoyé. Se fait en deux temps : Renvoie le numéro et l’sys_id de la demande après validation.
400	Indique que la demande n’est pas valide. Cela pourrait être dû à l’une des raisons suivantes : Au moins un élément envoyé n’existe pas. L’utilisateur n’a pas accès à un ou plusieurs éléments. Les variables obligatoires d’un ou plusieurs éléments n’ont pas reçu de réponse. (Seules les variables définies comme obligatoires sont respectées.) La valeur de quantité est envoyée et n’est pas un nombre entier positif.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Tableau 109. Éléments renvoyés dans le corps de la réponse lorsque la validation de l’achat en deux étapes est fausse

Nom	Description
cart_id	Sys_id du chariot. Type de données : chaîne
Éléments	Liste des objets contenant les détails de tous les éléments du panier. Type de données : tableau "items": [{ "cart_item_id": "String", "catalog_item_id": "String", "delivery_time": "String", "item_name": "String", "localized_price": "String", "localized_recurring_price": "String", "price": "String", "quantity": "String", "recurring_frequency": "String", "recurring_price": "String", "variables": {Object} }]
items.cart_item_id	Sys_id de l’élément dans le panier. Type de données : chaîne
items.catalog_item_id	Sys_id de l’élément de catalogue dans le panier. Type de données : chaîne
items.delivery_time	Durée nécessaire à la livraison de l’élément. Type de données : chaîne
items.item_name	Nom de l’élément dans le panier. Type de données : chaîne
items.localized_price	Prix de l’élément dans la devise locale. Type de données : chaîne
items.localized_recurring_price	Prix récurrent de l’élément dans la devise locale. Type de données : chaîne
items.price	Prix de l'élément. Type de données : chaîne
items.quantity	Numéro de l’élément dans le panier. Type de données : chaîne
items.recurring_frequency	Fréquence récurrente de l’élément. Type de données : chaîne
items.recurring_price	Prix récurrent de l’élément. Type de données : chaîne
éléments.variables	Paires nom-valeur associées à l’élément dans le panier. Type de données : objet
parent_id	Le cas échéant, le sys_id de l’enregistrement parent à partir duquel la demande est créée. Pour plus d’informations, consultez Configurer un mappage parent pour une demande. Type de données : chaîne
parent_table	Nom de la table parente (sensible à la casse). Type de données : chaîne
request_number	Numéro d’enregistrement de la demande. Type de données : chaîne
request_id	Sys_id de la demande. Type de données : chaîne
subtotal_price	Sous-total du panier. Type de données : chaîne
subtotal_price	Sous-total du bloc de fréquences actuel. Type de données : chaîne
subtotal_recurring_frequency	Sous-total de la fréquence de récurrence du panier. Type de données : chaîne
subtotal_recurring_frequency	Sous-total de fréquence récurrente du bloc de fréquences actuel. Type de données : chaîne
subtotal_recurring_price	Sous-total de prix récurrent du panier. Type de données : chaîne
subtotal_recurring_price	Sous-total de prix récurrent du bloc de fréquences actuel Type de données : chaîne
total_title	Titre du champ Total de la page. Type de données : chaîne
total_title	Titre du champ Total sur le bloc de fréquences actuel. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/items/6690750f4f7b4200086eeed18110c761/checkout_guide" \
--request POST \
--header "Accept:application/json"  \
--header "Content-Type:application/json" \
--data "{\"items\":[{
  \"sys_id\":\"04b7e94b4f7b4200086eeed18110c7fd\",
  \"variables\":{
    \"acrobat\":\"true\",
    \"Additional_software_requirements\":\"MS Office 2007\"
  },
  \"sysparm_quantity\":\"3\"
},
{
  \"sys_id\":\"e1be6dcb4f7b4200086eeed18110c74c\"
},
{
  \"sys_id\":\"186d917a6fab7980575967ddbb3ee4f2\",
  \"variables\":{
    \"new_email\":\"[e-mail]\"
  }
},
{
  \"sys_id\":\"8b3ae7fedc1be1004ece5c08239e522b\"
},
{
  \"sys_id\":\"962967674ff38200086eeed18110c7e7\",
  \"variables\":{
    \"ergonomic_office\":\"Office chair should have lumbar support\"
  }
}]}" \
--user "username":"password"

<!--Case-1: if two-step is false:-->
{
  "result": {
    "cart_id": "0d8c7a32c3211200d68d3b0ac3d3aeba",
    "subtotal_price": "$3,350.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$300.00",
    "total_title": "Total",
    "monthly": {
      "subtotal_price": "$50.00",
      "subtotal_recurring_frequency": "Monthly",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "90af095bcd38798071a208d710d1b64f",
          "variables": {},
          "quantity": "1",
          "localized_price": "$50.00",
          "price": "$50.00",
          "recurring_frequency": "Monthly",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Belkin iPad Mini Case",
          "cart_item_id": "cb6e485fc3211200d68d3b0ac3d3ae35",
          "delivery_time": "2 Days"
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "none": {
      "subtotal_price": "-",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "186d917a6fab7980575967ddbb3ee4f2",
          "variables": {
            "Preferred Email address": "[e-mail]"
          },
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "New Email Account",
          "cart_item_id": "17c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "global.Workflow"
        },
        {
          "catalog_item_id": "8b3ae7fedc1be1004ece5c08239e522b",
          "variables": {},
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Corp VPN",
          "cart_item_id": "97c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "2 Days"
        },
        {
          "catalog_item_id": "e1be6dcb4f7b4200086eeed18110c74c",
          "variables": {},
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "External Monitor",
          "cart_item_id": "d3c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "2 Days"
        },
        {
          "catalog_item_id": "962967674ff38200086eeed18110c7e7",
          "variables": {
            "Please describe any ergonomic requirements\n\t\t": "Office chair should have lumbar support"
          },
          "quantity": "1",
          "localized_price": "$0.00",
          "price": "$0.00",
          "recurring_frequency": "",
          "localized_recurring_price": "$0.00",
          "recurring_price": "$0.00",
          "item_name": "Desk Set Up",
          "cart_item_id": "d7c5241fc3211200d68d3b0ac3d3ae7f",
          "delivery_time": "5 Days"
        }
      ],
      "show_subtotal_price": "false",
      "subtotal_title": "Subtotal"
    },
    "yearly": {
      "subtotal_price": "$3,300.00",
      "subtotal_recurring_frequency": "Annually",
      "subtotal_recurring_price": "$300.00",
      "total_title": "Total",
      "items": [
        {
          "catalog_item_id": "04b7e94b4f7b4200086eeed18110c7fd",
          "variables": {
            "Adobe Photoshop": "",
            "Adobe Acrobat": "true",
            "Optional Software": "",
            "Additional software requirements": "MS Office 2007"
          },
          "quantity": "3",
          "localized_price": "$1,100.00",
          "price": "$1,100.00",
          "recurring_frequency": "Annually",
          "localized_recurring_price": "$100.00",
          "recurring_price": "$100.00",
          "item_name": "Standard Laptop",
          "cart_item_id": "9fc5241fc3211200d68d3b0ac3d3ae7e",
          "delivery_time": "5 Days"
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

Case-2: if two-step is true:
{
  "result": {
    "request_number": "REQ0010001",
    "request_id": "82a7e89fc3211200d68d3b0ac3d3ae0a"
  }
}

Catalogue de services : POST /sn_sc/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users

Renvoie une liste des utilisateurs dont la demande pour l’élément spécifié ne peut pas être déléguée (demandée par un autre utilisateur).

Vous pouvez appeler ce point de terminaison avant d’appeler un point de terminaison tel que l’API de Catalogue de services : POST /sn_sc/servicecatalog/items/{sys_id}/add_to_cart ou l’API de Catalogue de services : POST /sn_sc/servicecatalog/items/{sys_id}/order_now qui autorisent la demande d’un élément de catalogue de services au nom d’une autre personne. Ces appels échouent si vous transmettez un utilisateur qui n’est pas autorisé pour l’élément associé. Ce point de terminaison vous permet de vérifier votre liste d’utilisateurs avant d’appeler un point de terminaison qui commande l’élément ou tente d’ajouter l’élément à un panier.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users

URL par défaut : /api/sn_sc/servicecatalog/items/{item_sys_id}/get_invalid_delegated_users

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 110. 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
item_sys_id	Sys_id de l’élément de catalogue de services pour vérifier si l’utilisateur spécifié dispose des droits d’acquisition. Type de données : chaîne Table : Catalogue de services [sc_catalog]

Tableau 111. Paramètres de requête

Nom	Description
Aucun

Tableau 112. Paramètres de corps de demande (XML ou JSON)

Nom	Description
sysparm_also_request_for	Chaîne séparée par des virgules des sys_ids d’utilisateur valides. Le point de terminaison vérifie que ces utilisateurs disposent des droits d’acquisition sur l’élément du catalogue de services spécifié. Type de données : chaîne Table : utilisateurs [sys_users]

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 113. 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 114. 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 115. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	La demande a échoué. Demande incorrecte donnée pour traitement. Consultez le message dans les résultats de retour pour plus d’informations sur l’erreur.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
errCode	Numéro associé à l’erreur. Uniquement renvoyé en cas d’échec du point de terminaison. Type de données : chaîne
errMsg	Description de l’erreur rencontrée par le point de terminaison en cas d’échec.
invalidUsers	Noms des utilisateurs qui ne sont pas en mesure de demander l’élément de catalogue spécifié. Type de données : tableau

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/get_invalid_delegated_users" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"sysparm_also_request_for\":\"a8f98bb0eb32010045e1a5115206fe3a,62826bf03710200044e0bfc8bcbe5df1\"}" \
--user "username":"password"

{
  "result": {
    "invalidUsers": [
      "Abel Tuter"
    ]
  }
}

Demande cURL

curl "https://instance.servicenow.com /api/sn_sc/servicecatalog/items/04b7e94b4f7b4200086eeed18110c7fd/get_invalid_delegated_users" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"sysparm_also_request_for\":\"a8f98bb0eb32010045e1a5115206fe3a,62826bf03710200044e0bfc8bcbe5df1\"}" \
--user "username":"password"

{
  "result": {
    "errCode": "42202",
    "errMsg": "This item cannot be submitted for multiple people as it is not configured with Requested For"
  }
}

Catalogue de services : POST /sn_sc/servicecatalog/items/{sys_id}/order_now

Commande l’élément de catalogue spécifié.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/order_now

URL par défaut : /api/sn_sc/servicecatalog/items/{sys_id}/order_now

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 116. 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
sys_id	Sys_id de l’élément de catalogue de services. Type de données : chaîne Table : élément de catalogue [sc_cat_item]

Tableau 117. Paramètres de requête

Nom	Description
Aucun

Tableau 118. Paramètres de corps de demande (XML ou JSON)

Nom	Description
sysparm_also_request_for	Chaîne d’sys_ids d’utilisateurs séparés par des virgules d’autres utilisateurs pour lesquels commander l’élément spécifié. Vous ne pouvez pas spécifier plus de 50 utilisateurs supplémentaires pour recevoir l’élément. Si une personne de la liste n’est pas admissible à l’élément, l’ensemble de la demande est rejeté. Si l’élément associé ne possède pas le jeu de requested_for variables, la demande est rejetée. Si l’élément associé possède le requested_for jeu de variables, mais que la variable Activer la demande pour n’est pas configurée ou que l’utilisateur appelant ne dispose pas des rôles appropriés, la demande est rejetée. Table : Utilisateur [sys_user]
sysparm_quantity	Requis. Quantité de l’élément. Ne peut pas être un nombre négatif. Type de données : nombre
sysparm_requested_for	Sys_id de l’utilisateur pour lequel commander l’élément spécifié. Les paramètres des glide.sc.req_for.roles propriétés et glide.sc.req_for.roles.default déterminent le niveau auquel un utilisateur peut demander des éléments. Si une valeur est spécifiée dans la glide.sc.req_for.roles propriété, le système vérifie si l’utilisateur dispose du rôle spécifié pour demander des informations aux autres utilisateurs. Si la valeur de la glide.sc.req_for.roles propriété est vide et que la valeur de la glide.sc.req_for.roles.default propriété est refusée, aucun utilisateur ne peut demander d’éléments pour d’autres utilisateurs. Si la valeur de la glide.sc.req_for.roles propriété est vide et que la valeur de la glide.sc.req_for.roles.default propriété est autorisée, tout utilisateur peut demander des éléments pour d’autres utilisateurs. Type de données : chaîne
variables	Paires nom-valeur de toutes les variables obligatoires d’élément du panier. Les variables obligatoires sont définies sur le formulaire associé. Type de données : chaîne

En-têtes

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

Tableau 119. 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 120. 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 121. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Indique que la valeur de quantité n’est pas valide et que la demande n’est pas effectuée.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
Numéro	Numéro de la demande générée. Type de données : chaîne
parent_id	Le cas échéant, le sys_id de l’enregistrement parent à partir duquel la demande est créée. Pour plus d’informations, consultez Configurer un mappage parent pour une demande. Type de données : chaîne
parent_table	Le cas échéant, le nom de la table parente à partir de laquelle la demande est créée. Type de données : chaîne
request_id	Sys_id de la demande de commande. Type de données : chaîne
request_number	Numéro de demande. Type de données : chaîne
sys_id	Sys_id de la commande. Type de données : chaîne
Table	Nom de table de la demande. Type de données : chaîne

Exemple de demande cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/d82ea08510247200964f77ffeec6c4ee/order_now" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  sysparm_quantity: 1,
  variables: {
    replacement: 'Yes',
    originalnumber: '1640000',
    data_plan: '500MB'
  }
}" \
--user "username":"password"

{
  "result": {
    "sys_id": "cf56a3fcdb3a2300e890f71fbf9619ac",
    "number": "REQ0010012",
    "request_number": "REQ0010012",
    "request_id": "cf56a3fcdb3a2300e890f71fbf9619ac",
    "table": "sc_request"
  }
}

Catalogue de services : POST /sn_sc/servicecatalog/items/{sys_id}/submit_producer

Crée un enregistrement et renvoie le chemin relatif de l’API de table et l’URL de redirection pour accéder à l’enregistrement créé.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/submit_producer

URL par défaut : /api/sn_sc/servicecatalog/items/{sys_id}/submit_producer

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 122. 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
sys_id	Sys_id de la table dans laquelle créer le créateur d’enregistrement. Type de données : chaîne

Tableau 123. Paramètres de requête

Nom	Description
sysparm_view	Vue de l'interface utilisateur pour laquelle afficher les données. Détermine les champs renvoyés dans la réponse. Valeurs valides : desktop mobile les deux Si vous spécifiez également le paramètre sysparm_fields, il est prioritaire. Type de données : chaîne

Tableau 124. Paramètres de corps de demande (XML ou JSON)

Nom	Description
variables	Paires nom-valeur des variables de l’enregistrement du créateur à définir.

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 125. 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 126. 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 127. Codes d'état

Code d'état	Description
200	Indique que la demande a abouti et renvoie l’objet de réponse composé de la table, de l’API et de l’URL pour accéder à l’enregistrement créé.
400	La demande n’est pas traitée en raison d’un message de demande incorrect.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
404	La ressource demandée est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
Numéro	Numéro du ticket associé au créateur d’enregistrement. Type de données : chaîne
parent_id	Le cas échéant, sys_id de l’enregistrement parent à partir duquel la demande est créée. Pour plus d’informations, consultez Configurer un mappage parent pour une demande. Type de données : chaîne
parent_table	Nom de la table parente. Type de données : chaîne
record	Chemin d’accès relatif de l’API de table du créateur d’enregistrement nouvellement créé. Type de données : chaîne
redirect_portal_url	URL vers laquelle rediriger le Portail de services. Type de données : chaîne
redirect_to	Valeur de redirection. Type de données : chaîne
redirect_url	URL de redirection pour accéder au créateur d’enregistrement créé. Type de données : chaîne
sys_id	Sys_id de l’enregistrement créé. Type de données : chaîne
Table	Nom de la table sur laquelle la demande a été effectuée. Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/items/3f1dd0320a0a0b99000a53f7604a2ef9/submit_producer" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{'variables':{'urgency':'2','comments':'This is sample incident'}}" \
--user "username":"password"

{
  "result": {
    "sys_id": "6baf4e1ddbba2300e890f71fbf961963",
    "number": "INC0010006",
    "parent_id": null,
    "record": "api/now/table/incident/6baf4e1ddbba2300e890f71fbf961963",
    "redirect_portal_url": "",
    "parent_table": "task",
    "redirect_url": "incident.do?sys_id=6baf4e1ddbba2300e890f71fbf961963&sysparm_view=ess",
    "table": "incident",
    "redirect_to": ""
  }
}

Catalogue de services : POST /sn/sc/servicecatalog/variables/{sys_id}/display_value

Renvoie la valeur d’affichage de la variable spécifiée.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/variables/{sys_id}/display_value

URL par défaut : /api/sn_sc/servicecatalog/variables/{sys_id}/display_value

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 128. 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
sys_id	Sys_id de la variable dont la valeur d’affichage doit être renvoyée. Type de données : chaîne

Tableau 129. Paramètres de requête

Nom	Description
Aucun

Tableau 130. Paramètres de corps de demande (XML ou JSON)

Nom	Description
sysparm_value	Sys_id de l’enregistrement qui contient la valeur d’affichage à renvoyer. 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 131. 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 132. 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 133. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
404	Introuvable. L’élément demandé est introuvable.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
résultat	Valeur d’affichage de la variable. Type de données : chaîne

Demande cURL

 curl "https://instance.servicenow.com/api/sn_sc/servicecatalog/variables/2a3947a10a0a020e007f12648f8790c0/display_value" \ 
--request POST \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"sysparm_value\":\"62826bf03710200044e0bfc8bcbe5df1\"}" \ 
--user "username":"password" 

{
  "result": "Abel Tuter (Architect)"
}

Catalogue de services : PUT /sn_sc/servicecatalog/cart/{cart_item_id}

Met à jour l’élément spécifié dans le panier de l’utilisateur connecté.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/cart/{cart_item_id}

URL par défaut : /api/sn_sc/servicecatalog/cart/{cart_item_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 134. 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
cart_item_id	Sys_id de l’élément du panier à mettre à jour. Type de données : chaîne

Tableau 135. Paramètres de requête

Nom	Description
Aucun

Tableau 136. Paramètres de corps de demande (XML ou JSON)

Nom	Description
sysparm_quantity	Requis. Quantité de l’élément pour mettre à jour le panier. Type de données : chaîne
variables	Requis si des variables obligatoires sont spécifiées pour l’élément. Objet composé de toutes les paires noms-valeurs de variables obligatoires. Type de données : objet

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 137. 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 138. 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 139. Codes d'état

Code d'état	Description
201	Indique que la demande s’est terminée avec succès et que l’élément est ajouté au panier.
400	Les trois erreurs suivantes peuvent se produire : Valeur de quantité non valide :Indique que le paramètre sysparm_quantity n’est pas fourni ou qu’il contient une valeur non valide. Des contraintes de sécurité empêchent de commander l’élément :Indique que l’ID d’élément spécifié dans les paramètres de chemin d’accès n’est pas valide ou que l’utilisateur n’a pas accès à l’élément. Des variables obligatoires sont requises :Indique qu’une ou plusieurs des valeurs de variables obligatoires ne sont pas fournies dans la demande.
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

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

Nom	Description
cart_id	Sys_id du chariot. Type de données : chaîne
<recurring_frequency>	Décrit un élément dans le panier ayant une fréquence récurrente spécifique. Les valeurs possibles sont les suivantes : quotidien mensuel annuel Aucun (aucuns frais récurrents) Type de données : objet "<recurring_frequency>": { "frequency_label": "String", "items": [Array], "show_subtotal_price": "String", "subtotal_price": "String", "subtotal_recurring_frequency": "String", "subtotal_recurring_price": "String", "subtotal_title": "String", "total_title": "String" }
<recurring_frequency>.frequency_label	Fréquence des frais récurrents associés. S’il n’y a pas de frais récurrents pour l’élément, ce paramètre contient « null ». Type de données : chaîne
<recurring_frequency>.éléments	Liste des objets décrivant chaque élément associé à la catégorie de fréquence récurrente spécifiée. Type de données : tableau "items": [{ "cart_item_id": "String", "catalog_item_id": "String", "created.by": "String", "created_on": "String", "delivery_time": "String", "item_id": "String", "item_name": "String", "localized_price": "String", "localized_recurring_price": "String", "name": "String", "order_guide": "String", "picture": "String", "price": "String", "quantity": "String", "recurring_frequency": "String", "recurring_price": "String", "recurring_subtotal": Number, "recurring_subtotal_price": "String", "short_description": "String", "show_price": Boolean, "show_quantity": Boolean, "show_recurring_price": Boolean, "subtotal": Number, "subtotal_price": "String", "sys_class_name": "String", "sys_id": "String", "updated_by": "String", "updated_on": "String", "variables": {Object} }]
<recurring_frequency>.items.cart_item_id	Sys_id de l’élément dans ce panier. Type de données : chaîne
<recurring_frequency>.items.catalog_item_id	sys_id catalogue de l’élément. Type de données : chaîne
<recurring_frequency>.items.created.by	Utilisateur ayant initialement placé l’élément dans le panier. Type de données : chaîne
<recurring_frequency>.items.created_on	Date à laquelle l’élément a été initialement placé dans le panier. Type de données : chaîne
<recurring_frequency>.items.delivery_time	Temps nécessaire à la livraison de l’élément spécifié. Type de données : chaîne
<recurring_frequency>.items.item_id	Élément sys_id. Type de données : chaîne
<recurring_frequency>.items.item_name	Nom de l’élément spécifié. Type de données : chaîne
<recurring_frequency>.items.localized_price	Prix de l’article (en devise locale). Type de données : chaîne
<recurring_frequency>.items.localized_recurring_price	Frais récurrents pour l’élément spécifié (dans la devise locale). Type de données : chaîne
<recurring_frequency>.items.name	Nom de l’élément. Type de données : chaîne
<recurring_frequency>.items.order_guide	Nom du guide de commande auquel cet élément est associé. Si cet élément n’est pas associé à un guide de commande, ce paramètre contient une chaîne vide. Type de données : chaîne
<recurring_frequency>.éléments.image	Nom de fichier de l’image de l’élément. Type de données : chaîne
<recurring_frequency>.éléments.prix	Prix de l'élément. Type de données : chaîne
<recurring_frequency>.éléments.quantité	Numéro de l’élément spécifié dans le panier. Type de données : chaîne
<recurring_frequency>.items.recurring_frequency	Fréquence à laquelle les frais récurrents sont facturés pour l’élément spécifié. Type de données : chaîne Valeur par défaut : nul
<recurring_frequency>.items.recurring_price	Frais récurrents pour l’élément spécifié. Type de données : chaîne
<recurring_frequency>.items.recurring_subtotal	Sous-total des frais récurrents de l’élément (recurring_price x quantity). Type de données : nombre
<recurring_frequency>.items.recurring_subtotal_price	Sous-total des frais récurrents de l’élément. Type de données : chaîne
<recurring_frequency>.items.short_description	Brève description de l’élément. Type de données : chaîne
<recurring_frequency>.items.show_price	Marqueur indiquant si le prix de l’élément est affiché dans le panier. Valeurs possibles : true : affiche le prix de l’élément dans le panier. faux : n’affiche pas le prix de l’élément dans le panier. Type de données : booléennes
<recurring_frequency>.items.show.quantity	Marqueur indiquant s’il faut afficher la quantité de l’élément dans le panier. Valeurs possibles : vrai : afficher la quantité d’éléments dans le panier. faux : n’affiche pas la quantité d’articles dans le panier. Type de données : booléennes
<recurring_frequency>.items.show_recurring_price	Marqueur indiquant si les frais récurrents doivent apparaître dans le panier. Valeurs possibles : true : affiche les frais récurrents dans le panier. false : n’affiche pas les frais récurrents dans le panier. Type de données : booléennes
<recurring_frequency>.éléments.sous-total	Sous-total du nombre d’éléments. Type de données : nombre
<recurring_frequency>.items.subtotal_price	Sous-total de l’élément (price x quantity). Type de données : chaîne
nom_classe_<recurring_frequency>.items.sys	Nom de classification du système de l’élément. Type de données : chaîne
<recurring_frequency>.items.sys_id	Sys_id de l’élément. Type de données : chaîne
<recurring_frequency>.items.updated_by	Utilisateur qui a mis à jour l’élément après qu’il ait été initialement placé dans le panier. Type de données : chaîne
<recurring_frequency>.items.updated_on	Dernière date/heure à laquelle l’élément a été initialement placé dans le panier ou mis à jour. Type de données : chaîne
<recurring_frequency>.éléments.variables	Paires nom-valeur des variables d’élément. Type de données : objet
<recurring_frequency>.show_subtotal_price	Marqueur indiquant s’il faut afficher un sous-total pour la catégorie de frais récurrents associée. Type de données : chaîne
<recurring_frequency>.subtotal_price	Sous-total du coût de tous les éléments pour la catégorie de fréquence récurrente associée. Type de données : chaîne
<recurring_frequency>.subtotal_recurring_frequency	Type de fréquence de récurrence de sous-total, par exemple quotidienne, mensuelle, etc. Type de données : chaîne
<recurring_frequency>.subtotal_recurring_price	Sous-total des frais récurrents des éléments dans la catégorie de fréquence récurrente associée. Type de données : chaîne
<recurring_frequency>.subtotal_title	Si la show_subtotal_price est définie sur vrai, le texte à afficher dans le panier pour le sous-titre associé. Type de données : chaîne
<recurring_frequency>.total_title	Texte à afficher pour le titre total pour la catégorie de fréquence récurrente associée. Type de données : chaîne
show_subtotal_price	Marqueur indiquant s’il faut afficher le prix du sous-total dans le panier. Valeurs possibles : true : affiche les sous-totaux dans le panier. false : n’affiche pas de sous-totaux dans le panier. Type de données : chaîne
subtotal_price	Sous-total de tous les articles dans le panier. Type de données : chaîne
subtotal_recurring_frequency	Type de fréquence de récurrence de sous-total, par exemple quotidienne, mensuelle, etc. Identique à <recurring_frequency>.subtotal_recurring_frequency. Type de données : chaîne
subtotal_recurring_price	Sous-total des frais de fréquence récurrente pour tous les éléments du panier. Type de données : chaîne
subtotal_title	Texte à afficher dans le panier pour le titre du champ de sous-total. Type de données : chaîne
total_title	Texte à afficher dans le panier pour le titre total du champ Type de données : chaîne

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/cart/7d138fa21329e300027879d96144b065" \
--request PUT \
--header "Accept:application/json" \
--data "{\"sysparm_quantity\": \"2\" }" \
--user "username":"password"

{
  "result": {
    "cart_id": "0830db8413a56300397533e2e144b0ba",
    "subtotal_price": "$2,397.00",
    "subtotal_recurring_frequency": "",
    "subtotal_recurring_price": "$0.00",
    "total_title": "Total",
    "none": {
      "subtotal_price": "$2,397.00",
      "subtotal_recurring_frequency": "",
      "subtotal_recurring_price": "$0.00",
      "total_title": "Total",
      "frequency_label": null,
      "items": [
        {
          "updated_on": "2018-11-06 17:01:21",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "a846872a1369e300027879d96144b07e",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$799.00",
          "variables": {},
          "quantity": "1",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "a846872a1369e300027879d96144b07e",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 17:01:21",
          "localized_price": "$799.00",
          "subtotal": 799,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        },
        {
          "updated_on": "2018-11-06 17:21:08",
          "catalog_item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "short_description": "Apple iPhone 7 ",
          "recurring_subtotal_price": "$0.00",
          "delivery_time": "2 Days",
          "sys_class_name": "sc_cat_item",
          "sys_id": "7d138fa21329e300027879d96144b065",
          "price": "$799.00",
          "recurring_frequency": null,
          "subtotal_price": "$1,598.00",
          "variables": {},
          "quantity": "2",
          "item_id": "07f1666b0bf00300eba42da0d5673ab0",
          "recurring_price": "$0.00",
          "show_price": true,
          "item_name": "Apple iPhone7",
          "cart_item_id": "7d138fa21329e300027879d96144b065",
          "recurring_subtotal": 0,
          "show_quantity": true,
          "created_by": "admin",
          "picture": "e823ee6b0bf00300eba42da0d5673a95.iix",
          "created_on": "2018-11-06 16:47:30",
          "localized_price": "$799.00",
          "subtotal": 1598,
          "show_recurring_price": false,
          "name": "Apple iPhone7",
          "updated_by": "admin",
          "localized_recurring_price": "$0.00",
          "order_guide": ""
        }
      ],
      "show_subtotal_price": "true",
      "subtotal_title": "Subtotal"
    },
    "show_subtotal_price": "true",
    "subtotal_title": "Subtotal"
  }
}

Catalogue de services : PUT /sn_sc/servicecatalog/items/{sys_id}/submit_guide

Récupère une liste d’éléments en fonction des besoins décrits pour un guide de commande.

Format d'URL

URL versionnée : /api/sn_sc/{api_version}/servicecatalog/items/{sys_id}/submit_guide

URL par défaut : /api/sn_sc/servicecatalog/items/{sys_id}/submit_guide

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 140. 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
sys_id	Sys_id du guide de commande dont les éléments doivent être récupérés. Type de données : chaîne Table : Guide de commande [sc_cat_item_guide]

Tableau 141. Paramètres de requête

Nom	Description
Aucun

Tableau 142. Paramètres de corps de demande (XML ou JSON)

Nom	Description
variables	Variables demandées pour un élément. Chaque variable est un objet JSON composé de paires nom-valeur. Type de données : tableau

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 143. 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 144. 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 145. Codes d'état

Code d'état	Description
200	Indique que la demande s’est terminée avec succès. Renvoie une liste d’éléments en fonction de la liste de variables transmises. Si le jeu de résultats ne contient aucun élément, un tableau vide est renvoyé.
400	Indique que la demande n’est pas valide. Cela pourrait être dû à l’une des raisons suivantes : L’utilisateur n’a pas accès à l’élément. Les variables obligatoires d’un ou plusieurs éléments n’ont pas reçu de réponse. (Seules les variables définies comme obligatoires sont respectées.)
401	Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
500	Erreur interne lors du calcul des éléments en fonction des options choisies.

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

Nom	Description
Catalogues	Liste des objets auxquels l’élément appartient, ainsi que chaque titre de catalogue et sys_id du catalogue. Type de données : tableau d’objets "catalogs": [ { "sys_id": "String", "title": "String" } ]
catalogs.sys_id	Sys_id du catalogue. Type de données : chaîne
catalogues.titre	Titre du catalogue. Type de données : chaîne
catégorie	Catégorie qui contient cet élément. Type de données : objet "catalogs": { "sys_id": "String", "title": "String" }
category.sys_id	Sys_id de la catégorie. Type de données : chaîne
catégorie.titre	Titre de catégorie Type de données : chaîne
client_script	Liste de tous les scripts clients de catalogue définis sur l’élément de catalogue. Type de données : objet "client_script": { "onChange": [Array], "onLoad": [Array], "onSubmit": [Array] }
client_script.onChange	Liste des scripts clients onChange associés à l’élément. Type de données : tableau
client_script.onLoad	Liste des scripts clients onLoad associés à l’élément. Type de données : tableau
client_script.onSubmit	Liste des scripts clients onSubmit associés à l’élément. Type de données : tableau
data_lookup	Recherches de données définies sur l’élément de catalogue. Type de données : tableau
description	Description complète de l’élément de catalogue. Type de données : chaîne
icône	Chemin de l’image qui apparaît sous la forme d’une icône en regard de l’élément de catalogue. Type de données : chaîne
nom	Nom de l’élément de catalogue. Type de données : chaîne
short_description	Texte sur la page d’accueil du catalogue de services ou la page des résultats de recherche, ou titre sur le formulaire de commande de l’élément de catalogue. Type de données : chaîne
show_price	Marqueur indiquant s’il faut afficher les détails du prix. Si la valeur est vraie, renvoie les détails suivants. local_currency localized_price localized_recurring_price prix price_currency recurring_frequency recurring_price recurring_price_currency Type de données : booléennes
sys_id	Sys_id de l’élément de catalogue. Type de données : chaîne
type	Type d’élément. Valeurs possibles : Élément de catalogue Guide de commande Élément du créateur d’enregistrement Type de données : chaîne
variables	Paires nom-valeur de toutes les variables associées à l’élément de catalogue. Type de données : tableau
ui_policy	Liste de toutes les politiques d’interface utilisateur de catalogue définies sur l’élément de catalogue. Type de données : tableau

Demande cURL

curl "https://instance.servicenow.com/api/sn_sc/v1/servicecatalog/items/6690750f4f7b4200086eeed18110c761/submit_guide" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"variables\":{
    \"hiring_manager\":\"6816f79cc0a8016401c5a33be04be441\",
    \"hiring_group\":\"221f3db5c6112284009f4becd3039cc9\",
    \"remote\":\"No\",
    \"standard_package\":\"No\",
    \"laptop_type\":\"developer\"
  }
}" \
--user "username":"password"

{
  "result": [
    {
      "short_description": "Lenovo - Carbon x1",
      "icon": "1195c2084f889200086eeed18110c74a.iix",
      "description": "<p class=\"p1\"><font size=\"3\" color=\"#808080\"><span class=\"s1\">x1 Carbon</span></font></p>\n<p class=\"p1\"><font size=\"2\" color=\"#808080\" face=\"arial,helvetica,sans-serif\"><span class=\"s1\">The x1 Carbon is Lenovo's lightest ThinkPad yet. It provides a QHD display that fights glare and weighs less than three pounds. Ideal for most computing tasks, and highly mobile. </span></font></p>\n<p class=\"p2\"><font size=\"2\" color=\"#808080\" face=\"arial,helvetica,sans-serif\"><span class=\"s1\">Technical Specs:</span></font></p>\n<ul class=\"ul1\"><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">Intel core i5 processor</span></font></li><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">512GB solid state drive (SSD) </span></font></li><li class=\"li3\"><font size=\"2\" color=\"#808080\"><span class=\"s1\">Backlit keyboard</span></font></li></ul>",
      "show_price": true,
      "recurring_price": "$100.00",
      "type": "catalog_item",
      "local_currency": "USD",
      "sys_id": "04b7e94b4f7b4200086eeed18110c7fd",
      "recurring_price_currency": "USD",
      "localized_price": "$1,100.00",
      "price": "$1,100.00",
      "catalogs": [
       {
         "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
         "title": "Service Catalog"
       }
      ],
      "recurring_frequency": "Annually",
      "name": "Standard Laptop",
      "localized_recurring_price": "$100.00",
      "category": {
        "sys_id": "d258b953c611227a0146101fb1be7c31",
        "title": "Hardware"
      },
      "price_currency": "USD",
      "show_quantity": false,
      "quantity": "1",
      "order": "100",
      "variables": [
        {
          "label": "Optional Software",
          "type": 0,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "container_start",
          "render_label": true,
          "read_only": false,
          "children": [
            {
              "label": "Adobe Acrobat",
              "type": 7,
              "mandatory": false,
              "displayvalue": "false",
              "friendly_type": "check_box",
              "display_type": "CheckBox",
              "render_label": true,
              "read_only": false,
              "pricing_implications": false,
              "name": "acrobat",
              "attributes": "edge_encryption_enabled=true",
              "id": "90b72d4b4f7b4200086eeed18110c701",
              "value": false,
              "help_text": "",
              "max_length": 0
            },
            {
              "label": "Adobe Photoshop",
              "type": 7,
              "mandatory": false,
              "displayvalue": "false",
              "friendly_type": "check_box",
              "display_type": "CheckBox",
              "render_label": true,
              "read_only": false,
              "pricing_implications": false,
              "name": "photoshop",
              "attributes": "edge_encryption_enabled=true",
              "id": "a8b72d4b4f7b4200086eeed18110c701",
              "value": false,
              "help_text": "",
              "max_length": 0
            }
          ],
          "name": "optional_label",
          "attributes": "edge_encryption_enabled=true",
          "id": "10b72d4b4f7b4200086eeed18110c700",
          "value": "",
          "help_text": "",
          "max_length": 0
        },
        {
          "label": "Additional software requirements",
          "type": 2,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "multi_line_text",
          "display_type": "Multi Line Text",
          "render_label": true,
          "read_only": false,
          "name": "Additional_software_requirements",
          "attributes": "edge_encryption_enabled=true",
          "id": "a8b72d4b4f7b4200086eeed18110c702",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "e1be6dcb4f7b4200086eeed18110c74c",
      "short_description": "LG IPS 27\" Monitor",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "External Monitor",
      "icon": "08569a4c4f889200086eeed18110c77b.iix",
      "description": "<p><font size=\"2\"><span style=\"color: #485563;\"><br /> <font size=\"3\" color=\"#808080\">The striking design of the LG Cinema Screen incorporates an ultra-narrow bezel, so virtually all you see is picture. The viewing experience is more immersive for your favorite movies and games. Make the most of your time, with an LG Full HD LED monitor. </font></span></font></p>\n<p><font size=\"2\" color=\"#808080\">Item Specs:</font></p>\n<ul><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Screen Size: 27"</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Resolution: 1920 x 1080</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Aspect Ratio: 16:9</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Brightness: 250 cd/m2</font></li><li style=\"color: #485563;\"><font size=\"2\" color=\"#808080\">Supports Split Screen</font></li></ul>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "2c0b59874f7b4200086eeed18110c71f",
        "title": "Peripherals"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "200",
      "variables": [],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "186d917a6fab7980575967ddbb3ee4f2",
      "short_description": "New Email Creation",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "New Email Account",
      "icon": "b630e97e6fab7980575967ddbb3ee4d2.iix",
      "description": "<p style=\"font-size: 13px;\"><font size=\"4\"><span style=\"color: #485563;\">Service Overview:</span></font></p>\n\t<p style=\"font-size: 13px;\"><font size=\"3\">Creation of a new email account within our Microsoft Exchange environment.  Creation of your email address will also create your Active Directory account. </font></p>\n\t<p> </p>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "109f0438c6112276003ae8ac13e7009d",
        "title": "Services"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "300",
      "variables": [
        {
          "label": "Preferred Email address",
          "type": 6,
          "mandatory": true,
          "displayvalue": "",
          "friendly_type": "single_line_text",
          "display_type": "Single Line Text",
          "render_label": true,
          "read_only": false,
          "name": "new_email",
          "attributes": "edge_encryption_enabled=true",
          "id": "65865e474fbb4200086eeed18110c7dd",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "8b3ae7fedc1be1004ece5c08239e522b",
      "short_description": "Remote access to Internal Corporate Systems\n\t\t",
      "catalogs": [
        {
          "sys_id": "e0d08b13c3330100c8b837659bba8fb4",
          "title": "Service Catalog"
        }
      ],
      "name": "Corp VPN",
      "icon": "11dc8df74f778200086eeed18110c78e.iix",
      "description": "<p><font size=\"3\"><span style=\"color: #485563;\">Corp VPN Account</span></font></p>\n<ul><li style=\"color: #485563;\"><font size=\"2\">Corp VPN provides VPN (Virtual Private Network) access to all Internal Corporate Systems and to IP Restricted Customer Instances</font></li><li style=\"color: #485563;\"><font size=\"2\">By utilizing Corp VPN, users will be provided a similar experience to being within one of the Corporate office locations, while offsite</font></li></ul>\n<p><font size=\"2\"><span style=\"color: #485563;\"> </span></font></p>\n<p><font size=\"2\"><span style=\"color: #485563;\">Please reference the <span style=\"color: #485563;\">CORP VPN </span><span style=\"color: #485563;\">Installation</span><span style=\"color: #485563;\"> and Support Documentation</span> for instructions on installation, usage and FAQ’s. For all other questions, please contact <span style=\"color: #485563;\">IT Support.</span></span></font></p>\n<p> </p>\n<p><span style=\"font-size: 10pt; font-family: tahoma, arial, helvetica, sans-serif;\"><br /><br /></span></p>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "d2f7cae4c611227a018ddc481b34e099",
        "title": "Security and Access"
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "600",
      "variables": [],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    },
    {
      "sys_id": "962967674ff38200086eeed18110c7e7",
      "short_description": "Desk Set Up for New Hires or Employee Moves\n\t\t",
      "catalogs": [
        {
          "sys_id": "",
          "title": "Service Catalog"
        }
      ],
      "name": "Desk Set Up",
      "icon": "aa6b08ff4ff38200086eeed18110c7ed.iix",
      "description": "<p><font size=\"3\" face=\"arial, helvetica, sans-serif\">The facilities organization will set up your new desk with the following configuration:</font></p>\n<ul><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Docking Station</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Power Station</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Phone</font></li><li><font size=\"3\" face=\"arial, helvetica, sans-serif\">Office Chair</font></li></ul>",
      "show_price": false,
      "type": "catalog_item",
      "category": {
        "sys_id": "",
        "title": null
      },
      "show_quantity": false,
      "quantity": "1",
      "order": "900",
      "variables": [
        {
          "label": "Please describe any ergonomic requirements\n\t\t",
          "type": 2,
          "mandatory": false,
          "displayvalue": "",
          "friendly_type": "multi_line_text",
          "display_type": "Multi Line Text",
          "render_label": true,
          "read_only": false,
          "name": "ergonomic_office",
          "attributes": "edge_encryption_enabled=true",
          "id": "b0b9ab674ff38200086eeed18110c755",
          "value": "",
          "help_text": "",
          "max_length": 0
        }
      ],
      "ui_policy": [],
      "client_script": {
        "onChange": [],
        "onSubmit": [],
        "onLoad": []
      },
      "data_lookup": []
    }
  ]
}