---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Guide de commande - Dans le champ d'application

# Guide de commande - Dans le champ d'application {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes de lecture

L'API OrderGuide vous permet d'initialiser et d'afficher les détails du guide de commande.

Pour utiliser cette classe dans une application incluse dans le périmètre, utilisez l'identificateur `d'espace` de noms sn_sc. Le module d'extension Service Catalog Scoped API (com.glideapp.servicecatalog.scoped.api), qui est activé par défaut, est requis pour accéder à l'API OrderGuide .

## OrderGuide - OrderGuide (chaîne sys_id) {#ariaid-title2}

Crée une instance de la classe OrderGuide avec le sys_id spécifié.
{#OG-OrderGuide_S__table_bbt_ccc_5bb__entry__3}

| Nom | Type | Description |
|-|-|-|
| sys_id | Chaîne | sys_id de l'OrderGuide. |
[Tableau 1. Paramètres]

{#OG-OrderGuide_S__table_bbt_ccc_5bb}  
Exemple :

    var cart=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");

## Guide de commande : getID() {#ariaid-title3}

Renvoie la sys_id du guide de commande.
{#OG-getID__table_o2r_tyz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 2. Paramètres]

{#OG-getID__table_o2r_tyz_sbb} {#OG-getID__table_p2r_tyz_sbb__entry__2}

| Type | Description |
|-|-|
| Chaîne | sys_id du guide de commande. |
[Tableau 3. Renvoie]

{#OG-getID__table_p2r_tyz_sbb}  
Exemple :

    var cart=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");	
    	console.log(cart.getID());

Sortie :

    6690750f4f7b4200086eeed18110c761

## OrderGuide : init(demande de carte) {#ariaid-title4}

Initialise le guide de commande avec les éléments de catalogue et les variables spécifiés, puis renvoie le guide de commande.
{#OG-init_M__table_ym2_4zz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| request | Carte | Objet JSON contenant les détails de l'élément de catalogue et de la variable. |
[Tableau 4. Paramètres]

{#OG-init_M__table_ym2_4zz_sbb} {#OG-init_M__table_zm2_4zz_sbb__entry__2}

| Type | Description |
|-|-|
| Carte | Un objet JSON contenant les détails du guide de commande initialisé. |
[Tableau 5. Renvoie]

{#OG-init_M__table_zm2_4zz_sbb}  
Exemple :

    var guide = new sn_sc.OrderGuide('6690750f4f7b4200086eeed18110c761');
     
    var map = {};
    map.variables = {};
    //map.sysparm_id = '6690750f4f7b4200086eeed18110c761';
    map.variables['IOce433d0f4f7b4200086eeed18110c74d'] = '221f3db5c6112284009f4becd3039cc9'; //Here ce433d0f4f7b4200086eeed18110c74d is the sys_id of the variable and 221f3db5c6112284009f4becd3039cc9 is its value
    var includedItems = guide.init(map)

Sortie :

    {
    "cascade_variable_map":{
    },
    "items":[
    {
    "order":"-1",
    "quantity":"1",
    "show_quantity":false,
    "sys_id":"a4022d7b87c20300e3010cf888cb0bb2"
    },
    {
    "order":"300",
    "quantity":"1",
    "show_quantity":false,
    "sys_id":"186d917a6fab7980575967ddbb3ee4f2"
    },
    {
    "order":"600",
    "quantity":"1",
    "show_quantity":false,
    "sys_id":"8b3ae7fedc1be1004ece5c08239e522b"
    }
    ],
    "variable_assignments":{
    }
    }

## Guide de commande : isIncludeItems() {#ariaid-title5}

Spécifie si la case Afficher la bascule Inclure (include_items) est cochée pour le guide de commande spécifié.
Remarque :  
Le champ Afficher la bascule Inclure n'apparaît pas sur le formulaire Guide de commande par défaut. {#OG-isIncludeItems__table_ewn_tsd_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 6. Paramètres]

{#OG-isIncludeItems__table_ewn_tsd_sbb} {#OG-isIncludeItems__table_fwn_tsd_sbb__entry__2}

| Type | Description |
|-|-|
| Booléen | Renvoie la valeur true si la case Afficher le basculement Inclure est cochée pour le guide de commande spécifié. Sinon, renvoie la valeur \<\< faux \>\>. |
[Tableau 7. Renvoie]

{#OG-isIncludeItems__table_fwn_tsd_sbb}  

    var orderGuide=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");	
    	console.log(orderGuide.isIncludeItems());

Sortie :

    true

## Guide de commande : isTwoStep() {#ariaid-title6}

Spécifie si la validation en deux étapes est activée.
{#OG-isTwoStep__table_zjf_3yz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 8. Paramètres]

{#OG-isTwoStep__table_zjf_3yz_sbb} {#OG-isTwoStep__table_akf_3yz_sbb__entry__2}

| Type | Description |
|-|-|
| Booléen | Renvoie la valeur true si la validation en deux étapes est activée. Sinon, renvoie la valeur faux. |
[Tableau 9. Renvoie]

{#OG-isTwoStep__table_akf_3yz_sbb}  
Exemple :

    var orderGuide=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");	
    	console.log(orderGuide.isTwoStep());

Sortie :

    false

## Guide de commande : isUseCustomCart() {#ariaid-title7}

Spécifie si l'utilisation d'un panier distinct (différent de celui des éléments de catalogue) est activée pour un guide de commande en deux étapes.
{#OG-isUseCustomCart__table_xtd_vsd_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 10. Paramètres]

{#OG-isUseCustomCart__table_xtd_vsd_sbb} {#OG-isUseCustomCart__table_ytd_vsd_sbb__entry__2}

| Type | Description |
|-|-|
| Booléen | Renvoie la valeur true si une utilisation distincte du panier est activée pour un guide de commande en deux étapes. Sinon, renvoie la valeur \<\< faux \>\>. |
[Tableau 11. Renvoie]

{#OG-isUseCustomCart__table_ytd_vsd_sbb}  
Exemple :

    var orderGuide=new sn_sc.OrderGuide("6690750f4f7b4200086eeed18110c761");	
    	console.log (orderGuide.isUseCustomCart());

Sortie :

    false

## OrderGuide : navigateFromMap(Détails de l'élément de carte) {#ariaid-title8}

Permet d'accéder aux éléments de catalogue d'un guide de commande.
{#OG-navigateFromMap_M__table_xtm_czz_sbb__entry__3}

| Nom | Type | Description |
|-|-|-|
| itemDetails | Carte | Objet JSON contenant les détails des éléments de catalogue dans le guide de commande. |
[Tableau 12. Paramètres]

{#OG-navigateFromMap_M__table_xtm_czz_sbb} {#OG-navigateFromMap_M__table_ytm_czz_sbb__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 13. Renvoie]

{#OG-navigateFromMap_M__table_ytm_czz_sbb}  
Exemple :

    var orderGuide=new sn_sc.OrderGuide.navigateFromMap(itemdetails);