API ouverte du catalogue de produits

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

Supprime 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 1. Paramètres de chemin d'accès
Nom	Description
id	Sys_id de l’offre de produits à supprimer. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]

Tableau 2. Paramètres de requête
Nom	Description
Néant

Tableau 3. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Néant

En-têtes

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

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

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

Codes d'état

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

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

Paramètres du corps de la 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éussie :

"The product offering (d6f8d9995b020210235d85cced81c7eb) is successfully deleted"

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

Désactive, mais ne supprime pas, une ligne de liste de prix avec une sys_id spécifique.

Pour définir une ligne de liste de prix sur un état inactif, cette méthode DELETE met à jour la date de fin de la ligne de liste de prix à la date du jour. Une ligne de liste de prix avec une date de fin antérieure à la date d’aujourd’hui est également considérée comme inactive. Les lignes de liste de prix inactives ne sont pas récupérables dans les méthodes GET connexes.

Format d'URL

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

Paramètres de demande pris en charge

Tableau 7. Paramètres de chemin d'accès
Nom	Description
id	Sys_id de la ligne de liste de prix à supprimer. Table : Ligne de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne

Tableau 8. Paramètres de requête
Nom	Description
Néant

Tableau 9. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Néant

En-têtes

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

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

Tableau 11. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. 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 12. 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 du corps de la réponse (JSON ou XML)


Nom	Description
message	Code d’état avec un message indiquant l’inactivation réussie ou échouée de la ligne de liste de prix.

Demande cURL

L’exemple suivant montre comment désactiver ou supprimer avec succès une liste de prix du sys_id donné, 994j...

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c" \
--request DELETE\
--user 'username':'password'

Réponse. La réponse renvoie un code d’état 200 avec des détails sur l’inactivation réussie.

Status: 200 OK
"The price list line (994d5d364f8b5210f899f61d20ce0b7c) is inactive successfully"

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

Supprime ou archive la spécification de 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 a été 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 qui 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 passe de l’état actif à l’état Archivé.
Une spécification de produit associée à une spécification de produit ou à une offre 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 13. Paramètres de chemin d'accès
Nom	Description
id	Sys_id de la spécification du produit à supprimer. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]

Tableau 14. Paramètres de requête
Nom	Description
Néant

Tableau 15. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Néant

En-têtes

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

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

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

Codes d'état

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

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

Paramètres du corps de la 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"

API ouverte du catalogue de produits : 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 19. Paramètres de chemin d'accès
Nom	Description
Aucun

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. Type de données : chaîne Par défaut : tous les champs renvoyés.
limite	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la offset récupération de l’enregistrement. Type de données : nombre Par défaut : 20 Maximum : 100
décalage	Index de début auquel commencer à récupérer les 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. Type de données : nombre Par défaut : 0

Tableau 21. Paramètres du corps de la demande (JSON)
Nom	Description
Néant

En-têtes

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

Tableau 22. En-têtes de demandes
En-tête	Description
Aucun

Tableau 23. En-têtes de réponses
En-tête	Description
Plage de contenu	Plage de contenu renvoyé lors d’un appel paginé. Par exemple, si `offset=2` and `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. Prend uniquement en charge application/json.
un 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 spécifie 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 24. 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 retourné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. Type de données : chaîne Table : Catalogue d’offres de produits [sn_prd_pm_product_offering_catalog]
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 la 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 25. Paramètres de chemin d'accès
Nom	Description
id	Sys_id du catalogue d’offres de produits à récupérer. Type de données : chaîne Table : Catalogue d’offres de produits [sn_prd_pm_product_offering_catalog]

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. Type de données : chaîne Par défaut : Tous les champs.

Tableau 27. Paramètres du corps de la demande (JSON)
Nom	Description
Néant

En-têtes

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

Tableau 28. En-têtes de demandes
En-tête	Description
Néant

Tableau 29. 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 30. Codes d'état
Code d'état	Description
200	Réussi. La demande a été correctement traitée.
400	Demande incorrecte. Peut être l’une des raisons 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. Type de données : chaîne Table : Catalogue d’offres de produits [sn_prd_pm_product_offering_catalog]
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 la 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 31. Paramètres de chemin d'accès
Nom	Description
Aucun

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 nom productCaractéristique productOfferingPrice productOfferingTerm Spécification du produit prodSpecCharValueUse valide pour version Type de données : chaîne Par défaut : tous les champs sont renvoyés.
limite	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la offset récupération de l’enregistrement. Type de données : nombre Par défaut : 20 Maximum : 100
décalage	Index de début auquel commencer à récupérer les 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. Type de données : nombre Par défaut : 0
spécification	Filtrez les offres de produits par spécification de produit sys_id. Seules les offres de produits avec les sys_id de spécifications de produits spécifiées sont renvoyées dans la réponse. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
É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 valides : archivé brouillon publié retraité Type de données : chaîne

Tableau 33. Paramètres du corps de la demande (JSON)
Nom	Description
Néant

En-têtes

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

Tableau 34. En-têtes de demandes
En-tête	Description
Aucun

Tableau 35. En-têtes de réponses
En-tête	Description
Plage de contenu	Plage de contenu renvoyé lors d’un appel paginé. Par exemple, si `offset=2` and `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. Prend uniquement en charge application/json.
un 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 spécifie 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 36. 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 retourné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 le produit appartient. 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 produits. Type de données : tableau d’objets `"channel:" [ { "description": "String", "id": "String", "name": "String" } ]`
Canal.Description	Description du canal. Type de données : chaîne
channel.id	Sys_id du canal. Type de données : chaîne Table : Canal de distribution [sn_prd_pm_distribution_channel]
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	ID externe de l’offre de produits Type de données : chaîne Table : dans le champ external_id de la table Offre de produits [sn_prd_pm_product_offering].
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
id	Requis. Version initiale ou ID externe de l’offre de produits. Type de données : chaîne Table : dans le champ initial_version ou external_id de la table Offre de produits [sn_prd_pm_product_offering].
internalId	Version initiale de l’offre de produits. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
Version interne	Version de l’offre de produits. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
lastUpdate	Date de la dernière mise à jour de l’offre de produits. Type de données : chaîne
lifecycleStatus	État actuel du cycle de vie de l’offre de produits. Valeurs valides : Actif Brouillon Inactif Type de données : chaîne Valeur par défaut : chaîne vide
nom	Nom de l’offre de produits. Type de données : chaîne
productCaractéristique	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 de prix pour l’offre de produits. Type de données : tableau d’objets `"productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]`
productOfferingPrice.price	Informations de prix pour l’offre de produits. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOfferingPrice.price.taxIncludedAmount	Informations de prix pour l’offre de produits. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": "String" }`
productOfferingPrice.price.taxIncludedAmount.unit	Code de devise pour le prix de l’offre de produits. 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 d’offre de produit, paiement unique ou récurrent. Valeurs valides : nonRecurring (unique) récurrent Type de données : chaîne
productOfferingTerm	Durée valide du contrat pour l’offre de produits. Type de données : chaîne
Spécification du produit	Spécification du produit correspondant. Type de données : objet `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
productSpecification.internalId	Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
Spécification produit.Version interne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
productSpecification.version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].
prodSpecCharValueUse	Caractéristiques des offres 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 choix ou e-mail.
valide pour	Plage de dates pour laquelle l’offre de produits est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Date de fin de l’offre de produits. Type de données : chaîne
validFor.startDateTime	Date de début de l’offre de produits. Type de données : chaîne
version	Version externe de l’offre de produits. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].

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 la 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 produits.

Format d'URL

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

Paramètres de demande pris en charge

Tableau 37. Paramètres de chemin d'accès
Nom	Description
id	Version initiale de l’offre de produits à récupérer. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].

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 : catégorie canal description externalId id internalId Version interne lastUpdate nom productCaractéristique productOfferingPrice productOfferingTerm Spécification du produit prodSpecCharValueUse valide pour version Type de données : chaîne Par défaut : tous les champs sont renvoyés.
spécification	Filtrez les offres de produits par spécification de produit sys_id. Seules les offres de produits avec les sys_id de spécifications de produits spécifiées sont renvoyées dans la réponse. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
É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 valides : archivé brouillon publié retraité Type de données : chaîne

Tableau 39. Paramètres du corps de la demande (JSON)
Nom	Description
Néant

En-têtes

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

Tableau 40. En-têtes de demandes
En-tête	Description
Néant

Tableau 41. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. 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 42. 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 le produit appartient. 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 produits. Type de données : tableau d’objets `"channel:" [ { "description": "String", "id": "String", "name": "String" } ]`
Canal.Description	Description du canal. Type de données : chaîne
channel.id	Sys_id du canal. Type de données : chaîne Table : Canal de distribution [sn_prd_pm_distribution_channel]
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	ID externe de l’offre de produits Type de données : chaîne Table : dans le champ external_id de la table Offre de produits [sn_prd_pm_product_offering].
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
id	Requis. Version initiale ou ID externe de l’offre de produits. Type de données : chaîne Table : dans le champ initial_version ou external_id de la table Offre de produits [sn_prd_pm_product_offering].
internalId	Version initiale de l’offre de produits. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
Version interne	Version de l’offre de produits. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
lastUpdate	Date de la dernière mise à jour de l’offre de produits. Type de données : chaîne
lifecycleStatus	Indique l’état actuel du cycle de vie de l’offre de produit. Valeurs acceptées : Actif Inactif Brouillon Type de données : chaîne Valeur par défaut : chaîne vide
nom	Nom de l’offre de produits. Type de données : chaîne
productCaractéristique	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 de prix pour l’offre de produits. Type de données : tableau d’objets `"productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]`
productOfferingPrice.price	Informations de prix pour l’offre de produits. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOfferingPrice.price.taxIncludedAmount	Informations de prix pour l’offre de produits. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": "String" }`
productOfferingPrice.price.taxIncludedAmount.unit	Code de devise pour le prix de l’offre de produits. 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 produits est un paiement unique ou récurrent. Valeurs valides : non récurrent récurrent Type de données : chaîne
productOfferingTerm	Durée valide du contrat pour l’offre de produits. Type de données : chaîne
Spécification du produit	Spécification du produit correspondant. Type de données : objet `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
productSpecification.internalId	Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
Spécification produit.Version interne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
productSpecification.version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].
prodSpecCharValueUse	Caractéristique 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 choix ou e-mail. Type de données : chaîne
valide pour	Plage de dates pour laquelle l’offre de produits est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Date de fin de l’offre de produits. Type de données : chaîne
validFor.startDateTime	Date de début de l’offre de produits. Type de données : chaîne
version	Version externe de l’offre de produits. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].

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 la 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/productOfferingPrice

Récupère tous les enregistrements de ligne de liste de prix dans l’instance.

Format d'URL

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

Paramètres de demande pris en charge

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

Tableau 44. Paramètres de requête
Nom	Description
lastUpdate	Filtrez les résultats par date de dernière mise à jour de la ligne de prix. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
nom	Filtrez les lignes de liste de prix qui appartiennent au nom d’une liste de prix donnée. Tableau : Listes de prix [sn_csm_pricing_price_list] Type de données : chaîne
prix.valeur	Filtrer les résultats par une valeur de prix catalogue spécifique. Type de données : chaîne
priceList.id	Filtrez les résultats pour renvoyer uniquement une liste de prix avec une sys_id donnée. Tableau : Listes de prix [sn_csm_pricing_price_list] Type de données : chaîne
priceType	Filtrez les résultats par méthode de tarification de l’offre de produits. Valeurs valides : récurrent : permet aux entreprises de facturer des montants de prix récurrents à une fréquence spécifiée. one_time : prend en charge les frais et frais uniques ou récurrents pour une offre de produits. Type de données : chaîne
productOffering.id	Filtrez la ligne de liste de prix en fonction du sys_id de l’offre de produit. Table : Offre de produits [sn_prd_pm_product_offering] Type de données : chaîne
unitOfMeasure.id	Filtrez la ligne de liste de prix par sys_id de l’unité de mesure. Table : Lignes de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne
validFor.endDateTime	Filtrez la ligne de liste de prix selon une date et une heure de fin données. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
validFor.startDateTime	Filtrez la ligne de liste de prix selon une date et une heure de début données. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne

Tableau 45. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Néant

En-têtes

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

Tableau 46. 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.

Tableau 47. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. 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 du corps de la réponse (JSON ou XML)


Nom	Description
@type	Type de ligne de liste de prix. Toujours une valeur de `ProductOfferingPrice`. Type de données : chaîne
href	URL de l’enregistrement de la ligne de liste de prix dans l’instance. Type de données : chaîne
id	Sys_id de la ligne de liste de prix. Table : Lignes de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne
isBundle	Marqueur indiquant si la ligne de liste de prix fait partie d’un seul produit ou d’un ensemble de produits. Valeurs valides : vrai : la ligne de liste de prix fait partie d’un lot. faux : la ligne de liste de prix ne fait pas partie d’un lot. Type de données : booléennes
lastUpdate	Date et heure de la dernière mise à jour de la ligne de liste de prix. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
lifecycleStatus	État actuel du cycle de vie de la ligne de liste de prix. Valeurs valides : Actif Brouillon Inactif Type de données : chaîne
prix	Détails de prix catalogue de la ligne de liste de prix. Type de données : objet `"price": { "units": "String", "value": "String" }`
prix.unités	Code de devise du prix. Par exemple, `USD` ou `EUR.` Table : Devise [fx_currency] Type de données : chaîne
prix.valeur	Valeur du prix. Type de données : chaîne (représentée par un nombre)
priceList	Informations sur la liste de prix associées à la ligne de liste de prix. Type de données : objet `"priceList": { "id": "String", "name": "String", "@type": "String" }`
priceList.id	Sys_id de la liste de prix dans la table Liste de prix [sn_csm_pricing_price_list]. Type de données : chaîne
priceList.name	Nom de la liste de prix. Type de données : chaîne
priceList.@type	Le type de liste de prix. Lors de la sous-classe, cela définit le nom extensible de la sous-classe. a toujours une valeur de `priceList`. Type de données : chaîne
priceType	Méthode de tarification de l’offre de produits associée à cette ligne de liste de prix. Valeurs possibles : récurrent : facturez des montants de tarification récurrents à une fréquence spécifiée. La valeur indique recurringChargePeriodType la fréquence de la charge. one_time : Frais et frais supplémentaires uniques ou récurrents pour une offre de produits. Type de données : chaîne
productOffering	Offre de produits associée à la ligne de liste de prix. Type de données : objet `"productOffering": { "id": "String", "name": "String", "internalVersion": "String" }`
productOffering.id	Sys_id de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
offreproduit.versioninterne	Numéro de version interne de l’offre de produit. Par exemple, `PRDOF01024`. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOffering.name	Nom de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
recurringChargePeriodType	Périodicité ou fréquence de l’offre de produit associée à cette ligne de liste de prix. Renvoie un type de fréquence si priceType la valeur a été définie sur `Récurrent`, sinon renvoie une chaîne vide. Valeurs possibles : annuellement mensuel Type de données : chaîne
unité de mesure	Détails sur l’unité de mesure associée à la ligne de liste de prix. Type de données : objet `"unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }`
unitéDemesure.montant	Quantité de l’unité de mesure. Type de données : nombre
unitOfMeasure.id	Sys_id de l’unité de mesure. Table : Lignes de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne
unitéDemesure.unités	Type de l’unité de mesure associée à la ligne de liste de prix. Par exemple, `année` ou `ensemble`. Type de données : chaîne
valide pour	Durée de validité de la ligne de liste de prix. Type de données : objet `"validFor": { "endDate": "String", "startDate": "String" }`
validFor.endDate	Date et heure de fin auxquelles la ligne de liste de prix est valide. Type de données : chaîne (glide_date_time)
validFor.startDate	Date et heure de début auxquelles la ligne de liste de prix est valide. Type de données : chaîne (glide_date_time)

