Catalogue de produits : API ouverte

L’API ouverte Product Catalog fournit des points de terminaison pour créer et récupérer des catalogues de produits, des offres de produits et des spécifications de produits.

Utilisez cette API pour gérer les informations du catalogue de produits entre les systèmes externes et le Now Platform. L’API ouverte du catalogue de produits est une ServiceNow® implémentation de la spécification REST de l’API de gestion du catalogue de produits TM Forum. Cette implémentation est basée sur la spécification REST de l’API de gestion du catalogue de produits TMF620 version 4, avril 2021.

Cette API est incluse dans l’application Product Catalog Advanced, disponible sur .ServiceNow Store

Cette API est fournie dans l’espace de noms sn_tmf_api .

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]
• Offre de produits [sn_prd_pm_product_offering]
• Catalogue d’offres de produits [sn_prd_pm_product_offering_catalog]
• Caractéristiques des offres de produits [sn_prd_pm_product_offering_characteristic]
• Spécification de produit [sn_prd_pm_product_specification]
• Relation de spécification [sn_prd_pm_specification_relationship]

API ouverte du catalogue de produits : DELETE /sn_tmf_api/catalogmanagement/productOffering/{id}

Supprime l’offre de produit spécifiée.

Format d'URL

URL par défaut : /api/sn_tmf_api/catalogmanagement/productOffering/{id}

Paramètres de demande pris en charge

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

Nom	Description
id	Sys_id de l’offre de produit à supprimer. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne

Tableau 2. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
Aucun

En-têtes

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

Tableau 4. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

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

En-tête	Description
Aucun

Codes d'état

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

Tableau 6. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.

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

Nom	Description
message	Message d’échec ou de réussite concernant la suppression ou l’archivage de la spécification du produit.

Demande cURL

L’exemple suivant supprime l’offre de produit avec un ID de d6f8d9995b020210235d85cced81c7eb.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOffering/d6f8d9995b020210235d85cced81c7eb" \ 
--request DELETE\ 
--header "Accept:application/json" \ 
--user 'username':'password'

Le corps de la réponse renvoie un message de suppression réussi :

"The product offering (d6f8d9995b020210235d85cced81c7eb) is successfully deleted"

API ouverte du catalogue de produits : DELETE /sn_tmf_api/catalogmanagement/productSpecification/{id}

Supprime ou archive la spécification du produit spécifiée.

Lors de l’appel de cette méthode DELETE, une spécification de produit peut être supprimée ou archivée en fonction de son état :

• Une spécification de produit à l’état de brouillon est supprimée avec succès. La réponse renvoie un message de réussite.
• Une spécification de produit à l’état Archivé ne peut pas être supprimée. La réponse renvoie un message indiquant que la spécification est déjà archivée.
• Une spécification de produit dont l’état n’est pas à l’état de brouillon et qui est associée à d’autres spécifications ou offres de produit est archivée, mais pas supprimée. La réponse renvoie un message indiquant que la spécification est passée d’un état actif à un état archivé.
• Une spécification de produit associée à une spécification ou une offre de produit active ne peut pas être supprimée. La réponse renvoie un message d’erreur.

Format d'URL

URL par défaut : /sn_tmf_api/catalogmanagement/productSpecification/{id}

Paramètres de demande pris en charge

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

Nom	Description
id	Sys_id de la spécification du produit à supprimer. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne

Tableau 8. Paramètres de requête

Nom	Description
Aucun

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

Nom	Description
Aucun

En-têtes

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

Tableau 10. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

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

En-tête	Description
Aucun

Codes d'état

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

Tableau 12. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.

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

Nom	Description
message	Message d’échec ou de réussite concernant la suppression ou l’archivage de la spécification du produit.

Demande cURL

L’exemple suivant supprime la spécification du produit avec un ID de 8ef57fa05b308210235d85cced81c7d8.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productSpecification/8ef57fa05b308210235d85cced81c7d8" \ 
--request DELETE\ 
--header "Accept:application/json" \ 
--user 'username':'password'

Le corps de la réponse renvoie un message de réussite ou d’échec :

"The product specification (8ef57fa05b308210235d85cced81c7d8) is successfully deleted"

Catalogue de produits API ouverte : GET /sn_tmf_api/catalogmanagement/catalog

Récupère une liste de tous les catalogues d’offres de produits.

Format d'URL

URL par défaut : /api/sn_tmf_api/catalogmanagement/catalog

Paramètres de demande pris en charge

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

Nom	Description
Aucun

Tableau 14. Paramètres de requête

Nom	Description
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

Tableau 15. Paramètres du corps de la demande (JSON)

Nom	Description
Aucun

En-têtes

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

Tableau 16. En-têtes de demandes

En-tête	Description
Aucun

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

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
X-Total-Count	Pour les requêtes paginées, cet en-tête indique le nombre total d’enregistrements disponibles sur le serveur.

Codes d'état

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

Tableau 18. Codes d'état

Code d'état	Description
200	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
404	Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table.

Paramètres de corps de réponse (JSON)

Nom	Description
description	Description du catalogue d’offres de produits. Type de données : chaîne
id	Sys_id du catalogue d’offres de produits à partir de la table Catalogue d’offres de produits [sn_prd_pm_product_offering_catalog]. Type de données : chaîne
nom	Nom du catalogue d’offres de produits. Type de données : chaîne

Demande cURL

Cet exemple récupère tous les catalogues d’offres de produits.

curl --location --request GET "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog" \
--user 'username':'password'

Corps de réponse.

[
    {
        "id": "SD-WAN1344314wrfw14345",
        "name": "New Catalog",
        "description": "New Catalog"
    },
    {
        "id": "9919291ac34c20105252716b7d40dd0f",
        "name": "Enterprise Mobile Plan",
        "description": " Product Catalog for Enterprise Mobile Plan"
    }
]

API ouverte du catalogue de produits : GET /sn_tmf_api/catalogmanagement/catalog/{id}

Récupère un catalogue d’offres de produits.

Format d'URL

URL par défaut : /api/sn_tmf_api/catalogmanagement/catalog/{id}

Paramètres de demande pris en charge

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

Nom	Description
id	Sys_id du catalogue d’offres de produits à récupérer. Situé dans la table Catalogue d’offres de produits [sn_prd_pm_product_offering_catalog]. Type de données : chaîne

Tableau 20. Paramètres de requête

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

Tableau 21. Paramètres du corps de la demande (JSON)

Nom	Description
Aucun

En-têtes

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

Tableau 22. En-têtes de demandes

En-tête	Description
Aucun

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

En-tête	Description
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Codes d'état

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

Tableau 24. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. L’une des raisons suivantes peut être l’une des suivantes : Paramètre de chemin d’accès non valide URI non valide
404	Introuvable. L’élément demandé est introuvable.

Paramètres de corps de réponse (JSON)

Nom	Description
description	Description du catalogue d’offres de produits. Type de données : chaîne
id	Sys_id du catalogue d’offres de produits à partir de la table Catalogue d’offres de produits [sn_prd_pm_product_offering_catalog]. Type de données : chaîne
nom	Nom du catalogue d’offres de produits. Type de données : chaîne

Demande cURL

Cet exemple récupère un catalogue d’offres de produits pour un forfait Mobile d’entreprise.

curl --location --request GET "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog/9919291ac34c20105252716b7d40dd0f" \
--user 'username':'password'

Corps de réponse.

{
   "id": "9919291ac34c20105252716b7d40dd0f",
   "name": "Enterprise Mobile Plan",
   "description": " Product Catalog for Enterprise Mobile Plan"
}

API ouverte du catalogue de produits : GET /sn_tmf_api/catalogmanagement/productOffering

Récupère toutes les offres de produits.

Format d'URL

URL par défaut : /api/sn_tmf_api/catalogmanagement/productOffering

Paramètres de demande pris en charge

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

Nom	Description
Aucun

Tableau 26. Paramètres de requête

Nom	Description
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides : catégorie canal description externalId id internalId version interne lastUpdate (en anglais seulement) nom caractéristique du produit productOfferingPrice Terme de l’offre de produits Spécification du produit prodSpecCharValueUse valideFor version Par défaut : 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
spécification	Filtrez les offres de produits par sys_id de spécification de produit. Seules les offres de produits avec la spécification de produit spécifiée sys_id sont renvoyées dans la réponse. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
État	Filtrer les offres de produits par état. Seules les offres de produits dans l’état spécifié sont renvoyées dans la réponse. Valeurs acceptées : Archivés brouillon publié retraité Type de données : chaîne

Tableau 27. Paramètres du corps de la demande (JSON)

Nom	Description
Aucun

En-têtes

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

Tableau 28. En-têtes de demandes

En-tête	Description
Aucun

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

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
X-Total-Count	Pour les requêtes paginées, cet en-tête indique le nombre total d’enregistrements disponibles sur le serveur.

Codes d'état

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

Tableau 30. Codes d'état

Code d'état	Description
200	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
404	Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table.

Paramètres de corps de réponse (JSON)

