--- 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 --- # API ouverte de Catalogue de services # API ouverte de Catalogue de services {#ariaid-title1} * Rversion finale: Xanadu * * Mis à jour 1 août 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 20 minutes de lecture L'API ouverte de Catalogue de services fournit des points de terminaison pour créer et récupérer les spécifications de service. Utilisez cette API pour gérer les informations du catalogue de services entre les systèmes externes et le Now Platform. L'API ouverte Service Catalog est une ServiceNow® implémentation de la spécification REST de l'API TM Forum Service Catalog. Cette implémentation est basée sur la [spécification REST de l'API TMF633 Service Catalog version 4, octobre](https://www.tmforum.org/resources/standard/tmf633-service-catalog-api-user-guide-v4-0-0/) 2020. Cette API est incluse dans l'application Product Catalog Advanced, disponible sur .ServiceNow Store Cette API est fournie dans l'espace de noms `sn_prd_pm_adv` . L'utilisateur appelant doit avoir le rôle sn_prd_pm_adv.catalog_integrator. Cette API crée et met à jour les données dans les tables suivantes. * Caractéristique \[sn_prd_pm_characteristic\] * Option de la caractéristique \[sn_prd_pm_characteristic_option\] * Spécification de service \[sn_prd_pm_service_specification\] * Relation de spécification \[sn_prd_pm_specification_relationship\] {#service-catalog-open-api__ul_fhn_pjj_hsb} ## Catalogue de services ouvert : GET /servicespecification {#ariaid-title2} Récupère une liste de toutes les spécifications de service. ### Format d'URL URL par défaut : /api/sn_prd_pm_adv/catalogmanagement/servicespecification ### Paramètres de demande pris en charge {#tmf_service_cat-GET-servicespec__section_nfr_vgy_fsb} {#tmf_service_cat-GET-servicespec__table_ofr_vgy_fsb__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 1. Paramètres de chemin d'accès] {#tmf_service_cat-GET-servicespec__table_ofr_vgy_fsb} {#tmf_service_cat-GET-servicespec__table_pfr_vgy_fsb__entry__2} | Nom | Description | |-|-| | champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Si ce paramètre n'est pas utilisé, tous les champs sont renvoyés. Type de données : chaîne | | limite | Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d'enregistrements, utilisez le paramètre pour paginer la récupération de l'enregistrement offset . Par défaut : 20 Maximum : 100 Type de données : nombre | | décalage | Index de départ auquel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Par défaut : 0 Type de données : nombre | | État | Filtrer les spécifications de service par état. Seules les spécifications avec un état correspondant à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne | [Tableau 2. Paramètres de requête] {#tmf_service_cat-GET-servicespec__table_pfr_vgy_fsb} {#tmf_service_cat-GET-servicespec__table_qfr_vgy_fsb__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 3. Paramètres du corps de la demande (JSON)] {#tmf_service_cat-GET-servicespec__table_qfr_vgy_fsb} ### 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."). {#tmf_service_cat-GET-servicespec__table_kqy_wgy_fsb__entry__2} | En-tête | Description | |-|-| | Aucun | | [Tableau 4. En-têtes de demandes] {#tmf_service_cat-GET-servicespec__table_kqy_wgy_fsb} {#tmf_service_cat-GET-servicespec__table_c2r_4gm_lsb__entry__2}{#tmf_service_cat-GET-servicespec__content-range-row}{#tmf_service_cat-GET-servicespec__content-type-row}{#tmf_service_cat-GET-servicespec__links-pagination-row}{#tmf_service_cat-GET-servicespec__x-total-count-descr} | En-tête | Description | |-|-| | Plage de contenu | Spécifie la plage de contenu renvoyée dans un appel paginé. Par exemple, si `offset=2` et `limit=3`, la valeur de l'en-tête Content-Range est `les éléments 3 à 5`. | | Type de contenu | Format de données du corps de la réponse. Ne prend en charge application/jsonque les fichiers . | | Lien | Contient les liens suivants pour parcourir les résultats de la requête. * premier * dernier * suivant * previous {#tmf_service_cat-GET-servicespec__ul_zzk_sdm_lsb} | | X-Total-Count | Pour les requêtes paginées, cet en-tête indique le nombre total d'enregistrements disponibles sur le serveur. | [Tableau 5. En-têtes de réponses] {#tmf_service_cat-GET-servicespec__table_c2r_4gm_lsb} ### 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."). {#tmf_service_cat-GET-servicespec__table_qbg_4cm_lsb__entry__2}{#tmf_service_cat-GET-servicespec__tmf-get-status-200-p}{#tmf_service_cat-GET-servicespec__tmf-get-status-206-entry}{#tmf_service_cat-GET-servicespec__tmf-get-status-400-entry}{#tmf_service_cat-GET-servicespec__tmf-get-status-404-entry} | Code d'état | Description | |-|-| | 200 | Demande traitée avec succès. Ressource complète renvoyée en réponse (aucune pagination). | | 206 | Ressource partielle renvoyée en réponse (avec pagination). | | 400 | Demande incorrecte. Raisons possibles : * Paramètre de chemin d'accès non valide * URI non valide {#tmf_service_cat-GET-servicespec__ul_rys_1gy_fsb} | | 404 | Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n'a été trouvé dans la table. | [Tableau 6. Codes d'état] {#tmf_service_cat-GET-servicespec__table_qbg_4cm_lsb} ### Paramètres de corps de réponse (JSON) {#tmf_service_cat-GET-servicespec__section_sqv_3t3_hsb} {#tmf_service_cat-GET-servicespec__table_hnx_3gy_fsb__entry__2} | Nom | Description | |-|-| | description | Description de la spécification. Type de données : chaîne | | externalId | External_id de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | id | Initial_version ou external_id de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | internalId | Initial_version de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | version interne | Version de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | lastUpdate (en anglais seulement) | Date de la dernière mise à jour de la spécification. Type de données : chaîne | | nom | Nom de la spécification. Type de données : chaîne | | Spécification de ressource | Spécifications de ressources pour cette spécification de service. Type de données : tableau "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ] | | resourceSpecification.id | Initial_version ou external_id de la spécification de ressource. Type de données : chaîne | | resourceSpecification.internalId | Initial_version de la spécification de ressource. Type de données : chaîne | | resourceSpecification.internalVersion | External_version de la spécification de ressource. Type de données : chaîne | | resourceSpecification.name | Nom de la spécification de ressource. Type de données : chaîne | | resourceSpecification.version | Version de la spécification de ressource. Type de données : chaîne | | serviceSpecificationRelationship | Relations de cette spécification avec d'autres spécifications de service. Type de données : tableau "serviceSpecificationRelationship": [ { "id": "String", "internalId": "String", "internalVersion": "String", "relationshipType": "String", "validFor": {Object}, "version": "String" } ] | | serviceSpecificationRelationship.id | Initial_version ou external_id de la spécification connexe. Type de données : chaîne | | serviceSpecificationRelationship.internalId | Initial_version de la spécification connexe. | | serviceSpecificationRelationship.internalVersion | Version de la spécification connexe. Type de données : chaîne | | serviceSpecificationRelationship.relationshipType | Type de relation. Type de données : chaîne | | serviceSpecificationRelationship.validFor | Plage de dates pour laquelle la relation est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" } | | serviceSpecificationRelationship.validFor.endDateTime | Date de fin de la relation. Type de données : chaîne | | serviceSpecificationRelationship.validFor.startDateTime | Date de début de la relation. Type de données : chaîne | | serviceSpecificationRelationship.version | External_version de la spécification connexe. Type de données : chaîne | | specCharacteristic (en anglais seulement) | Caractéristique de spécification. Type de données : tableau "specCharacteristic": [ { "characteristicValueSpecification": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ] | | specCharacteristic.characteristicValueSpecification | Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau "characteristicValueSpecification": [ { "value": "String" } ] | | specCharacteristic.characteristicValueSpecification.value | Valeur de la caractéristique. Type de données : chaîne | | specCharacteristic.description | Description de la caractéristique. Type de données : chaîne | | specCharacteristic.name | Nom de la caractéristique. Type de données : chaîne | | specCharacteristic.validFor | Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" } | | specCharacteristic.validFor.endDateTime | Date de fin de la caractéristique. Type de données : chaîne | | specCharacteristic.validFor.startDateTime | Date de début de la caractéristique. Type de données : chaîne | | specCharacteristic.valueType | Type de valeur de la caractéristique, tel que le choix ou l'e-mail. Type de données : chaîne | | valideFor | Plage de dates pour laquelle la spécification est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" } | | valideFor.endDateTime | Date de fin de la spécification. Type de données : chaîne | | valideFor.startDateTime | Date de début de la spécification. Type de données : chaîne | | version | External_version de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | @type | Type de spécification. Type de données : chaîne | [ ] {#tmf_service_cat-GET-servicespec__table_hnx_3gy_fsb} ### Demande cURL {#tmf_service_cat-GET-servicespec__example_cmv_y2j_hsb} Cet exemple récupère toutes les spécifications de service. curl --location --request GET "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/servicespecification" \ --user 'username':'password' Corps de réponse. [ { "id": "16d79ec3532520103b6bddeeff7b12a6", "name": "SD WAN Optimization Service", "description": "SD WAN Optimization Service", "lastUpdate": "2022-01-23 22:48:55", "validFor": { "startDateTime": "2022-01-12", "endDateTime": "2027-02-11" }, "serviceSpecificationRelationship": [ { "id": "a1f5fe981bb420106ba59acf034bcb4f", "name": "Deduplication and Compression", "version": "1", "type": "rfs", "validFor": { "startDateTime": "2021-02-11", "endDateTime": "2027-02-11" } } ], "resourceSpecification": [], "serviceSpecCharacteristic": [ { "name": "SSL Optimization", "description": "SSL Optimization", "valueType": "choice", "validFor": { "startDatetime": "2022-01-14 07:47:57" }, "productSpecCharacteristicValue": [ { "value": "False", "validFor": { "startDateTime": "" } }, { "value": "True", "validFor": { "startDateTime": "" } } ] }, { "name": "CIFS Optimization", "description": "CIFS Optimization Protocol", "valueType": "choice", "validFor": { "startDatetime": "2022-01-14 07:49:09" }, "productSpecCharacteristicValue": [ { "value": "SMB1", "validFor": { "startDateTime": "" } }, { "value": "SMB2", "validFor": { "startDateTime": "" } } ] } ] }, { "id": "31c5caff07266010a7955b7e0ad3006b", "name": "Firewall Administration", "description": "Firewall Administration", "lastUpdate": "2022-01-23 11:46:48", "validFor": { "startDateTime": "2021-11-22", "endDateTime": "" }, "serviceSpecificationRelationship": [], "resourceSpecification": [ { "id": "3546463307666010a7955b7e0ad3005d", "name": "Cisco Firewall Management system", "version": "1" } ], "serviceSpecCharacteristic": [ { "name": "Firewall Administration CPE Model", "description": "Firewall Administration CPE Model", "valueType": "choice", "validFor": { "startDatetime": "2022-02-20 00:55:37" }, "productSpecCharacteristicValue": [ { "value": "2100 series", "validFor": { "startDateTime": "" } }, { "value": "4100 series", "validFor": { "startDateTime": "" } }, { "value": "7300 series", "validFor": { "startDateTime": "" } }, { "value": "9300 series", "validFor": { "startDateTime": "" } } ] }, { "name": "Firewall Administration CPE Type", "description": "Firewall Administration CPE Type", "valueType": "choice", "validFor": { "startDatetime": "2022-02-20 00:53:45" }, "productSpecCharacteristicValue": [ { "value": "Physical", "validFor": { "startDateTime": "" } }, { "value": "Virtual", "validFor": { "startDateTime": "" } } ] }, { "name": "Configuration and Policy backup", "description": "Configuration and Policy backup", "valueType": "choice", "validFor": { "startDatetime": "2022-01-21 10:46:02" }, "productSpecCharacteristicValue": [ { "value": "Weekly", "validFor": { "startDateTime": "" } }, { "value": "Monthly", "validFor": { "startDateTime": "" } }, { "value": "Daily", "validFor": { "startDateTime": "" } } ] }, { "name": "Remote CLI troubleshoot support", "description": "Remote CLI troubleshoot support", "valueType": "choice", "validFor": { "startDatetime": "2022-01-21 10:45:38" }, "productSpecCharacteristicValue": [ { "value": "Standard support", "validFor": { "startDateTime": "" } }, { "value": "Premium support", "validFor": { "startDateTime": "" } }, { "value": "Basic support", "validFor": { "startDateTime": "" } } ] }, { "name": "Firewall Administration CPE ID", "description": "Firewall Administration CPE ID", "valueType": "single_line_text", "validFor": { "startDatetime": "2022-02-20 00:57:50" }, "productSpecCharacteristicValue": [] } ] } ] ## Catalogue de services ouvert : GET /servicespecification/{specificationId} {#ariaid-title3} Récupère une spécification de service. ### Format d'URL URL par défaut : /api/sn_prd_pm_adv/catalogmanagement/servicespecification/{specificationId} ### Paramètres de demande pris en charge {#tmf_service_cat-GET-servicespec-id__entry__2} | Nom | Description | |-|-| | specificationId | Sys_id de la spécification de service à récupérer. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | [Tableau 7. Paramètres de chemin d'accès] {#tmf_service_cat-GET-servicespec-id__table_pfr_vgy_fsb__entry__2} | Nom | Description | |-|-| | champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Si ce paramètre n'est pas utilisé, tous les champs sont renvoyés. Type de données : chaîne | | État | Filtrer les spécifications de service par état. Seules les spécifications avec un état correspondant à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne | [Tableau 8. Paramètres de requête] {#tmf_service_cat-GET-servicespec-id__table_pfr_vgy_fsb} {#tmf_service_cat-GET-servicespec-id__entry__12} | Nom | Description | |-|-| | Aucun | | [Tableau 9. Paramètres du corps de la demande (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."). {#tmf_service_cat-GET-servicespec-id__table_kqy_wgy_fsb__entry__2} | En-tête | Description | |-|-| | Aucun | | [Tableau 10. En-têtes de demandes] {#tmf_service_cat-GET-servicespec-id__table_kqy_wgy_fsb} {#tmf_service_cat-GET-servicespec-id__table_sc4_cgy_ksb__entry__2} | En-tête | Description | |-|-| | Type de contenu | Format de données du corps de la réponse. Ne prend en charge application/jsonque les fichiers . | [Tableau 11. En-têtes de réponses] {#tmf_service_cat-GET-servicespec-id__table_sc4_cgy_ksb} ### 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."). {#tmf_service_cat-GET-servicespec-id__entry__24} | Code d'état | Description | |-|-| | 200 | Demande traitée avec succès. | | 400 | Demande incorrecte. L'une des raisons suivantes peut être l'une des suivantes : * Paramètre de chemin d'accès non valide * URI non valide {#tmf_service_cat-GET-servicespec-id__ul_rys_1gy_fsb} | | 404 | Enregistrement introuvable. L'enregistrement associé à l'ID est introuvable dans la table. | [Tableau 12. Codes d'état] ### Paramètres de corps de réponse (JSON) {#tmf_service_cat-GET-servicespec-id__section_wgn_gt3_hsb} {#tmf_service_cat-GET-servicespec-id__table_hnx_3gy_fsb__entry__2} | Nom | Description | |-|-| | description | Description de la spécification. Type de données : chaîne | | externalId | External_id de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | id | Initial_version ou external_id de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | internalId | Initial_version de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | version interne | Version de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | lastUpdate (en anglais seulement) | Date de la dernière mise à jour de la spécification. Type de données : chaîne | | nom | Nom de la spécification. Type de données : chaîne | | Spécification de ressource | Spécifications de ressources pour cette spécification de service. Type de données : tableau "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ] | | resourceSpecification.id | Initial_version ou external_id de la spécification de ressource. Type de données : chaîne | | resourceSpecification.internalId | Initial_version de la spécification de ressource. Type de données : chaîne | | resourceSpecification.internalVersion | External_version de la spécification de ressource. Type de données : chaîne | | resourceSpecification.name | Nom de la spécification de ressource. Type de données : chaîne | | resourceSpecification.version | Version de la spécification de ressource. Type de données : chaîne | | serviceSpecificationRelationship | Relations de cette spécification avec d'autres spécifications de service. Type de données : tableau "serviceSpecificationRelationship": [ { "id": "String", "internalId": "String", "internalVersion": "String", "relationshipType": "String", "validFor": {Object}, "version": "String" } ] | | serviceSpecificationRelationship.id | Initial_version ou external_id de la spécification connexe. Type de données : chaîne | | serviceSpecificationRelationship.internalId | Initial_version de la spécification connexe. | | serviceSpecificationRelationship.internalVersion | Version de la spécification connexe. Type de données : chaîne | | serviceSpecificationRelationship.relationshipType | Type de relation. Type de données : chaîne | | serviceSpecificationRelationship.validFor | Plage de dates pour laquelle la relation est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" } | | serviceSpecificationRelationship.validFor.endDateTime | Date de fin de la relation. Type de données : chaîne | | serviceSpecificationRelationship.validFor.startDateTime | Date de début de la relation. Type de données : chaîne | | serviceSpecificationRelationship.version | External_version de la spécification connexe. Type de données : chaîne | | specCharacteristic (en anglais seulement) | Caractéristique de spécification. Type de données : tableau "specCharacteristic": [ { "characteristicValueSpecification": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ] | | specCharacteristic.characteristicValueSpecification | Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau "characteristicValueSpecification": [ { "value": "String" } ] | | specCharacteristic.characteristicValueSpecification.value | Valeur de la caractéristique. Type de données : chaîne | | specCharacteristic.description | Description de la caractéristique. Type de données : chaîne | | specCharacteristic.name | Nom de la caractéristique. Type de données : chaîne | | specCharacteristic.validFor | Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" } | | specCharacteristic.validFor.endDateTime | Date de fin de la caractéristique. Type de données : chaîne | | specCharacteristic.validFor.startDateTime | Date de début de la caractéristique. Type de données : chaîne | | specCharacteristic.valueType | Type de valeur de la caractéristique, tel que le choix ou l'e-mail. Type de données : chaîne | | valideFor | Plage de dates pour laquelle la spécification est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" } | | valideFor.endDateTime | Date de fin de la spécification. Type de données : chaîne | | valideFor.startDateTime | Date de début de la spécification. Type de données : chaîne | | version | External_version de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | @type | Type de spécification. Type de données : chaîne | [ ] {#tmf_service_cat-GET-servicespec-id__table_hnx_3gy_fsb} ### Demande cURL Cet exemple récupère une spécification de service pour un service de pare-feu. curl --location --request GET "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/servicespecification/31c5caff07266010a7955b7e0ad3006b" \ --user 'username':'password' Corps de réponse. { "id": "31c5caff07266010a7955b7e0ad3006b", "name": "Firewall Administration", "description": "Firewall Administration", "lastUpdate": "2022-01-23 11:46:48", "validFor": { "startDateTime": "2021-11-22", "endDateTime": "" }, "serviceSpecificationRelationship": [], "resourceSpecification": [ { "id": "3546463307666010a7955b7e0ad3005d", "name": "Cisco Firewall Management system", "version": "1" } ], "serviceSpecCharacteristic": [ { "name": "Firewall Administration CPE Model", "description": "Firewall Administration CPE Model", "valueType": "choice", "validFor": { "startDatetime": "2022-02-20 00:55:37" }, "productSpecCharacteristicValue": [ { "value": "2100 series", "validFor": { "startDateTime": "" } }, { "value": "4100 series", "validFor": { "startDateTime": "" } }, { "value": "7300 series", "validFor": { "startDateTime": "" } }, { "value": "9300 series", "validFor": { "startDateTime": "" } } ] }, { "name": "Firewall Administration CPE Type", "description": "Firewall Administration CPE Type", "valueType": "choice", "validFor": { "startDatetime": "2022-02-20 00:53:45" }, "productSpecCharacteristicValue": [ { "value": "Physical", "validFor": { "startDateTime": "" } }, { "value": "Virtual", "validFor": { "startDateTime": "" } } ] }, { "name": "Configuration and Policy backup", "description": "Configuration and Policy backup", "valueType": "choice", "validFor": { "startDatetime": "2022-01-21 10:46:02" }, "productSpecCharacteristicValue": [ { "value": "Weekly", "validFor": { "startDateTime": "" } }, { "value": "Monthly", "validFor": { "startDateTime": "" } }, { "value": "Daily", "validFor": { "startDateTime": "" } } ] }, { "name": "Remote CLI troubleshoot support", "description": "Remote CLI troubleshoot support", "valueType": "choice", "validFor": { "startDatetime": "2022-01-21 10:45:38" }, "productSpecCharacteristicValue": [ { "value": "Standard support", "validFor": { "startDateTime": "" } }, { "value": "Premium support", "validFor": { "startDateTime": "" } }, { "value": "Basic support", "validFor": { "startDateTime": "" } } ] }, { "name": "Firewall Administration CPE ID", "description": "Firewall Administration CPE ID", "valueType": "single_line_text", "validFor": { "startDatetime": "2022-02-20 00:57:50" }, "productSpecCharacteristicValue": [] } ] } ## Catalogue de services ouvert : POST/servicespecification {#ariaid-title4} Crée une spécification de service. ### Format d'URL URL par défaut : /api/sn_prd_pm_adv/catalogmanagement/servicespecification ### Paramètres de demande pris en charge {#tmf_service_cat-POST-servicespec__entry__2} | Nom | Description | |-|-| | Aucun | | [Tableau 13. Paramètres de chemin d'accès] {#tmf_service_cat-POST-servicespec__entry__6} | Nom | Description | |-|-| | Aucun | | [Tableau 14. Paramètres de requête] {#tmf_service_cat-POST-servicespec__entry__10} | Nom | Description | |-|-| | description | Requis. Description de la spécification. Type de données : chaîne | | externalId | External_id de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Si les deux externalIdid sont fournis, ils doivent faire référence à la même spécification. Type de données : chaîne Par défaut : chaîne vide | | id | Initial_version ou external_id de la spécification de service. Si id ce n'est pas fourni, ce point de terminaison crée une nouvelle spécification avec version=1. S'il id est fourni, ce point de terminaison crée une nouvelle version de la spécification donnée. Si les deux externalIdid sont fournis, ils doivent faire référence à la même spécification. Type de données : chaîne Par défaut : chaîne vide | | version interne | Version de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne Par défaut : chaîne vide | | lastUpdate (en anglais seulement) | Date de la dernière mise à jour de la spécification. Type de données : chaîne Par défaut : chaîne vide | | nom | Requis. Nom de la spécification. Type de données : chaîne | | Spécification de ressource | Requis. Spécifications de ressources pour cette spécification de service. Type de données : tableau "resourceSpecification": [ { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } ] | | resourceSpecification.id | Requis. Initial_version ou external_id de la spécification de ressource. Type de données : chaîne | | resourceSpecification.internalVersion | External_version de la spécification de ressource. Type de données : chaîne Par défaut : chaîne vide | | resourceSpecification.name | Nom de la spécification de ressource. Type de données : chaîne Par défaut : chaîne vide | | resourceSpecification.version | Version de la spécification de ressource. Type de données : chaîne Par défaut : chaîne vide | | serviceSpecificationRelationship | Relations de cette spécification avec d'autres spécifications de service. Type de données : tableau "serviceSpecificationRelationship": [ { "id": "String", "internalVersion": "String", "relationshipType": "String", "validFor": {Object}, "version": "String" } ] | | serviceSpecificationRelationship.id | Requis si le serviceSpecificationRelationship paramètre est utilisé. Initial_version ou external_id de la spécification connexe. Type de données : chaîne | | serviceSpecificationRelationship.internalVersion | Version de la spécification connexe. Type de données : chaîne Par défaut : chaîne vide | | serviceSpecificationRelationship.relationshipType | Requis si le serviceSpecificationRelationship paramètre est utilisé. Type de relation. Valeurs valides : * composed_of * Paquets {#tmf_service_cat-POST-servicespec__ul_kjr_xnx_fsb} Type de données : chaîne | | serviceSpecificationRelationship.validFor | Plage de dates pour laquelle la relation est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" } | | serviceSpecificationRelationship.validFor.endDateTime | Date de fin de la relation. Type de données : chaîne Par défaut : chaîne vide | | serviceSpecificationRelationship.validFor.startDateTime | Date de début de la relation. Type de données : chaîne Par défaut : chaîne vide | | serviceSpecificationRelationship.version | External_version de la spécification connexe. Type de données : chaîne Par défaut : chaîne vide | | specCharacteristic (en anglais seulement) | Caractéristique de spécification. Type de données : tableau "specCharacteristic": [ { "characteristicValueSpecification": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ] | | specCharacteristic.characteristicValueSpecification | Requis. Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau "characteristicValueSpecification": [ { "value": "String" } ] | | specCharacteristic.characteristicValueSpecification.value | Requis. Valeur de la caractéristique. Type de données : chaîne | | specCharacteristic.description | Description de la caractéristique. Type de données : chaîne Par défaut : chaîne vide | | specCharacteristic.name | Requis. Nom de la caractéristique. Type de données : chaîne | | specCharacteristic.validFor | Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" } | | specCharacteristic.validFor.endDateTime | Date de fin de la caractéristique. Type de données : chaîne Par défaut : chaîne vide | | specCharacteristic.validFor.startDateTime | Date de début de la caractéristique. Type de données : chaîne Par défaut : chaîne vide | | specCharacteristic.valueType | Requis. Type de valeur de la caractéristique, tel que le choix ou l'e-mail. Type de données : chaîne | | valideFor | Requis. Plage de dates pour laquelle la spécification est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" } | | valideFor.endDateTime | Date de fin de la spécification. Type de données : chaîne Par défaut : chaîne vide | | valideFor.startDateTime | Date de début de la spécification. Type de données : chaîne Par défaut : chaîne vide | | version | External_version de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. La version doit être unique pour la chaîne de versions donnée. Type de données : chaîne Par défaut : chaîne vide | | @type | Requis. Type de spécification. Valeurs valides : * Spécification ServiceFacing client * ResourceFacingServiceSpecification {#tmf_service_cat-POST-servicespec__ul_lys_rmp_fsb} Type de données : chaîne | [Tableau 15. Paramètres du corps de la demande (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."). {#tmf_service_cat-POST-servicespec__entry__78}{#tmf_service_cat-POST-servicespec__accept-JSON-only-entry-RESTAPI}{#tmf_service_cat-POST-servicespec__content_type-JSON-only-entry-RESTAPI} | En-tête | Description | |-|-| | Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. | | Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. | [Tableau 16. En-têtes de demandes] {#tmf_service_cat-POST-servicespec__table_sc4_cgy_ksb__entry__2} | En-tête | Description | |-|-| | Type de contenu | Format de données du corps de la réponse. Ne prend en charge application/jsonque les fichiers . | [Tableau 17. En-têtes de réponses] {#tmf_service_cat-POST-servicespec__table_sc4_cgy_ksb} ### 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."). {#tmf_service_cat-POST-servicespec__entry__88} | Code d'état | Description | |-|-| | 201 | Demande traitée avec succès. | | 400 | Demande incorrecte. L'une des raisons suivantes peut être l'une des suivantes : * Charge utile vide. * Charge utile non valide. Champ obligatoire manquant : \ {#tmf_service_cat-POST-servicespec__ul_nc5_myx_fsb} | [Tableau 18. Codes d'état] ### Paramètres de corps de réponse (JSON) {#tmf_service_cat-POST-servicespec__section_wwt_jt3_hsb} {#tmf_service_cat-POST-servicespec__table_hnx_3gy_fsb__entry__2} | Nom | Description | |-|-| | description | Description de la spécification. Type de données : chaîne | | externalId | External_id de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | id | Initial_version ou external_id de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | internalId | Initial_version de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | version interne | Version de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | lastUpdate (en anglais seulement) | Date de la dernière mise à jour de la spécification. Type de données : chaîne | | nom | Nom de la spécification. Type de données : chaîne | | Spécification de ressource | Spécifications de ressources pour cette spécification de service. Type de données : tableau "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ] | | resourceSpecification.id | Initial_version ou external_id de la spécification de ressource. Type de données : chaîne | | resourceSpecification.internalId | Initial_version de la spécification de ressource. Type de données : chaîne | | resourceSpecification.internalVersion | External_version de la spécification de ressource. Type de données : chaîne | | resourceSpecification.name | Nom de la spécification de ressource. Type de données : chaîne | | resourceSpecification.version | Version de la spécification de ressource. Type de données : chaîne | | serviceSpecificationRelationship | Relations de cette spécification avec d'autres spécifications de service. Type de données : tableau "serviceSpecificationRelationship": [ { "id": "String", "internalId": "String", "internalVersion": "String", "relationshipType": "String", "validFor": {Object}, "version": "String" } ] | | serviceSpecificationRelationship.id | Initial_version ou external_id de la spécification connexe. Type de données : chaîne | | serviceSpecificationRelationship.internalId | Initial_version de la spécification connexe. | | serviceSpecificationRelationship.internalVersion | Version de la spécification connexe. Type de données : chaîne | | serviceSpecificationRelationship.relationshipType | Type de relation. Type de données : chaîne | | serviceSpecificationRelationship.validFor | Plage de dates pour laquelle la relation est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" } | | serviceSpecificationRelationship.validFor.endDateTime | Date de fin de la relation. Type de données : chaîne | | serviceSpecificationRelationship.validFor.startDateTime | Date de début de la relation. Type de données : chaîne | | serviceSpecificationRelationship.version | External_version de la spécification connexe. Type de données : chaîne | | specCharacteristic (en anglais seulement) | Caractéristique de spécification. Type de données : tableau "specCharacteristic": [ { "characteristicValueSpecification": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ] | | specCharacteristic.characteristicValueSpecification | Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau "characteristicValueSpecification": [ { "value": "String" } ] | | specCharacteristic.characteristicValueSpecification.value | Valeur de la caractéristique. Type de données : chaîne | | specCharacteristic.description | Description de la caractéristique. Type de données : chaîne | | specCharacteristic.name | Nom de la caractéristique. Type de données : chaîne | | specCharacteristic.validFor | Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" } | | specCharacteristic.validFor.endDateTime | Date de fin de la caractéristique. Type de données : chaîne | | specCharacteristic.validFor.startDateTime | Date de début de la caractéristique. Type de données : chaîne | | specCharacteristic.valueType | Type de valeur de la caractéristique, tel que le choix ou l'e-mail. Type de données : chaîne | | valideFor | Plage de dates pour laquelle la spécification est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" } | | valideFor.endDateTime | Date de fin de la spécification. Type de données : chaîne | | valideFor.startDateTime | Date de début de la spécification. Type de données : chaîne | | version | External_version de la spécification de service. Situé dans la table Spécification de service \[sn_prd_pm_service_specification\]. Type de données : chaîne | | @type | Type de spécification. Type de données : chaîne | [ ] {#tmf_service_cat-POST-servicespec__table_hnx_3gy_fsb} ### Demande cURL Cet exemple crée une spécification de service pour un service de pare-feu. curl "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/servicespecification" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ "externalId": "7655", "name": "Firewall Service", "description": "This service specification describes a firewall service that can be deployed in customer-premises equipment.", "validFor": { "startDateTime": "2017-08-23T00:00", "endDateTime": "2021-03-25T00:00" }, "lastUpdate": "2020-08-15T00:00", "resourceSpecification": [ { "id": "af66e551c32f10105252716b7d40dd52", "name": "Firewall" } ], "specCharacteristic": [ { "name": "Edge", "description": "This characteristic describes the operating system run by the service", "valueType": "choice", "validFor": { "startDateTime": "2017-08-12T00:00", "endDateTime": "2021-03-07T00:00" }, "characteristicValueSpecification": [ { "value": "Android KitKat" } ], } ], "serviceSpecRelationship": [ { "relationshipType": "composed_of", "id": "65033023ebdb30107ee5302698522849", "validFor": { "startDateTime": "2017-08-25T00:00", "endDateTime": "2021-03-25T00:00" } } ], "@type": "ResourceFacingServiceSpecification" }" \ --user 'username':'password' Corps de réponse. { "id": "21a7ee64c32310105253716b8d40dd60", "name": "Firewall Service", "description": "This service specification describes a firewall service that can be deployed in customer-premises equipment.", "validFor": { "startDateTime": "2017-08-23T00:00", "endDateTime": "2021-03-25T00:00" }, "lastUpdate": "2020-08-15T00:00", "resourceSpecification": [ { "id": "af66e551c32f10105252716b7d40dd52", "name": "Firewall" } ], "specCharacteristic": [ { "name": "Edge", "description": "This characteristic describes the operating system run by the service", "valueType": "choice", "validFor": { "startDateTime": "2017-08-12T00:00", "endDateTime": "2021-03-07T00:00" }, "characteristicValueSpecification": [ { "value": "Android KitKat" } ], } ], "serviceSpecRelationship": [ { "relationshipType": "composed_of", "id": "65033023ebdb30107ee5302698522849", "validFor": { "startDateTime": "2017-08-25T00:00", "endDateTime": "2021-03-25T00:00" } } ], "@type": "ResourceFacingServiceSpecification" }