Demande cURL

L’exemple suivant renvoie les deux lignes de liste de prix qui existent sur l’instance.

curl "http://instance.servicenow.com/api/sn_tmf_api/ catalogmanagement/productOfferingPrice " \
--request GET\
--user 'username':'password'

Corps de la réponse.

[
  {
    "id": "2c4628ac7f4f9e50f8994fa63c86653c",
    "name": "new Price list",
    "lastUpdate": "2025-01-08 19:57:28",
    "isBundle": false,
    "lifecycleStatus": "Draft",
    "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/2c4628ac7f4f9e50f8994fa63c86653c",
    "validFor": {
      "startDateTime": "2027-03-22 22:15:58",
      "endDateTime": ""
    },
    "productOffering": {
      "id": "f2c92ac6a5260210f8774c9b4be6ce56",
      "name": "Managed Connectivity Services Supreme Bundle",
      "internalVersion": "1"
    },
    "priceType": "one_time",
    "recurringChargePeriodType": "",
    "unitOfMeasure": {
      "id": "9a7a119953020110286eddeeff7b1238",
      "amount": 1,
      "units": "Month"
    },
    "price": {
      "units": "USD",
      "value": "800"
    },
    "priceList": {
      "id": "d653246c7f4f9e50f8994fa63c86655a",
      "name": "new Price list",
      "@type": "priceList"
    },
    "@type": "ProductOfferingPrice"
  },
  {
    "id": "dfb7ec607f8f9e50f8994fa63c866569",
    "name": "new Price list",
    "lastUpdate": "2025-01-08 19:57:46",
    "isBundle": false,
    "lifecycleStatus": "Draft",
    "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569",
    "validFor": {
      "startDateTime": "2026-05-28 22:15:58",
      "endDateTime": ""
    },
    "productOffering": {
      "id": "f2c92ac6a5260210f8774c9b4be6ce56",
      "name": "Managed Connectivity Services Supreme Bundle",
      "internalVersion": "1"
    },
    "priceType": "one_time",
    "recurringChargePeriodType": "",
    "unitOfMeasure": {
      "id": "1eaa559953020110286eddeeff7b12c7",
      "amount": 1,
      "units": "Year"
    },
    "price": {
      "units": "USD",
      "value": "800"
    },
    "priceList": {
      "id": "d653246c7f4f9e50f8994fa63c86655a",
      "name": "new Price list",
      "@type": "priceList"
    },
    "@type": "ProductOfferingPrice"
  }
]

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

Récupère les détails d’une ligne spécifique de la liste de prix.

Format d'URL

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

Paramètres de demande pris en charge

Tableau 49. Paramètres de chemin d'accès
Nom	Description
id	Requis. Sys_id de la ligne de liste de prix à récupérer. Table : Lignes de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne

Tableau 50. Paramètres de requête
Nom	Description
lastUpdate	Filtrez les résultats par date de dernière mise à jour de la ligne de prix. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
nom	Filtrez les lignes de liste de prix qui appartiennent au nom d’une liste de prix donnée. Tableau : Listes de prix [sn_csm_pricing_price_list] Type de données : chaîne
prix.valeur	Filtrer les résultats par une valeur de prix catalogue spécifique. Type de données : chaîne
priceList.id	Filtrez les résultats pour renvoyer uniquement une liste de prix avec une sys_id donnée. Tableau : Listes de prix [sn_csm_pricing_price_list] Type de données : chaîne
priceType	Filtrez les résultats par méthode de tarification de l’offre de produits. Valeurs valides : récurrent : permet aux entreprises de facturer des montants de prix récurrents à une fréquence spécifiée. one_time : prend en charge les frais et frais uniques ou récurrents pour une offre de produits. Type de données : chaîne
productOffering.id	Filtrez la ligne de liste de prix en fonction du sys_id de l’offre de produit. Table : Offre de produits [sn_prd_pm_product_offering] Type de données : chaîne
unitOfMeasure.id	Filtrez la ligne de liste de prix par sys_id de l’unité de mesure. Table : Lignes de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne
validFor.endDateTime	Filtrez la ligne de liste de prix selon une date et une heure de fin données. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
validFor.startDateTime	Filtrez la ligne de liste de prix selon une date et une heure de début données. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne

Tableau 51. Paramètres de corps de demande (XML ou JSON)
Nom	Description
Néant

En-têtes

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

Tableau 52. 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.

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. 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 54. 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 du corps de la réponse (JSON ou XML)


Nom	Description
@type	Type de ligne de liste de prix. Toujours une valeur de `ProductOfferingPrice`. Type de données : chaîne
href	URL de l’enregistrement de la ligne de liste de prix dans l’instance. Type de données : chaîne
id	Sys_id de la ligne de liste de prix. Table : Lignes de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne
isBundle	Marqueur indiquant si la ligne de liste de prix fait partie d’un seul produit ou d’un ensemble de produits. Valeurs valides : vrai : la ligne de liste de prix fait partie d’un lot. faux : la ligne de liste de prix ne fait pas partie d’un lot. Type de données : booléennes
lastUpdate	Date et heure de la dernière mise à jour de la ligne de liste de prix. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
lifecycleStatus	État actuel du cycle de vie de la ligne de liste de prix. Valeurs valides : Actif Brouillon Inactif Type de données : chaîne
prix	Détails de prix catalogue de la ligne de liste de prix. Type de données : objet `"price": { "units": "String", "value": "String" }`
prix.unités	Code de devise du prix. Par exemple, `USD` ou `EUR.` Table : Devise [fx_currency] Type de données : chaîne
prix.valeur	Valeur du prix. Type de données : chaîne (représentée par un nombre)
priceList	Informations sur la liste de prix associées à la ligne de liste de prix. Type de données : objet `"priceList": { "id": "String", "name": "String", "@type": "String" }`
priceList.id	Sys_id de la liste de prix dans la table Liste de prix [sn_csm_pricing_price_list]. Type de données : chaîne
priceList.name	Nom de la liste de prix. Type de données : chaîne
priceList.@type	Le type de liste de prix. Lors de la sous-classe, cela définit le nom extensible de la sous-classe. a toujours une valeur de `priceList`. Type de données : chaîne
priceType	Méthode de tarification de l’offre de produits associée à cette ligne de liste de prix. Valeurs possibles : récurrent : facturez des montants de tarification récurrents à une fréquence spécifiée. La valeur indique recurringChargePeriodType la fréquence de la charge. one_time : Frais et frais supplémentaires uniques ou récurrents pour une offre de produits. Type de données : chaîne
productOffering	Offre de produits associée à la ligne de liste de prix. Type de données : objet `"productOffering": { "id": "String", "name": "String", "internalVersion": "String" }`
productOffering.id	Sys_id de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
offreproduit.versioninterne	Numéro de version interne de l’offre de produit. Par exemple, `PRDOF01024`. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOffering.name	Nom de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
recurringChargePeriodType	Périodicité ou fréquence de l’offre de produit associée à cette ligne de liste de prix. Renvoie un type de fréquence si priceType la valeur a été définie sur `Récurrent`, sinon renvoie une chaîne vide. Valeurs possibles : annuellement mensuel Type de données : chaîne
unité de mesure	Détails sur l’unité de mesure associée à la ligne de liste de prix. Type de données : objet `"unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }`
unitéDemesure.montant	Quantité de l’unité de mesure. Type de données : nombre
unitOfMeasure.id	Sys_id de l’unité de mesure. Table : Lignes de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne
unitéDemesure.unités	Type de l’unité de mesure associée à la ligne de liste de prix. Par exemple, `année` ou `ensemble`. Type de données : chaîne
valide pour	Durée de validité de la ligne de liste de prix. Type de données : objet `"validFor": { "endDate": "String", "startDate": "String" }`
validFor.endDate	Date et heure de fin auxquelles la ligne de liste de prix est valide. Type de données : chaîne (glide_date_time)
validFor.startDate	Date et heure de début auxquelles la ligne de liste de prix est valide. Type de données : chaîne (glide_date_time)

Demande cURL

L’exemple suivant renvoie les détails du prix de l’offre de produits avec l’ID dfb7ec60...

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569" \
--request GET\
--user 'username':'password'

Réponse.

{
  "id": "dfb7ec607f8f9e50f8994fa63c866569",
  "name": "new Price list",
  "lastUpdate": "2025-01-08 19:57:46",
  "isBundle": false,
  "lifecycleStatus": "Draft",
  "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569",
  "validFor": {
    "startDateTime": "2026-05-28 22:15:58",
    "endDateTime": ""
  },
  "productOffering": {
    "id": "f2c92ac6a5260210f8774c9b4be6ce56",
    "name": "Managed Connectivity Services Supreme Bundle",
    "internalVersion": "1"
  },
  "priceType": "one_time",
  "recurringChargePeriodType": "",
  "unitOfMeasure": {
    "id": "1eaa559953020110286eddeeff7b12c7",
    "amount": 1,
    "units": "Year"
  },
  "price": {
    "units": "USD",
    "value": "800"
  },
  "priceList": {
    "id": "d653246c7f4f9e50f8994fa63c86655a",
    "name": "new Price list",
    "@type": "priceList"
  },
  "@type": "ProductOfferingPrice"
}

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 55. Paramètres de chemin d'accès
Nom	Description
Aucun

Tableau 56. 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 nom productSpecCaractéristique Relation des spécifications du produit resourceSpecification Spécification de service valide pour version Type de données : chaîne Par défaut : tous les champs sont renvoyés.
limite	Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d’enregistrements, utilisez le paramètre pour paginer la offset récupération de l’enregistrement. Type de données : nombre Par défaut : 20 Maximum : 100
décalage	Index de début auquel commencer à récupérer les 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. Type de données : nombre Par défaut : 0
É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é brouillon publié retraité Type de données : chaîne

Tableau 57. Paramètres du corps de la demande (JSON)
Nom	Description
Néant

En-têtes

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

Tableau 58. En-têtes de demandes
En-tête	Description
Aucun

Tableau 59. En-têtes de réponses
En-tête	Description
Plage de contenu	Plage de contenu renvoyé lors d’un appel paginé. Par exemple, si `offset=2` and `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. Prend uniquement en charge application/json.
un 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 spécifie 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 60. 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 retourné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. ID externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_id de la table Spécification de produit [sn_prd_pm_product_specification].
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
id	Version initiale ou ID externe de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version ou external_id de la table Spécification de produit [sn_prd_pm_product_specification].
internalId	Requis. Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de produit [sn_prd_pm_product_specification].
Version interne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification].
isBundle	Marqueur qui indique s’il représente productSpecification un produit unique ou un ensemble de produits. Valeurs valides : true : la spécification de produit est un lot de produits qui contient plusieurs produits. false : le cahier des charges contient un seul produit. Type de données : booléennes Valeur par défaut : false
lastUpdate	Date de 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 Valeur par défaut : chaîne vide
nom	Nom de la spécification. Type de données : chaîne
productSpecCaractéristique	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 pour 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 choix ou e-mail. Type de données : chaîne
Relation des spécifications du produit	Relations de cette spécification avec d’autres spécifications de 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	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" }`
RelationshipSpécificationproduit.valideFor.endDateTime	Date de fin de la relation. Type de données : chaîne
RelationshipSpécificationproduit.validFor.startDateTime	Date de début de la relation. Type de données : chaîne
resourceSpecification	Liste 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	Version initiale ou ID externe de la spécification de ressource. Type de données : chaîne Table : dans le champ sys_id ou external_id de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.internalId	Version initiale de la spécification de ressource. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.internalVersion	Version de la spécification de ressource. Type de données : chaîne Table : dans le champ Version de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.name	Nom de la spécification de ressource. Type de données : chaîne Table : Spécification de ressource [sn_prd_pm_resource_specification]
resourceSpecification.version	Version externe de la spécification de ressource. Type de données : chaîne Table : dans le champ external_version de la table Spécification de ressource [sn_prd_pm_resource_specification].
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	Version initiale ou ID externe de la spécification de service. Type de données : chaîne Table : dans le champ sys_id ou external_id de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.internalId	Version initiale de la spécification de service. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.internalVersion	Version de la spécification de service. Type de données : chaîne Table : dans le champ Version de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.name	Nom de la spécification de service. Type de données : chaîne Table : Spécification de service [sn_prd_pm_service_specification]
serviceSpecification.version	Version externe de la spécification de service. Type de données : chaîne Table : dans le champ external_version de la table Spécifications de service [sn_prd_pm_service_specification].
valide pour	Plage de dates pour laquelle la spécification est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Date de fin de la spécification. Type de données : chaîne
validFor.startDateTime	Date de début de la spécification. Type de données : chaîne
version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification].

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 la 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 61. Paramètres de chemin d'accès
Nom	Description
specificationId	L’initial_version de la spécification du produit à récupérer. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]

Tableau 62. 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 nom productSpecCaractéristique Relation des spécifications du produit resourceSpecification Spécification de service valide pour version Type de données : chaîne Par défaut : tous les champs sont renvoyés.
É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é brouillon publié retraité Type de données : chaîne

Tableau 63. Paramètres du corps de la demande (JSON)
Nom	Description
Néant

En-têtes

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

Tableau 64. En-têtes de demandes
En-tête	Description
Néant