Nom	Description
catégorie	Liste des catégories auxquelles appartient le produit. Type de données : tableau d’objets "category:" [ { "id": "String", "name": "String" } ]
category.id	ID de la catégorie. Type de données : chaîne
category.name	Nom de la catégorie. Type de données : chaîne
canal	Canaux à utiliser pour vendre l’offre de produit. Type de données : tableau d’objets "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
description.canal	Description du canal. Type de données : chaîne
channel.id	Sys_id du canal à partir de la table Canal de distribution [sn_prd_pm_distribution_channel]. Type de données : chaîne
channel.name	Nom du canal. Type de données : chaîne
description	Description de l'offre de produit. Type de données : chaîne
externalId	external_id de l’offre de produit dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
href	Un lien relatif vers l’enregistrement de ressource. Type de données : chaîne Par défaut : chaîne vide
id	Obligatoire. initial_version ou external_id de l’offre de produits à partir de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
internalId	initial_version de l’offre de produit à partir de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
version interne	Version de l’offre de produit de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
lastUpdate (en anglais seulement)	Date de la dernière mise à jour de l’offre de produit. Type de données : chaîne
lifecycleStatus	État actuel du cycle de vie de l’offre de produits. Valeurs acceptées : Actif Inactif Brouillon Type de données : chaîne Par défaut : chaîne vide
nom	Nom de l’offre de produits. Type de données : chaîne
caractéristique du produit	Liste des caractéristiques du produit. Type de données : tableau d’objets "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nom de la caractéristique. Type de données : chaîne
productCharacteristic.value	Valeur de la caractéristique. Type de données : chaîne
productOfferingPrice	Informations sur le prix de l’offre de produits. Type de données : tableau d’objets "productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]
productOfferingPrice.price	Informations sur le prix de l’offre de produits. Type de données : objet "price": { "taxIncludedAmount": {Object} }
productOfferingPrice.price.taxIncludedAmount	Informations sur le prix de l’offre de produits. Type de données : objet "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	Code de devise du prix de l’offre de produit. Type de données : chaîne
productOfferingPrice.price.taxIncludedAmount.value	Prix de l’offre de produits TTC. Type de données : chaîne
productOfferingPrice.priceType	Type de prix de l’offre de produit, paiement unique ou récurrent. Valeurs valides : non récurrent (ponctuel) récurrent Type de données : chaîne
Terme de l’offre de produits	Durée contractuelle valide pour l’offre de produit. Type de données : chaîne
Spécification du produit	Spécification du produit pour le produit. Type de données : objet "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	initial_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
Spécification produit.internalId	initial_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
Spécification produit.Version interne	Version de la spécification du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
spécification produit.version	external_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
prodSpecCharValueUse	Caractéristiques de l’offre de produits. Type de données : tableau d’objets "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	Valeurs possibles de la caractéristique. Type de données : tableau d’objets "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.description	Description de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.name	Nom de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor	Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	Date de fin de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor.startDateTime	Date de début de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.valueType	Type de valeur de la caractéristique, tel que le choix ou l’e-mail.
valideFor	Plage de dates pour laquelle l’offre de produit est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
valideFor.endDateTime	Date de fin de l’offre de produit. Type de données : chaîne
valideFor.startDateTime	Date de début de l’offre de produit. Type de données : chaîne
version	external_version de l’offre de produit à partir de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne

Demande cURL

Cet exemple récupère toutes les offres de produits.

curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering" \
--user 'username':'password'

Corps de réponse :

[
   {
      "id": "24413",
      "name": "Premium SD-WAN Offering New",
      "version": "",
      "internalVersion": "1",
      "internalId": "0199f8e65b430110235d85cced81c7d2",
      "description": "Premium SD-WAN Offering",
      "lastUpdate": "2022-01-27 05:41:16",
      "validFor": {
         "startDateTime": "2021-08-05",
         "endDateTime": "2026-09-04"
      },
      "productOfferingTerm": "not_applicable",
      "productOfferingPrice": [
         {
            "priceType": "recurring",
            "price": {
               "taxIncludedAmount": {
                  "unit": "JPY",
                  "value": 984.0913
               }
            }
         },
         {
            "priceType": "nonRecurring",
            "price": {
               "taxIncludedAmount": {
                  "unit": "GBP",
                  "value": 2434
               }
            }
         }
      ],
      "productSpecification": {
         "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
         "name": "SD-WAN Service Package",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
      },
      "prodSpecCharValueUse": [
         {
            "name": "Routing",
            "description": "Routing",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:08:20"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "WAN Optimization",
            "description": "WAN Optimization",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:10:28"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "CPE Model",
            "description": "CPE Model",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:11:54"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "ISR",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "ASR",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "Security Type",
            "description": "Security Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-30 12:51:13"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "a6514bd3534560102f18ddeeff7b1247",
               "name": "SD-WAN Security",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "a6514bd3534560102f18ddeeff7b1247"
            }
         },
         {
            "name": "CPE Type",
            "description": "CPE Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:11:16"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Virtual",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Physical",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "Tenancy",
            "description": "Tenancy",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:04:24"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Advance (50 site)",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base (10 site)",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium (>50 sites)",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "216663aa53702010cd6dddeeff7b12b5",
               "name": "SD-WAN Controller",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "216663aa53702010cd6dddeeff7b12b5"
            }
         }
      ],
      "channel": [
         {
            "id": "e561aae4c3e710105252716b7d40dd8f",
            "name": "Web"
         }
      ],
      "category": {
         "id": "c0ed043653b02010cd6dddeeff7b1277",
         "name": "SD-WAN"
      }
   }
]

API ouverte du catalogue de produits : GET /sn_tmf_api/catalogmanagement/productOffering/{id}

Récupère une offre de produit.

Format d'URL

URL par défaut : /api/sn_tmf_api/catalogmanagement/productOffering/{id}

Paramètres de demande pris en charge

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

Nom	Description
id	Initial_version de l’offre de produit à récupérer. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne

Tableau 32. Paramètres de requête

Nom	Description
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides : catégorie canal description externalId id internalId version interne lastUpdate (en anglais seulement) nom caractéristique du produit productOfferingPrice Terme de l’offre de produits Spécification du produit prodSpecCharValueUse valideFor version Par défaut : tous les champs sont renvoyés. Type de données : chaîne
spécification	Filtrez les offres de produits par sys_id de spécification de produit. Seules les offres de produits avec la spécification de produit spécifiée sys_id sont renvoyées dans la réponse. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
État	Filtrer les offres de produits par état. Seules les offres de produits dans l’état spécifié sont renvoyées dans la réponse. Valeurs acceptées : Archivés brouillon publié retraité Type de données : chaîne

Tableau 33. Paramètres du corps de la demande (JSON)

Nom	Description
Aucun

En-têtes

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

Tableau 34. En-têtes de demandes

En-tête	Description
Aucun

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

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 .

Codes d'état

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

Tableau 36. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Raisons possibles : Paramètre de chemin d’accès non valide URI non valide
404	Introuvable. L’élément demandé est introuvable.

Paramètres de corps de réponse (JSON)

Nom	Description
catégorie	Liste des catégories auxquelles appartient le produit. Type de données : tableau "category:" [ { "id": "String", "name": "String" } ]
category.id	ID de la catégorie. Type de données : chaîne
category.name	Nom de la catégorie. Type de données : chaîne
canal	Canaux à utiliser pour vendre l’offre de produit. Type de données : tableau "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
description.canal	Description du canal. Type de données : chaîne
channel.id	Sys_id du canal à partir de la table Canal de distribution [sn_prd_pm_distribution_channel]. Type de données : chaîne
channel.name	Nom du canal. Type de données : chaîne
description	Description de l'offre de produit. Type de données : chaîne
externalId	external_id de l’offre de produit dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
href	Un lien relatif vers l’enregistrement de ressource. Type de données : chaîne Par défaut : chaîne vide
id	Obligatoire. initial_version ou external_id de l’offre de produits à partir de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
internalId	initial_version de l’offre de produit à partir de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
version interne	Version de l’offre de produit de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
lastUpdate (en anglais seulement)	Date de la dernière mise à jour de l’offre de produit. Type de données : chaîne
lifecycleStatus	Indique l’état actuel du cycle de vie de l’offre de produits. Valeurs acceptées : Actif Inactif Brouillon Type de données : chaîne Par défaut : chaîne vide
nom	Nom de l’offre de produits. Type de données : chaîne
caractéristique du produit	Liste des caractéristiques du produit. Type de données : tableau "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nom de la caractéristique. Type de données : chaîne
productCharacteristic.value	Valeur de la caractéristique. Type de données : chaîne
productOfferingPrice	Informations sur le prix de l’offre de produits. Type de données : tableau "productOfferingPrice": [ { "price": Object, "priceType": "String" } ]
productOfferingPrice.price	Informations sur le prix de l’offre de produits. Type de données : objet "price": { "taxIncludedAmount": Object }
productOfferingPrice.price.taxIncludedAmount	Informations sur le prix de l’offre de produits. Type de données : objet "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	Code de devise du prix de l’offre de produit. Type de données : chaîne
productOfferingPrice.price.taxIncludedAmount.value	Prix de l’offre de produits TTC. Type de données : chaîne
productOfferingPrice.priceType	Identifie si le prix de l’offre de produit est un paiement unique ou récurrent. Valeurs valides : non récurrent récurrent Type de données : chaîne
Terme de l’offre de produits	Durée contractuelle valide pour l’offre de produit. Type de données : chaîne
Spécification du produit	Spécification du produit pour le produit. Type de données : objet "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	initial_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
Spécification produit.internalId	initial_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
Spécification produit.Version interne	Version de la spécification du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
spécification produit.version	external_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
prodSpecCharValueUse	Caractéristique de l’offre de produits. Type de données : tableau "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.description	Description de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.name	Nom de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor	Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	Date de fin de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor.startDateTime	Date de début de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.valueType	Type de valeur de la caractéristique, tel que le choix ou l’e-mail.
valideFor	Plage de dates pour laquelle l’offre de produit est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
valideFor.endDateTime	Date de fin de l’offre de produit. Type de données : chaîne
valideFor.startDateTime	Date de début de l’offre de produit. Type de données : chaîne
version	external_version de l’offre de produit à partir de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne

