API du catalogue de services cloud

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 31 minutes de lecture

    • L’API Catalogue de services cloud fournit des méthodes liées aux opérations Jour 1 (mise en service) et Jour 2 (modification) disponibles dans le catalogue de services cloud, telles que la création de piles de services dans le cloud et l’appel de demandes d’opérations de ressources. Vous pouvez également récupérer des informations sur les demandes du catalogue, les piles obtenant l’état et d’autres informations.

    Cette API est incluse dans l’espace de noms now et nécessite le rôle sn_cmp.cloud_service_user. L’application Cloud Services Catalog (CSC) est disponible en tant qu’abonnement distinct et nécessite le bundle ITOM Enterprise ou le droit de produit ITOM Cloud Accelerate.

    L’API Catalogue de services cloud présente les actions que vous effectuez pendant les opérations du Jour 2. Dans le contexte de cette API, les éléments de catalogue de ressources désignent les éléments de catalogue liés aux opérations du Jour 2.

    Pour utiliser cette API, assurez-vous d’avoir terminé le processus de configuration guidée du catalogue de services cloud ou d’avoir une configuration de travail dans laquelle la mise en service et les opérations de catalogue fonctionnent dans l’interface utilisateur. Pour plus d’informations sur ces étapes, reportez-vous à la section Cloud Services Catalog.

    Catalogue des services cloud : GET /now/cmp_catalog_api/itemsbyciclass

    Renvoie une liste d’éléments du catalogue de ressources en fonction d’une classe d’éléments de configuration (CI) donnée.

    Format d'URL

    URL par défaut : /api/now/cmp_catalog_api/itemsbyciclass

    Paramètres de demande pris en charge

    Tableau 1. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 2. Paramètres de requête
    Nom Description
    ci_class Requis. Nom de la classe CI à partir de laquelle obtenir les éléments de catalogue de ressources (par exemple, « cmdb_ci_vm_instance »). Situé dans le champ Type de CI de référence dans la table Élément de configuration [cmdb_ci].

    Type de données : chaîne
    display_variables Marqueur indiquant s’il faut répertorier les variables d’élément de catalogue associées à chaque élément de catalogue.
    Valeurs valides :
    • true : affiche la liste des variables d’élément de catalogue.
    • false : n’affiche pas les variables d’élément de catalogue de la liste.

    Type de données : booléennes

    Valeur par défaut : false
    operation_name Facultatif. Nom de l'exploitation. Situé dans la colonne Nom de l’interface de ressource dans la table OperationSignature [sn_cmp_rb_op_signature].
    Remarque :
    Ce paramètre peut interroger tout ou partie de l’opération. Par exemple, si vous souhaitez répertorier toutes les interfaces commençant par « ServiceNow », vous pouvez définir la variable comme operation_name = Servicenow.

    Par défaut : tous les éléments de catalogue de tous types d’opérations sont renvoyés.

    Type de données : chaîne
    resource_interface Facultatif. Interface de ressources sur laquelle l’élément de catalogue de ressources est hébergé. Situé dans la colonne Nom de la table ResourceInterfaces [sn_cmp_rb_resourceinterface].

    Type de données : chaîne
    Tableau 3. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

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

    Tableau 4. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 5. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

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

    Tableau 6. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    403 Interdit. L’utilisateur ne dispose pas des droits d’accès à l’enregistrement spécifié.
    404 Introuvable. L’élément demandé est introuvable.
    405 Méthode non valide. La fonctionnalité est désactivée.
    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
    actif État actif de l’élément de catalogue d’opérations de ressources.

    Valeurs possibles :

    • vrai : l’élément de catalogue d’opération de ressource est actif.
    • faux : l’élément de catalogue d’opération de ressource est inactif.

    Type de données : chaîne
    created_on Horodatage à partir de la création de l’élément de catalogue d’opérations de ressources.

    Format : aaaa-MM-jj HH :mm :ss.

    Type de données : chaîne
    display_name Nom de l’interface de ressources. Situé dans la table ResourceInterfaces [sn_cmp_rb_resourceinterface].

    Type de données : chaîne
    id Sys_id de l’élément de catalogue de l’opération de ressources.

    Type de données : chaîne

    Table : Élément de catalogue d’opérations de ressources [sn_cmp_rsrc_opr_cat_item]
    nom Nom de l’élément de catalogue de l’opération de ressources. Situé dans la table Élément de catalogue d’opérations de ressources [sn_cmp_rsrc_opr_cat_item].

    Type de données : chaîne
    short_description Brève description de l’élément de catalogue de l’opération de ressources.

    Type de données : chaîne

    Table : Élément de catalogue d’opérations de ressources [sn_cmp_rsrc_opr_cat_item]
    updated_on Horodatage de la dernière mise à jour de l’élément de catalogue d’opérations de ressources. Format requis : aaaa-MM-jj HH :mm :ss.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant demande et renvoie l’état de l’élément de demande.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/itemsbyciclass?ci_class=cmdb_ci_vm_instance&resource_interface=Virtual%20Machine%20Store%20Extension%20Interface&operation_name=Execute%20Job%20Template" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Réponse :

    [
  {
    "display_name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "created_on": "2019-04-28 12:58:26",
    "updated_on": "2019-04-28 12:58:26",
    "name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "short_description": "Catalog item to invoke operation",
    "active": true
  }
]

    Catalogue des services cloud : GET /now/cmp_catalog_api/itemsbyrb

    Renvoie une liste d’éléments du catalogue de ressources en fonction d’un bloc de ressources donné.

    Format d'URL

    URL par défaut : /api/now/cmp_catalog_api/itemsbyrb

    Paramètres de demande pris en charge

    Tableau 7. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 8. Paramètres de requête
    Nom Description
    display_variables Marqueur indiquant s’il faut répertorier les variables d’élément de catalogue associées à chaque élément de catalogue.
    Valeurs valides :
    • true : affiche la liste des variables d’élément de catalogue.
    • false : n’affiche pas les variables d’élément de catalogue de la liste.

    Type de données : booléennes

    Valeur par défaut : false
    operation_name Facultatif. Nom de l'exploitation. Situé dans la colonne Nom de l’interface de ressource dans la table OperationSignature [sn_cmp_rb_op_signature].
    Remarque :
    Ce paramètre peut interroger tout ou partie de l’opération. Par exemple, si vous souhaitez répertorier toutes les interfaces commençant par « ServiceNow », vous pouvez définir la variable comme operation_name = Servicenow.

    Par défaut : tous les éléments de catalogue de tous types d’opérations sont renvoyés.

    Type de données : chaîne
    resource_block Obligatoire. Nom du bloc de ressources à partir duquel obtenir ses éléments de catalogue d’opérations de ressources connexes (par exemple, serveur virtuel).

    Par défaut : tous les éléments de catalogue de tous types d’opérations sont renvoyés.

    Type de données : chaîne

    Table : Bloc de ressources [sn_cmp_rb_resourceblock]
    resource_interface Facultatif. Interface de ressources sur laquelle l’élément de catalogue de ressources est hébergé. Situé dans la colonne Nom de la table ResourceInterfaces [sn_cmp_rb_resourceinterface].

    Type de données : chaîne
    Tableau 9. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

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

    Tableau 10. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    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
    200 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    403 Interdit. L’utilisateur ne dispose pas des droits d’accès à l’enregistrement spécifié.
    404 Introuvable. L’élément demandé est introuvable.
    405 Méthode non valide. La fonctionnalité est désactivée.
    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
    actif État actif de l’élément de catalogue d’opérations de ressources.

    Valeurs possibles :

    • vrai : l’élément de catalogue d’opération de ressource est actif.
    • faux : l’élément de catalogue d’opération de ressource est inactif.

    Type de données : chaîne
    display_name Nom de l’interface de ressources. Situé dans la table ResourceInterfaces [sn_cmp_rb_resourceinterface].

    Type de données : chaîne
    id Sys_id de l’élément de catalogue de l’opération de ressources.

    Type de données : chaîne

    Table : Élément de catalogue d’opérations de ressources [sn_cmp_rsrc_opr_cat_item]
    nom Nom de l’élément de catalogue de l’opération de ressources. Situé dans la table Élément de catalogue d’opérations de ressources [sn_cmp_rsrc_opr_cat_item].

    Type de données : chaîne
    short_description Brève description de l’élément de catalogue de l’opération de ressources.

    Type de données : chaîne

    Table : Élément de catalogue d’opérations de ressources [sn_cmp_rsrc_opr_cat_item]
    variables Liste de détails supplémentaires sur l’élément de catalogue de ressources. Les variables renvoyées dans cette API varient en fonction des paramètres de requête qui ont été transmis.

    Type de données : tableau d’objets

    "variables": [
  {
    "parameter1": "String",
    "parameter2": "String"
  }
]

    Voici un exemple de liste d’éléments de catalogue de ressources basés sur un bloc de ressources de serveur virtuel :

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/itemsbyrb?resource_interface=Virtual%20Machine%20Store%20Extension%20Interface&operation_name=Execute%20Job%20Template&resource_block=Virtual%20Server" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Réponse :

    [
  {
    "display_name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "created_on": "2019-04-28 12:58:26",
    "updated_on": "2019-04-28 12:58:26",
    "name": "Virtual Server-Virtual Machine Store Extension Interface-Execute Job Template",
    "short_description": "Catalog item to invoke operation",
    "active": true
  }
]

    Catalogue de services cloud : GET /now/cmp_catalog_api/services

    Renvoie une liste d’éléments de catalogue en fonction du plan donné d’un type de catalogue de mise en service ou de cycle de vie.

    Format d'URL

    URL par défaut : /api/now/cmp_catalog_api/services

    Paramètres de demande pris en charge

    Tableau 13. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 14. Paramètres de requête
    Nom Description
    catalog_type Facultatif. Type d’élément de catalogue. Valeurs acceptées (sensibles à la casse) :
    • Mise en service : renvoie tous les éléments de catalogue de type plan.
    • Cycle de vie : renvoie tous les éléments de catalogue de type d’opération du jour 2.

    Si l’entrée est vide (par défaut), tous les services des deux types de catalogue sont renvoyés.

    Type de données : chaîne
    display_variables Marqueur indiquant s’il faut répertorier les variables d’élément de catalogue associées à chaque élément de catalogue.
    Valeurs valides :
    • true : affiche la liste des variables d’élément de catalogue.
    • false : n’affiche pas les variables d’élément de catalogue de la liste.

    Type de données : booléennes

    Valeur par défaut : false
    blueprint_name Facultatif. Nom du plan dans lequel extraire les éléments de catalogue connexes. Situé dans la table Élément de catégorie [sn_cmp_bp_cat_item].
    Remarque :
    Ce paramètre peut interroger une partie ou la totalité du nom du plan. Par exemple, si vous souhaitez répertorier tous les plans commençant par « ServiceNow », vous pouvez définir la variable comme blueprint_name = ServiceNow.

    Par défaut : tous les services de tous les plans sont renvoyés.

    Type de données : chaîne
    Tableau 15. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir 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 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    403 Interdit. L’utilisateur ne dispose pas des droits d’accès à l’enregistrement spécifié.
    404 Introuvable. L’élément demandé est introuvable.
    405 Méthode non valide. La fonctionnalité est désactivée.
    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
    actif Marqueur indiquant si le catalogue est actif.
    Valeurs possibles :
    • vrai : le catalogue est actif.
    • faux : le catalogue n’est pas actif.

    Type de données : chaîne
    plan Sys_id du plan.

    Type de données : chaîne

    Table : Plan [sn_cmp_bp_blueprint]
    blueprint_category Sys_id de la catégorie du plan.

    Type de données : chaîne

    Table : Catégorie de service dans le cloud [sn_capi_service_category]
    blueprint_category_name Nom de la catégorie de plan.
    Valeurs possibles :
    • Accès
    • Analyse
    • Services d'application
    • Chaîne de blocs
    • Productivité de l’entreprise
    • Calculer
    • Gestion de configuration
    • Conteneurs
    • Base de données
    • Outils de développement
    • Événement
    • Cloud hybride
    • L’IOT
    • IPAM
    • Équilibreur fort
    • Apprentissage automatique
    • Outils de gestion
    • Place de marché
    • Mobile
    • Réseau
    • Productivité
    • Sécurité
    • Accès Shell
    • Stockage
    • Outils
    • Inconnu
    • Réalité virtuelle

    Type de données : chaîne

    Table :Catégorie de service dans le cloud [sn_capi_service_category]
    blueprint_name Nom du plan. Situé dans la table Plan [sn_cmp_bp_blueprint].

    Type de données : chaîne
    blueprint_type Type de plan.

    Valeur possible : Plan personnalisé

    Type de données : chaîne
    catalog_name Nom du catalogue.

    Type de données : chaîne

    Table : élément de catalogue dans le cloud [sn_cmp_bp_cat_item]
    catalog_type Type de catalogue.
    Valeurs possibles :
    • 1 : Le catalogue est de type mise en service.
    • 2 : le catalogue est de type cycle de vie.

    Type de données : chaîne
    catalog_type Type de catalogue.
    Valeurs possibles :
    • 1 : Le catalogue est de type mise en service.
    • 2 : le catalogue est de type cycle de vie.

    Type de données : chaîne
    createdOn Horodatage à partir de la création de l’élément de catalogue.

    Type de données : chaîne
    createdBy Utilisateur qui a créé l’élément de catalogue.

    Type de données : chaîne
    id Sys_id du plan.

    Type de données : chaîne

    Table : élément de catalogue dans le cloud [sn_cmp_bp_cat_item]
    last_updated_on Horodatage de la dernière mise à jour de l’élément de catalogue.

    Type de données : chaîne
    last_updated_by Utilisateur qui a mis à jour l’élément de catalogue pour la dernière fois, tel qu’un administrateur ou le système.

    Type de données : chaîne
    operation Sys_id de l’opération.

    Type de données : chaîne

    Table : OperationSignature [sn_cmp_rb_op_signature]
    operation_name Nom de l'exploitation.
    Valeurs possibles :
    • Annuler l’approvisionnement : supprime les ressources dont l’état est Terminé et met à jour les tables CMDB des ressources en conséquence.
    • ModifyLease : modifie l’opération de bail planifiée sur les ressources mises en service.
    • ModifySchedule : modifie le calendrier des ressources mises en service.
    • Démarrer : démarre les ressources qui sont à l’état Désactivé.
    • Arrêter : arrête les ressources qui sont à l’état Activé.

    Type de données : chaîne
    variables Détails sur l’élément de catalogue de la liste. Les variables renvoyées dans cette API varient en fonction des paramètres de requête transmis dans la demande.

    Type de données : tableau d’objets

    "variables": [
  {
    "parameter1": "String",
    "parameter2": "String"
  }
]

    Cet exemple renvoie tous les éléments de catalogue d’un plan de type de cycle de vie nommé « classicLB ».

    curl "https://instance.servicenow.comapi/now/cmp_catalog_api/services?display_variables=true&catalog_type=LifeCycle&blueprint_name=classiclb" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Réponse :

    [
  {
    "catalog_name": "Deprovision",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "01b2341a56789012345d6ddeeff7b89fc",
    "variables": [
      {
        "id": "a12d34c5678c91234bf45678912d34e4",
        "name": "StackID",
        "question_text": "StackID",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:03",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:46:02",
    "created_by": "user@password.com",
    "operation": "a70d51c0476c46104bf15222516d4375",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Deprovision"
  },
  {
    "catalog_name": "ModifySchedule",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": null,
    "id": "361d55c0476c46104bf15222516d4351",
    "variables": [
      {
        "id": "031d55c0476c46104bf15222516d43af",
        "name": "ScheduleProfile",
        "question_text": "ScheduleProfile",
        "default_value": "Not specified"
      },
      {
        "id": "0b1d55c0476c46104bf15222516d43c9",
        "name": "ScheduleTimeZone",
        "question_text": "ScheduleTimeZone",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:53",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:52",
    "created_by": "user@password.com",
    "operation": "130d51c0476c46104bf15222516d436c",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "ModifySchedule"
  },
  {
    "catalog_name": "Stop",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "542dd5c0476c46104bf15222516d43b0",
    "variables": [
      {
        "id": "a02d19c0476c46104bf15222516d4301",
        "name": "StackID",
        "question_text": "StackID",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:00",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:58",
    "created_by": "user@password.com",
    "operation": "930d51c0476c46104bf15222516d436f",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Stop"
  },
  {
    "catalog_name": "Cleanup",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "712d59c0476c46104bf15222516d435c",
    "variables": [
      {
        "id": "da2d59c0476c46104bf15222516d43dc",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "da2d59c0476c46104bf15222516d43e2",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:46:06",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:46:04",
    "created_by": "user@password.com",
    "operation": "ab0d51c0476c46104bf15222516d437b",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Cleanup"
  },
  {
    "catalog_name": "ModifyLease",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": null,
    "id": "bb1dd5c0476c46104bf15222516d4301",
    "variables": [
      {
        "id": "142dd5c0476c46104bf15222516d4382",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "d82dd5c0476c46104bf15222516d4394",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:58",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:56",
    "created_by": "user@password.com",
    "operation": "2b0d51c0476c46104bf15222516d4378",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "ModifyLease"
  },
  {
    "catalog_name": "Start",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "active": true,
    "category": "86d85478678232005ca552e457415a79",
    "blueprint_category_name": "Compute",
    "shortDescription": "Are you sure you want to perform this operation?",
    "id": "d71d95c0476c46104bf15222516d4312",
    "variables": [
      {
        "id": "731d95c0476c46104bf15222516d43ae",
        "name": "resourceId",
        "question_text": "ResourceId",
        "default_value": "Not specified"
      },
      {
        "id": "731d95c0476c46104bf15222516d43b4",
        "name": "operationName",
        "question_text": "OperationName",
        "default_value": "Not specified"
      }
    ],
    "last_updated_on": "2024-02-19 07:45:55",
    "last_updated_by": "system",
    "catalog_type": "2",
    "created_on": "2024-02-19 07:45:54",
    "created_by": "user@password.com",
    "operation": "270d51c0476c46104bf15222516d4372",
    "blueprint_type": "Custom Blueprint",
    "operation_name": "Start"
  }
]

    Catalogue des services cloud : GET /now/cmp_catalog_api/stacks

    Renvoie une liste d’éléments de catalogue basés sur des plans de type Mise en service (également appelés piles).

    Format d'URL

    URL par défaut : /api/now/cmp_catalog_api/stacks

    Paramètres de demande pris en charge

    Tableau 19. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 20. Paramètres de requête
    Nom Description
    blueprint_name Facultatif. Nom du plan dans lequel extraire les éléments de catalogue connexes. Situé dans la table Élément de catégorie [sn_cmp_bp_cat_item].
    Remarque :
    Ce paramètre peut interroger une partie ou la totalité du nom du plan. Par exemple, si vous souhaitez répertorier tous les plans commençant par « ServiceNow », vous pouvez définir la variable comme blueprint_name = ServiceNow.

    Par défaut : tous les services de tous les plans sont renvoyés.

    Type de données : chaîne
    display_variables Marqueur indiquant s’il faut répertorier les variables d’élément de catalogue associées à chaque élément de catalogue.
    Valeurs valides :
    • true : affiche la liste des variables d’élément de catalogue.
    • false : n’affiche pas les variables d’élément de catalogue de la liste.

    Type de données : booléennes

    Valeur par défaut : false
    Tableau 21. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir 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 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    403 Interdit. L’utilisateur ne dispose pas des droits d’accès à l’enregistrement spécifié.
    404 Introuvable. L’élément demandé est introuvable.
    405 Méthode non valide. La fonctionnalité est désactivée.
    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
    actif Marqueur indiquant si le catalogue est actif.
    Valeurs possibles :
    • vrai : le catalogue est actif.
    • faux : le catalogue n’est pas actif.

    Type de données : chaîne
    plan Sys_id du plan.

    Type de données : chaîne

    Table : Plan [sn_cmp_bp_blueprint]
    blueprint_category Sys_id de la catégorie du plan.

    Type de données : chaîne

    Table : Catégorie de service dans le cloud [sn_capi_service_category]
    blueprint_category_name Nom de la catégorie de plan.
    Valeurs possibles :
    • Accès
    • Analyse
    • Services d'application
    • Chaîne de blocs
    • Productivité de l’entreprise
    • Calculer
    • Gestion de configuration
    • Conteneurs
    • Base de données
    • Outils de développement
    • Événement
    • Cloud hybride
    • L’IOT
    • IPAM
    • Équilibreur fort
    • Apprentissage automatique
    • Outils de gestion
    • Place de marché
    • Mobile
    • Réseau
    • Productivité
    • Sécurité
    • Accès Shell
    • Stockage
    • Outils
    • Inconnu
    • Réalité virtuelle

    Type de données : chaîne

    Table :Catégorie de service dans le cloud [sn_capi_service_category]
    blueprint_name Nom du plan. Situé dans la table Plan [sn_cmp_bp_blueprint].

    Type de données : chaîne
    blueprint_type Type de plan.

    Valeur possible : Plan personnalisé

    Type de données : chaîne
    catalog_name Nom du catalogue.

    Type de données : chaîne

    Table : élément de catalogue dans le cloud [sn_cmp_bp_cat_item]
    catalog_type Type de catalogue.
    Valeurs possibles :
    • 1 : Le catalogue est de type mise en service.
    • 2 : le catalogue est de type cycle de vie.

    Type de données : chaîne
    catalog_type_name Nom du type de catalogue.
    Valeurs possibles :
    • Opération de mise en service (Jour 1) : le type de catalogue est nommé mise en service.
    • Opération de cycle de vie (Jour 2) : le type de catalogue est appelé cycle de vie.

    Type de données : chaîne
    id Sys_id du plan.

    Type de données : chaîne

    Table : élément de catalogue dans le cloud [sn_cmp_bp_cat_item]
    Opérations de cycle de vie Objet contenant le nom et l’sys_id de l’opération de cycle de vie.

    Type de date : tableau d’objets

    "lifecycleOperations": [
      {
        "id": "String",
        "name": "String"
      }
    lifecycleOperations.id Sys_id de l’opération de cycle de vie.

    Type de données : chaîne

    Table : OperationSignature [sn_cmp_rb_op_signature]
    lifeCycleOperations.name Type d’opérations de cycle de vie.
    Valeurs possibles :
    • Nettoyage : nettoie les ressources dont l’état est terminé.
    • Annuler l’approvisionnement : supprime les ressources ayant un état terminé et met à jour les tables CMDB des ressources en conséquence.
    • ModifyLease : modifie l’opération de bail planifiée sur les ressources mises en service.
    • ModifySchedule : effectue la planification des heures ouvrables sur les piles au moment de la mise en service ou sur les piles existantes.
    • Démarrer : démarre les ressources qui sont à l’état Désactivé.
    • Arrêter : arrête les ressources qui sont à l’état Activé.

    Type de date : objet
    operation Sys_id de l’opération.

    Type de données : chaîne

    Table : OperationSignature [sn_cmp_rb_op_signature]
    operation_name Nom de l'exploitation.
    Valeurs possibles :
    • Annuler l’approvisionnement : supprime les ressources dont l’état est Terminé et met à jour les tables CMDB des ressources en conséquence.
    • ModifyLease : modifie l’opération de bail planifiée sur les ressources mises en service.
    • ModifySchedule : modifie le calendrier des ressources mises en service.
    • Démarrer : démarre les ressources qui sont à l’état Désactivé.
    • Arrêter : arrête les ressources qui sont à l’état Activé.

    Type de données : chaîne
    shortDescription Description brève du catalogue.

    Type de données : chaîne
    template_name Nom du modèle.

    Type de données : chaîne

    Table : élément de catalogue dans le cloud [sn_cmp_bp_cat_item]
    template_type Sys_id du type de modèle.

    Type de données : chaîne

    Table : élément de catalogue dans le cloud [sn_cmp_bp_cat_item]
    template_cloud_product_name Nom du produit.

    Type de données : chaîne

    Table : élément de catalogue dans le cloud [sn_cmp_bp_cat_item]
    variables Détails sur l’élément de catalogue de la liste. Les variables renvoyées dans cette API varient en fonction des paramètres de requête transmis dans la demande.

    Type de données : tableau d’objets

    "variables": [
  {
    "parameter1": "String",
    "parameter2": "String"
  }
]

    L’exemple suivant renvoie tous les éléments de catalogue de l’instance avec le type de catalogue de mise en service.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/stacks" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Rendre:

    [
  {
    "catalog_type": "1",
    "catalog_type_name": "Provision Operation (Day 1)",
    "catalog_name": "classiclb",
    "blueprint": "d90d9d80476c46104bf15222516d43b9",
    "blueprint_name": "classiclb",
    "blueprint_category": "57c0dbd9934b22004a9032bfa67ffb79",
    "blueprint_category_name": "Compute",
    "active": true,
    "category": "8641fe260b212200eff7ef9bb4673a3d",
    "shortDescription": null,
    "id": "07cc9580476c46104bf15222516d43c3",
    "last_updated_on": "2024-02-19 07:46:13",
    "last_updated_by": "user@servicenow.com",
    "blueprint_type": "Cloud Template",
    "template_type": "932f81e49f00320048111f80a57fcf6e",
    "template_name": "CloudFormation Template",
    "template_cloud_product": "52cfc4749f00320048111f80a57fcf9a",
    "template_cloud_product_name": "AWS CloudFormation",
    "lifecycleOperations": [
      {
        "id": "1d2d19c0476c46104bf15222516d4392",
        "name": "Deprovision"
      },
      {
        "id": "361d55c0476c46104bf15222516d4351",
        "name": "ModifySchedule"
      },
      {
        "id": "542dd5c0476c46104bf15222516d43b0",
        "name": "Stop"
      },
      {
        "id": "712d59c0476c46104bf15222516d435c",
        "name": "Cleanup"
      },
      {
        "id": "bb1dd5c0476c46104bf15222516d4301",
        "name": "ModifyLease"
      },
      {
        "id": "d71d95c0476c46104bf15222516d4312",
        "name": "Start"
      }
    ],
    "created_on": "2024-02-19 07:44:44",
    "created_by": "user@servicenow.com",
    "operation": "130d51c0476c46104bf15222516d4368",
    "operation_name": "Provision"
  }
]

    Catalogue des services cloud : GET /now/cmp_catalog_api/status

    Renvoie l’état et les détails d’un RITM (élément de demande) de catalogue donné.

    Utilisez cette méthode pour identifier et tracer l’origine de la demande et surveiller son flux. La réponse comprend ce qui suit :
    1. Numéro RITM de la demande soumise
    2. Étape à laquelle se trouve la demande
    3. Utilisateurs qui ont ouvert la demande et à laquelle la demande est affectée
    4. Groupe affecté à la demande
    5. Quand la demande a été ouverte
    6. L’état de la demande
    7. Données de soumission

    Format d'URL

    URL par défaut : /api/now/cmp_catalog_api/status

    Paramètres de demande pris en charge

    Tableau 25. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 26. Paramètres de requête
    Nom Description
    req_item Numéro d’élément de demande unique dans la table Élément demandé [sc_req_item]. Par exemple, RITM0000001.

    Type de données : chaîne
    Tableau 27. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir 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 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    403 Interdit. L’utilisateur ne dispose pas des droits d’accès à l’enregistrement spécifié.
    404 Introuvable. L’élément demandé est introuvable.
    405 Méthode non valide. La fonctionnalité est désactivée.
    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
    assignmentGroup Groupe affecté à la demande.

    Type de données : chaîne
    assignedTo E-mail de l’utilisateur affecté à la demande.

    Type de données : chaîne
    Élément de catégorie Sys_id de la demande d’élément de catalogue.

    Type de données : chaîne

    Table : élément de catalogue dans le cloud [sn_cmp_bp_cat_item]
    erreur Message avec des détails sur une erreur renvoyée.
    Messages d’erreur possibles :
    • Enregistrement introuvable : l’élément de demande n’existe pas.
    • Utilisateur non authentifié : les informations d’identification de l’utilisateur ne sont pas autorisées à effectuer cette demande.

    Type de données : chaîne
    Numéro Numéro d’élément de demande unique (RITM) attribué au nouvel élément de demande.

    Type de données : chaîne

    Table : Élément de demande [sc_req_item]
    openedAt Horodatage à partir de l’ouverture de l’élément de demande.

    Format : aaaa-MM-jj HH :mm :ss.

    Type de date : chaîne
    openedBy Sys_id de l’utilisateur qui a ouvert la demande.

    Type de données : chaîne
    étape Étape actuelle du traitement de l’élément de demande.
    Valeurs possibles :
    • Déploiement de la pile
    • Déploiement annulé
    • Échec du déploiement
    • Déploiement réussi
    • Limite des ressources dépassée
    • Nouvelle tentative de déploiement de la pile
    • Tâche créée pour l'utilisateur
    • En attente d'approbation de la demande de mise en service

    Type de données : chaîne
    État État d’achèvement actuel de l’élément de demande.
    Valeurs possibles :
    • Fermé terminé
    • Fermé incomplet
    • Fermé ignoré
    • Ouvert
    • En attente
    • Travail en cours

    Type de données : chaîne
    submissionData Informations sur l’envoi de la demande, telles que le compte dans le cloud, l’emplacement, l’application et les données du centre de coûts. Les données de soumission varient en fonction du numéro d’élément de demande transmis dans la demande.

    Type de données : objet

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id Sys_id de l’enregistrement de l’élément de demande.

    Type de données : chaîne

    Table : Élément de demande [sc_req_item]

    Demande cURL

    L’exemple suivant renvoie les informations d’état du numéro d’élément de demande, RITM0010076.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/statusreq_item=RITM0010076" \
--request GET \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

    Réponse :

    { 
  "catItem": "39737024c390719005091d75e0013115", 
  "stage": "Task Created for User", 
  "sys_id": "ee1197db476cc2904bf15222516d439f", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "number": "RITM0010072", 
  "openedAt": "2024-02-29 18:32:55", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"CloudAccount\":\"AzureCA\",\"CSC_Azure_Functions_newResourceGroup\":\"test-rg-dnd\",\"CSC_Azure_Functions_runTimeVersion\":\"~18\",\"CSC_Azure_Functions_runTimeEngine\":\"node\",\"CSC_Azure_Functions_os\":\"Windows\",\"CSC_Azure_Functions_functionAppName\":\"sa02291029-fa\",\"LeaseEndDate\":\"2024-05-29 17:29:57\",\"ScheduleProfile\":\"-- No Schedule --\",\"UserGroup\":\"cfcbad03d711110050f5edcb9e61038f\",\"CSC_Azure_Functions_applicationName\":\"function-app\",\"ScheduleTimeZone\":\"America/Los_Angeles\",\"BusinessService\":\"\",\"environment\":\"Production\",\"CostCenter\":\"\",\"UseExistingWorkspace\":false,\"CSC_Azure_Functions_existingResourceGroup\":\"cpg-dnd\",\"CSC_Azure_Functions_isNewResourceGroup\":\"false\",\"CSC_Azure_Functions_storageAccountName\":\"sa02291029fasa\",\"Application\":\"\",\"StackName\":\"sa02291029\",\"Location\":\"Azure Datacenter - eastus\",\"Workspace\":\"\"}" 
}

    Catalogue de services cloud : POST /now/cmp_catalog_api/submitoprequest

    Soumet une demande d’opération de ressources pour effectuer des opérations du jour 2 sur les ressources mises en service.

    Format d'URL

    URL par défaut : /api/now/cmp_catalog_api/submitoprequest

    Paramètres de demande pris en charge

    Tableau 31. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 32. Paramètres de requête
    Nom Description
    cat_id Obligatoire. sys_id de l’élément de catalogue cloud à invoquer. Disponible dans la table Élément de catalogue cloud [sn_cmp_bp_cat_item].

    Type de données : chaîne
    Tableau 33. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    CloudAccount Requis. Nom du compte dans le cloud dans lequel soumettre la demande. Les noms de compte sont disponibles dans la table Compte dans le cloud [cmdb_ci_cmp_cloud_account].

    Type de données : chaîne
    Emplacement Requis. Emplacement du centre de données dans lequel mettre en service la ressource. Par exemple, us-west-1 ou asia-south-2. Cette valeur doit correspondre à l’emplacement du centre de données du fournisseur de plateforme du compte dans le cloud. Disponible dans la table Centre de données associé [sn_cmp_ca_assc_datacenter].

    Type de données : chaîne
    StackName Requis. Nom de la pile. Le nom de la pile est dynamique et est reflété dans Resource Management.

    Type de données : chaîne
    resourceId Requis. Sys_id de la ressource dans laquelle les opérations du Jour 2 seront effectuées.

    Type de données : chaîne

    Table : Éléments de la pile [sn_cmp_stack_item]
    resource_block Obligatoire. Nom du bloc de ressources à partir duquel obtenir ses éléments de catalogue d’opérations de ressources connexes (par exemple, serveur virtuel).

    Par défaut : tous les éléments de catalogue de tous types d’opérations sont renvoyés.

    Type de données : chaîne

    Table : Bloc de ressources [sn_cmp_rb_resourceblock]
    operation_name Facultatif. Nom de l'exploitation. Situé dans la colonne Nom de l’interface de ressource dans la table OperationSignature [sn_cmp_rb_op_signature]. Le nom de l’opération que vous saisissez dépend de la valeur transmise dans le resourceBlock paramètre.
    Remarque :
    Ce paramètre peut interroger tout ou partie de l’opération. Par exemple, si vous souhaitez répertorier toutes les interfaces commençant par « ServiceNow », vous pouvez définir la variable comme operation_name = Servicenow.
    Par défaut : tous les éléments de catalogue de tous types d’opérations sont renvoyés.Type de données : chaîne
    resourceInterface Obligatoire. Nom du bloc de ressources à partir duquel obtenir ses éléments de catalogue d’opérations de ressources connexes (par exemple, serveur virtuel). L’interface de ressources que vous entrez dépend de la valeur transmise dans les resourceBlock paramètres and operation_name .

    Par défaut : tous les éléments de catalogue de tous types d’opérations sont renvoyés.

    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 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 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    403 Interdit. L’utilisateur ne dispose pas des droits d’accès à l’enregistrement spécifié.
    404 Introuvable. L’élément demandé est introuvable.
    405 Méthode non valide. La fonctionnalité est désactivée.
    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
    assignmentGroup Groupe affecté à la demande.

    Type de données : chaîne
    assignedTo E-mail de l’utilisateur affecté à la demande.

    Type de données : chaîne
    Élément de catégorie Sys_id de la demande d’élément de catalogue.

    Type de données : chaîne

    Table : élément de catalogue dans le cloud [sn_cmp_bp_cat_item]
    Numéro Numéro d’élément de demande unique (RITM) attribué au nouvel élément de demande.

    Type de données : chaîne

    Table : Élément de demande [sc_req_item]
    openedAt Horodatage à partir de l’ouverture de l’élément de demande.

    Format : aaaa-MM-jj HH :mm :ss.

    Type de date : chaîne
    openedBy Sys_id de l’utilisateur qui a ouvert la demande.

    Type de données : chaîne
    étape Étape actuelle du traitement de l’élément de demande.
    Valeurs possibles :
    • Déploiement de la pile
    • Déploiement annulé
    • Échec du déploiement
    • Déploiement réussi
    • Limite des ressources dépassée
    • Nouvelle tentative de déploiement de la pile
    • Tâche créée pour l'utilisateur
    • En attente d'approbation de la demande de mise en service

    Type de données : chaîne
    État État d’achèvement actuel de l’élément de demande.
    Valeurs possibles :
    • Fermé terminé
    • Fermé incomplet
    • Fermé ignoré
    • Ouvert
    • En attente
    • Travail en cours

    Type de données : chaîne
    submissionData Informations sur l’envoi de la demande, telles que le compte dans le cloud, l’emplacement, l’application et les données du centre de coûts. Les données de soumission varient en fonction du numéro d’élément de demande transmis dans la demande.

    Type de données : objet

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id Sys_id de l’enregistrement de l’élément de demande.

    Type de données : chaîne

    Table : Élément de demande [sc_req_item]

    L’exemple suivant crée un élément de demande d’opération Jour 2.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/submitoprequest?cat_id=e44dcd238731e5101126cbb4dabb3506" /
--request POST\ 
--header 'Accept: application/json' \ 
--user 'username':'password'

//Request body:
{"StackName":"sa02292143","CloudAccount":"AWS","Location":"AWS Datacenter - us-east-1","resourceId":"df8c61e3eb2cc210d298fbbdbad0cd74","operationName":"Deprovision","resourceInterface":"S3 Interface","resourceBlock":"S3"}

    Corps de la réponse :

    { 
  "number": "RITM0010078", 
  "catItem": "e44dcd238731e5101126cbb4dabb3506", 
  "stage": "request_approved", 
  "sys_id": "9bf5cab3c3594610bc89b33605013190", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "openedAt": "2024-04-08 09:08:47", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"StackName\":\"sa02292143\",\"CloudAccount\":\"AWS\",\"Location\":\"AWS Datacenter - us-east-1\",\"resourceId\":\"df8c61e3eb2cc210d298fbbdbad0cd74\",\"operationName\":\"Deprovision\",\"resourceInterface\":\"S3 Interface\",\"resourceBlock\":\"S3\"}" 
} 
 
Sample Request Body for CSC S3 Bucket Catalog Order: 
 
{"StackName":"sa02292143","CloudAccount":"AWS","Location":"AWS Datacenter - us-east-1","resourceId":"df8c61e3eb2cc210d298fbbdbad0cd74","operationName":"Deprovision","resourceInterface":"S3 Interface","resourceBlock":"S3"}

    Catalogue de services cloud : POST /now/cmp_catalog_api/submitrequest

    Soumet une demande de services dans le cloud. Cette méthode accepte les demandes mises en service pour les opérations du jour 2 et les éléments de catalogue d’opérations de piles ou de ressources.

    Format d'URL

    URL par défaut : /api/now/cmp_catalog_api/submitrequest

    Paramètres de demande pris en charge

    Tableau 37. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 38. Paramètres de requête
    Nom Description
    cat_id Obligatoire. sys_id de l’élément de catalogue cloud à invoquer. Disponible dans la table Élément de catalogue cloud [sn_cmp_bp_cat_item].

    Type de données : chaîne
    Tableau 39. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    CloudAccount Requis. Nom du compte dans le cloud dans lequel soumettre la demande. Les noms de compte sont disponibles dans la table Compte dans le cloud [cmdb_ci_cmp_cloud_account].

    Type de données : chaîne
    Emplacement Requis. Emplacement du centre de données dans lequel mettre en service la ressource. Par exemple, us-west-1 ou asia-south-2. Cette valeur doit correspondre à l’emplacement du centre de données du fournisseur de plateforme du compte dans le cloud. Disponible dans la table Centre de données associé [sn_cmp_ca_assc_datacenter].

    Type de données : chaîne
    StackName Requis. Nom de la pile. Le nom de la pile est dynamique et est reflété dans Resource Management.

    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 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 Réussi. La demande a été correctement traitée.
    400 Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
    401 Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises.
    403 Interdit. L’utilisateur ne dispose pas des droits d’accès à l’enregistrement spécifié.
    404 Introuvable. L’élément demandé est introuvable.
    405 Méthode non valide. La fonctionnalité est désactivée.
    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
    assignmentGroup Groupe affecté à la demande.

    Type de données : chaîne
    assignedTo E-mail de l’utilisateur affecté à la demande.

    Type de données : chaîne
    Élément de catégorie Sys_id de la demande d’élément de catalogue.

    Type de données : chaîne

    Table : élément de catalogue dans le cloud [sn_cmp_bp_cat_item]
    Numéro Numéro d’élément de demande unique (RITM) attribué au nouvel élément de demande.

    Type de données : chaîne

    Table : Élément de demande [sc_req_item]
    openedAt Horodatage à partir de l’ouverture de l’élément de demande.

    Format : aaaa-MM-jj HH :mm :ss.

    Type de date : chaîne
    openedBy Sys_id de l’utilisateur qui a ouvert la demande.

    Type de données : chaîne
    étape Étape actuelle du traitement de l’élément de demande.
    Valeurs possibles :
    • Déploiement de la pile
    • Déploiement annulé
    • Échec du déploiement
    • Déploiement réussi
    • Limite des ressources dépassée
    • Nouvelle tentative de déploiement de la pile
    • Tâche créée pour l'utilisateur
    • En attente d'approbation de la demande de mise en service

    Type de données : chaîne
    État État d’achèvement actuel de l’élément de demande.
    Valeurs possibles :
    • Fermé terminé
    • Fermé incomplet
    • Fermé ignoré
    • Ouvert
    • En attente
    • Travail en cours

    Type de données : chaîne
    submissionData Informations sur l’envoi de la demande, telles que le compte dans le cloud, l’emplacement, l’application et les données du centre de coûts. Les données de soumission varient en fonction du numéro d’élément de demande transmis dans la demande.

    Type de données : objet

    "submissionData": "{\"key1\":\"value\", \"key2\":\"value\"}"
}
    sys_id Sys_id de l’enregistrement de l’élément de demande.

    Type de données : chaîne

    Table : Élément de demande [sc_req_item]

    L’exemple suivant soumet une demande de ressource de cloud dans le compte cloud AWS de l’instance.

    curl "https://instance.servicenow.com/api/now/cmp_catalog_api/submitrequest?cat_id=022e3deec3122910a769f44ed40131b9" /
--request POST \ 
--header 'Accept: application/json' \ 
--user 'username':'password'

//Request body:
{"CloudAccount":"AWS","Location":"us-east-1","StackName":"ss"}

    Réponse :

    { 
  "number": "RITM0010001", 
  "catItem": "022e3deec3122910a769f44ed40131b9", 
  "stage": "check_permissions", 
  "sys_id": "86d34233c3594610bc89b336050131dd", 
  "assignedTo": null, 
  "assignmentGroup": null, 
  "openedAt": "2024-04-08 08:59:25", 
  "openedBy": "6816f79cc0a8016401c5a33be04be441", 
  "state": "Open", 
  "submissionData": "{\"CloudAccount\":\"AWS\",\"Location\":\"us-east-1\",\"StackName\":\"ss\"}" 
}