Tableau 65. 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 66. 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. ID externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_id de la table Spécification de produit [sn_prd_pm_product_specification].
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
id	Version initiale ou ID externe de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version ou external_id de la table Spécification de produit [sn_prd_pm_product_specification].
internalId	Requis. Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de produit [sn_prd_pm_product_specification].
Version interne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification].
isBundle	Marqueur qui indique s’il représente productSpecification un produit unique ou un ensemble de produits. Valeurs valides : true : la spécification de produit est un lot de produits qui contient plusieurs produits. false : le cahier des charges contient un seul produit. Type de données : booléennes Valeur par défaut : false
lastUpdate	Date de 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 valides : Actif Brouillon Inactif Type de données : chaîne Valeur par défaut : chaîne vide
nom	Nom de la spécification. Type de données : chaîne
productSpecCaractéristique	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 choix ou e-mail. Type de données : chaîne
Relation des spécifications du produit	Relations de cette spécification avec d’autres spécifications de 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	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" }`
RelationshipSpécificationproduit.valideFor.endDateTime	Date de fin de la relation. Type de données : chaîne
RelationshipSpécificationproduit.validFor.startDateTime	Date de début de la relation. Type de données : chaîne
resourceSpecification	Liste 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	Version initiale ou ID externe de la spécification de ressource. Type de données : chaîne Table : dans le champ sys_id ou external_id de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.internalId	Version initiale de la spécification de ressource. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.internalVersion	Version de la spécification de ressource. Type de données : chaîne Table : dans le champ Version de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.name	Nom de la spécification de ressource. Type de données : chaîne Table : Spécification de ressource [sn_prd_pm_resource_specification]
resourceSpecification.version	Version externe de la spécification de ressource. Type de données : chaîne Table : dans le champ external_version de la table Spécification de ressource [sn_prd_pm_resource_specification].
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	Version initiale ou ID externe de la spécification de service. Type de données : chaîne Table : dans le champ sys_id ou external_id de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.internalId	Version initiale de la spécification de service. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.internalVersion	Version de la spécification de service. Type de données : chaîne Table : dans le champ Version de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.name	Nom de la spécification de service. Type de données : chaîne Table : Spécification de service [sn_prd_pm_service_specification]
serviceSpecification.version	Version externe de la spécification de service. Type de données : chaîne Table : dans le champ external_version de la table Spécifications de service [sn_prd_pm_service_specification].
valide pour	Plage de dates pour laquelle la spécification est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Date de fin de la spécification. Type de données : chaîne
validFor.startDateTime	Date de début de la spécification. Type de données : chaîne
version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification].

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 la 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 67. Paramètres de chemin d'accès
Nom	Description
id	Sys_id de l’offre de produits à mettre à jour. Type de données : chaîne Table : Offre de produits [sn_prd_pm_product_offering]

Tableau 68. Paramètres de requête
Nom	Description
Néant

Tableau 69. Paramètres du corps de la demande (JSON)
Nom	Description
catégorie	Liste des catégories auxquelles le produit appartient. Type de données : tableau d’objets `"category:" [ { "id": "String", "name": "String" } ]` Tableau : Catégorie [sc_category]
category.id	Requis si le category paramètre est utilisé. ID de la catégorie. Type de données : chaîne Tableau : Catégorie [sc_category]
category.name	Nom de la catégorie. Type de données : chaîne Valeur par défaut : chaîne vide
canal	Requis. Canaux à utiliser pour vendre l’offre de produits. Type de données : tableau d’objets `"channel:" [ { "description": "String", "id": "String", "name": "String" } ]`
Canal.Description	Description du canal. Type de données : chaîne Valeur par défaut : chaîne vide
channel.id	Requis. Sys_id du canal. Type de données : chaîne Table : Canal de distribution [sn_prd_pm_distribution_channel]
channel.name	Nom du canal. Type de données : chaîne Valeur par défaut : chaîne vide
description	Requis. Description de l'offre de produit. Type de données : chaîne
externalId	ID externe de l’offre de produits Type de données : chaîne Table : dans le champ external_id de la table Offre de produits [sn_prd_pm_product_offering].
id	Requis. Version initiale ou ID externe de l’offre de produits. Type de données : chaîne Table : dans le champ initial_version ou external_id de la table Offre de produits [sn_prd_pm_product_offering].
internalId	Version initiale de l’offre de produits. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
Version interne	Version de l’offre de produits. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
lastUpdate	Date de la dernière mise à jour de l’offre de produits. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00 Valeur par défaut : chaîne vide
nom	Requis. Nom de l’offre de produits. Type de données : chaîne
productCaractéristique	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 Valeur par défaut : chaîne vide
productCharacteristic.value	Valeur de la caractéristique. Type de données : chaîne Valeur par défaut : chaîne vide
productOfferingPrice	Informations de prix pour l’offre de produits. Type de données : tableau d’objets `"productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]`
productOfferingPrice.price	Informations de prix pour l’offre de produits. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOfferingPrice.price.taxIncludedAmount	Informations de prix pour l’offre de produits. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": "String" }`
productOfferingPrice.price.taxIncludedAmount.unit	Code de devise pour le prix de l’offre de produits. Type de données : chaîne Valeur par défaut : chaîne vide
productOfferingPrice.price.taxIncludedAmount.value	Prix de l’offre de produits TTC. Type de données : chaîne Valeur par défaut : chaîne vide
productOfferingPrice.priceType	Type d’offre de produit. Requis si le productOfferingPrice paramètre est utilisé. Valeurs valides : nonRecurring (unique) récurrent Type de données : chaîne
productOfferingTerm	Durée valide du contrat pour l’offre de produits. Type de données : chaîne Valeur par défaut : chaîne vide
Spécification du produit	Requis. Spécification du produit correspondant. Type de données : objet `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Requis. Initial_version ou external_id de la spécification du produit. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]
productSpecification.internalId	Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
Spécification produit.Version interne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
productSpecification.version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].
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 pour la caractéristique. Type de données : tableau d’objets `"productSpecCharacteristicValue": [ { "validFor": {Object}, "value": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.productSpecCharacteristicValue.validFor	Date et heure de validité de la caractéristique. Type de données : objet `"validFor": { "startDateTime": "String" }`
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	Date et heure de début de validité de la caractéristique. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00
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. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00
prodSpecCharValueUse.validFor.startDateTime	Date et heure de début de la caractéristique. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00
prodSpecCharValueUse.valueType	Type de valeur de la caractéristique, tel que choix ou e-mail. Type de données : chaîne
valide pour	Requis. Plage de dates pour laquelle l’offre de produits est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Requis. Date et heure de fin de l’offre de produits. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00
validFor.startDateTime	Requis. Date et heure de début de l’offre de produits. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00
version	Version externe de l’offre de produits. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].

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 70. 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 71. 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 72. 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 la réponse (JSON ou XML)


Nom	Description
catégorie	Liste des catégories auxquelles le produit appartient. 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 produits. Type de données : tableau d’objets `"channel:" [ { "description": "String", "id": "String", "name": "String" } ]`
Canal.Description	Description du canal. Type de données : chaîne
channel.id	Sys_id du canal. Type de données : chaîne Table : Canal de distribution [sn_prd_pm_distribution_channel]
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	ID externe de l’offre de produits Type de données : chaîne Table : dans le champ external_id de la table Offre de produits [sn_prd_pm_product_offering].
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
id	Requis. Version initiale ou ID externe de l’offre de produits. Type de données : chaîne Table : dans le champ initial_version ou external_id de la table Offre de produits [sn_prd_pm_product_offering].
internalId	Version initiale de l’offre de produits. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
Version interne	Version de l’offre de produits. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
lastUpdate	Date de la dernière mise à jour de l’offre de produits. Type de données : chaîne
liftcycleStatus	État actuel du cycle de vie. Valeurs acceptées : Actif Brouillon Inactif Type de données : chaîne Valeur par défaut : chaîne vide
nom	Nom de l’offre de produits. Type de données : chaîne
productCaractéristique	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 de prix pour l’offre de produits. Type de données : tableau d’objets `"productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]`
productOfferingPrice.price	Informations de prix pour l’offre de produits. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOfferingPrice.price.taxIncludedAmount	Informations de prix pour l’offre de produits. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": "String" }`
productOfferingPrice.price.taxIncludedAmount.unit	Code de devise pour le prix de l’offre de produits. 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	Offre de produits, type de prix, paiement unique ou récurrent. Valeurs possibles : nonRecurring (unique) récurrent Type de données : chaîne
productOfferingTerm	Durée valide du contrat pour l’offre de produits. Type de données : chaîne
Spécification du produit	Spécification du produit correspondant. Type de données : objet `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
productSpecification.internalId	Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
Spécification produit.Version interne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
productSpecification.version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].
prodSpecCharValueUse	Caractéristiques des offres de produits. Type de données : tableau d’objets `"prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristicValue	Liste des valeurs possibles pour la caractéristique. Type de données : tableau d’objets `"productSpecCharacteristicValue": [ { "validFor": {Object}, "value": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.productSpecCharacteristicValue.validFor	Date et heure de validité de la caractéristique. Type de données : objet `"validFor": { "startDateTime": "String" }`
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	Date et heure de début de validité de la caractéristique. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00
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 choix ou e-mail. Type de données : chaîne
valide pour	Plage de dates pour laquelle l’offre de produits est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Date de fin de l’offre de produits. Type de données : chaîne
validFor.startDateTime	Date de début de l’offre de produits. Type de données : chaîne
version	Version externe de l’offre de produits. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].

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 la 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/productOfferingPrice/{id}

Met à jour un enregistrement de ligne de liste de prix avec un sys_id donné dans la table Ligne de liste de prix [sn_csm_pricing_price_list_line].

Format d'URL

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

Paramètres de demande pris en charge

Tableau 73. Paramètres de chemin d'accès
Nom	Description
id	Requis. Sys_id de la ligne de liste de prix à récupérer. Table : Lignes de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne

Tableau 74. Paramètres de requête
Nom	Description
Néant