Demande cURL

Cet exemple récupère une offre de produit.

curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering/24413" \
--user 'username':'password'

Corps de réponse :

{
   "id": "24413",
   "name": "Premium SD-WAN Offering New",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2022-01-27 05:41:16",
   "version": "",
   "internalVersion": "2",
   "internalId": "69017a0f536520103b6bddeeff7b127d",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "not_applicable",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-30 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "abc",
            "internalVersion": "1",
            "internalId": "a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   }
}

API ouverte du catalogue de produits : GET /sn_tmf_api/catalogmanagement/productSpecification

Récupère toutes les spécifications du produit.

Format d'URL

URL par défaut : /api/sn_tmf_api/catalogmanagement/productSpecification

Paramètres de demande pris en charge

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

Nom	Description
Aucun

Tableau 38. Paramètres de requête

Nom	Description
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides : description externalId id internalId version interne lastUpdate (en anglais seulement) nom Caractéristique de spécification du produit Relation de spécifications du produit Spécification de ressource Spécification de service valideFor version Par défaut : 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 produits par état. Seules les spécifications de produit dans l’état spécifié sont renvoyées dans la réponse. Valeurs acceptées : Archivés brouillon publié retraité Type de données : chaîne

Tableau 39. Paramètres du corps de la demande (JSON)

Nom	Description
Aucun

En-têtes

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

Tableau 40. En-têtes de demandes

En-tête	Description
Aucun

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

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
X-Total-Count	Pour les requêtes paginées, cet en-tête indique le nombre total d’enregistrements disponibles sur le serveur.

Codes d'état

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

Tableau 42. Codes d'état

Code d'état	Description
200	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
404	Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table.

Paramètres de corps de réponse (JSON)

Nom	Description
description	Description de la spécification. Type de données : chaîne
externalId	Requis. External_id de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
href	Lien relatif à l’enregistrement de ressource. Type de données : chaîne Par défaut : chaîne vide
id	Initial_version ou external_id de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
internalId	Requis. Initial_version de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
version interne	Version de la spécification produit issue de la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
isBundle (en anglais seulement)	Marqueur indiquant s’il s’agit productSpecification d’un seul produit ou d’un lot de produits. Valeurs valides : true : la spécification du produit est un lot de produits et contient plusieurs produits. false : la spécification du produit ne contient qu’un seul produit. Type de données : booléennes Valeur par défaut : false
lastUpdate (en anglais seulement)	Date de la dernière mise à jour de la spécification. Type de données : chaîne
lifecycleStatus	État actuel du cycle de vie de la spécification du produit. Valeurs acceptées : Actif Inactif Brouillon Type de données : chaîne Par défaut : chaîne vide
nom	Nom de la spécification. Type de données : chaîne
Caractéristique de spécification du produit	Caractéristique de spécification. Type de données : tableau d’objets "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
productSpecCharacteristic.description	Description de la caractéristique. Type de données : chaîne
productSpecCharacteristic.name	Nom de la caractéristique. Type de données : chaîne
productSpecCharacteristic.productSpecCharacteristicValue	Liste des valeurs possibles de la caractéristique. Type de données : tableau d’objets "productSpecCharacteristicValue": [ { "value": "String" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
productSpecCharacteristic.validFor	Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	Date de fin de la caractéristique. Type de données : chaîne
productSpecCharacteristic.validFor.startDateTime	Date de début de la caractéristique. Type de données : chaîne
productSpecCharacteristic.valueType	Type de valeur de la caractéristique, tel que le choix ou l’e-mail. Type de données : chaîne
Relation de spécifications du produit	Relations de cette spécification avec d’autres spécifications du produit. Type de données : tableau d’objets "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": {Object} } ]
productSpecificationRelationship.id	ID de la spécification connexe. Type de données : chaîne
productSpecificationRelationship.type	Type de relation. Type de données : chaîne
productSpecificationRelationship.validFor	Plage de dates pour laquelle la relation est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	Date de fin de la relation. Type de données : chaîne
productSpecificationRelationship.validFor.startDateTime	Date de début de la relation. Type de données : chaîne
Spécification de ressource	Liste des spécifications de ressource associées à cette spécification de produit. Type de données : tableau d’objets "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	Initial_version ou external_id de la spécification de ressource. Situé dans le champ sys_id ou external_id de la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.internalId	Initial_version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.internalVersion	Version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.name	Nom de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.version	External_version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
Spécification de service	Liste des spécifications de service associées à cette spécification de produit. Type de données : tableau d’objets "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	Initial_version ou external_id de la spécification de service. Situé dans le champ sys_id ou external_id de la table Spécification de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceSpecification.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
serviceSpecification.internalVersion	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
serviceSpecification.name	Nom 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
serviceSpecification.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
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 du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne

Demande cURL

Cet exemple récupère toutes les spécifications du produit.

curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification" \
--user 'username':'password'

Corps de réponse :

[
   {
      "id": "0c47f2257441c110f877ca57242ff9bd",
      "name": "SD-WAN My Device",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "0c47f2257441c110f877ca57242ff9bd",
      "description": "This is my product specification ...",
      "lastUpdate": "2022-01-14 17:57:23",
      "validFor": {
         "startDateTime": "2022-01-11",
         "endDateTime": "2027-01-10"
      },
      "serviceSpecification": [
         {
            "id": "e23ae2d01bb420106ba59acf034bcb56",
            "name": "IP Sec Tunnel",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "e23ae2d01bb420106ba59acf034bcb56"
         }
      ],
      "productSpecificationRelationship": [
         {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "1",
            "type": "Service",
            "validFor": {
               "startDateTime": "2022-01-11",
               "endDateTime": "2027-02-12"
            }
         }
      ],
      "resourceSpecification": [
         {
            "id": "493fa60b536520103b6bddeeff7b12b6",
            "name": "Customer Premise SD-WAN Router",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "493fa60b536520103b6bddeeff7b12b6"
         }
      ],
      "productSpecCharacteristic": [
         {
            "name": "New characteristic",
            "description": "This product has new spec characteristic.",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-13 06:47:43"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "TestValue",
                  "validFor": {
                     "startDateTime": "2022-01-11"
                  }
               }
            ]
         }
      ]
   }
]

API ouverte du catalogue de produits : GET /sn_tmf_api/catalogmanagement/productSpecification/{id}

Récupère une spécification de produit spécifiée.

Format d'URL

URL par défaut : /api/sn_tmf_api/catalogmanagement/productSpecification/{id}

Paramètres de demande pris en charge

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

Nom	Description
specificationId	Le initial_version de la spécification du produit à récupérer. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne

Tableau 44. Paramètres de requête

Nom	Description
champs	Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Champs valides : description externalId id internalId version interne lastUpdate (en anglais seulement) nom Caractéristique de spécification du produit Relation de spécifications du produit Spécification de ressource Spécification de service valideFor version Par défaut : tous les champs sont renvoyés. Type de données : chaîne
État	Filtrer les spécifications de produits par état. Seules les spécifications de produit dans l’état spécifié sont renvoyées dans la réponse. Valeurs acceptées : Archivés brouillon publié retraité Type de données : chaîne

Tableau 45. Paramètres du corps de la demande (JSON)

Nom	Description
Aucun

En-têtes

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

Tableau 46. En-têtes de demandes

En-tête	Description
Aucun

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

En-tête	Description
Content-Type	Format de données du corps de la demande. Prend uniquement en charge application/json.

Codes d'état

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

Tableau 48. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Raisons possibles : Paramètre de chemin d’accès non valide URI non valide
404	Introuvable. L’élément demandé est introuvable.

Paramètres de corps de réponse (JSON)

