--- 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 --- # Cloud Services Catalog API # Cloud Services Catalog API {#ariaid-title1} * Rversion finale: Xanadu * * Mis à jour 1 août 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 31 minutes de lecture L'API Cloud Services Catalog fournit des méthodes liées aux opérations du jour 1 (mise en service) et du 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, l'obtention de l'état des piles 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 soit le bundle ITOM Enterprise, soit l'autorisation de produit ITOM Cloud Accelerate. L'API Cloud Services Catalog propose les actions que vous effectuez pendant les opérations du Jour 2. Dans le contexte de cette API, les éléments du catalogue de ressources font référence aux é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 les opérations de mise en service et de catalogue fonctionnent dans l'interface utilisateur. Pour en savoir plus sur ces étapes, reportez-vous à la section [Cloud Services Catalog](https://www.servicenow.com/docs/access?context=csc-home&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). ## Catalogue de services cloud : GET /now/cmp_catalog_api/itemsbyciclass {#ariaid-title2} Renvoie une liste d'éléments du catalogue de ressources basée sur 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 {#cs-catalog-GET-itemsbyciclass__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 1. Paramètres de chemin d'accès] {#cs-catalog-GET-itemsbyciclass__entry__6}{#cs-catalog-GET-itemsbyciclass__operation_name-ph-3} | Nom | Description | |-|-| | ci_class | Requis. Nom de la classe CI à partir de laquelle obtenir les éléments du catalogue de ressources (par exemple, \<\< cmdb_ci_vm_instance \>\>). Situé dans le champ Type de CI de référence de 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 : * vrai : affiche les variables d'éléments de catalogue de la liste. * faux : n'affiche pas de variables d'éléments de catalogue de 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 de la table OperationSignature \[sn_cmp_rb_op_signature\]. Remarque : Ce paramètre permet d'interroger une partie ou la totalité 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, tous types d'opérations confondus, sont renvoyés.{#cs-catalog-GET-itemsbyciclass__operation_name-ph-2} Type de données : chaîne | | resource_interface | Facultatif. Interface de ressource 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 2. Paramètres de requête] {#cs-catalog-GET-itemsbyciclass__entry__16} | Nom | Description | |-|-| | Aucun | | [Tableau 3. Paramètres de corps de demande (XML ou JSON)] ### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#cs-catalog-GET-itemsbyciclass__entry__20}{#cs-catalog-GET-itemsbyciclass__accept-RESTAPI} | 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 4. En-têtes de demandes] {#cs-catalog-GET-itemsbyciclass__entry__24} | En-tête | Description | |-|-| | Aucun | | [Tableau 5. En-têtes de réponses] ### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#cs-catalog-GET-itemsbyciclass__table_kyz_xq3_1bc__entry__2}{#cs-catalog-GET-itemsbyciclass__entry-200-status-code}{#cs-catalog-GET-itemsbyciclass__entry-400-status-code}{#cs-catalog-GET-itemsbyciclass__entry-401-status-code}{#cs-catalog-GET-itemsbyciclass__entry-403-status-code}{#cs-catalog-GET-itemsbyciclass__entry-404-status-code}{#cs-catalog-GET-itemsbyciclass__entry-405-status-code}{#cs-catalog-GET-itemsbyciclass__entry-500-status-code} | 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 possède pas les 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. | [Tableau 6. Codes d'état] {#cs-catalog-GET-itemsbyciclass__table_kyz_xq3_1bc} ### Paramètres du corps de réponse (JSON ou XML) {#cs-catalog-GET-itemsbyciclass__entry__44} | Nom | Description | |-|-| | Actif | État actif de l'élément de catalogue de l'opération de ressource. 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. {#cs-catalog-GET-itemsbyciclass__ul_c1g_4jp_gbc} 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 ressource. 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 | | 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 d'opérations 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 | | updated_on | Horodatage à partir 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 de services cloud : GET /now/cmp_catalog_api/itemsbyrb {#ariaid-title3} Renvoie une liste d'éléments du catalogue de ressources basée sur 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 {#cs-catalog-GET-itemsbyrb__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 7. Paramètres de chemin d'accès] {#cs-catalog-GET-itemsbyrb__entry__6}{#cs-catalog-GET-itemsbyrb__operation_name-ph-3}{#cs-catalog-GET-itemsbyrb__resource_block-ph-3} | 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 : * vrai : affiche les variables d'éléments de catalogue de la liste. * faux : n'affiche pas de variables d'éléments de catalogue de 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 de la table OperationSignature \[sn_cmp_rb_op_signature\]. Remarque : Ce paramètre permet d'interroger une partie ou la totalité 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, tous types d'opérations confondus, sont renvoyés.{#cs-catalog-GET-itemsbyrb__operation_name-ph-2} 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). Disponible dans la table Bloc de ressources \[sn_cmp_rb_resourceblock\]. Par défaut : tous les éléments de catalogue, tous types d'opérations confondus, sont renvoyés.{#cs-catalog-GET-itemsbyrb__resource_block-ph-2} Type de données : chaîne | | resource_interface | Facultatif. Interface de ressource 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 8. Paramètres de requête] {#cs-catalog-GET-itemsbyrb__entry__16} | Nom | Description | |-|-| | Aucun | | [Tableau 9. Paramètres de corps de demande (XML ou JSON)] ### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#cs-catalog-GET-itemsbyrb__entry__20}{#cs-catalog-GET-itemsbyrb__accept-RESTAPI} | 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 10. En-têtes de demandes] {#cs-catalog-GET-itemsbyrb__entry__24} | En-tête | Description | |-|-| | Aucun | | [Tableau 11. En-têtes de réponses] ### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#cs-catalog-GET-itemsbyrb__table_kyz_xq3_1bc__entry__2}{#cs-catalog-GET-itemsbyrb__entry-200-status-code}{#cs-catalog-GET-itemsbyrb__entry-400-status-code}{#cs-catalog-GET-itemsbyrb__entry-401-status-code}{#cs-catalog-GET-itemsbyrb__entry-403-status-code}{#cs-catalog-GET-itemsbyrb__entry-404-status-code}{#cs-catalog-GET-itemsbyrb__entry-405-status-code}{#cs-catalog-GET-itemsbyrb__entry-500-status-code} | 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 possède pas les 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. | [Tableau 12. Codes d'état] {#cs-catalog-GET-itemsbyrb__table_kyz_xq3_1bc} ### Paramètres du corps de réponse (JSON ou XML) {#cs-catalog-GET-itemsbyrb__table_dbv_lt3_1bc__entry__2} | Nom | Description | |-|-| | Actif | État actif de l'élément de catalogue de l'opération de ressource. 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. {#cs-catalog-GET-itemsbyrb__ul_c1g_4jp_gbc} 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 ressource. 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 | | 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 d'opérations 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 | | variables | Liste des 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" } ] | [ ] {#cs-catalog-GET-itemsbyrb__table_dbv_lt3_1bc} Cet 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 {#ariaid-title4} Renvoie une liste d'éléments de catalogue basée sur le 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 {#cs-catalog-GET-services__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 13. Paramètres de chemin d'accès] {#cs-catalog-GET-services__entry__6} | 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 Blueprint. * `Cycle de vie` : renvoie tous les éléments de catalogue du jour 2 Type d'opération. {#cs-catalog-GET-services__ul_klg_1jg_cbc} 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 : * vrai : affiche les variables d'éléments de catalogue de la liste. * faux : n'affiche pas de variables d'éléments de catalogue de 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 14. Paramètres de requête] {#cs-catalog-GET-services__entry__14} | Nom | Description | |-|-| | Aucun | | [Tableau 15. Paramètres de corps de demande (XML ou JSON)] ### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#cs-catalog-GET-services__entry__18}{#cs-catalog-GET-services__accept-RESTAPI} | 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 16. En-têtes de demandes] {#cs-catalog-GET-services__entry__22} | En-tête | Description | |-|-| | Aucun | | [Tableau 17. En-têtes de réponses] ### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#cs-catalog-GET-services__table_kyz_xq3_1bc__entry__2}{#cs-catalog-GET-services__entry-200-status-code}{#cs-catalog-GET-services__entry-400-status-code}{#cs-catalog-GET-services__entry-401-status-code}{#cs-catalog-GET-services__entry-403-status-code}{#cs-catalog-GET-services__entry-404-status-code}{#cs-catalog-GET-services__entry-405-status-code}{#cs-catalog-GET-services__entry-500-status-code} | 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 possède pas les 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. | [Tableau 18. Codes d'état] {#cs-catalog-GET-services__table_kyz_xq3_1bc} ### Paramètres du corps de réponse (JSON ou XML) {#cs-catalog-GET-services__table_mqx_4y3_1bc__entry__2} | Nom | Description | |-|-| | Actif | Marqueur indiquant si le catalogue est actif. Valeurs possibles : * vrai : le catalogue est actif. * faux : le catalogue n'est pas actif. {#cs-catalog-GET-services__ul_yxy_yl5_dcc} Type de données : chaîne | | plan | sys_id du plan. Situé dans la table Plan \[sn_cmp_bp_blueprint\]. Type de données : chaîne | | blueprint_category | sys_id de la catégorie Blueprint. Situé dans la table Catégorie de services dans le cloud \[sn_capi_service_category\]. Type de données : chaîne | | blueprint_category_name | Nom de la catégorie de plan. Situé dans la table Catégorie de services dans le cloud \[sn_capi_service_category\]. 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 bruyant * Apprentissage automatique * Outils de gestion * Place de marché * Mobile * Réseau * Productivité * Sécurité * Accès Shell * Stockage * Outils * Inconnu * Réalité virtuelle {#cs-catalog-GET-services__ul_qsx_xl5_dcc} Type de données : chaîne | | 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. Situé dans la table Élément de catalogue dans le cloud \[sn_cmp_bp_cat_item\]. 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 | | 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 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. Situé dans la table Élément de catalogue dans le cloud \[sn_cmp_bp_cat_item\]. Type de données : chaîne | | last_updated_on | Horodatage à partir 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. Disponible dans la table OperationSignature \[sn_cmp_rb_op_signature\]. | | operation_name | Nom de l'exploitation. Valeurs possibles : * Démarrer : démarre les ressources qui sont dans un état désactivé. * Arrêter : arrête les ressources qui sont dans un état actif. * ModifySchedule : modifie le calendrier pour les ressources mises en service. * Annuler l'approvisionnement : supprime les ressources ayant un état terminé et met à jour les tables CMDB de ressources en conséquence. * ModifyLease : modifie l'opération de bail planifiée sur les ressources mises en service. Type de données : chaîne | | variables | Objet contenant des détails supplémentaires sur l'élément de catalogue de listes. Les variables renvoyées dans cette API varient en fonction des paramètres de requête transmis dans la requête. Type de données : objet "variables": [ { "parameter1": "String", "parameter2": "String" } ] | [ ] {#cs-catalog-GET-services__table_mqx_4y3_1bc} 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 de services cloud : GET /now/cmp_catalog_api/stacks {#ariaid-title5} Renvoie une liste d'éléments de catalogue basée 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 {#cs-catalog-GET-stacks__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 19. Paramètres de chemin d'accès] {#cs-catalog-GET-stacks__entry__6} | 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 : * vrai : affiche les variables d'éléments de catalogue de la liste. * faux : n'affiche pas de variables d'éléments de catalogue de liste. Type de données : booléennes Valeur par défaut : false | [Tableau 20. Paramètres de requête] {#cs-catalog-GET-stacks__entry__12} | Nom | Description | |-|-| | Aucun | | [Tableau 21. Paramètres de corps de demande (XML ou JSON)] ### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#cs-catalog-GET-stacks__entry__16}{#cs-catalog-GET-stacks__accept-RESTAPI} | 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 22. En-têtes de demandes] {#cs-catalog-GET-stacks__entry__20} | En-tête | Description | |-|-| | Aucun | | [Tableau 23. En-têtes de réponses] ### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#cs-catalog-GET-stacks__entry__24}{#cs-catalog-GET-stacks__entry-200-status-code}{#cs-catalog-GET-stacks__entry-400-status-code}{#cs-catalog-GET-stacks__entry-401-status-code}{#cs-catalog-GET-stacks__entry-403-status-code}{#cs-catalog-GET-stacks__entry-404-status-code}{#cs-catalog-GET-stacks__entry-405-status-code}{#cs-catalog-GET-stacks__entry-500-status-code} | 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 possède pas les 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. | [Tableau 24. Codes d'état] ### Paramètres du corps de réponse (JSON ou XML) {#cs-catalog-GET-stacks__entry__40} | Nom | Description | |-|-| | Actif | Marqueur indiquant si le catalogue est actif. Valeurs possibles : * vrai : le catalogue est actif. * faux : le catalogue n'est pas actif. {#cs-catalog-GET-stacks__ul_yxy_yl5_dcc} Type de données : chaîne | | plan | sys_id du plan. Situé dans la table Plan \[sn_cmp_bp_blueprint\]. Type de données : chaîne | | blueprint_category | sys_id de la catégorie Blueprint. Situé dans la table Catégorie de services dans le cloud \[sn_capi_service_category\]. Type de données : chaîne | | blueprint_category_name | Nom de la catégorie de plan. Situé dans la table Catégorie de services dans le cloud \[sn_capi_service_category\]. 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 bruyant * Apprentissage automatique * Outils de gestion * Place de marché * Mobile * Réseau * Productivité * Sécurité * Accès Shell * Stockage * Outils * Inconnu * Réalité virtuelle {#cs-catalog-GET-stacks__ul_qsx_xl5_dcc} Type de données : chaîne | | 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. Situé dans la table Élément de catalogue dans le cloud \[sn_cmp_bp_cat_item\]. 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 | | catalog_type_name | Nom du type de catalogue. Valeurs possibles : * Opération de mise en service (Jour 1) : le type de catalogue est la mise en service nommée. * Opération de cycle de vie (Jour 2) : le type de catalogue est nommé cycle de vie. Type de données : chaîne | | id | sys_id du plan. Situé dans la table Élément de catalogue dans le cloud \[sn_cmp_bp_cat_item\]. Type de données : chaîne | | lifecycleOperations | Objet contenant le nom et la 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. Disponible dans la table OperationSignature \[sn_cmp_rb_op_signature\]. | | lifeCycleOperations.name | Type d'opérations de cycle de vie. Valeurs possibles : 1. Annulation d'approvisionnement : supprime les ressources à l'état terminé et met à jour les tables CMDB de ressources en conséquence. 2. ModifySchedule : planifie les heures ouvrables sur les piles au moment de la mise en service ou sur les piles existantes. 3. Arrêter : arrête les ressources qui sont dans un état actif. 4. Nettoyage : nettoie les ressources dont l'état est terminé. 5. ModifyLease : modifie l'opération de bail planifiée sur les ressources mises en service. 6. Démarrer : démarre les ressources qui sont dans un état désactivé. Type de date : Objet | | operation | sys_id de l'opération. Disponible dans la table OperationSignature \[sn_cmp_rb_op_signature\]. | | operation_name | Nom de l'exploitation. Valeurs possibles : * Démarrer : démarre les ressources qui sont dans un état désactivé. * Arrêter : arrête les ressources qui sont dans un état actif. * ModifySchedule : modifie le calendrier pour les ressources mises en service. * Annuler l'approvisionnement : supprime les ressources ayant un état terminé et met à jour les tables CMDB de ressources en conséquence. * ModifyLease : modifie l'opération de bail planifiée sur les ressources mises en service. Type de données : chaîne | | shortDescription | Une description courte du catalogue. Type de données : chaîne | | template_name | Nom du modèle. Disponible dans la table Élément de catalogue cloud \[sn_cmp_bp_cat_item\]. Type de données : chaîne | | template_type | sys_id du type de modèle. Disponible dans la table Élément de catalogue cloud \[sn_cmp_bp_cat_item\]. Type de données : chaîne | | template_cloud_product_name | Nom du produit. Disponible dans la table Élément de catalogue cloud \[sn_cmp_bp_cat_item\]. Type de données : chaîne | | variables | Objet contenant des détails supplémentaires sur l'élément de catalogue de listes. Les variables renvoyées dans cette API varient en fonction des paramètres de requête transmis dans la requête. Type de données : objet "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 de services cloud : GET /now/cmp_catalog_api/status {#ariaid-title6} Renvoie l'état et les détails d'un RITM (élément de demande) de catalogue donné. Cette méthode permet d'identifier et de tracer l'origine de la demande et de surveiller son flux. La réponse comprend les éléments suivants : 1. Numéro RITM pour la demande soumise 2. Étape à laquelle se trouve la demande 3. Utilisateurs qui ont ouvert la demande et qui l'ont 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 {#cs-catalog-GET-status__ol_rxn_n44_cbc} ### Format d'URL URL par défaut : /api/now/cmp_catalog_api/status ### Paramètres de demande pris en charge {#cs-catalog-GET-status__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 25. Paramètres de chemin d'accès] {#cs-catalog-GET-status__entry__6} | 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 26. Paramètres de requête] {#cs-catalog-GET-status__entry__10} | Nom | Description | |-|-| | Aucun | | [Tableau 27. Paramètres de corps de demande (XML ou JSON)] ### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#cs-catalog-GET-status__entry__14}{#cs-catalog-GET-status__accept-RESTAPI} | 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 28. En-têtes de demandes] {#cs-catalog-GET-status__entry__18} | En-tête | Description | |-|-| | Aucun | | [Tableau 29. En-têtes de réponses] ### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#cs-catalog-GET-status__entry__22}{#cs-catalog-GET-status__entry-200-status-code}{#cs-catalog-GET-status__entry-400-status-code}{#cs-catalog-GET-status__entry-401-status-code}{#cs-catalog-GET-status__entry-403-status-code}{#cs-catalog-GET-status__entry-404-status-code}{#cs-catalog-GET-status__entry-405-status-code}{#cs-catalog-GET-status__entry-500-status-code} | 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 possède pas les 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. | [Tableau 30. Codes d'état] ### Paramètres du corps de réponse (JSON ou XML) {#cs-catalog-GET-status__entry__38} | 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 catalogue | sys_id de la demande d'élément de catalogue. Situé dans la table Élément de catalogue dans le cloud \[sn_cmp_bp_cat_item\]. Type de données : chaîne | | erreur | Message contenant 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. Situé dans la table Élément de demande \[sc_req_item\]. Type de données : chaîne | | 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 de traitement de l'élément de demande. Valeurs possibles : * Tâche créée pour l'utilisateur * Déploiement réussi * En attente d'approbation de la demande de mise en service * Limite des ressources dépassée * Échec du déploiement * Déploiement annulé * Nouvelle tentative de déploiement de la pile * Déploiement de la pile {#cs-catalog-GET-status__ul_fg5_4l5_dcc} Type de données : chaîne | | État | État d'achèvement actuel de l'élément de demande. Valeurs possibles : * Ouvert * En cours de résolution * Fermé terminé * Fermé incomplet * Fermé ignoré * En attente {#cs-catalog-GET-status__ul_o4x_4l5_dcc} Type de données : chaîne | | Données de soumission | Informations sur la soumission d'une demande, telles que les données de compte cloud, d'emplacement, d'application et de 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 d'élément de demande. Situé dans la table Élément de demande \[sc_req_item\]. Type de données : chaîne | [ ] ### Demande cURL L'exemple suivant renvoie des informations d'état pour le 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 {#ariaid-title7} 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 {#cs-catalog-POST-submitoprequest__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 31. Paramètres de chemin d'accès] {#cs-catalog-POST-submitoprequest__table_urr_lqw_cbc__entry__2} | Nom | Description | |-|-| | cat_id | Obligatoire. sys_id de l'élément de catalogue cloud à appeler. Disponible dans la table Élément de catalogue cloud \[sn_cmp_bp_cat_item\]. Type de données : chaîne | [Tableau 32. Paramètres de requête] {#cs-catalog-POST-submitoprequest__table_urr_lqw_cbc} {#cs-catalog-POST-submitoprequest__entry__10}{#cs-catalog-POST-submitoprequest__resource_block-ph-3} | 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 se reflète dans la gestion des ressources. Type de données : chaîne | | resourceId | Requis. Le sys_id de la ressource où les opérations du Jour 2 seront effectuées. Situé dans la 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). Disponible dans la table Bloc de ressources \[sn_cmp_rb_resourceblock\]. Par défaut : tous les éléments de catalogue, tous types d'opérations confondus, sont renvoyés.{#cs-catalog-POST-submitoprequest__resource_block-ph-2} Type de données : chaîne | | operation_name | Facultatif. Nom de l'exploitation. Situé dans la colonne Nom de l'interface de ressource de 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 permet d'interroger une partie ou la totalité 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, tous types d'opérations confondus, sont renvoyés.Type de données : chaîne | | Interface des ressources | Obligatoire. Nom du bloc de ressources à partir duquel obtenir ses éléments de catalogue d'opérations de ressources connexes (par exemple, Serveur virtuel). Disponible dans la table Bloc de ressources \[sn_cmp_rb_resourceblock\]. L'interface de ressource que vous saisissez dépend de la valeur transmise dans les resourceBlock paramètres and operation_name . Par défaut : tous les éléments de catalogue, tous types d'opérations confondus, sont renvoyés. Type de données : chaîne | [Tableau 33. Paramètres de corps de demande (XML ou JSON)] ### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#cs-catalog-POST-submitoprequest__entry__26}{#cs-catalog-POST-submitoprequest__accept-RESTAPI} | 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 34. En-têtes de demandes] {#cs-catalog-POST-submitoprequest__entry__30} | En-tête | Description | |-|-| | Aucun | | [Tableau 35. En-têtes de réponses] ### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#cs-catalog-POST-submitoprequest__table_xdr_41j_1bc__entry__2}{#cs-catalog-POST-submitoprequest__entry-200-status-code}{#cs-catalog-POST-submitoprequest__entry-400-status-code}{#cs-catalog-POST-submitoprequest__entry-401-status-code}{#cs-catalog-POST-submitoprequest__entry-403-status-code}{#cs-catalog-POST-submitoprequest__entry-404-status-code}{#cs-catalog-POST-submitoprequest__entry-405-status-code}{#cs-catalog-POST-submitoprequest__entry-500-status-code} | 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 possède pas les 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. | [Tableau 36. Codes d'état] {#cs-catalog-POST-submitoprequest__table_xdr_41j_1bc} ### Paramètres du corps de réponse (JSON ou XML) {#cs-catalog-POST-submitoprequest__section_fsy_vsw_cbc} {#cs-catalog-POST-submitoprequest__table_m3n_ndj_1bc__entry__2} | 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 catalogue | sys_id de la demande d'élément de catalogue. Situé dans la table Élément de catalogue dans le cloud \[sn_cmp_bp_cat_item\]. Type de données : chaîne | | Numéro | Numéro d'élément de demande unique (RITM) attribué au nouvel élément de demande. Situé dans la table Élément de demande \[sc_req_item\]. Type de données : chaîne | | 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 de traitement de l'élément de demande. Valeurs possibles : * Tâche créée pour l'utilisateur * Déploiement réussi * En attente d'approbation de la demande de mise en service * Limite des ressources dépassée * Échec du déploiement * Déploiement annulé * Nouvelle tentative de déploiement de la pile * Déploiement de la pile {#cs-catalog-POST-submitoprequest__ul_fg5_4l5_dcc} Type de données : chaîne | | État | État d'achèvement actuel de l'élément de demande. Valeurs possibles : * Ouvert * En cours de résolution * Fermé terminé * Fermé incomplet * Fermé ignoré * En attente {#cs-catalog-POST-submitoprequest__ul_o4x_4l5_dcc} Type de données : chaîne | | Données de soumission | Informations sur la soumission d'une demande, telles que les données de compte cloud, d'emplacement, d'application et de 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 d'élément de demande. Situé dans la table Élément de demande \[sc_req_item\]. Type de données : chaîne | [ ] {#cs-catalog-POST-submitoprequest__table_m3n_ndj_1bc} 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 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 {#ariaid-title8} 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 de piles ou d'opérations de ressources. ### Format d'URL URL par défaut : /api/now/cmp_catalog_api/submitrequest ### Paramètres de demande pris en charge {#cs-catalog-POST-submitrequest__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 37. Paramètres de chemin d'accès] {#cs-catalog-POST-submitrequest__entry__6} | Nom | Description | |-|-| | cat_id | Obligatoire. sys_id de l'élément de catalogue cloud à appeler. Disponible dans la table Élément de catalogue cloud \[sn_cmp_bp_cat_item\]. Type de données : chaîne | [Tableau 38. Paramètres de requête] {#cs-catalog-POST-submitrequest__entry__10} | 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 se reflète dans la gestion des ressources. Type de données : chaîne | [Tableau 39. Paramètres de corps de demande (XML ou JSON)] ### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#cs-catalog-POST-submitrequest__entry__18}{#cs-catalog-POST-submitrequest__accept-RESTAPI} | 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 40. En-têtes de demandes] {#cs-catalog-POST-submitrequest__entry__22} | En-tête | Description | |-|-| | Aucun | | [Tableau 41. En-têtes de réponses] ### 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](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres."). {#cs-catalog-POST-submitrequest__table_xdr_41j_1bc__entry__2}{#cs-catalog-POST-submitrequest__entry-200-status-code}{#cs-catalog-POST-submitrequest__entry-400-status-code}{#cs-catalog-POST-submitrequest__entry-401-status-code}{#cs-catalog-POST-submitrequest__entry-403-status-code}{#cs-catalog-POST-submitrequest__entry-404-status-code}{#cs-catalog-POST-submitrequest__entry-405-status-code}{#cs-catalog-POST-submitrequest__entry-500-status-code} | 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 possède pas les 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. | [Tableau 42. Codes d'état] {#cs-catalog-POST-submitrequest__table_xdr_41j_1bc} ### Paramètres du corps de réponse (JSON ou XML) {#cs-catalog-POST-submitrequest__table_m3n_ndj_1bc__entry__2} | 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 catalogue | sys_id de la demande d'élément de catalogue. Situé dans la table Élément de catalogue dans le cloud \[sn_cmp_bp_cat_item\]. Type de données : chaîne | | Numéro | Numéro d'élément de demande unique (RITM) attribué au nouvel élément de demande. Situé dans la table Élément de demande \[sc_req_item\]. Type de données : chaîne | | 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 de traitement de l'élément de demande. Valeurs possibles : * Tâche créée pour l'utilisateur * Déploiement réussi * En attente d'approbation de la demande de mise en service * Limite des ressources dépassée * Échec du déploiement * Déploiement annulé * Nouvelle tentative de déploiement de la pile * Déploiement de la pile {#cs-catalog-POST-submitrequest__ul_fg5_4l5_dcc} Type de données : chaîne | | État | État d'achèvement actuel de l'élément de demande. Valeurs possibles : * Ouvert * En cours de résolution * Fermé terminé * Fermé incomplet * Fermé ignoré * En attente {#cs-catalog-POST-submitrequest__ul_o4x_4l5_dcc} Type de données : chaîne | | Données de soumission | Informations sur la soumission d'une demande, telles que les données de compte cloud, d'emplacement, d'application et de 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 d'élément de demande. Situé dans la table Élément de demande \[sc_req_item\]. Type de données : chaîne | [ ] {#cs-catalog-POST-submitrequest__table_m3n_ndj_1bc} L'exemple suivant soumet une demande de ressource 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\"}" }