Tableau 75. Paramètres de corps de demande (XML ou JSON)
Nom	Description
@type	Requis. Type de ligne de liste de prix. Toujours une valeur de `ProductOfferingPrice`. Type de données : chaîne
externalId	ID externe de la ligne de liste de prix. Type de données : chaîne
isBundle	Marqueur indiquant si la ligne de liste de prix fait partie d’un seul produit ou d’un ensemble de produits. Valeurs valides : vrai : la ligne de liste de prix fait partie d’un lot. faux : la ligne de liste de prix ne fait pas partie d’un lot. Type de données : booléennes Valeur par défaut : false
lastUpdate	Requis. Date de la dernière mise à jour de la ligne de prix. Format : AAAA-MM-JJ Type de données : chaîne
lifeCycleStatus	Requis. État actuel du cycle de vie de la ligne de liste de produits. Valeurs valides : actif brouillon inactif Type de données : chaîne Par défaut : brouillon
nom	Requis. Nom permettant de donner la ligne de la liste de prix. Type de données : chaîne
prix	Requis. Détails de prix catalogue de la ligne de liste de prix. Type de données : objet `"price": { "unit": "String", "value": "String" }`
prix.unité	Requis. Code de devise de la ligne de liste de prix. Par exemple, `USD` ou `EUR.` Table : table Devise [fx_currency]. Type de données : chaîne
prix.valeur	Requis. Valeur du prix. Type de données : chaîne (représentée par un nombre. Par exemple, `« 800 »`.)
priceList	Requis. Informations sur la liste de prix associées à la ligne de liste de prix. Type de données : objet `"priceList": { "id": "String", "name": "String", "@type": "String" }`
priceList.id	Requis. Sys_id de la ligne de liste de prix. Table : Lignes de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne
priceList.name	Nom de la ligne de liste de prix. Type de données : chaîne
priceList.@type	Type de ligne de liste de prix. Lors de la sous-classe, cela définit le nom extensible de la sous-classe. La valeur est toujours `priceList`. Type de données : chaîne
priceType	Requis. Filtrez la ligne de liste de prix par méthode de tarification de l’offre de produit. Valeurs valides : récurrent : facturez des montants de tarification récurrents à une fréquence spécifiée. La fréquence est définie dans le recurringChargePeriodType paramètre. one_time : prend en charge les frais et frais uniques ou récurrents pour une offre de produits. Type de données : chaîne Par défaut : récurrent
productOffering	Requis. Offre de produit de la ligne de liste de prix. Type de données : objet `"productOffering": { "id": "String", "name": "String", "internalVersion": "String" }`
productOffering.id	Requis. Sys_id de l’offre de produits. Table : Offre de produits [sn_prd_pm_product_offering] Type de données : chaîne
offreproduit.versioninterne	Numéro de version interne de l’offre de produit. Type de données : chaîne (représentée par un nombre. Par exemple, `« 1 »`.)
productOffering.name	Nom de l’offre de produits. Type de données : chaîne
recurringChargePeriodType	Requis si priceType est récurrent. Termes d’engagement sélectionnés lors de la création de l’offre de produit. Valeurs valides : annuellement mensuel Type de données : chaîne
unité de mesure	Requis. Détails sur l’unité de mesure associée à la ligne de liste de prix. Type de données : objet `"unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }`
unitéDemesure.montant	Quantité de l’unité de mesure. Type de données : nombre
unitOfMeasure.id	Requis. Sys_id de l’unité de mesure dans la table Liste de lignes de prix. Table : Ligne de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne
unitéDemesure.unités	Type de l’unité de mesure associée à la ligne de liste de prix. Par exemple, `chaquegroupe` ou. Type de données : chaîne
valide pour	Requis. Durée de validité de la ligne de liste de prix. Type de données : objet `"validFor": { "endDate": "String", "startDate": "String" }`
validFor.endDate	Date de fin à laquelle la ligne de liste de prix est valide. Type de données : chaîne (glide_date_time)
validFor.endDateTime	Date et heure de fin auxquelles la ligne de liste de prix est valide. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne (glide_date)
validFor.startDate	Date de début de validité de la ligne de liste de prix. Type de données : chaîne (glide_date_time)
validFor.startDateTime	Date et heure de début auxquelles la ligne de liste de prix est valide. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne (glide_date)

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.

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. 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 78. 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 du corps de la réponse (JSON ou XML)


Nom	Description
id	Sys_id de la ligne de liste de prix. Table : Lignes de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne
href	URL de l’enregistrement de la ligne de liste de prix dans l’instance. Type de données : chaîne
lastUpdate	Date et heure de la dernière mise à jour de la ligne de liste de prix. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
valide pour	Durée de validité de la ligne de liste de prix. Type de données : objet `"validFor": { "endDate": "String", "startDate": "String" }`
validFor.endDate	Date et heure de fin auxquelles la ligne de liste de prix est valide. Type de données : chaîne (glide_date_time)
validFor.startDate	Date et heure de début auxquelles la ligne de liste de prix est valide. Type de données : chaîne (glide_date_time)
isBundle	Marqueur indiquant si la ligne de liste de prix fait partie d’un seul produit ou d’un ensemble de produits. Valeurs valides : vrai : la ligne de liste de prix fait partie d’un lot. faux : la ligne de liste de prix ne fait pas partie d’un lot. Type de données : booléennes
lifecycleStatus	État actuel du cycle de vie de la ligne de liste de prix. Valeurs valides : Actif Brouillon Inactif Type de données : chaîne
productOffering	Offre de produits associée à la ligne de liste de prix. Type de données : objet `"productOffering": { "id": "String", "name": "String", "internalVersion": "String" }`
productOffering.id	Sys_id de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
offreproduit.versioninterne	Numéro de version interne de l’offre de produit. Par exemple, `PRDOF01024`. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOffering.name	Nom de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
priceType	Méthode de tarification de l’offre de produits associée à cette ligne de liste de prix. Valeurs possibles : récurrent : facturez des montants de tarification récurrents à une fréquence spécifiée. La valeur indique recurringChargePeriodType la fréquence de la charge. one_time : Frais et frais supplémentaires uniques ou récurrents pour une offre de produits. Type de données : chaîne
recurringChargePeriodType	Périodicité ou fréquence de l’offre de produit associée à cette ligne de liste de prix. Renvoie un type de fréquence si priceType la valeur a été définie sur `Récurrent`, sinon renvoie une chaîne vide. Valeurs possibles : annuellement mensuel Type de données : chaîne
unité de mesure	Détails sur l’unité de mesure associée à la ligne de liste de prix. Type de données : objet `"unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }`
unitéDemesure.montant	Quantité de l’unité de mesure. Type de données : nombre
unitOfMeasure.id	Sys_id de l’unité de mesure. Table : Lignes de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne
unitéDemesure.unités	Type de l’unité de mesure associée à la ligne de liste de prix. Par exemple, `année` ou `ensemble`. Type de données : chaîne
prix	Détails de prix catalogue de la ligne de liste de prix. Type de données : objet `"price": { "units": "String", "value": "String" }`
prix.unités	Code de devise du prix. Par exemple, `USD` ou `EUR.` Table : Devise [fx_currency] Type de données : chaîne
prix.valeur	Valeur du prix. Type de données : chaîne (représentée par un nombre)
priceList	Informations sur la liste de prix associées à la ligne de liste de prix. Type de données : objet `"priceList": { "id": "String", "name": "String", "@type": "String" }`
priceList.id	Sys_id de la liste de prix dans la table Liste de prix [sn_csm_pricing_price_list]. Type de données : chaîne
priceList.name	Nom de la liste de prix. Type de données : chaîne
priceList.@type	Le type de liste de prix. Lors de la sous-classe, cela définit le nom extensible de la sous-classe. a toujours une valeur de `priceList`. Type de données : chaîne
@type	Toujours une valeur de `ProductOfferingPrice`. Lors de la sous-classe, cela définit le nom extensible de la sous-classe. Type de données : chaîne
État	État de la liste de prix associée à cette ligne de liste de prix. Type de données : chaîne
externalId	ID externe de cette ligne de liste de prix. Type de données : chaîne

Demande cURL

L’exemple suivant met à jour les dates auxquelles le prix de l’offre de produits avec l’ID 3ddd0... est valide pour.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c" \
--request patch\
--user 'username':'password'
--data {
  "validFor": {
    "endDateTime": "2024-06-25 15:15:58"
  }
}

Corps de la réponse :

{
  "validFor": {
    "endDateTime": "2024-06-25 15:15:58"
  },
  "id": "994d5d364f8b5210f899f61d20ce0b7c",
  "name": "new Price list",
  "lastUpdate": "2025-01-16 00:15:32",
  "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c",
  "lifecycleStatus": "Draft"
}

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

Met à jour la spécification du 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 79. Paramètres de chemin d'accès
Nom	Description
id	Sys_id de l’offre de produits à mettre à jour. Type de données : chaîne Tableau : Spécification de produit [sn_prd_pm_product_specification]

Tableau 80. Paramètres de requête
Nom	Description
Néant