Nom	Description
description	Description de la spécification. Type de données : chaîne
externalId	Requis. External_id de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
href	Lien relatif à l’enregistrement de ressource. Type de données : chaîne Par défaut : chaîne vide
id	Initial_version ou external_id de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
internalId	Requis. Initial_version de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
version interne	Version de la spécification produit issue de la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
isBundle (en anglais seulement)	Marqueur indiquant s’il s’agit productSpecification d’un seul produit ou d’un lot de produits. Valeurs valides : true : la spécification du produit est un lot de produits et contient plusieurs produits. false : la spécification du produit ne contient qu’un seul produit. Type de données : booléennes Valeur par défaut : false
lastUpdate (en anglais seulement)	Date de la dernière mise à jour de la spécification. Type de données : chaîne
lifecycleStatus	Indique l’état actuel du cycle de vie de la spécification du produit. Valeurs valides : Actif Inactif Brouillon Type de données : chaîne Par défaut : chaîne vide
nom	Nom de la spécification. Type de données : chaîne
Caractéristique de spécification du produit	Caractéristiques de spécification. Type de données : tableau d’objets "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
productSpecCharacteristic.description	Description de la caractéristique. Type de données : chaîne
productSpecCharacteristic.name	Nom de la caractéristique. Type de données : chaîne
productSpecCharacteristic.productSpecCharacteristicValue	Valeurs possibles de la caractéristique. Type de données : tableau d’objets "productSpecCharacteristicValue": [ { "value": "String" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
productSpecCharacteristic.validFor	Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	Date de fin de la caractéristique. Type de données : chaîne
productSpecCharacteristic.validFor.startDateTime	Date de début de la caractéristique. Type de données : chaîne
productSpecCharacteristic.valueType	Type de valeur de la caractéristique, tel que le choix ou l’e-mail. Type de données : chaîne
Relation de spécifications du produit	Relations de cette spécification avec d’autres spécifications du produit. Type de données : tableau d’objets "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": {Object} } ]
productSpecificationRelationship.id	ID de la spécification connexe. Type de données : chaîne
productSpecificationRelationship.type	Type de relation. Type de données : chaîne
productSpecificationRelationship.validFor	Plage de dates pour laquelle la relation est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	Date de fin de la relation. Type de données : chaîne
productSpecificationRelationship.validFor.startDateTime	Date de début de la relation. Type de données : chaîne
Spécification de ressource	Liste des spécifications de ressource associées à cette spécification de produit. Type de données : tableau d’objets "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	Initial_version ou external_id de la spécification de ressource. Situé dans le champ sys_id ou external_id de la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.internalId	Initial_version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.internalVersion	Version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.name	Nom de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.version	External_version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
Spécification de service	Liste des spécifications de service associées à cette spécification de produit. Type de données : tableau d’objets "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	Initial_version ou external_id de la spécification de service. Situé dans le champ sys_id ou external_id de la table Spécification de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceSpecification.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
serviceSpecification.internalVersion	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
serviceSpecification.name	Nom 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
serviceSpecification.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
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 du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne

Demande cURL

Cet exemple récupère une spécification de produit.

curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification/0c47f2257441c110f877ca57242ff9bd" \
--user 'username':'password'

Corps de réponse :

{
   "id": "0c47f2257441c110f877ca57242ff9bd",
   "name": "SD-WAN My Device",
   "version": "v1",
   "internalVersion": "1",
   "internalId": "0c47f2257441c110f877ca57242ff9bd",
   "description": "This is my product specification ...",
   "lastUpdate": "2022-01-14 17:57:23",
   "validFor": {
      "startDateTime": "2022-01-11",
      "endDateTime": "2027-01-10"
   },
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "e23ae2d01bb420106ba59acf034bcb56"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "version": "v1",
         "internalVersion": "1",
         "internalId": " a6514bd3534560102f18ddeeff7b1247",
         "type": "Service",
         "validFor": {
            "startDateTime": "2022-01-11",
            "endDateTime": "2027-02-12"
         }
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "493fa60b536520103b6bddeeff7b12b6"
      }
   ],
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-01-13 06:47:43"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "TestValue",
               "validFor": {
                  "startDateTime": "2022-01-11"
               }
            }
         ]
      }
   ]
}

API ouverte du catalogue de produits : PATCH /sn_tmf_api/catalogmanagement/productOffering/{id}

Met à jour l’offre de produits spécifiée.

Format d'URL

URL par défaut : /api/sn_tmf_api/catalogmanagement/productOffering/{id}

Paramètres de demande pris en charge

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

Nom	Description
id	Sys_id de l’offre de produits à mettre à jour. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne

Tableau 50. Paramètres de requête

Nom	Description
Aucun

Tableau 51. Paramètres du corps de la demande (JSON)

Nom	Description
catégorie	Liste des catégories auxquelles appartient le produit. Situé dans la table Catégorie [sc_category]. Type de données : tableau d’objets "category:" [ { "id": "String", "name": "String" } ]
category.id	Requis si le category paramètre est utilisé. ID de la catégorie. Situé dans la table Catégorie [sc_category]. Type de données : chaîne
category.name	Nom de la catégorie. Type de données : chaîne Par défaut : chaîne vide
canal	Requis. Canaux à utiliser pour vendre l’offre de produit. Type de données : tableau d’objets "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
description.canal	Description du canal. Type de données : chaîne Par défaut : chaîne vide
channel.id	Requis. Sys_id du canal à partir de la table Canal de distribution [sn_prd_pm_distribution_channel]. Type de données : chaîne
channel.name	Nom du canal. Type de données : chaîne Par défaut : chaîne vide
description	Requis. Description de l'offre de produit. Type de données : chaîne
externalId	external_id de l’offre de produit dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
id	Obligatoire. initial_version ou external_id de l’offre de produits à partir de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
internalId	initial_version de l’offre de produit à partir de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
version interne	Version de l’offre de produit de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
lastUpdate (en anglais seulement)	Date de la dernière mise à jour de l’offre de produit. Format : JJ-MM-AAAA 00:00:00 Type de données : chaîne Par défaut : chaîne vide
nom	Requis. Nom de l’offre de produits. Type de données : chaîne
caractéristique du produit	Liste des caractéristiques du produit. Type de données : tableau d’objets "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nom de la caractéristique. Type de données : chaîne Par défaut : chaîne vide
productCharacteristic.value	Valeur de la caractéristique. Type de données : chaîne Par défaut : chaîne vide
productOfferingPrice	Informations sur le prix de l’offre de produits. Type de données : tableau d’objets "productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]
productOfferingPrice.price	Informations sur le prix de l’offre de produits. Type de données : objet "price": { "taxIncludedAmount": {Object} }
productOfferingPrice.price.taxIncludedAmount	Informations sur le prix de l’offre de produits. Type de données : objet "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	Code de devise du prix de l’offre de produit. Type de données : chaîne Par défaut : chaîne vide
productOfferingPrice.price.taxIncludedAmount.value	Prix de l’offre de produits TTC. Utilisez une valeur décimale, par exemple 123,45. Type de données : chaîne Par défaut : chaîne vide
productOfferingPrice.priceType	Type d’offre de produit. Requis si le productOfferingPrice paramètre est utilisé. Valeurs valides : non récurrent (ponctuel) récurrent Type de données : chaîne
Terme de l’offre de produits	Durée contractuelle valide, en mois, pour l’offre de produits. Type de données : chaîne Par défaut : chaîne vide
Spécification du produit	Requis. Spécification du produit pour le produit. Type de données : objet "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	Requis. Initial_version ou external_id des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
Spécification produit.internalId	initial_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
Spécification produit.Version interne	Version de la spécification du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
spécification produit.version	external_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
prodSpecCharValueUse	Caractéristiques de l’offre de produits. Type de données : tableau d’objets "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau d’objets "productSpecCharacteristicValue": [ { "validFor": { "startDateTime": "String" }, "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.productSpecSpecificValue.validFor	Date et heure auxquelles la caractéristique est valide. Type de données : objet "validFor": { "startDateTime": "String" }
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	Date et heure de début auxquelles la caractéristique est valide. Format : JJ-MM-AAAA 00:00:00 Type de données : chaîne
prodSpecCharValueUse.description	Description de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.name	Requis. Nom de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor	Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	Date et heure de fin de la caractéristique. Format : JJ-MM-AAAA 00:00:00 Type de données : chaîne
prodSpecCharValueUse.validFor.startDateTime	Date et heure de début de la caractéristique. Format : JJ-MM-AAAA 00:00:00 Type de données : chaîne
prodSpecCharValueUse.valueType	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 l’offre de produit est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
valideFor.endDateTime	Requis. Date et heure de fin de l’offre de produit. Format : JJ-MM-AAAA 00:00:00 Type de données : chaîne
valideFor.startDateTime	Requis. Date et heure de début de l’offre de produit. Format : JJ-MM-AAAA 00:00:00 Type de données : chaîne
version	external_version de l’offre de produit à partir de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne

Paramètres de corps de réponse (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.

Tableau 52. En-têtes de demandes

En-tête	Description
Accepter	Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json
Content-Type	Format de données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

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

En-tête	Description
Type de contenu	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

Codes d'état

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

Tableau 54. Codes d'état

Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Un type de demande incorrecte ou mal formé a été détecté.
404	Introuvable. L’élément demandé est introuvable.

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

Nom	Description
catégorie	Liste des catégories auxquelles appartient le produit. Type de données : tableau d’objets "category:" [ { "id": "String", "name": "String" } ]
category.id	ID de la catégorie. Type de données : chaîne
category.name	Nom de la catégorie. Type de données : chaîne
canal	Canaux à utiliser pour vendre l’offre de produit. Type de données : tableau d’objets "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
description.canal	Description du canal. Type de données : chaîne
channel.id	Sys_id du canal à partir de la table Canal de distribution [sn_prd_pm_distribution_channel]. Type de données : chaîne
channel.name	Nom du canal. Type de données : chaîne
description	Description de l'offre de produit. Type de données : chaîne
externalId	external_id de l’offre de produit dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
href	Un lien relatif vers l’enregistrement de ressource. Type de données : chaîne Par défaut : chaîne vide
id	Obligatoire. initial_version ou external_id de l’offre de produits à partir de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
internalId	initial_version de l’offre de produit à partir de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
version interne	Version de l’offre de produit de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
lastUpdate (en anglais seulement)	Date de la dernière mise à jour de l’offre de produit. Type de données : chaîne
liftcycleStatus	Indique l’état actuel du cycle de vie. Valeurs acceptées : Actif Brouillon Inactif Type de données : chaîne Par défaut : chaîne vide
nom	Nom de l’offre de produits. Type de données : chaîne
caractéristique du produit	Liste des caractéristiques du produit. Type de données : tableau d’objets "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nom de la caractéristique. Type de données : chaîne
productCharacteristic.value	Valeur de la caractéristique. Type de données : chaîne
productOfferingPrice	Informations sur le prix de l’offre de produits. Type de données : tableau d’objets "productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]
productOfferingPrice.price	Informations sur le prix de l’offre de produits. Type de données : objet "price": { "taxIncludedAmount": {Object} }
productOfferingPrice.price.taxIncludedAmount	Informations sur le prix de l’offre de produits. Type de données : objet "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	Code de devise du prix de l’offre de produit. Type de données : chaîne
productOfferingPrice.price.taxIncludedAmount.value	Prix de l’offre de produits TTC. Type de données : chaîne
productOfferingPrice.priceType	Type de prix de l’offre de produit, paiement unique ou récurrent. Valeurs possibles : non récurrent (ponctuel) récurrent Type de données : chaîne
Terme de l’offre de produits	Durée contractuelle valide pour l’offre de produit. Type de données : chaîne
Spécification du produit	Spécification du produit pour le produit. Type de données : objet "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	initial_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
Spécification produit.internalId	initial_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
Spécification produit.Version interne	Version de la spécification du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
spécification produit.version	external_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
prodSpecCharValueUse	Caractéristiques de l’offre de produits. Type de données : tableau d’objets "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object} "productSpecCharacteristicValue": [Array], "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau d’objets "productSpecCharacteristicValue": [ { "validFor": { "startDateTime": "String" }, "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.productSpecSpecificValue.validFor	Date et heure auxquelles la caractéristique est valide. Type de données : objet "validFor": { "startDateTime": "String" }
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	Date et heure de début auxquelles la caractéristique est valide. Format : JJ-MM-AAAA 00:00:00 Type de données : chaîne
prodSpecCharValueUse.description	Description de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.name	Nom de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor	Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	Date de fin de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor.startDateTime	Date de début de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.valueType	Type de valeur de la caractéristique, tel que le choix ou l’e-mail.
valideFor	Plage de dates pour laquelle l’offre de produit est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
valideFor.endDateTime	Date de fin de l’offre de produit. Type de données : chaîne
valideFor.startDateTime	Date de début de l’offre de produit. Type de données : chaîne
version	external_version de l’offre de produit à partir de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne

Demande cURL

L’exemple suivant met à jour l’offre de produits avec l’ID d6f8d9995b020210235d85cced81c7eb avec les informations fournies dans le corps de la demande.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOffering/d6f8d9995b020210235d85cced81c7eb" \ 
--request PATCH\ 
--header "Accept:application/json" \ 
--user 'username':'password'
--data '{
  "name": "Offering 1",
  "displayName": "Offering 1",
  "description": "Offering 1 desc",
  "lastUpdate": "2024-04-01 16:05:19",
  "version": "Offering 1 EXTV",
  "validFor": {
    "startDateTime": "2028-02-29",
    "endDateTime": "2033-03-30"
  },
  "productOfferingTerm": "12_months",
  "productOfferingPrice": [
    {
      "priceType": "recurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": 632.1483
        }
      }
    },
    {
      "priceType": "nonRecurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": 1264.2966
        }
      }
    }
  ],
  "productSpecification": {
    "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
    "name": "SD-WAN Service Package",
    "internalVersion": "3"
  },
  "prodSpecCharValueUse": [
    {
      "name": "Bandwidth",
      "description": "Bandwidth",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2026-12-06 02:32:11"
      },
      "productSpecCharacteristicValue": [
        {
          "value": "1 Gbps",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "5 Gbps",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 Gbps",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "500 Mbps",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "productSpecification": {
        "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
        "name": "SD-WAN Service Package",
        "internalVersion": "3"
      }
    }
  ],
  "channel": [
    {
      "id": "e561aae4c3e710105252716b7d40dd8f",
      "name": "Web"
    }
  ],
  "category": [
    {
      "id": "13e305a143b631105029d1529ab8f267",
      "name": "SD-WAN_all_offers"
    }
  ]
}'

Corps de réponse :

{
  "result": {
    "name": "Offering 1",
    "displayName": "Offering 1",
    "description": "Offering 1 desc",
    "lastUpdate": "2024-04-01 16:05:19",
    "version": "Offering 1 EXTV",
    "validFor": {
      "startDateTime": "2028-02-29",
      "endDateTime": "2033-03-30"
    },
    "productOfferingTerm": "12_months",
    "productOfferingPrice": [
      {
        "priceType": "recurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 632.1483
          }
        }
      },
      {
        "priceType": "nonRecurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 1264.2966
          }
        }
      }
    ],
    "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "internalVersion": "3",
      "sys_id": "79fa17da775131108e191e599a5a997b",
      "version": "",
      "status": "published",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
    },
    "prodSpecCharValueUse": [
      {
        "name": "Bandwidth",
        "description": "Bandwidth",
        "valueType": "choice",
        "validFor": {
          "startDatetime": "2026-12-06 02:32:11"
        },
        "productSpecCharacteristicValue": [
          {
            "value": "1 Gbps",
            "validFor": {
              "startDateTime": ""
            }
          },
          {
            "value": "5 Gbps",
            "validFor": {
              "startDateTime": ""
            }
          },
          {
            "value": "2 Gbps",
            "validFor": {
              "startDateTime": ""
            }
          },
          {
            "value": "500 Mbps",
            "validFor": {
              "startDateTime": ""
            }
          }
        ],
        "productSpecification": {
          "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "name": "SD-WAN Service Package",
          "internalVersion": "3",
          "version": "",
          "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
        }
      }
    ],
    "channel": [
      {
        "id": "e561aae4c3e710105252716b7d40dd8f",
        "name": "Web"
      }
    ],
    "category": [
      {
        "id": "13e305a143b631105029d1529ab8f267",
        "name": "SD-WAN_all_offers"
      }
    ],
    "href": "/api/sn_tmf_api/catalogmanagement/productOffering/d6f8d9995b020210235d85cced81c7eb"
  }
}

API ouverte du catalogue de produits : PATCH /sn_tmf_api/catalogmanagement/productSpecification/{id}

Met à jour les spécifications du produit spécifié.

Format d'URL

URL par défaut : /api/sn_tmf_api/catalogmanagement/productSpecification/{id}

Paramètres de demande pris en charge

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

Nom	Description
id	Sys_id de l’offre de produits à mettre à jour. Situé dans la table Spécifications de produit[sn_prd_pm_product_specification]. Type de données : chaîne

Tableau 56. Paramètres de requête

Nom	Description
Aucun

Tableau 57. Paramètres du corps de la demande (JSON)