Tableau 81. 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. ID externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_id de la table Spécification de produit [sn_prd_pm_product_specification].
id	Version initiale ou ID externe de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version ou external_id de la table Spécification de produit [sn_prd_pm_product_specification].
internalId	Requis. Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de produit [sn_prd_pm_product_specification].
Version interne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification].
isBundle	Marqueur qui indique s’il représente productSpecification un produit unique ou un ensemble de produits. Valeurs valides : true : la spécification de produit est un lot de produits qui contient plusieurs produits. false : le cahier des charges contient un seul produit. Type de données : booléennes Valeur par défaut : false
lastUpdate	Date de dernière mise à jour de la spécification. Type de données : chaîne Valeur par défaut : chaîne vide
nom	Requis. Nom de la spécification. Type de données : chaîne
productSpecCaractéristique	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	Liste des valeurs possibles pour la caractéristique. Type de données : tableau d’objets `"productSpecCharacteristicValue": [ { "validFor": {Object}, "value": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.productSpecCharacteristicValue.validFor	Date et heure de validité de la caractéristique. Type de données : objet `"validFor": { "startDateTime": "String" }`
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	Date et heure de début de validité de la caractéristique. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00
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 choix ou e-mail. Type de données : chaîne
Relation des spécifications du produit	Détails des relations de la spécification avec d’autres spécifications de 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" }`
RelationshipSpécificationproduit.valideFor.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
RelationshipSpécificationproduit.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
resourceSpecification	Requis. Détails 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. Version initiale ou ID externe de la spécification de ressource. Type de données : chaîne Table : dans le champ sys_id ou external_id de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.internalId	Version initiale de la spécification de ressource. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.internalVersion	Version de la spécification de ressource. Type de données : chaîne Table : dans le champ Version de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.name	Nom de la spécification de ressource. Type de données : chaîne Table : Spécification de ressource [sn_prd_pm_resource_specification]
resourceSpecification.version	Version externe de la spécification de ressource. Type de données : chaîne Table : dans le champ external_version de la table Spécification de ressource [sn_prd_pm_resource_specification].
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	Version initiale ou ID externe de la spécification de service. Type de données : chaîne Table : dans le champ sys_id ou external_id de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.internalId	Version initiale de la spécification de service. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.internalVersion	Version de la spécification de service. Type de données : chaîne Table : dans le champ Version de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.name	Nom de la spécification de service. Type de données : chaîne Table : Spécification de service [sn_prd_pm_service_specification]
serviceSpecification.version	Version externe de la spécification de service. Type de données : chaîne Table : dans le champ external_version de la table Spécifications de service [sn_prd_pm_service_specification].
valide pour	Requis. Plage de dates pour laquelle la spécification est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.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
validFor.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	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification].

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 82. 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 83. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. 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 84. 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 de champ>
404	Introuvable. L’élément demandé est introuvable.

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


Nom	Description
description	Description de la spécification. Type de données : chaîne
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne
id	Version initiale ou ID externe de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version ou external_id de la table Spécification de produit [sn_prd_pm_product_specification].
internalId	Requis. Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de produit [sn_prd_pm_product_specification].
Version interne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification].
lastUpdate	Date de 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
productSpecCaractéristique	Caractéristiques de la 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
prodSpecCharValueUse.productSpecCharacteristicValue	Liste des valeurs possibles pour la caractéristique. Type de données : tableau d’objets `"productSpecCharacteristicValue": [ { "validFor": {Object}, "value": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristicValue.value	Valeur de la caractéristique. Type de données : chaîne
prodSpecCharValueUse.productSpecCharacteristicValue.validFor	Date et heure de validité de la caractéristique. Type de données : objet `"validFor": { "startDateTime": "String" }`
prodSpecCharValueUse.productSpecCharacteristicValue.validFor.startDateTime	Date et heure de début de validité de la caractéristique. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00
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 choix ou e-mail. Type de données : chaîne
Relation des spécifications du produit	Relations de cette spécification avec d’autres spécifications de 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" }`
RelationshipSpécificationproduit.valideFor.endDateTime	Date de fin et type de relation. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
RelationshipSpécificationproduit.validFor.startDateTime	Date de début et type de relation. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
resourceSpecification	Liste 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	Version initiale ou ID externe de la spécification de ressource. Type de données : chaîne Table : dans le champ sys_id ou external_id de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.internalId	Version initiale de la spécification de ressource. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.internalVersion	Version de la spécification de ressource. Type de données : chaîne Table : dans le champ Version de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.name	Nom de la spécification de ressource. Type de données : chaîne Table : Spécification de ressource [sn_prd_pm_resource_specification]
resourceSpecification.version	Version externe de la spécification de ressource. Type de données : chaîne Table : dans le champ external_version de la table Spécification de ressource [sn_prd_pm_resource_specification].
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	Version initiale ou ID externe de la spécification de service. Type de données : chaîne Table : dans le champ sys_id ou external_id de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.internalId	Version initiale de la spécification de service. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.internalVersion	Version de la spécification de service. Type de données : chaîne Table : dans le champ Version de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.name	Nom de la spécification de service. Type de données : chaîne Table : Spécification de service [sn_prd_pm_service_specification]
serviceSpecification.version	Version externe de la spécification de service. Type de données : chaîne Table : dans le champ external_version de la table Spécifications de service [sn_prd_pm_service_specification].
valide pour	Plage de dates pour laquelle la spécification est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Date et heure de fin de la spécification. Format : JJ-MM-AAAA 00:00:00. Type de données : chaîne
validFor.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	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification].

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 la 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 85. Paramètres de chemin d'accès
Nom	Description
Aucun

Tableau 86. Paramètres de requête
Nom	Description
Néant

Tableau 87. Paramètres du corps de la demande (JSON)
Nom	Description
description	Description du catalogue d’offres de produits. Type de données : chaîne Valeur par défaut : chaîne vide
externalId	Identificateur unique pour le catalogue d’offres de produits du système externe. Type de données : chaîne Valeur 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 88. 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 89. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. 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 90. Codes d'état
Code d'état	Description
201	Demande traitée avec succès.
400	Demande incorrecte. Peut être l’une des raisons suivantes : Charge utile vide. Charge utile non valide. Champ obligatoire manquant : <nom de 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 Type de données : chaîne Table : Catalogue d’offres de produits [sn_prd_pm_product_offering_catalog]
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 la 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 91. Paramètres de chemin d'accès
Nom	Description
Aucun

Tableau 92. Paramètres de requête
Nom	Description
Néant