Nom	Description
description	Requis. Description de la spécification. Type de données : chaîne
externalId	Requis. External_id de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
id	Initial_version ou external_id de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
internalId	Requis. Initial_version de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
version interne	Version de la spécification produit issue de la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
isBundle (en anglais seulement)	Marqueur indiquant s’il s’agit productSpecification d’un seul produit ou d’un lot de produits. Valeurs valides : true : la spécification du produit est un lot de produits et contient plusieurs produits. false : la spécification du produit ne contient qu’un seul produit. Type de données : booléennes Valeur par défaut : false
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
Caractéristique de spécification du produit	Caractéristique de spécification. Type de données : tableau d’objets "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]
productSpecCharacteristic.description	Description de la caractéristique. Type de données : chaîne
productSpecCharacteristic.name	Requis. Nom de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.productSpecCharacteristicValue	Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau d’objets "productSpecCharacteristicValue": [ { "validFor": { "startDateTime": "String" }, "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.productSpecSpecificValue.validFor	Date et heure auxquelles la caractéristique est valide. Type de données : objet "validFor": { "startDateTime": "String" }
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	Date et heure de début auxquelles la caractéristique est valide. Format : JJ-MM-AAAA 00:00:00 Type de données : chaîne
productSpecCharacteristic.validFor	Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	Date et heure de fin de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, 2025-01-31 09:35:43. Type de données : chaîne
productSpecCharacteristic.validFor.startDateTime	Date et heure de début de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, 2025-01-31 09:35:43. Type de données : chaîne
productSpecCharacteristic.valueType	Type de valeur de la caractéristique, tel que le choix ou l’e-mail. Type de données : chaîne
Relation de spécifications du produit	Relations de cette spécification avec d’autres spécifications du produit. Type de données : tableau d’objets "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
productSpecificationRelationship.id	ID de la spécification associée. Type de données : chaîne
productSpecificationRelationship.type	Requis si le productSpecificationRelationship paramètre est utilisé. Type de relation. Valeurs valides : Paquets composed_of Type de données : chaîne
productSpecificationRelationship.validFor	Plage de dates pour laquelle la relation est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	Date de fin de la relation. Format : JJ-MM-AAAA 00:00:00. Par exemple, 2025-01-31 09:35:43. Type de données : chaîne
productSpecificationRelationship.validFor.startDateTime	Date de début de la relation. Format : JJ-MM-AAAA 00:00:00. Par exemple, 2025-01-31 09:35:43. Type de données : chaîne
Spécification de ressource	Requis. Tableau des spécifications de ressources associées à cette spécification de produit. Type de données : tableau d’objets "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	Requis. Initial_version ou external_id de la spécification de ressource. Situé dans le champ sys_id ou external_id de la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.internalId	Initial_version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.internalVersion	Version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.name	Nom de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.version	External_version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
Spécification de service	Liste des spécifications de service associées à cette spécification de produit. Type de données : tableau d’objets "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	Initial_version ou external_id de la spécification de service. Situé dans le champ sys_id ou external_id de la table Spécification de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceSpecification.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
serviceSpecification.internalVersion	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
serviceSpecification.name	Nom 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
serviceSpecification.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
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 et heure de fin de la spécification. Format : JJ-MM-AAAA 00:00:00. Par exemple, 2025-01-31 09:35:43. Type de données : chaîne
valideFor.startDateTime	Date et heure de début de la spécification. Format : JJ-MM-AAAA 00:00:00. Par exemple, 2025-01-31 09:35:43. Type de données : chaîne
version	External_version de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne

En-têtes

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

Tableau 58. En-têtes de demandes

En-tête	Description
Type de contenu	Format de données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json

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

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 .

Codes d'état

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

Tableau 60. Codes d'état

Code d'état	Description
200	Demande traitée avec succès.
400	Demande incorrecte. Raisons possibles : Charge utile vide. Charge utile non valide. Champ obligatoire manquant : <nom du champ>
404	Introuvable. L’élément demandé est introuvable.

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

Nom	Description
description	Description de la spécification. Type de données : chaîne
href	Un lien relatif vers l’enregistrement de ressource. Type de données : chaîne
id	Initial_version ou external_id de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
internalId	Requis. Initial_version de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
version interne	Version de la spécification produit issue de la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
lastUpdate (en anglais seulement)	Date de la dernière mise à jour de la spécification. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
nom	Nom de la spécification. Type de données : chaîne
Caractéristique de spécification du produit	Caractéristiques du cahier des charges. Type de données : tableau d’objets "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": Array, "validFor": Object, "valueType": "String" } ]
productSpecCharacteristic.description	Description de la caractéristique. Type de données : chaîne
productSpecCharacteristic.name	Nom de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.productSpecCharacteristicValue	Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau d’objets "productSpecCharacteristicValue": [ { "validFor": { "startDateTime": "String" }, "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.productSpecSpecificValue.validFor	Date et heure auxquelles la caractéristique est valide. Type de données : objet "validFor": { "startDateTime": "String" }
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	Date et heure de début auxquelles la caractéristique est valide. Format : JJ-MM-AAAA 00:00:00 Type de données : chaîne
productSpecCharacteristic.validFor	Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	Date et heure de fin de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
productSpecCharacteristic.validFor.startDateTime	Date et heure de début de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
productSpecCharacteristic.valueType	Type de valeur de la caractéristique, tel que le choix ou l’e-mail. Type de données : chaîne
Relation de spécifications du produit	Relations de cette spécification avec d’autres spécifications du produit. Type de données : tableau d’objets "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
productSpecificationRelationship.id	Sys_id de la spécification connexe. Type de données : chaîne
productSpecificationRelationship.type	Type de relation. Type de données : chaîne
productSpecificationRelationship.validFor	Plage de dates pour laquelle la relation est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	Date de fin et type de la relation. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
productSpecificationRelationship.validFor.startDateTime	Date de début et type de la relation. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
Spécification de ressource	Liste des spécifications de ressource associées à cette spécification de produit. Type de données : tableau d’objets "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	Initial_version ou external_id de la spécification de ressource. Situé dans le champ sys_id ou external_id de la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.internalId	Initial_version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.internalVersion	Version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.name	Nom de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.version	External_version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
Spécification de service	Liste des spécifications de service associées à cette spécification de produit. Type de données : tableau d’objets "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	Initial_version ou external_id de la spécification de service. Situé dans le champ sys_id ou external_id de la table Spécification de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceSpecification.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
serviceSpecification.internalVersion	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
serviceSpecification.name	Nom 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
serviceSpecification.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
valideFor	Plage de dates pour laquelle la spécification est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
valideFor.endDateTime	Date et heure de fin de la spécification. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
valideFor.startDateTime	Date et heure de début de la spécification. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
version	External_version de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne

Demande cURL

L’exemple suivant met à jour l’ID de spécification du produit d6f8d9995b020210235d85cced81c7eb avec les informations fournies dans le corps de la demande.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productSpecification/d6f8d9995b020210235d85cced81c7eb" \ 
--request PATCH\ 
--header "Accept:application/json" \ 
--user 'username':'password'
--data '{
  "id": "1001",
  "name": "SD-WAN 0322 test",
  "description": "This is my product specification ...",
  "validFor": {
    "startDateTime": "2017-06-19T00:00",
    "endDateTime": "2018-01-13T00:00"
  },
  "productSpecCharacteristic": [
    {
      "name": "New characteristic",
      "description": "This product has new spec characteristic.",
      "valueType": "label",
      "validFor": {
        "startDateTime": "2017-06-20T00:00"
      }
    }
  ],
  "serviceSpecification": [
    {
      "id": "e23ae2d01bb420106ba59acf034bcb56",
      "name": "IP Sec Tunnel",
      "internalVersion": "2"
    }
  ],
  "productSpecificationRelationship": [
    {
      "id": "a6514bd3534560102f18ddeeff7b1247",
      "name": "SD-WAN Security",
      "internalVersion": "2",
      "type": "bundles",
      "validFor": {
        "startDateTime": "2017-06-16T00:00"
      }
    }
  ],
  "resourceSpecification": [
    {
      "id": "493fa60b536520103b6bddeeff7b12b6",
      "name": "Customer Premise SD-WAN Router"
    }
  ],
  "@type": "ProductSpecification"
}

Corps de réponse :

{
  "result": {
    "id": "1001",
    "name": "SD-WAN 0322 test",
    "description": "This is my product specification ...",
    "validFor": {
      "startDateTime": "2017-06-19T00:00",
      "endDateTime": "2018-01-13T00:00"
    },
    "productSpecCharacteristic": [
      {
        "name": "New characteristic",
        "description": "This product has new spec characteristic.",
        "valueType": "label",
        "validFor": {
          "startDateTime": "2017-06-20T00:00"
        }
      }
    ],
    "serviceSpecification": [
      {
        "id": "e23ae2d01bb420106ba59acf034bcb56",
        "name": "IP Sec Tunnel",
        "internalVersion": "2",
        "sys_id": "dd8354205b550210235d85cced81c7cd",
        "version": "",
        "status": "published",
        "internalId": "e23ae2d01bb420106ba59acf034bcb56"
      }
    ],
    "productSpecificationRelationship": [
      {
        "id": "a6514bd3534560102f18ddeeff7b1247",
        "name": "SD-WAN Security",
        "internalVersion": "2",
        "type": "bundles",
        "validFor": {
          "startDateTime": "2017-06-16T00:00"
        },
        "sys_id": "7a491dd3776301108b2a1e599a5a99d3",
        "version": "",
        "status": "published",
        "internalId": "a6514bd3534560102f18ddeeff7b1247"
      }
    ],
    "resourceSpecification": [
      {
        "id": "493fa60b536520103b6bddeeff7b12b6",
        "name": "Customer Premise SD-WAN Router",
        "sys_id": "493fa60b536520103b6bddeeff7b12b6",
        "internalVersion": "1",
        "version": "",
        "status": "published",
        "internalId": "493fa60b536520103b6bddeeff7b12b6"
      }
    ],
    "@type": "ProductSpecification",
    "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/3d140fe85be1c210235d85cced81c73a"
  }
}

API ouverte du catalogue de produits : POST /sn_tmf_api/catalogmanagement/catalog

Crée un catalogue d’offres de produits.

Format d'URL

URL par défaut : /api/sn_tmf_api/catalogmanagement/catalog

Paramètres de demande pris en charge

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

Nom	Description
Aucun

Tableau 62. Paramètres de requête

Nom	Description
Aucun

Tableau 63. Paramètres du corps de la demande (JSON)

Nom	Description
description	Description du catalogue d’offres de produits. Type de données : chaîne Par défaut : chaîne vide
externalId	Identificateur unique du catalogue d’offres de produits à partir du système externe. Type de données : chaîne Par défaut : chaîne vide
nom	Requis. Nom du catalogue d’offres de produits. Type de données : chaîne

En-têtes

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

Tableau 64. En-têtes de demandes

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 65. En-têtes de réponses

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 .

Codes d'état

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

Tableau 66. Codes d'état

Code d'état	Description
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 : <nom du champ>

Paramètres de corps de réponse (JSON)

Nom	Description
description	Description du catalogue d’offres de produits. Type de données : chaîne
id	Sys_id du catalogue d’offres de produits à partir de la table Catalogue d’offres de produits [sn_prd_pm_product_offering_catalog]. Type de données : chaîne
nom	Nom du catalogue d’offres de produits. Type de données : chaîne

Demande cURL

Cet exemple crée un catalogue d’offres de produits.

curl --location --request POST "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog" \
--header "Content-Type: application/json" \
--data-raw '{
    "id": "testId",
    "name": "Catalog",
    "description": "Description"
}'
--user 'username':'password'

Corps de réponse.

{
   "id": "45715d02c3510110bc0526083c40dd6b",
   "description": "Description",
   "name": "Catalog1"
}

API ouverte du catalogue de produits : POST /sn_tmf_api/catalogmanagement/productOffering

Crée une offre de produits.

Format d'URL

URL par défaut : /api/sn_tmf_api/catalogmanagement/productOffering

Paramètres de demande pris en charge

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

Nom	Description
Aucun

Tableau 68. Paramètres de requête