Tableau 93. Paramètres du corps de la demande (JSON)
Nom	Description
catégorie	Liste des catégories auxquelles le produit appartient. Type de données : tableau d’objets `"category:" [ { "id": "String", "name": "String" } ]` Tableau : Catégorie [sc_category]
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 produits. Type de données : tableau d’objets `"channel:" [ { "description": "String", "id": "String", "name": "String" } ]`
Canal.Description	Description du canal. Type de données : chaîne
channel.id	Requis. Sys_id du canal. Type de données : chaîne Table : Canal de distribution [sn_prd_pm_distribution_channel]
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 pour l’offre de produit du système externe. Type de données : chaîne
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne
id	Requis. Version initiale ou ID externe de l’offre de produits. Type de données : chaîne Table : dans les champs initial_version ou external_id de la table Offre de produits [sn_prd_pm_product_offering].
internalId	Version initiale de l’offre de produits. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
Version interne	Version de l’offre de produits. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
lastUpdate	Date de la dernière mise à jour de l’offre de produits. Type de données : chaîne
lifecycleStatus	État actuel du cycle de vie. Valeurs valides : Actif Brouillon Inactif Type de données : chaîne
nom	Requis. Nom de l’offre de produits. Type de données : chaîne
productCaractéristique	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 de prix pour l’offre de produits. Type de données : tableau d’objets `"productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]`
productOfferingPrice.price	Informations de prix pour l’offre de produits. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOfferingPrice.price.taxIncludedAmount	Informations de prix pour l’offre de produits. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": "String" }`
productOfferingPrice.price.taxIncludedAmount.unit	Code de devise pour le prix de l’offre de produits. 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é. Offre de produits, type de prix, paiement unique ou récurrent. Valeurs valides : nonRecurring (unique) récurrent Type de données : chaîne
productOfferingTerm	Durée valide du contrat pour l’offre de produits. Type de données : chaîne
Spécification du produit	Requis. Spécification du produit correspondant. Type de données : objet `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Requis. Version initiale ou ID externe de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version ou externa_id de la table Spécification de produit [sn_prd_pm_product_specification].
productSpecification.internalId	Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
Spécification produit.Version interne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
productSpecification.version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].
prodSpecCharValueUse	Caractéristiques des offres 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 choix ou e-mail. Type de données : chaîne
valide pour	Requis. Plage de dates pour laquelle l’offre de produits est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Date de fin de l’offre de produits. Type de données : chaîne
validFor.startDateTime	Date de début de l’offre de produits. Type de données : chaîne
version	Version externe de l’offre de produits. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].

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 94. 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 95. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. 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 96. 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 de champ>

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


Nom	Description
catégorie	Liste des catégories auxquelles le produit appartient. 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 produits. Type de données : tableau d’objets `"channel:" [ { "description": "String", "id": "String", "name": "String" } ]`
Canal.Description	Description du canal. Type de données : chaîne
channel.id	Sys_id du canal. Type de données : chaîne Table : Canal de distribution [sn_prd_pm_distribution_channel]
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	ID externe de l’offre de produits Type de données : chaîne Table : dans le champ external_id de la table Offre de produits [sn_prd_pm_product_offering].
href	Lien relatif vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
id	Requis. Version initiale ou ID externe de l’offre de produits. Type de données : chaîne Table : dans le champ initial_version ou external_id de la table Offre de produits [sn_prd_pm_product_offering].
internalId	Version initiale de l’offre de produits. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
Version interne	Version de l’offre de produits. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
lastUpdate	Date de la dernière mise à jour de l’offre de produits. Type de données : chaîne
lifecycleStatus	État actuel du cycle de vie de l’offre de produits. Valeurs valides : Actif Brouillon Inactif Type de données : chaîne Valeur par défaut : chaîne vide
nom	Nom de l’offre de produits. Type de données : chaîne
productCaractéristique	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 de prix pour l’offre de produits. Type de données : tableau d’objets `"productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]`
productOfferingPrice.price	Informations de prix pour l’offre de produits. Type de données : objet `"price": { "taxIncludedAmount": {Object} }`
productOfferingPrice.price.taxIncludedAmount	Informations de prix pour l’offre de produits. Type de données : objet `"taxIncludedAmount": { "unit": "String", "value": "String" }`
productOfferingPrice.price.taxIncludedAmount.unit	Code de devise pour le prix de l’offre de produits. 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	Offre de produits, type de prix, paiement unique ou récurrent. Valeurs possibles : nonRecurring (unique) récurrent Type de données : chaîne
productOfferingTerm	Durée valide du contrat pour l’offre de produits. Type de données : chaîne
Spécification du produit	Spécification du produit correspondant. Type de données : objet `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
productSpecification.internalId	Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Offre de produits [sn_prd_pm_product_offering].
Spécification produit.Version interne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Offre de produits [sn_prd_pm_product_offering].
productSpecification.version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].
prodSpecCharValueUse	Caractéristiques des offres 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 choix ou e-mail. Type de données : chaîne
valide pour	Plage de dates pour laquelle l’offre de produits est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Date de fin de l’offre de produits. Type de données : chaîne
validFor.startDateTime	Date de début de l’offre de produits. Type de données : chaîne
version	Version externe de l’offre de produits. Type de données : chaîne Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].

Demande cURL

Cet exemple crée une offre de produit.

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 la 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/productOfferingPrice

Crée un nouvel enregistrement de ligne de liste de prix dans la table Ligne de liste de prix [sn_csm_pricing_price_list_line].

Format d'URL

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

Paramètres de demande pris en charge

Tableau 97. Paramètres de chemin d'accès
Nom	Description
Aucun

Tableau 98. Paramètres de requête
Nom	Description
Néant

Tableau 99. Paramètres de corps de demande (XML ou JSON)
Nom	Description
@type	Requis. Type de ligne de liste de prix. Toujours une valeur de `ProductOfferingPrice`. Type de données : chaîne
externalId	ID externe de la ligne de liste de prix. Type de données : chaîne
isBundle	Marqueur indiquant si la ligne de liste de prix fait partie d’un seul produit ou d’un ensemble de produits. Valeurs valides : vrai : la ligne de liste de prix fait partie d’un lot. faux : la ligne de liste de prix ne fait pas partie d’un lot. Type de données : booléennes Valeur par défaut : false
lastUpdate	Requis. Date de la dernière mise à jour de la ligne de prix. Format : AAAA-MM-JJ Type de données : chaîne
lifeCycleStatus	Requis. État actuel du cycle de vie de la ligne de liste de produits. Valeurs valides : actif brouillon inactif Type de données : chaîne Par défaut : brouillon
nom	Requis. Nom permettant de donner la ligne de la liste de prix. Type de données : chaîne
prix	Requis. Détails de prix catalogue de la ligne de liste de prix. Type de données : objet `"price": { "unit": "String", "value": "String" }`
prix.unité	Requis. Code de devise de la ligne de liste de prix. Par exemple, `USD` ou `EUR.` Table : table Devise [fx_currency]. Type de données : chaîne
prix.valeur	Requis. Valeur du prix. Type de données : chaîne (représentée par un nombre. Par exemple, `« 800 »`.)
priceList	Requis. Informations sur la liste de prix associées à la ligne de liste de prix. Type de données : objet `"priceList": { "id": "String", "name": "String", "@type": "String" }`
priceList.id	Requis. Sys_id de la ligne de liste de prix. Table : Lignes de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne
priceList.name	Nom de la ligne de liste de prix. Type de données : chaîne
priceList.@type	Type de ligne de liste de prix. Lors de la sous-classe, cela définit le nom extensible de la sous-classe. La valeur est toujours `priceList`. Type de données : chaîne
priceType	Requis. Filtrez la ligne de liste de prix par méthode de tarification de l’offre de produit. Valeurs valides : récurrent : facturez des montants de tarification récurrents à une fréquence spécifiée. La fréquence est définie dans le recurringChargePeriodType paramètre. one_time : prend en charge les frais et frais uniques ou récurrents pour une offre de produits. Type de données : chaîne Par défaut : récurrent
productOffering	Requis. Offre de produit de la ligne de liste de prix. Type de données : objet `"productOffering": { "id": "String", "name": "String", "internalVersion": "String" }`
productOffering.id	Requis. Sys_id de l’offre de produits. Table : Offre de produits [sn_prd_pm_product_offering] Type de données : chaîne
offreproduit.versioninterne	Numéro de version interne de l’offre de produit. Type de données : chaîne (représentée par un nombre. Par exemple, `« 1 »`.)
productOffering.name	Nom de l’offre de produits. Type de données : chaîne
recurringChargePeriodType	Requis si priceType est récurrent. Termes d’engagement sélectionnés lors de la création de l’offre de produit. Valeurs valides : annuellement mensuel Type de données : chaîne
unité de mesure	Requis. Détails sur l’unité de mesure associée à la ligne de liste de prix. Type de données : objet `"unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }`
unitéDemesure.montant	Quantité de l’unité de mesure. Type de données : nombre
unitOfMeasure.id	Requis. Sys_id de l’unité de mesure dans la table Liste de lignes de prix. Table : Ligne de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne
unitéDemesure.unités	Type de l’unité de mesure associée à la ligne de liste de prix. Par exemple, `chaquegroupe` ou. Type de données : chaîne
valide pour	Requis. Durée de validité de la ligne de liste de prix. Type de données : objet `"validFor": { "endDate": "String", "startDate": "String" }`
validFor.endDate	Date de fin à laquelle la ligne de liste de prix est valide. Type de données : chaîne (glide_date_time)
validFor.endDateTime	Date et heure de fin auxquelles la ligne de liste de prix est valide. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne (glide_date)
validFor.startDate	Date de début de validité de la ligne de liste de prix. Type de données : chaîne (glide_date_time)
validFor.startDateTime	Date et heure de début auxquelles la ligne de liste de prix est valide. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne (glide_date)

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 100. 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.

Tableau 101. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. 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 102. 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 du corps de la réponse (JSON ou XML)


Nom	Description
id	Sys_id de la ligne de liste de prix. Table : Lignes de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne
href	URL de l’enregistrement de la ligne de liste de prix dans l’instance. Type de données : chaîne
lastUpdate	Date et heure de la dernière mise à jour de la ligne de liste de prix. Format : JJ-MM-AAAA HH :mm :ss Type de données : chaîne
valide pour	Durée de validité de la ligne de liste de prix. Type de données : objet `"validFor": { "endDate": "String", "startDate": "String" }`
validFor.endDate	Date et heure de fin auxquelles la ligne de liste de prix est valide. Type de données : chaîne (glide_date_time)
validFor.startDate	Date et heure de début auxquelles la ligne de liste de prix est valide. Type de données : chaîne (glide_date_time)
isBundle	Marqueur indiquant si la ligne de liste de prix fait partie d’un seul produit ou d’un ensemble de produits. Valeurs valides : vrai : la ligne de liste de prix fait partie d’un lot. faux : la ligne de liste de prix ne fait pas partie d’un lot. Type de données : booléennes
lifecycleStatus	État actuel du cycle de vie de la ligne de liste de prix. Valeurs valides : Actif Brouillon Inactif Type de données : chaîne
productOffering	Offre de produits associée à la ligne de liste de prix. Type de données : objet `"productOffering": { "id": "String", "name": "String", "internalVersion": "String" }`
productOffering.id	Sys_id de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
offreproduit.versioninterne	Numéro de version interne de l’offre de produit. Par exemple, `PRDOF01024`. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
productOffering.name	Nom de l’offre de produits. Situé dans la table Offre de produit [sn_prd_pm_product_offering]. Type de données : chaîne
priceType	Méthode de tarification de l’offre de produits associée à cette ligne de liste de prix. Valeurs possibles : récurrent : facturez des montants de tarification récurrents à une fréquence spécifiée. La valeur indique recurringChargePeriodType la fréquence de la charge. one_time : Frais et frais supplémentaires uniques ou récurrents pour une offre de produits. Type de données : chaîne
recurringChargePeriodType	Périodicité ou fréquence de l’offre de produit associée à cette ligne de liste de prix. Renvoie un type de fréquence si priceType la valeur a été définie sur `Récurrent`, sinon renvoie une chaîne vide. Valeurs possibles : annuellement mensuel Type de données : chaîne
unité de mesure	Détails sur l’unité de mesure associée à la ligne de liste de prix. Type de données : objet `"unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }`
unitéDemesure.montant	Quantité de l’unité de mesure. Type de données : nombre
unitOfMeasure.id	Sys_id de l’unité de mesure. Table : Lignes de liste de prix [sn_csm_pricing_price_list_line] Type de données : chaîne
unitéDemesure.unités	Type de l’unité de mesure associée à la ligne de liste de prix. Par exemple, `année` ou `ensemble`. Type de données : chaîne
prix	Détails de prix catalogue de la ligne de liste de prix. Type de données : objet `"price": { "units": "String", "value": "String" }`
prix.unités	Code de devise du prix. Par exemple, `USD` ou `EUR.` Table : Devise [fx_currency] Type de données : chaîne
prix.valeur	Valeur du prix. Type de données : chaîne (représentée par un nombre)
priceList	Informations sur la liste de prix associées à la ligne de liste de prix. Type de données : objet `"priceList": { "id": "String", "name": "String", "@type": "String" }`
priceList.id	Sys_id de la liste de prix dans la table Liste de prix [sn_csm_pricing_price_list]. Type de données : chaîne
priceList.name	Nom de la liste de prix. Type de données : chaîne
priceList.@type	Le type de liste de prix. Lors de la sous-classe, cela définit le nom extensible de la sous-classe. a toujours une valeur de `priceList`. Type de données : chaîne
@type	Toujours une valeur de `ProductOfferingPrice`. Lors de la sous-classe, cela définit le nom extensible de la sous-classe. Type de données : chaîne
État	État de la liste de prix associée à cette ligne de liste de prix. Type de données : chaîne
externalId	ID externe de cette ligne de liste de prix. Type de données : chaîne