Nom	Description
Aucun

Tableau 69. Paramètres du corps de la demande (JSON)

Nom	Description
catégorie	Liste des catégories auxquelles appartient le produit. Situé dans la table Catégorie [sc_category]. Type de données : tableau d’objets "category:" [ { "id": "String", "name": "String" } ]
category.id	Requis si le category paramètre est utilisé. ID de la catégorie. Type de données : chaîne
category.name	Nom de la catégorie. Type de données : chaîne
canal	Requis. Canaux à utiliser pour vendre l’offre de produit. Type de données : tableau "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
description.canal	Description du canal. Type de données : chaîne
channel.id	Requis. Sys_id du canal à partir de la table Canal de distribution [sn_prd_pm_distribution_channel]. Type de données : chaîne
channel.name	Nom du canal. Type de données : chaîne
description	Requis. Description de l'offre de produit. Type de données : chaîne
externalId	Identificateur unique de l’offre de produit du système externe. Type de données : chaîne
href	Un lien relatif vers l’enregistrement de ressource. Type de données : chaîne
id	Requis. Initial_version ou external_id de l’offre de produits à partir de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
internalId	initial_version de l’offre de produit à partir de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
version interne	Version de l’offre de produit de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
lastUpdate (en anglais seulement)	Date de la dernière mise à jour de l’offre de produit. Type de données : chaîne
lifecycleStatus	Indique l’état actuel du cycle de vie. Valeurs acceptées : Actif Inactif Brouillon Type de données : chaîne
nom	Requis. Nom de l’offre de produits. Type de données : chaîne
caractéristique du produit	Liste des caractéristiques du produit. Type de données : tableau d’objets "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nom de la caractéristique. Type de données : chaîne
productCharacteristic.value	Valeur de la caractéristique. Type de données : chaîne
productOfferingPrice	Informations sur le prix de l’offre de produits. Type de données : tableau d’objets "productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]
productOfferingPrice.price	Informations sur le prix de l’offre de produits. Type de données : objet "price": { "taxIncludedAmount": {Object} }
productOfferingPrice.price.taxIncludedAmount	Informations sur le prix de l’offre de produits. Type de données : objet "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	Code de devise du prix de l’offre de produit. Type de données : chaîne
productOfferingPrice.price.taxIncludedAmount.value	Prix de l’offre de produits TTC. Type de données : chaîne
productOfferingPrice.priceType	Requis si le productOfferingPrice paramètre est utilisé. Type de prix de l’offre de produit, paiement unique ou récurrent. Valeurs valides : non récurrent (ponctuel) récurrent Type de données : chaîne
Terme de l’offre de produits	Durée contractuelle valide pour l’offre de produit. Type de données : chaîne
Spécification du produit	Requis. Spécification du produit pour le produit. Type de données : objet "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	Requis. Initial_version ou external_id des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
Spécification produit.internalId	initial_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
Spécification produit.Version interne	Version de la spécification du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
spécification produit.version	external_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
prodSpecCharValueUse	Caractéristiques de l’offre de produits. Type de données : tableau d’objets "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	Requis. Liste des valeurs possibles de la caractéristique. Type de données : tableau d’objets "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Requis. Valeur de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.description	Description de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.name	Requis. Nom de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor	Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	Date de fin de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor.startDateTime	Date de début de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.valueType	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 l’offre de produit est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
valideFor.endDateTime	Date de fin de l’offre de produit. Type de données : chaîne
valideFor.startDateTime	Date de début de l’offre de produit. Type de données : chaîne
version	external_version de l’offre de produit à partir de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne

En-têtes

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

Tableau 70. En-têtes de demandes

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 71. En-têtes de réponses

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 .

Codes d'état

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

Tableau 72. Codes d'état

Code d'état	Description
201	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Raisons possibles : Charge utile vide. Charge utile non valide. Champ obligatoire manquant : <nom du champ>

Paramètres de corps de réponse (JSON)

Nom	Description
catégorie	Liste des catégories auxquelles appartient le produit. Type de données : tableau "category:" [ { "id": "String", "name": "String" } ]
category.id	ID de la catégorie. Type de données : chaîne
category.name	Nom de la catégorie. Type de données : chaîne
canal	Canaux à utiliser pour vendre l’offre de produit. Type de données : tableau d’objets "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
description.canal	Description du canal. Type de données : chaîne
channel.id	Sys_id du canal à partir de la table Canal de distribution [sn_prd_pm_distribution_channel]. Type de données : chaîne
channel.name	Nom du canal. Type de données : chaîne
description	Description de l'offre de produit. Type de données : chaîne
externalId	external_id de l’offre de produit dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
href	Un lien relatif vers l’enregistrement de ressource. Type de données : chaîne Par défaut : chaîne vide
id	Obligatoire. initial_version ou external_id de l’offre de produits à partir de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne
internalId	initial_version de l’offre de produit à partir de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
version interne	Version de l’offre de produit de la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
lastUpdate (en anglais seulement)	Date de la dernière mise à jour de l’offre de produit. Type de données : chaîne
lifecycleStatus	État actuel du cycle de vie de l’offre de produits. Valeurs acceptées : Actif Inactif Brouillon Type de données : chaîne Par défaut : chaîne vide
nom	Nom de l’offre de produits. Type de données : chaîne
caractéristique du produit	Liste des caractéristiques du produit. Type de données : tableau d’objets "productCharacteristic": [ { "name": "String", "value": "String" } ]
productCharacteristic.name	Nom de la caractéristique. Type de données : chaîne
productCharacteristic.value	Valeur de la caractéristique. Type de données : chaîne
productOfferingPrice	Informations sur le prix de l’offre de produits. Type de données : tableau d’objets "productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]
productOfferingPrice.price	Informations sur le prix de l’offre de produits. Type de données : objet "price": { "taxIncludedAmount": {Object} }
productOfferingPrice.price.taxIncludedAmount	Informations sur le prix de l’offre de produits. Type de données : objet "taxIncludedAmount": { "unit": "String", "value": "String" }
productOfferingPrice.price.taxIncludedAmount.unit	Code de devise du prix de l’offre de produit. Type de données : chaîne
productOfferingPrice.price.taxIncludedAmount.value	Prix de l’offre de produits TTC. Type de données : chaîne
productOfferingPrice.priceType	Type de prix de l’offre de produit, paiement unique ou récurrent. Valeurs possibles : non récurrent (ponctuel) récurrent Type de données : chaîne
Terme de l’offre de produits	Durée contractuelle valide pour l’offre de produit. Type de données : chaîne
Spécification du produit	Spécification du produit pour le produit. Type de données : objet "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
productSpecification.id	initial_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
Spécification produit.internalId	initial_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
Spécification produit.Version interne	Version de la spécification du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
spécification produit.version	external_version des spécifications du produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
prodSpecCharValueUse	Caractéristiques de l’offre de produits. Type de données : tableau d’objets "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	Liste des valeurs possibles de la caractéristique. Type de données : tableau d’objets "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.description	Description de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.name	Nom de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor	Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	Date de fin de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.validFor.startDateTime	Date de début de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.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 l’offre de produit est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
valideFor.endDateTime	Date de fin de l’offre de produit. Type de données : chaîne
valideFor.startDateTime	Date de début de l’offre de produit. Type de données : chaîne
version	external_version de l’offre de produit à partir de la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne

Demande cURL

Cet exemple crée une offre de produits.

curl --location --request POST "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering" \
--header "Content-Type: application/json" \
--data-raw '{
   "id": "d52a756b5bde0110235d85cced81c7ab",
   "name": "Premium SD-WAN Offering New",
   "version": "",
   "internalVersion": "2",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2021-08-16 04:55:52",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "24_months",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913488140197
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      },
      {
         "name": "CPE Id",
         "description": "CPE Id",
         "valueType": "single_line_text",
         "validFor": {
            "startDatetime": "2021-08-15 17:50:26"
         },
         "productSpecCharacteristicValue": [],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-23 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "v1",
            "internalVersion": "1",
            "internalId": " a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": " 39b627aa53702010cd6dddeeff7b1202"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   }
}'
--user 'username':'password'

Corps de réponse :

{
   "id": "d52a756b5bde0110235d85cced81c7ab",
   "name": "Premium SD-WAN Offering New",
   "version": null,
   "internalVersion": "5",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2021-08-16 04:55:52",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "24_months",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913488140197
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": null,
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": null,
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      },
      {
         "name": "CPE Id",
         "description": "CPE Id",
         "valueType": "single_line_text",
         "validFor": {
            "startDatetime": "2021-08-15 17:50:26"
         },
         "productSpecCharacteristicValue": [],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-23 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": null,
            "internalVersion": "1",
            "internalId": "a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   },
   "internalId": "fbc1c0a25b030110235d85cced81c724",
   "externalId": "d52a756b5bde0110235d85cced81c7ab"
}

API ouverte du catalogue de produits : POST /sn_tmf_api/catalogmanagement/productSpecification

Crée une spécification de produit.

Format d'URL

URL par défaut : /api/sn_tmf_api/catalogmanagement/productSpecification

Paramètres de demande pris en charge

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

Nom	Description
Aucun

Tableau 74. Paramètres de requête

Nom	Description
Aucun

Tableau 75. Paramètres du corps de la demande (JSON)

Nom	Description
description	Requis. Description de la spécification. Type de données : chaîne
externalId	Identificateur unique pour la spécification du produit provenant du système externe. Type de données : chaîne Par défaut : chaîne vide
id	Requis. Initial_version ou external_id de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
internalId	Requis. Initial_version de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
version interne	Version de la spécification produit issue de la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
lastUpdate (en anglais seulement)	Date de la dernière mise à jour de la spécification. Format : JJ-MM-AAAA 00:00:00. Par exemple, 2025-01-31 09:35:43. 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
Caractéristique de spécification du produit	Caractéristique de spécification. Type de données : tableau "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": Array, "validFor": Object, "valueType": "String" } ]
productSpecCharacteristic.description	Description de la caractéristique. Type de données : chaîne Par défaut : chaîne vide
productSpecCharacteristic.name	Requis. Nom de la caractéristique. Type de données : chaîne
productSpecCharacteristic.productSpecCharacteristicValue	Requis. Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau "productSpecCharacteristicValue": [ { "value": "String" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	Requis. Valeur de la caractéristique. Type de données : chaîne
productSpecCharacteristic.validFor	Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	Date de fin de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, 2025-01-31 09:35:43. Type de données : chaîne Par défaut : chaîne vide
productSpecCharacteristic.validFor.startDateTime	Date de début de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Par exemple, 2025-01-31 09:35:43. Type de données : chaîne Par défaut : chaîne vide
productSpecCharacteristic.valueType	Type de valeur de la caractéristique, tel que le choix ou l’e-mail. Type de données : chaîne Par défaut : chaîne vide
Relation de spécifications du produit	Relations de cette spécification avec d’autres spécifications du produit. Type de données : tableau "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
productSpecificationRelationship.id	ID de la spécification connexe. Type de données : chaîne Par défaut : chaîne vide
productSpecificationRelationship.type	Requis si le productSpecificationRelationship paramètre est utilisé. Type de relation. Valeurs valides : composed_of Paquets Type de données : chaîne
productSpecificationRelationship.validFor	Plage de dates pour laquelle la relation est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	Date de fin de la relation. Format : JJ-MM-AAAA 00:00:00. Par exemple, 2025-01-31 09:35:43. Type de données : chaîne Par défaut : chaîne vide
productSpecificationRelationship.validFor.startDateTime	Date de début de la relation. Format : JJ-MM-AAAA 00:00:00. Par exemple, 2025-01-31 09:35:43. Type de données : chaîne Par défaut : chaîne vide
Spécification de ressource	Requis. Tableau des spécifications de ressources associées à cette spécification de produit. Type de données : tableau "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	Requis. Le initial_version ou le external_id de la spécification de ressource. Situé dans le champ sys_id ou external_id de la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.internalId	Initial_version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.internalVersion	Version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.name	Nom de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.version	External_version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
Spécification de service	Liste des spécifications de service associées à cette spécification de produit. Type de données : tableau d’objets "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	Initial_version ou external_id de la spécification de service. Situé dans le champ sys_id ou external_id de la table Spécification de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceSpecification.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
serviceSpecification.internalVersion	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
serviceSpecification.name	Nom 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
serviceSpecification.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
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. Format : JJ-MM-AAAA 00:00:00. Par exemple, 2025-01-31 09:35:43. Type de données : chaîne Par défaut : chaîne vide
valideFor.startDateTime	Date de début de la spécification. Format : JJ-MM-AAAA 00:00:00. Par exemple, 2025-01-31 09:35:43. Type de données : chaîne Par défaut : chaîne vide
version	External_version de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne

En-têtes

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

Tableau 76. En-têtes de demandes

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 77. En-têtes de réponses

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 .

Codes d'état

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

Tableau 78. Codes d'état

Code d'état	Description
201	Demande traitée avec succès.
400	Demande incorrecte. Raisons possibles : Charge utile vide. Charge utile non valide. Champ obligatoire manquant : <nom du champ>

Paramètres de corps de réponse (JSON)

Nom	Description
description	Description de la spécification. Type de données : chaîne
href	Lien relatif à l’enregistrement de ressource. Type de données : chaîne Par défaut : chaîne vide
id	Initial_version ou external_id de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
internalId	Requis. Initial_version de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne
version interne	Version de la spécification produit issue de la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne
isBundle (en anglais seulement)	Marqueur indiquant s’il s’agit productSpecification d’un seul produit ou d’un lot de produits. Valeurs valides : true : la spécification du produit est un lot de produits et contient plusieurs produits. false : la spécification du produit ne contient qu’un seul produit. Type de données : booléennes Valeur par défaut : false
lastUpdate (en anglais seulement)	Date de la dernière mise à jour de la spécification. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
lifecycleStatus	État actuel du cycle de vie de la spécification du produit. Valeurs possibles : Actif Inactif Brouillon Type de données : chaîne Par défaut : chaîne vide
nom	Nom de la spécification. Type de données : chaîne
Caractéristique de spécification du produit	Caractéristique de spécification. Type de données : tableau "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": Array, "validFor": Object, "valueType": "String" } ]
productSpecCharacteristic.description	Description de la caractéristique. Type de données : chaîne
productSpecCharacteristic.name	Nom de la caractéristique. Type de données : chaîne
productSpecCharacteristic.productSpecCharacteristicValue	Tableau contenant les valeurs possibles de la caractéristique. Type de données : tableau "productSpecCharacteristicValue": [ { "value": "String" } ]
productSpecCharacteristic.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
productSpecCharacteristic.validFor	Plage de dates pour laquelle la caractéristique est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecCharacteristic.validFor.endDateTime	Date de fin de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
productSpecCharacteristic.validFor.startDateTime	Date de début de la caractéristique. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
productSpecCharacteristic.valueType	Type de valeur de la caractéristique, tel que le choix ou l’e-mail. Type de données : chaîne
Relation de spécifications du produit	Relations de cette spécification avec d’autres spécifications du produit. Type de données : tableau "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
productSpecificationRelationship.id	Sys_id de la spécification connexe. Type de données : chaîne
productSpecificationRelationship.type	Type de relation. Type de données : chaîne
productSpecificationRelationship.validFor	Plage de dates pour laquelle la relation est valide. Type de données : objet "validFor": { "endDateTime": "String", "startDateTime": "String" }
productSpecificationRelationship.validFor.endDateTime	Date de fin de la relation. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
productSpecificationRelationship.validFor.startDateTime	Date de début de la relation. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
Spécification de ressource	Liste des spécifications de ressource associées à cette spécification de produit. Type de données : tableau d’objets "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	Initial_version ou external_id de la spécification de ressource. Situé dans le champ sys_id ou external_id de la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.internalId	Initial_version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.internalVersion	Version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.name	Nom de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
resourceSpecification.version	External_version de la spécification de ressource. Situé dans la table Spécification de ressource [sn_prd_pm_resource_specification]. Type de données : chaîne
Spécification de service	Liste des spécifications de service associées à cette spécification de produit. Type de données : tableau d’objets "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	Initial_version ou external_id de la spécification de service. Situé dans le champ sys_id ou external_id de la table Spécification de service [sn_prd_pm_service_specification]. Type de données : chaîne
serviceSpecification.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
serviceSpecification.internalVersion	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
serviceSpecification.name	Nom 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
serviceSpecification.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
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. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
valideFor.startDateTime	Date de début de la spécification. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
version	External_version de la spécification du produit à partir de la table Spécifications du produit [sn_prd_pm_product_specification]. Type de données : chaîne

Demande cURL

Cet exemple crée une spécification de produit.

curl --location --request POST "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification" \
--header "Content-Type: application/json" \
--data-raw '{
   "name": "SD-WAN My Device",
   "description": "This is my product specification ...",
   "internalId": "1c3c9a325bc34110235d85cced81c7d5",
   "isBundle": false,
   "lastUpdate": "2017-06-17T00:00",
   "validFor": {
      "startDateTime": "2017-06-19T00:00",
      "endDateTime": "2018-01-13T00:00"
   },
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "label",
         "validFor": {
            "startDateTime": "2017-06-20T00:00"
         },
         "productSpecCharacteristicValue": [
            {
               "validFor": {
                  "startDateTime": "2017-06-17T00:00"
               },
               "value": "TestValue"
            }
         ]
      }
   ],
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "type": "bundles",
         "validFor": {
            "startDateTime": "2017-06-16T00:00"
         }
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router"
      }
   ]
}'
--user 'username':'password'

Corps de réponse.

{
   "id": "exter123",
   "name": "SD-WAN My Device",
   "version": "v1",
   "internalId": "63c3d946745d8150f877ca57242ff918",
   "description": "This is my product specification ...",
   "isBundle": false,
   "lastUpdate": "2017-06-17T00:00",
   "validFor": {
      "startDateTime": "2017-06-19T00:00",
      "endDateTime": "2018-01-13T00:00"
   },
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "choice",
         "validFor": {
            "startDateTime": "2017-06-20T00:00"
         },
         "productSpecCharacteristicValue": [
            {
               "validFor": {
                  "startDateTime": "2017-06-17T00:00"
               },
               "value": "TestValue"
            }
         ]
      }
   ],
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "e23ae2d01bb420106ba59acf034bcb56"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "type": "bundles",
         "validFor": {
            "startDateTime": "2017-06-16T00:00"
         },
         "valid": true,
         "version": "v1",
         "internalVersion": "1",
         "internalId": "a6514bd3534560102f18ddeeff7b1247"
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "493fa60b536520103b6bddeeff7b12b6"
      }
   ]
}