Demande cURL

L’exemple suivant crée un nouvel enregistrement de ligne de liste de prix en fonction des données spécifiées dans le corps de la demande et l’insère dans la table Ligne de liste de prix [sn_csm_pricing_price_list_line].

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice " \
--request POST\
--user 'username':'password'
--data {
  "name": "new Price list",
  "validFor": {
    "startDateTime": "2024-05-28 15:15:58",
    "endDateTime": "2025-06-28 15:15:58"
  },
  "priceType": "recurring",
  "recurringChargePeriodType": "monthly",
  "lastUpdate": "2023-09-23 00:00:00",
  "isBundle": false,
  "lifecycleStatus": "Draft",
  "unitOfMeasure": {
    "id": "1eaa559953020110286eddeeff7b12c7",
    "amount": 1,
    "units": "Year"
  },
  "price": {
    "unit": "USD",
    "value": "800"
  },
  "productOffering": {
    "id": "9e3dd57a4fcb5210f899f61d20ce0bf2",
    "name": "Maintenance Fee",
    "internalVersion": "1"
  },
  "priceList": {
    "name": "new price list",
    "@type": "priceList"
  },
  "externalId": "test123",
  "@type": "ProductOfferingPrice"
}

Corps de la réponse. Un ID unique est affecté à ce nouvel enregistrement de ligne de liste de prix. Le corps de la réponse renvoie ces informations ainsi qu’une URL vers le nouvel enregistrement à l’aide du paramètre de href réponse.

{
  "name": "new Price list",
  "validFor": {
    "startDateTime": "2024-05-28 15:15:58",
    "endDateTime": "2025-06-28 15:15:58"
  },
  "priceType": "recurring",
  "recurringChargePeriodType": "monthly",
  "lastUpdate": "2023-09-23 00:00:00",
  "isBundle": false,
  "lifecycleStatus": "Draft",
  "unitOfMeasure": {
    "id": "1eaa559953020110286eddeeff7b12c7",
    "amount": 1,
    "units": "Year"
  },
  "price": {
    "unit": "USD",
    "value": "800"
  },
  "productOffering": {
    "id": "9e3dd57a4fcb5210f899f61d20ce0bf2",
    "name": "Maintenance Fee",
    "internalVersion": "1"
  },
  "priceList": {
    "id": "194d5d364f8b5210f899f61d20ce0b7a",
    "name": "new Price list",
    "@type": "priceList"
  },
  "externalId": "test123",
  "@type": "ProductOfferingPrice",
  "id": "994d5d364f8b5210f899f61d20ce0b7c",
  "state": "draft",
  "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c"
}

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 103. Paramètres de chemin d'accès
Nom	Description
Aucun

Tableau 104. Paramètres de requête
Nom	Description
Néant

Tableau 105. 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 de la spécification de produit du système externe. Type de données : chaîne Valeur par défaut : chaîne vide
id	Requis. Version initiale ou ID externe de la spécification du produit. Type de données : chaîne Tableau : dans le initial_version ou le external_id de la table des spécifications du produit [sn_prd_pm_product_specification].
internalId	Requis. Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de produit [sn_prd_pm_product_specification].
Version interne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification].
lastUpdate	Date de dernière mise à jour de la spécification. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00. Par exemple, `2025-01-31 09:35:43`. Valeur par défaut : chaîne vide
nom	Requis. Nom de la spécification. Type de données : chaîne
productSpecCaractéristique	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 Valeur par défaut : chaîne vide
productSpecCharacteristic.name	Requis. Nom de la caractéristique. Type de données : chaîne
productSpecCharacteristic.productSpecCharacteristicValue	Requis. 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. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00. Par exemple, `2025-01-31 09:35:43`. Valeur par défaut : chaîne vide
productSpecCharacteristic.validFor.startDateTime	Date de début de la caractéristique. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00. Par exemple, `2025-01-31 09:35:43`. Valeur par défaut : chaîne vide
productSpecCharacteristic.valueType	Type de valeur de la caractéristique, tel que choix ou e-mail. Type de données : chaîne Valeur par défaut : chaîne vide
Relation des spécifications du produit	Relations de cette spécification avec d’autres spécifications de produit. Type de données : tableau `"productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]`
productSpecificationRelationship.id	ID de la spécification associée. Type de données : chaîne Valeur par défaut : chaîne vide
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" }`
RelationshipSpécificationproduit.valideFor.endDateTime	Date de fin de la relation. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00. Par exemple, `2025-01-31 09:35:43`. Valeur par défaut : chaîne vide
RelationshipSpécificationproduit.validFor.startDateTime	Date de début de la relation. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00. Par exemple, `2025-01-31 09:35:43`. Valeur par défaut : chaîne vide
resourceSpecification	Requis. 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. Version initiale ou ID externe de la spécification de ressource. Type de données : chaîne Table : dans le champ sys_id ou external_id de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.internalId	Version initiale de la spécification de ressource. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.internalVersion	Version de la spécification de ressource. Type de données : chaîne Table : dans le champ Version de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.name	Nom de la spécification de ressource. Type de données : chaîne Table : Spécification de ressource [sn_prd_pm_resource_specification]
resourceSpecification.version	Version externe de la spécification de ressource. Type de données : chaîne Table : dans le champ external_version de la table Spécification de ressource [sn_prd_pm_resource_specification].
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	Version initiale ou ID externe de la spécification de service. Type de données : chaîne Table : dans le champ sys_id ou external_id de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.internalId	Version initiale de la spécification de service. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.internalVersion	Version de la spécification de service. Type de données : chaîne Table : dans le champ Version de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.name	Nom de la spécification de service. Type de données : chaîne Table : Spécification de service [sn_prd_pm_service_specification]
serviceSpecification.version	Version externe de la spécification de service. Type de données : chaîne Table : dans le champ external_version de la table Spécifications de service [sn_prd_pm_service_specification].
valide pour	Requis. Plage de dates pour laquelle la spécification est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Date de fin de la spécification. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00. Par exemple, `2025-01-31 09:35:43`. Valeur par défaut : chaîne vide
validFor.startDateTime	Date de début de la spécification. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00. Par exemple, `2025-01-31 09:35:43`. Valeur par défaut : chaîne vide
version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification].

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 106. 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 107. En-têtes de réponses
En-tête	Description
Type de contenu	Format de données du corps de la réponse. 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 108. 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 de 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 vers l’enregistrement de ressource. Type de données : chaîne Valeur par défaut : chaîne vide
id	Version initiale ou ID externe de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version ou external_id de la table Spécification de produit [sn_prd_pm_product_specification].
internalId	Requis. Version initiale de la spécification du produit. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de produit [sn_prd_pm_product_specification].
Version interne	Version de la spécification du produit. Type de données : chaîne Table : dans le champ Version de la table Spécification de produit [sn_prd_pm_product_specification].
isBundle	Marqueur qui indique s’il représente productSpecification un produit unique ou un ensemble de produits. Valeurs valides : true : la spécification de produit est un lot de produits qui contient plusieurs produits. false : le cahier des charges contient un seul produit. Type de données : booléennes Valeur par défaut : false
lastUpdate	Date de dernière mise à jour de la spécification. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00.
lifecycleStatus	État actuel du cycle de vie de la spécification du produit. Valeurs possibles : Actif Brouillon Inactif Type de données : chaîne Valeur par défaut : chaîne vide
nom	Nom de la spécification. Type de données : chaîne
productSpecCaractéristique	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	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 Format : JJ-MM-AAAA 00:00:00.
productSpecCharacteristic.validFor.startDateTime	Date de début de la caractéristique. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00.
productSpecCharacteristic.valueType	Type de valeur de la caractéristique, tel que choix ou e-mail. Type de données : chaîne
Relation des spécifications du produit	Relations de cette spécification avec d’autres spécifications de 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" }`
RelationshipSpécificationproduit.valideFor.endDateTime	Date de fin de la relation. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00.
RelationshipSpécificationproduit.validFor.startDateTime	Date de début de la relation. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00.
resourceSpecification	Liste 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	Version initiale ou ID externe de la spécification de ressource. Type de données : chaîne Table : dans le champ sys_id ou external_id de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.internalId	Version initiale de la spécification de ressource. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.internalVersion	Version de la spécification de ressource. Type de données : chaîne Table : dans le champ Version de la table Spécification de ressource [sn_prd_pm_resource_specification].
resourceSpecification.name	Nom de la spécification de ressource. Type de données : chaîne Table : Spécification de ressource [sn_prd_pm_resource_specification]
resourceSpecification.version	Version externe de la spécification de ressource. Type de données : chaîne Table : dans le champ external_version de la table Spécification de ressource [sn_prd_pm_resource_specification].
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	Version initiale ou ID externe de la spécification de service. Type de données : chaîne Table : dans le champ sys_id ou external_id de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.internalId	Version initiale de la spécification de service. Type de données : chaîne Table : dans le champ initial_version de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.internalVersion	Version de la spécification de service. Type de données : chaîne Table : dans le champ Version de la table Spécification de service [sn_prd_pm_service_specification].
serviceSpecification.name	Nom de la spécification de service. Type de données : chaîne Table : Spécification de service [sn_prd_pm_service_specification]
serviceSpecification.version	Version externe de la spécification de service. Type de données : chaîne Table : dans le champ external_version de la table Spécifications de service [sn_prd_pm_service_specification].
valide pour	Plage de dates pour laquelle la spécification est valide. Type de données : objet `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Date de fin de la spécification. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00.
validFor.startDateTime	Date de début de la spécification. Type de données : chaîne Format : JJ-MM-AAAA 00:00:00.
version	Version externe de la spécification du produit. Type de données : chaîne Table : dans le champ external_version de la table Spécification de produit [sn_prd_pm_product_specification].

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 la 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"
      }
   ]
}