API ouverte du catalogue de produits

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

    • L’API ouverte de Catalogue de produits fournit des points de terminaison permettant de créer et de récupérer des catalogues de produits, des offres de produits et des spécifications de produits.

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

    Cette API est incluse dans l’application Product Catalog Advanced, qui est disponible sur le ServiceNow Store et s’exécute dans l’espace de noms sn_tmf_api .

    L’utilisateur appelant doit avoir le rôle sn_prd_pm_adv.catalog_integrator.

    Cette API crée et met à jour les données dans les tables suivantes.
    • Caractéristique [sn_prd_pm_characteristic]
    • Option de la caractéristique [sn_prd_pm_characteristic_option]
    • Offre de produits [sn_prd_pm_product_offering]
    • Catalogue d’offres de produits [sn_prd_pm_product_offering_catalog]
    • Caractéristique des offres de produits [sn_prd_pm_product_offering_characteristic]
    • Spécification de produit [sn_prd_pm_product_specification]
    • Relation de spécification [sn_prd_pm_specification_relationship]

    API ouverte du catalogue de produits : SUPPRIMER /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
    Aucune
    Tableau 3. Paramètres du corps de la demande (XML ou JSON)
    Nom Description
    Aucune

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 des données du corps de la réponse. Types pris en charge : application/json ou application/xml.

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

    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é traitée avec succès.
    400 Demande incorrecte. Un type de demande incorrect ou une demande mal formée a été détecté.

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

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

    Demande cURL

    L’exemple suivant supprime l’offre de produits 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 un 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 sur la date du jour. Une ligne de liste de prix avec une date de fin antérieure à la date du jour est également considérée comme inactive. Les lignes de liste de prix inactives ne peuvent pas être récupérées 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 des prix [sn_csm_pricing_price_list_line]

    Type de données : chaîne
    Tableau 8. Paramètres de requête
    Nom Description
    Aucune
    Tableau 9. Paramètres du corps de la demande (XML ou JSON)
    Nom Description
    Aucune

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 des données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Par défaut : application/json
    Tableau 11. En-têtes de réponses
    En-tête Description
    Type de contenu Format des 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é traitée avec succès.
    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 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 de catalogue de produits : DELETE /sn_tmf_api/catalogmanagement/productSpecification/{id}

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

    Lors de l’appel de cette méthode DELETE, une spécification de produit peut être supprimée ou archivée en fonction de son état :
    • Une spécification de produit à l’état de brouillon 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 produits est archivée, mais pas supprimée. La réponse renvoie un message indiquant que la spécification est passée 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

    Table : Spécification de produit [sn_prd_pm_product_specification]
    Tableau 14. Paramètres de requête
    Nom Description
    Aucune
    Tableau 15. Paramètres du corps de la demande (XML ou JSON)
    Nom Description
    Aucune

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 des données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Par défaut : application/json
    Tableau 17. En-têtes de réponses
    En-tête Description
    Aucune

    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é traitée avec succès.
    400 Demande incorrecte. Un type de demande incorrect ou une demande mal formée a été détecté.

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

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

    Demande cURL

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

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

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

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

    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
    Aucune
    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 récupération de l’enregistrement offset .

    Type de données : nombre

    Par défaut : 20

    Maximum : 100
    décalage Index de départ sur lequel commencer à récupérer les enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en 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
    Aucune

    En-têtes

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

    Tableau 22. En-têtes de demandes
    En-tête Description
    Accepter Format des données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 23. En-têtes de réponses
    En-tête Description
    Plage de contenu Plage de contenu renvoyé dans 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 des données du corps de la réponse. Prend uniquement en charge application/json.
    Lien Contient les liens suivants pour parcourir les résultats de la requête.
    • premier
    • dernier
    • suivant
    • previous
    Nombre X-Total 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 renvoyée en réponse (avec pagination).
    400
    Demande incorrecte. Raisons possibles :
    • Paramètre de chemin d’accès non valide
    • URI non valide
    404 Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table.

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

    Nom Description
    description Description du catalogue d’offres de produits. Uniquement renvoyé si le champ contient une valeur.

    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]
    lifecycleStatus État du cycle de vie actuel de la ligne de liste de prix.
    Valeurs valides :
    • Actives
    • Brouillon
    • Inactif

    Type de données : chaîne
    nom Nom du catalogue d’offres de produits.

    Type de données : chaîne
    statut État du catalogue de l’offre de produits.

    Valeur possible : publiée

    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": "341f4953b71a9910ff00f203ae11a9bb",
    "name": "Home Internet Plan",
    "lifecycleStatus": "Active",
    "status": "published"
  },
  {
    "id": "69f494792b11525047f3f3e30391bf66",
    "name": "Chemical Processing",
    "lifecycleStatus": "Active",
    "description": " Catalog for Chemical Processing Industry",
    "status": "published"
  }
]

    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
    Aucune

    En-têtes

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

    Tableau 28. En-têtes de demandes
    En-tête Description
    Accepter Format des données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 29. En-têtes de réponses
    En-tête Description
    Type de contenu Format des 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é traitée avec succès.
    400
    Demande incorrecte. Cela 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 du 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]
    lifecycleStatus État du cycle de vie actuel de la ligne de liste de prix.
    Valeurs valides :
    • Actives
    • Brouillon
    • Inactif

    Type de données : chaîne
    nom Nom du catalogue d’offres de produits.

    Type de données : chaîne

    Demande cURL

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

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

    Corps de la réponse.

    {
  "id": "69f494792b11525047f3f3e30391bf66",
  "name": "Chemical Processing",
  "lifecycleStatus": "Active",
  "description": " Catalog for Chemical Processing Industry"
}

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

    Récupère toutes les offres de produits ou un sous-ensemble d’offres de produits, en fonction des paramètres de filtre spécifiés.

    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
    Aucune
    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
    • productCharacteristic
    • productOfferingPrice
    • productOfferingTerm
    • Spécification du produit
    • prodSpecCharValueUse
    • validFor
    • 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 récupération de l’enregistrement offset .

    Type de données : nombre

    Par défaut : 20

    Maximum : 100
    décalage Index de départ sur lequel commencer à récupérer les enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en 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 le sys_id de spécification de produit spécifié sont renvoyées dans la réponse.

    Type de données : chaîne

    Table : Spécification de produit [sn_prd_pm_product_specification]
    État Filtrez 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é
    • Mis hors service

    Type de données : chaîne
    Tableau 33. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucune

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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
    Type de contenu Format des données du corps de la demande. Prend uniquement en charge application/json.
    Tableau 35. En-têtes de réponses
    En-tête Description
    Plage de contenu Plage de contenu renvoyé dans 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 des données du corps de la réponse. Prend uniquement en charge application/json.
    Lien Contient les liens suivants pour parcourir les résultats de la requête.
    • premier
    • dernier
    • suivant
    • previous
    Nombre X-Total 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 renvoyée en réponse (avec pagination).
    400
    Demande incorrecte. Raisons possibles :
    • Paramètre de chemin d’accès non valide
    • URI non valide
    404 Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table.

    Paramètres du corps de réponse

    Nom Description
    bundledGroupProductOffering Groupes enfants des offres de produits. Ceux-ci montrent des sous-groupes hiérarchiques.

    Type de données : tableau d’objets

    "bundledGroupProductOffering": [
  {
    "bundledGroupProductOfferingOption": {Object},
    "bundledProductOffering": [Array],
    "id": "String",
    "name": "String"
  }
]
    bundledGroupProductOffering.bundledGroupProductOfferingOption Plage de nombres qui spécifie les limites inférieure et supérieure du nombre d’offres de produits associée qui peuvent être achetés dans le cadre de l’offre de produits groupés connexe.

    Type de données : objet

    "bundledGroupProductOfferingOption": {
  "numberRelOfferLowerLimit": "String",
  "numberRelOfferUpperLimit": "String"
}
    bundledGroupProductOffering.bundledGroupProductOfferingOption.numberRelOfferLowerLimit Limite inférieure d’une offre de produits qui peut être achetée dans le cadre de l’offre groupée connexe.

    Type de données : chaîne
    bundledGroupProductOffering.bundledGroupProductOfferingOption.numberRelOfferUpperLimit Limite supérieure d’une offre de produits qui peut être achetée dans le cadre de l’offre groupée connexe.

    Type de données : chaîne
    bundledGroupProductOffering.bundledProductOffering Groupes enfants des offres de produits associées à l’ensemble. Même format que bundledProductOffering spécifié ci-dessous.

    Type de données : tableau d’objets
    bundledGroupProductOffering.ID Sys_id de l’enregistrement groupé. Utile dans les cas où l’offre ou le groupe de produits parents comprend plusieurs groupes.

    Type de données : chaîne

    Table : groupe de relations d’offre de produits [sn_prd_pm_product_offering_relationship_group]
    bundledGroupProductOffering.Name (Nom) Nom du groupe d’offres de produits enfants.

    Type de données : chaîne
    bundledProductOffering Liste des offres de produits incluses dans le groupe d’offres de produits. L’offre groupée de produits hérite de tous les attributs des offres de produits incluses.

    Type de données : tableau d’objets

    "bundledProductOffering": [
  {
    "bundledProductOfferingOption": {Object},
    "externalId": "String",
    "href": "String",
    "id": "String",
    "name": "String",
    "version": Number
  }
]
    bundledProductOffering.bundledProductOfferingOption Options de groupe de produits, telles que le nombre par défaut d’offres de produits et les contraintes d’approvisionnement d’offres de produits supérieures et inférieures.

    Type de données : objet

    "bundledProductOfferingOption": {
  "numberRelOfferDefault": "String",
  "numberRelOfferLowerLimit": "String",
  "numberRelOfferUpperLimit": "String"
}
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferDefault Nombre par défaut d’offres de produits à se procurer dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferLowerLimit Limite inférieure du nombre d’offres de produits associés qui peuvent être obtenus dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferUpperLimit Limite supérieure du nombre d’offres de produits associées qui peuvent être achetées dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.ID externe ID externe de la relation d’offre de produits.

    Pour plus d’informations sur les relations d’offre de produits, reportez-vous à la section Create product offering relationships.

    Type de données : chaîne
    bundledProductOffering.href Lien relatif à l’offre de produits associée.

    Type de données : chaîne
    bundledProductOffering.ID ID Sys_id ou externe de l’offre de produits groupés.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]
    bundledProductOffering.Name (Nom) Nom du groupe d’offres de produits.

    Type de données : chaîne
    bundledProductOffering.version Version du catalogue 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].
    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
    displayName Nom d’affichage de l’offre de produit.

    Type de données : chaîne
    externalId ID externe de l’offre de produit.

    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 à l’enregistrement de ressource.

    Type de données : chaîne

    Par défaut : chaîne vide
    id Requis. Version initiale ou ID externe de l’offre de produit.

    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 Sys_id ou ID interne de l’enregistrement d’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].
    isBundle Marqueur indiquant si l’offre de produits est un lot.
    Valeurs possibles :
    • vrai : l’offre de produits est un lot.
    • faux : offre de produit unique.

    Type de données : booléen

    Valeur par défaut : false
    isSellable Marqueur indiquant si l’offre de produits associée peut être vendue seule ou si elle doit faire partie d’un ensemble d’offres de produits.
    Valeurs possibles :
    • vrai : Peut être vendu séparément.
    • faux : vendu uniquement dans le cadre d’un lot.

    Type de données : booléen

    Valeur par défaut : false
    lastUpdate Date à laquelle l’offre de produits a été mise à jour pour la dernière fois.

    Type de données : chaîne
    lifecycleStatus État du cycle de vie actuel de l’offre de produit.

    Valeurs valides :

    • Actives
    • Brouillon
    • Inactif

    Type de données : chaîne

    Par défaut : chaîne vide
    nom Nom de l’offre de produits.

    Type de données : chaîne
    prodSpecCharValueUse Caractéristiques des offres de produits.

    Type de données : tableau d’objets

    "prodSpecCharValueUse": [
   {
      "description": "String",
      "name": "String",
      "productSpecCharacteristicValue": [Array],
      "validFor": {Object},
      "valueType": "String"
   }
]
    prodSpecCharValueUse.Descriptif Description de la caractéristique.

    Type de données : chaîne
    prodSpecCharValueUse.Name (Nom)
    Nom de la caractéristique.

    Type de données : chaîne
    prodSpecCharValueUse.productSpecCharacteristicValue
    Liste des valeurs possibles de la caractéristique.

    Type de données : tableau d’objets

    "productSpecCharacteristicValue": [
 {
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "validFor": {Object},
    "value": "String"
 }
]
    prodSpecCharValueUse.productSpecCharacteristicValue.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique.
    Valeurs possibles :
    • true : valeur par défaut.
    • false : pas la valeur par défaut.

    Valeur par défaut : false
    prodSpecCharValueUse.productSpecCharacteristicValue.isMandatory Marqueur indiquant si la valeur de caractéristique associée est une valeur obligatoire pour la caractéristique.
    Valeurs possibles :
    • true : valeur obligatoire.
    • faux : valeur non obligatoire.

    Valeur par défaut : false
    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 la validité de la valeur caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    prodSpecCharValueUse.productSpecCharacteristicValue.value (valeur)
    Valeur 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": {
  "startDateTime": "String"
}
    prodSpecCharValueUse.validFor.startDateTime Date de début de la caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    prodSpecCharValueUse.valueType Type de données du prodSpecCharValueUse.productSpecCharacteristicValue.value paramètre.
    Valeurs possibles :
    • choix
    • e-mail
    • Numéro
    • Texte
    • oui/non

    Type de données : chaîne
    productCharacteristic Liste des caractéristiques du produit.

    Type de données : tableau d’objets

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.Name (Nom) Nom de la caractéristique.

    Type de données : chaîne
    productCharacteristic.value (valeur) Valeur de la caractéristique.

    Type de données : chaîne
    productOfferingCharacteristic Qualité caractéristique ou caractéristique distinctive d’une offre de produits. Les caractéristiques peuvent prendre une valeur discrète qui est fixée au moment de la conception (création de catalogue), comme le classement du plan mobile. Ces caractéristiques ne sont généralement pas modifiables au niveau des stocks.

    Pour en savoir plus sur les caractéristiques des offres de produits, reportez-vous à la section Create product characteristics and characteristic options.

    Type de données : tableau d’objets

    productOfferingCharacteristic": [  
  {
    "characteristicValueSpecification": [Array],
    "name": "String",
    "valueType": "String"
  }
]
    productOfferingCharacteristic.characteristicValueSpecification Liste des valeurs de caractéristiques associées à la caractéristique d’offre de produits.

    Type de données : tableau d’objets

    "characteristicValueSpecification": [  
  { 
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "value": "String"
  }  
]
    productOfferingCharacteristic.characteristicValueSpecification.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique associée.
    Valeurs possibles :
    • true : est la valeur par défaut.
    • false : n’est pas la valeur par défaut.

    Type de données : booléen

    Valeur par défaut : false
    productOfferingCharacteristic.characteristicValueSpecification.isMandatory Marqueur indiquant si la valeur de caractéristique associée est obligatoire pour la caractéristique associée.
    Valeurs possibles :
    • true : est obligatoire.
    • false : n’est pas obligatoire.

    Type de données : booléen

    Valeur par défaut : false
    productOfferingCharacteristic.characteristicValueSpecification.value (valeur) Numéro ou texte attribué à la caractéristique de spécification de produit associée.
    Par exemple :
    "characteristicValueSpecification": [
  {
    "value": "choice 1"
  },
  {
    "value": "choice 2"
  }
]

    Type de données : chaîne
    productOfferingCharacteristic.Name (Nom) Nom de la caractéristique de l’offre de produits associée.

    Type de données : chaîne
    productOfferingCharacteristic.valueType Type de données du productOfferingCharacteristic.​characteristicValueSpecification.​value paramètre.
    Valeurs possibles :
    • choix
    • e-mail
    • Numéro
    • Texte
    • oui/non

    Type de données : chaîne
    productOfferingPrice Informations sur les prix de l’offre de produits.

    Type de données : tableau d’objets

    "productOfferingPrice": [
  {
    "price": {Object},
    "priceType": "String"
  }
]
    productOfferingPrice.Prix Informations sur les prix de l’offre de produits.

    Type de données : objet

    "price": {
  "taxIncludedAmount": {Object}
}
    productOfferingPrice.prix.taxIncludedAmount Informations sur les prix de l’offre de produits.

    Type de données : objet

    "taxIncludedAmount": {
  "unit": "String",
  "value": "String"
}
    offreproduitPrix.prix.taxeMontantInclus.unité Code de devise pour le prix de l’offre de produits.

    Type de données : chaîne
    offreproduitPrix.prix.taxeMontantInclus.valeur Prix de l’offre de produits TTC.

    Type de données : chaîne
    productOfferingPrice.type de prix Type de prix de l’offre de produits, paiement unique ou récurrent.
    Valeurs possibles :
    • nonRecurring (unique)
    • Récurrent

    Type de données : chaîne
    productOfferingTerm Durée du contrat valide pour l’offre de produit.

    Type de données : chaîne
    Spécification du produit Spécification du produit pour le produit.

    Type de données : objet

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "name": "String",
  "version": "String"
}
    Spécification du produit.ID Sys_id de l’enregistrement de 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 du produit.ID interne Sys_id ou ID interne de l’enregistrement de 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 du 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].
    Spécification du produit.Name (Nom) Nom de la spécification du produit.

    Type de données : chaîne

    Table : dans le champ Nom de la table Offre de produits [sn_prd_pm_product_offering].
    Spécification du produit.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].
    statut État de l’offre de produit.
    Valeurs possibles :
    • brouillon
    • publié

    Type de données : chaîne
    validFor 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 produit.

    Type de données : chaîne

    Format : JJ-MM-AAAA
    validFor.startDateTime Date de début de l’offre de produit.

    Type de données : chaîne

    Format : JJ-MM-AAAA
    version Version externe de l’offre de produit.

    Type de données : chaîne

    Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].

    L’exemple de code suivant récupère les deux premiers enregistrements d’offre de produits.

    curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering?limit=2" \
--header "Accept:application/json" \
--user 'username':'password'

    Corps de réponse :

    [
  {
    "id": "7b012c4d41ea7910f8771355f12634a4",
    "externalId": "7b012c4d41ea7910f8771355f12634a4",
    "href": "/api/sn_tmf_api/catalogmanagement/productOffering/0361dd9fd0a63110f8770dbf976be16f",
    "name": "Ultimate internet - 1Gbps Plan",
    "displayName": "Ultimate internet - 1Gbps Plan",
    "description": "Ultimate internet - 1Gbps Plan",
    "isSellable": true,
    "lifecycleStatus": "Active",
    "isBundle": false,
    "lastUpdate": "2025-03-08 02:07:04",
    "version": "",
    "internalVersion": "1",
    "internalId": "0361dd9fd0a63110f8770dbf976be16f",
    "validFor": {
      "startDateTime": "2023-11-14",
      "endDateTime": ""
    },
    "productOfferingTerm": "not_applicable",
    "productOfferingPrice": [
      {
        "priceType": "recurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 0
          }
        }
      },
      {
        "priceType": "nonRecurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 0
          }
        }
      }
    ],
    "productOfferingCharacteristic": "",
    "bundledProductOffering": [],
    "bundledGroupProductOffering": [],
    "productSpecification": {},
    "prodSpecCharValueUse": [],
    "channel": "",
    "category": [
      {
        "id": "e6f0159fd0a63110f8770dbf976be18c",
        "name": "Internet"
      }
    ],
    "status": "published"
  },
  {
    "id": "313b917843235210a82ed6085bb8f2c7",
    "externalId": "313b917843235210a82ed6085bb8f2c7",
    "href": "/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11",
    "name": "Internet bundle",
    "displayName": "Internet bundle",
    "description": "Internet bundle",
    "isSellable": false,
    "lifecycleStatus": "Draft",
    "isBundle": true,
    "lastUpdate": "2025-04-09 15:59:09",
    "version": "",
    "internalVersion": "1",
    "internalId": "03c99cb53bf066509b48d69a04e45a11",
    "validFor": {
      "startDateTime": "2028-12-15",
      "endDateTime": "2034-01-14"
    },
    "productOfferingTerm": "not_applicable",
    "productOfferingPrice": [
      {
        "priceType": "recurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 0
          }
        }
      },
      {
        "priceType": "nonRecurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 0
          }
        }
      }
    ],
    "productOfferingCharacteristic": [
      {
        "name": "Connectivity need",
        "valueType": "choice",
        "characteristicValueSpecification": [
          {
            "isMandatory": false,
            "isDefault": false,
            "value": "When in use"
          }
        ]
      },
      {
        "name": "Firewall Security",
        "valueType": "choice",
        "characteristicValueSpecification": [
          {
            "isMandatory": false,
            "isDefault": true,
            "value": "Premium"
          }
        ]
      }
    ],
    "bundledProductOffering": [
      {
        "href": "/api/sn_tmf_api/catalogmanagement/productOffering/57c99cb53bf066509b48d69a04e45a17",
        "id": "0f61dd9fd0a63110f8770dbf976be168",
        "externalId": "EXT-123",
        "name": "Solana Sports streaming channel",
        "version": "1",
        "bundledProductOfferingOption": {
          "numberRelOfferDefault": "1",
          "numberRelOfferLowerLimit": "1",
          "numberRelOfferUpperLimit": "1"
        }
      }
    ],
    "bundledGroupProductOffering": [
      {
        "id": "063b957843235210a82ed6085bb8f205",
        "name": "Streaming Channel",
        "bundledProductOffering": [
          {
            "href": "/api/sn_tmf_api/catalogmanagement/productOffering/5bc99cb53bf066509b48d69a04e45a1a",
            "id": "62619d9fd0a63110f8770dbf976be180",
            "externalId": "EXT-345",
            "name": "Solana Movie streaming channel",
            "version": "1",
            "bundledProductOfferingOption": {
              "numberRelOfferDefault": "1",
              "numberRelOfferLowerLimit": "1",
              "numberRelOfferUpperLimit": "1"
            }
          }
        ],
        "bundledGroupProductOfferingOption": {
          "numberRelOfferLowerLimit": "1",
          "numberRelOfferUpperLimit": "1"
        }
      }
    ],
    "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": "",
      "internalVersion": "3",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
    },
    "prodSpecCharValueUse": [
      {
        "name": "Tenancy",
        "description": "Tenancy",
        "valueType": "choice",
        "validFor": {
          "startDatetime": "2025-02-27 21:04:24"
        },
        "productSpecCharacteristicValue": [
          {
            "value": "Premium (>50 sites)",
            "validFor": {
              "startDateTime": ""
            },
            "isDefault": false,
            "isMandatory": false
          },
          {
            "value": "Base (10 site)",
            "validFor": {
              "startDateTime": ""
            },
            "isDefault": false,
            "isMandatory": false
          }
        ],
        "productSpecification": {
          "id": "216663aa53702010cd6dddeeff7b12b5",
          "name": "SD-WAN Controller",
          "version": "",
          "internalVersion": "1",
          "internalId": "216663aa53702010cd6dddeeff7b12b5"
        }
      }
    ],
    "channel": [
      {
        "id": "58ad5522c3702010df4773ce3640ddb2",
        "name": "Agent Assist"
      }
    ],
    "category": [
      {
        "id": "13e305a143b631105029d1529ab8f267",
        "name": "SD-WAN_all_offers"
      }
    ],
    "status": "draft"
  }
]

    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 produit à 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
    • productCharacteristic
    • productOfferingPrice
    • productOfferingTerm
    • Spécification du produit
    • prodSpecCharValueUse
    • validFor
    • 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 le sys_id de spécification de produit spécifié sont renvoyées dans la réponse.

    Type de données : chaîne

    Table : Spécification de produit [sn_prd_pm_product_specification]
    État Filtrez 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é
    • Mis hors service

    Type de données : chaîne
    Tableau 39. Paramètres du corps de la demande
    Nom Description
    Aucune

    En-têtes

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

    Tableau 40. En-têtes de demandes
    En-tête Description
    Accepter Format des données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 41. En-têtes de réponses
    En-tête Description
    Type de contenu Format des 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 42. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès.
    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 réponse

    Nom Description
    bundledGroupProductOffering Groupes enfants des offres de produits. Ceux-ci montrent des sous-groupes hiérarchiques.

    Type de données : tableau d’objets

    "bundledGroupProductOffering": [
  {
    "bundledGroupProductOfferingOption": {Object},
    "bundledProductOffering": [Array],
    "id": "String",
    "name": "String"
  }
]
    bundledGroupProductOffering.bundledGroupProductOfferingOption Plage de nombres qui spécifie les limites inférieure et supérieure du nombre d’offres de produits associée qui peuvent être achetés dans le cadre de l’offre de produits groupés connexe.

    Type de données : objet

    "bundledGroupProductOfferingOption": {
  "numberRelOfferLowerLimit": "String",
  "numberRelOfferUpperLimit": "String"
}
    bundledGroupProductOffering.bundledGroupProductOfferingOption.numberRelOfferLowerLimit Limite inférieure d’une offre de produits qui peut être achetée dans le cadre de l’offre groupée connexe.

    Type de données : chaîne
    bundledGroupProductOffering.bundledGroupProductOfferingOption.numberRelOfferUpperLimit Limite supérieure d’une offre de produits qui peut être achetée dans le cadre de l’offre groupée connexe.

    Type de données : chaîne
    bundledGroupProductOffering.bundledProductOffering Groupes enfants des offres de produits associées à l’ensemble. Même format que bundledProductOffering spécifié ci-dessous.

    Type de données : tableau d’objets
    bundledGroupProductOffering.ID Sys_id de l’enregistrement groupé. Utile dans les cas où l’offre ou le groupe de produits parents comprend plusieurs groupes.

    Type de données : chaîne

    Table : groupe de relations d’offre de produits [sn_prd_pm_product_offering_relationship_group]
    bundledGroupProductOffering.Name (Nom) Nom du groupe d’offres de produits enfants.

    Type de données : chaîne
    bundledProductOffering Liste des offres de produits incluses dans le groupe d’offres de produits. L’offre groupée de produits hérite de tous les attributs des offres de produits incluses.

    Type de données : tableau d’objets

    "bundledProductOffering": [
  {
    "bundledProductOfferingOption": {Object},
    "externalId": "String",
    "href": "String",
    "id": "String",
    "name": "String",
    "version": Number
  }
]
    bundledProductOffering.bundledProductOfferingOption Options de groupe de produits, telles que le nombre par défaut d’offres de produits et les contraintes d’approvisionnement d’offres de produits supérieures et inférieures.

    Type de données : objet

    "bundledProductOfferingOption": {
  "numberRelOfferDefault": "String",
  "numberRelOfferLowerLimit": "String",
  "numberRelOfferUpperLimit": "String"
}
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferDefault Nombre par défaut d’offres de produits à se procurer dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferLowerLimit Limite inférieure du nombre d’offres de produits associés qui peuvent être obtenus dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferUpperLimit Limite supérieure du nombre d’offres de produits associées qui peuvent être achetées dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.ID externe ID externe de la relation d’offre de produits.

    Pour plus d’informations sur les relations d’offre de produits, reportez-vous à la section Create product offering relationships.

    Type de données : chaîne
    bundledProductOffering.href Lien relatif à l’offre de produits associée.

    Type de données : chaîne
    bundledProductOffering.ID ID Sys_id ou externe de l’offre de produits groupés.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]
    bundledProductOffering.Name (Nom) Nom du groupe d’offres de produits.

    Type de données : chaîne
    bundledProductOffering.version Version du catalogue 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].
    catégorie Liste des catégories auxquelles le produit appartient.

    Type de données : tableau d’objets

    "category:" [
  {
    "id": "String",
    "name": "String"
  }
]
    category.id Sys_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.Descriptif 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
    displayName Nom d’affichage de l’offre de produit.

    Type de données : chaîne
    externalId ID externe de l’offre de produit.

    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 à l’enregistrement de ressource.

    Type de données : chaîne

    Par défaut : chaîne vide
    id Requis. Version initiale ou ID externe de l’offre de produit.

    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 Sys_id ou ID interne de l’enregistrement d’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].
    isBundle Marqueur indiquant si l’offre de produits est un lot.
    Valeurs possibles :
    • vrai : l’offre de produits est un lot.
    • faux : offre de produit unique.

    Type de données : booléen

    Valeur par défaut : false
    isSellable Marqueur indiquant si l’offre de produits associée peut être vendue seule ou si elle doit faire partie d’un ensemble d’offres de produits.
    Valeurs possibles :
    • vrai : Peut être vendu séparément.
    • faux : vendu uniquement dans le cadre d’un lot.

    Type de données : booléen

    Valeur par défaut : false
    lastUpdate Date à laquelle l’offre de produits a été mise à jour pour la dernière fois.

    Type de données : chaîne

    Format : JJ-MM-AAAA HH-mm-SS
    lifecycleStatus État du cycle de vie actuel de l’offre de produit.
    Valeurs possibles :
    • Actives
    • Inactif
    • Brouillon

    Type de données : chaîne

    Par défaut : chaîne vide
    nom Nom de l’offre de produits.

    Type de données : chaîne
    prodSpecCharValueUse Caractéristiques des offres de produits.

    Type de données : tableau d’objets

    "prodSpecCharValueUse": [
   {
      "description": "String",
      "name": "String",
      "productSpecCharacteristicValue": [Array],
      "validFor": {Object},
      "valueType": "String"
   }
]
    prodSpecCharValueUse.Descriptif Description de la caractéristique.

    Type de données : chaîne
    prodSpecCharValueUse.Name (Nom)
    Nom de la caractéristique.

    Type de données : chaîne
    prodSpecCharValueUse.productSpecCharacteristicValue
    Liste des valeurs possibles de la caractéristique.

    Type de données : tableau d’objets

    "productSpecCharacteristicValue": [
 {
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "validFor": {Object},
    "value": "String"
 }
]
    prodSpecCharValueUse.productSpecCharacteristicValue.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique.
    Valeurs possibles :
    • true : valeur par défaut.
    • false : pas la valeur par défaut.

    Valeur par défaut : false
    prodSpecCharValueUse.productSpecCharacteristicValue.isMandatory Marqueur indiquant si la valeur de caractéristique associée est une valeur obligatoire pour la caractéristique.
    Valeurs possibles :
    • true : valeur obligatoire.
    • faux : valeur non obligatoire.

    Valeur par défaut : false
    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 la validité de la valeur caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    prodSpecCharValueUse.productSpecCharacteristicValue.value (valeur)
    Valeur 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": {
  "startDateTime": "String"
}
    prodSpecCharValueUse.validFor.startDateTime Date de début de la caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    prodSpecCharValueUse.valueType Type de données du prodSpecCharValueUse.productSpecCharacteristicValue.value paramètre.
    Valeurs possibles :
    • choix
    • e-mail
    • Numéro
    • Texte
    • oui/non

    Type de données : chaîne
    productCharacteristic Liste des caractéristiques du produit.

    Type de données : tableau d’objets

    "productCharacteristic": [
   {
      "name": "String",
      "value": "String"
   }
]
    productCharacteristic.Name (Nom) Nom de la caractéristique.

    Type de données : chaîne
    productCharacteristic.value (valeur) Valeur de la caractéristique.

    Type de données : chaîne
    productOfferingCharacteristic Qualité caractéristique ou caractéristique distinctive d’une offre de produits. Les caractéristiques peuvent prendre une valeur discrète qui est fixée au moment de la conception (création de catalogue), comme le classement du plan mobile. Ces caractéristiques ne sont généralement pas modifiables au niveau des stocks.

    Pour en savoir plus sur les caractéristiques des offres de produits, reportez-vous à la section Create product characteristics and characteristic options.

    Type de données : tableau d’objets

    productOfferingCharacteristic": [  
  {
    "characteristicValueSpecification": [Array],
    "name": "String",
    "valueType": "String"
  }
]
    productOfferingCharacteristic.characteristicValueSpecification Liste des valeurs de caractéristiques associées à la caractéristique d’offre de produits.

    Type de données : tableau d’objets

    "characteristicValueSpecification": [  
  { 
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "value": "String"
  }  
]
    productOfferingCharacteristic.characteristicValueSpecification.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique associée.
    Valeurs possibles :
    • true : est la valeur par défaut.
    • false : n’est pas la valeur par défaut.

    Type de données : booléen

    Valeur par défaut : false
    productOfferingCharacteristic.characteristicValueSpecification.isMandatory Marqueur indiquant si la valeur de caractéristique associée est obligatoire pour la caractéristique associée.
    Valeurs possibles :
    • true : est obligatoire.
    • false : n’est pas obligatoire.

    Type de données : booléen

    Valeur par défaut : false
    productOfferingCharacteristic.characteristicValueSpecification.value (valeur) Numéro ou texte attribué à la caractéristique de spécification de produit associée.
    Par exemple :
    "characteristicValueSpecification": [
  {
    "value": "choice 1"
  },
  {
    "value": "choice 2"
  }
]

    Type de données : chaîne
    productOfferingCharacteristic.Name (Nom) Nom de la caractéristique de l’offre de produits associée.

    Type de données : chaîne
    productOfferingCharacteristic.valueType Type de données du productOfferingCharacteristic.​characteristicValueSpecification.​value paramètre.
    Valeurs possibles :
    • choix
    • e-mail
    • Numéro
    • Texte
    • oui/non

    Type de données : chaîne
    productOfferingPrice Informations sur les prix de l’offre de produits.

    Type de données : tableau d’objets

    "productOfferingPrice": [
   {
      "price": {Object},
      "priceType": "String"
   }
]
    productOfferingPrice.Prix Informations sur les prix de l’offre de produits.

    Type de données : objet

    "price": {
   "taxIncludedAmount": {Object}
}
    productOfferingPrice.prix.taxIncludedAmount Informations sur les prix de l’offre de produits.

    Type de données : objet

    "taxIncludedAmount": {
   "unit": "String",
   "value": "String"
}
    productOfferingPrice.prix.taxIncludedAmount.unité Code de devise pour le prix de l’offre de produits.

    Type de données : chaîne
    productOfferingPrice.prix.taxIncludedAmount.value (valeur) Prix de l’offre de produits TTC.

    Type de données : chaîne
    productOfferingPrice.type de prix Identifie si le prix de l’offre de produits est un paiement unique ou récurrent.
    Valeurs possibles :
    • non récurrent
    • Récurrent

    Type de données : chaîne
    productOfferingTerm Durée du contrat valide pour l’offre de produit.

    Type de données : chaîne
    Spécification du produit Spécification du produit pour le produit.

    Type de données : objet

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "name": "String",
  "version": "String"
}
    Spécification du produit.ID Sys_id de l’enregistrement de 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 du produit.ID interne Sys_id ou ID interne de l’enregistrement de 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 du 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].
    Spécification du produit.Name (Nom) Nom de la spécification du produit.

    Type de données : chaîne

    Table : dans le champ Nom de la table Offre de produits [sn_prd_pm_product_offering].
    Spécification du produit.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].
    statut État de l’offre de produit.
    Valeurs possibles :
    • brouillon
    • publié

    Type de données : chaîne
    validFor 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 produit.

    Type de données : chaîne

    Format : JJ-MM-AAAA
    validFor.startDateTime Date de début de l’offre de produit.

    Type de données : chaîne

    Format : JJ-MM-AAAA
    version Version externe de l’offre de produit.

    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 l’offre de produits spécifiée.

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

    Corps de réponse :

    {
  "id": "313b917843235210a82ed6085bb8f2c7",
  "externalId": "313b917843235210a82ed6085bb8f2c7",
  "href": "/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11",
  "name": "Internet bundle",
  "displayName": "Internet bundle",
  "description": "Internet bundle",
  "isSellable": false,
  "lifecycleStatus": "Draft",
  "isBundle": true,
  "lastUpdate": "2025-04-09 15:59:09",
  "version": "",
  "internalVersion": "1",
  "internalId": "03c99cb53bf066509b48d69a04e45a11",
  "validFor": {
    "startDateTime": "2028-12-15",
    "endDateTime": "2034-01-14"
  },
  "productOfferingTerm": "not_applicable",
  "productOfferingPrice": [
    {
      "priceType": "recurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": 0
        }
      }
    },
    {
      "priceType": "nonRecurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": 0
        }
      }
    }
  ],
  "productOfferingCharacteristic": [
    {
      "name": "Connectivity need",
      "valueType": "choice",
      "characteristicValueSpecification": [
        {
          "isMandatory": false,
          "isDefault": false,
          "value": "When in use"
        }
      ]
    },
    {
      "name": "Firewall Security",
      "valueType": "choice",
      "characteristicValueSpecification": [
        {
          "isMandatory": false,
          "isDefault": true,
          "value": "Premium"
        }
      ]
    }
  ],
  "bundledProductOffering": [
    {
      "href": "/api/sn_tmf_api/catalogmanagement/productOffering/57c99cb53bf066509b48d69a04e45a17",
      "id": "0f61dd9fd0a63110f8770dbf976be168",
      "externalId": "EXT-123",
      "name": "Solana Sports streaming channel",
      "version": "1",
      "bundledProductOfferingOption": {
        "numberRelOfferDefault": "1",
        "numberRelOfferLowerLimit": "1",
        "numberRelOfferUpperLimit": "1"
      }
    }
  ],
  "bundledGroupProductOffering": [
    {
      "id": "063b957843235210a82ed6085bb8f205",
      "name": "Streaming Channel",
      "bundledProductOffering": [
        {
          "href": "/api/sn_tmf_api/catalogmanagement/productOffering/5bc99cb53bf066509b48d69a04e45a1a",
          "id": "62619d9fd0a63110f8770dbf976be180",
          "externalId": "EXT-345",
          "name": "Solana Movie streaming channel",
          "version": "1",
          "bundledProductOfferingOption": {
            "numberRelOfferDefault": "1",
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "bundledGroupProductOfferingOption": {
        "numberRelOfferLowerLimit": "1",
        "numberRelOfferUpperLimit": "1"
      }
    }
  ],
  "productSpecification": {
    "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
    "name": "SD-WAN Service Package",
    "version": "",
    "internalVersion": "3",
    "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
  },
  "prodSpecCharValueUse": [
    {
      "name": "Tenancy",
      "description": "Tenancy",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2025-02-27 21:04:24"
      },
      "productSpecCharacteristicValue": [
        {
          "value": "Premium (>50 sites)",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "Base (10 site)",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        }
      ],
      "productSpecification": {
        "id": "216663aa53702010cd6dddeeff7b12b5",
        "name": "SD-WAN Controller",
        "version": "",
        "internalVersion": "1",
        "internalId": "216663aa53702010cd6dddeeff7b12b5"
      }
    }
  ],
  "channel": [
    {
      "id": "58ad5522c3702010df4773ce3640ddb2",
      "name": "Agent Assist"
    }
  ],
  "category": [
    {
      "id": "13e305a143b631105029d1529ab8f267",
      "name": "SD-WAN_all_offers"
    }
  ],
  "status": "draft"
}

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

    Récupère tous les enregistrements de lignes 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 : AAAA-MM-JJ 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.

    Table : 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.

    Table : Listes de prix [sn_csm_pricing_price_list]

    Type de données : chaîne
    type de prix Filtrez les résultats par méthode de tarification de l’offre de produit.
    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 supplémentaires 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
    unité de mesure.ID Filtrez la ligne de liste de prix par sys_id de l’unité de mesure.

    Table : Lignes de liste des 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 : AAAA-MM-JJ 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 : AAAA-MM-JJ HH :mm :ss

    Type de données : chaîne
    Tableau 45. Paramètres du corps de la demande (XML ou JSON)
    Nom Description
    Aucune

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 des 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 des 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é traitée avec succès.
    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 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 ligne de liste de prix dans l’instance.

    Type de données : chaîne
    id Sys_id de la ligne de liste des prix.

    Table : Lignes de liste des 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éen
    lastUpdate Date et heure de la dernière mise à jour de la ligne de liste de prix.

    Format : AAAA-MM-JJ HH :mm :ss

    Type de données : chaîne
    lifecycleStatus État du cycle de vie actuel de la ligne de liste de prix.
    Valeurs valides :
    • Actives
    • Brouillon
    • Inactif

    Type de données : chaîne
    price Détails de prix catalogue de la ligne de liste des 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 de prix Méthode de tarification de l’offre de produit 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 de recurringChargePeriodType indique la fréquence de la facturation.
    • one_time : 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 produits [sn_prd_pm_product_offering].

    Type de données : chaîne
    productOffering.Version interne Numéro de version interne de l’offre de produits. Par exemple, PRDOF01024. Situé dans la table Offre de produits [sn_prd_pm_product_offering].

    Type de données : chaîne
    productOffering.Name (Nom) Nom de l’offre de produits. Situé dans la table Offre de produits [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 s’il priceType a été défini sur Récurrent, sinon renvoie une chaîne vide.
    Valeurs possibles :
    • Jour et mois de l
    • 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 Montant de l’unité de mesure.

    Type de données : nombre
    unitOfMeasure.id Sys_id de l’unité de mesure.

    Table : Lignes de liste des prix [sn_csm_pricing_price_list_line]

    Type de données : chaîne
    unité de mesure.Unités Type de l’unité de mesure associée à la ligne de liste des prix. Par exemple, année ou ensemble.

    Type de données : chaîne
    validFor 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 de liste de prix spécifique.

    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 des 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 : AAAA-MM-JJ 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.

    Table : 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.

    Table : Listes de prix [sn_csm_pricing_price_list]

    Type de données : chaîne
    type de prix Filtrez les résultats par méthode de tarification de l’offre de produit.
    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 supplémentaires 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
    unité de mesure.ID Filtrez la ligne de liste de prix par sys_id de l’unité de mesure.

    Table : Lignes de liste des 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 : AAAA-MM-JJ 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 : AAAA-MM-JJ HH :mm :ss

    Type de données : chaîne
    Tableau 51. Paramètres du corps de la demande (XML ou JSON)
    Nom Description
    Aucune

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 des 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 des 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é traitée avec succès.
    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 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 ligne de liste de prix dans l’instance.

    Type de données : chaîne
    id Sys_id de la ligne de liste des prix.

    Table : Lignes de liste des 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éen
    lastUpdate Date et heure de la dernière mise à jour de la ligne de liste de prix.

    Format : AAAA-MM-JJ HH :mm :ss

    Type de données : chaîne
    lifecycleStatus État du cycle de vie actuel de la ligne de liste de prix.
    Valeurs valides :
    • Actives
    • Brouillon
    • Inactif

    Type de données : chaîne
    price Détails de prix catalogue de la ligne de liste des 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 de prix Méthode de tarification de l’offre de produit 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 de recurringChargePeriodType indique la fréquence de la facturation.
    • one_time : 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 produits [sn_prd_pm_product_offering].

    Type de données : chaîne
    productOffering.Version interne Numéro de version interne de l’offre de produits. Par exemple, PRDOF01024. Situé dans la table Offre de produits [sn_prd_pm_product_offering].

    Type de données : chaîne
    productOffering.Name (Nom) Nom de l’offre de produits. Situé dans la table Offre de produits [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 s’il priceType a été défini sur Récurrent, sinon renvoie une chaîne vide.
    Valeurs possibles :
    • Jour et mois de l
    • 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 Montant de l’unité de mesure.

    Type de données : nombre
    unitOfMeasure.id Sys_id de l’unité de mesure.

    Table : Lignes de liste des prix [sn_csm_pricing_price_list_line]

    Type de données : chaîne
    unité de mesure.Unités Type de l’unité de mesure associée à la ligne de liste des prix. Par exemple, année ou ensemble.

    Type de données : chaîne
    validFor 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 tous les enregistrements de spécifications de produits.

    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
    Aucune
    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
    • productSpecCharacteristic
    • productSpecificationRelationship
    • Spécification de ressource
    • Spécification de service
    • validFor
    • 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 récupération de l’enregistrement offset .

    Type de données : nombre

    Par défaut : 20

    Maximum : 100
    décalage Index de départ sur lequel commencer à récupérer les enregistrements. Utilisez cette valeur pour paginer la récupération de l’enregistrement. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit leur nombre, en 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é
    • Mis hors service

    Type de données : chaîne
    Tableau 57. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucune

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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
    Accepter Format des données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Par défaut : application/json
    Tableau 59. En-têtes de réponses
    En-tête Description
    Plage de contenu Plage de contenu renvoyé dans 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 des données du corps de la réponse. Prend uniquement en charge application/json.
    Lien Contient les liens suivants pour parcourir les résultats de la requête.
    • premier
    • dernier
    • suivant
    • previous
    Nombre X-Total 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 renvoyée en réponse (avec pagination).
    400
    Demande incorrecte. Raisons possibles :
    • Paramètre de chemin d’accès non valide
    • URI non valide
    404 Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table.

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

    Nom Description
    description Description de la spécification.

    Type de données : chaîne
    displayName Nom d’affichage de la spécification du produit.

    Type de données : chaîne
    externalId
    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 à l’enregistrement de ressource.

    Type de données : chaîne

    Par défaut : chaîne vide
    id ID Sys_id ou externe de la spécification du produit.

    Type de données : chaîne

    Table : dans le champ sys_id ou external_id de la table Spécification de produit [sn_prd_pm_product_specification].
    internalId
    Sys_id ou ID interne 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 indiquant s’il représente productSpecification un produit unique ou un ensemble de produits.
    Valeurs possibles :
    • vrai : la spécification de produit est un lot de produits qui contient plusieurs produits.
    • faux : le cahier des charges contient un seul produit.
    Type de données : booléen
    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 possibles :

    • Actives
    • Inactif
    • Brouillon

    Type de données : chaîne
    nom Nom de la spécification.

    Type de données : chaîne
    productSpecCharacteristic Caractéristique de la spécification du produit.

    Type de données : tableau d’objets

    "productSpecCharacteristic": [
  {
    "description": "String",
    "name": "String",
    "productSpecCharacteristicValue": [Array],
    "validFor": {Object},
    "valueType": "String"
  }
]
    productSpecCharacteristic.Descriptif Description de la caractéristique.

    Type de données : chaîne
    productSpecCharacteristic.Name (Nom) Nom de la caractéristique.

    Type de données : chaîne
    productSpecCharacteristic.productSpecCharacteristicValue
    Liste des valeurs possibles de la caractéristique.

    Type de données : tableau d’objets

    "productSpecCharacteristicValue": [
 {
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "validFor": {Object},
    "value": "String"
 }
]
    productSpecCharacteristic.productSpecCharacteristicValue.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique.
    Valeurs possibles :
    • true : valeur par défaut.
    • false : pas la valeur par défaut.

    Valeur par défaut : false
    productSpecCharacteristic.productSpecCharacteristicValue.isMandatory Marqueur indiquant si la valeur de caractéristique associée est une valeur obligatoire pour la caractéristique.
    Valeurs possibles :
    • true : valeur obligatoire.
    • faux : valeur non obligatoire.

    Valeur par défaut : false
    productSpecCharacteristic.productSpecCharacteristicValue.validFor Date et heure de validité de la caractéristique.

    Type de données : objet

    "validFor": {
  "startDateTime": "String"
}
    productSpecCharacteristic.productSpecCharacteristicValue.validFor.startDateTime Date et heure de début de la validité de la valeur caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    productSpecCharacteristic.productSpecCharacteristicValue.value (valeur)
    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": {
  "startDateTime": "String"
}
    productSpecCharacteristic.validFor.startDateTime Date de début de la caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    productSpecCharacteristic.valueType Type de valeur de la caractéristique, tel que choix ou e-mail.

    Type de données : chaîne
    productSpecificationRelationship les relations de cette spécification avec d’autres spécifications de produit.

    Type de données : tableau d’objets

    "productSpecificationRelationship": [
  {
    "compatibilityRelationshipType": "String",
    "id": "String",
    "internalId": "String",
    "internalVersion": "String",
    "name": "String",
    "prodSpecRelationshipOption": {Object},
    "type": "String",
    "validFor": {Object},
    "version": "String"
]
    productSpecificationRelationship.compatibilityRelationshipType Type de relation de compatibilité dans les valeurs attendues des spécifications du produit.

    Pour plus d’informations sur les relations de compatibilité, reportez-vous à la section .

    Table : Compatibles [sn_compt_mgmt_compatibles]
    productSpecificationRelationship.id Sys_id de la spécification connexe.

    Type de données : chaîne
    productSpecificationRelationship.ID interne Sys_id (ID interne) de la relation de spécifications du produit.

    Type de données : chaîne
    productSpecificationRelationship.Version interne Version de la relation de spécification de produit.

    Type de données : chaîne
    productSpecificationRelationship.Name (Nom) Nom de la relation de spécification de produit.

    Type de données : chaîne
    productSpecificationRelationship.prodSpecRelationshipOption Cardinalité de la relation de spécification du produit.

    Type de données : objet

    "prodSpecRelationshipOption": {
  "numberSpecRelDefault": "String",
  "numberSpecRelLowerLimit": "String",
  "numberSpecRelUpperLimit": "String"
}
    productSpecificationRelationship.prodSpecRelationshipOption.numberSpecRelDefault Valeur par défaut de la spécification de produit.

    Type de données : chaîne
    productSpecificationRelationship.prodSpecRelationshipOption.numberSpecRelLowerLimit Nombre minimum de commandes pouvant être achetées.

    Type de données : chaîne
    productSpecificationRelationship.prodSpecRelationshipOption.nombreSpecRelUpperLimit Nombre maximal de commandes pouvant être achetées.

    Type de données : chaîne
    productSpecificationRelationship.Type Type de relation de spécification de produit.

    Type de données : chaîne
    productSpecificationRelationship.validFor Plage de dates à laquelle la relation de spécifications du produit est valide.

    Type de données : objet

    "validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}
    productSpecificationRelationship.validFor.endDateTime Date de fin de la relation.

    Type de données : chaîne
    productSpecificationRelationship.validFor.startDateTime Date de début de la relation.

    Type de données : chaîne
    productSpecificationRelationship.version Version de la relation de spécification de produit.

    Type de données : chaîne
    Spécification de ressource 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 ID Sys_id ou 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.ID interne Version initiale (sys_id) de l’enregistrement de 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.Version interne 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) 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écifications de service [sn_prd_pm_service_specification].
    serviceSpecification.ID interne Version initiale de la spécification de service.

    Type de données : chaîne

    Table : dans le champ initial_version de la table Service Specification (Spécification de service) [sn_prd_pm_service_specification].
    serviceSpecification.Version interne 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) 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écification de service [sn_prd_pm_service_specification].
    statut État de la spécification du produit.
    Valeurs possibles :
    • brouillon
    • publié

    Type de données : chaîne
    validFor 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
    validFor.startDateTime Date de début de la spécification.

    Type de données : chaîne

    Format : JJ-MM-AAAA
    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 les deux premiers enregistrements de spécification de produit.

    curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification?limit=2" \
--header "Accept:application/json" \
--user 'username':'password'

    Corps de réponse :

    [
  {
    "id": "0435b48a742e4a10f877468e695efa3c",
    "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/0435b48a742e4a10f877468e695efa3c",
    "name": "Managed PoS PS",
    "displayName": "Managed PoS PS",
    "version": "",
    "internalVersion": "1",
    "internalId": "0435b48a742e4a10f877468e695efa3c",
    "description": "Managed PoS PS",
    "lastUpdate": "2032-09-26 20:07:12",
    "lifecycleStatus": "Active",
    "isBundle": false,
    "validFor": {
      "startDateTime": "2032-09-26",
      "endDateTime": ""
    },
    "serviceSpecification": [],
    "productSpecificationRelationship": [],
    "resourceSpecification": [],
    "productSpecCharacteristic": [
      {
        "productSpecCharacteristicValue": [
          {
            "value": "4",
            "validFor": {
              "startDateTime": ""
            },
            "isDefault": false,
            "isMandatory": true
          },
          {
            "value": "2",
            "validFor": {
              "startDateTime": ""
            },
            "isDefault": false,
            "isMandatory": true
          },
          {
            "value": "1",
            "validFor": {
              "startDateTime": ""
            },
            "isDefault": false,
            "isMandatory": true
          }
        ],
        "name": "Number of POS Terminals",
        "description": "Number of POS Terminals",
        "valueType": "choice",
        "validFor": {
          "startDatetime": "2024-05-31 21:43:14"
        }
      },
      {
        "productSpecCharacteristicValue": [
          {
            "value": "Gold",
            "validFor": {
              "startDateTime": ""
            },
            "isDefault": false,
            "isMandatory": true
          },
          {
            "value": "Bronze",
            "validFor": {
              "startDateTime": ""
            },
            "isDefault": false,
            "isMandatory": true
          },
          {
            "value": "Silver",
            "validFor": {
              "startDateTime": ""
            },
            "isDefault": false,
            "isMandatory": true
          }
        ],
        "name": "Managed Service Level",
        "description": "Managed Service Level",
        "valueType": "choice",
        "validFor": {
          "startDatetime": "2024-05-31 21:15:24"
        }
      }
    ],
    "status": "published"
  },
  {
    "id": "1a0936f840102610f87798b149fd435d",
    "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/1a0936f840102610f87798b149fd435d",
    "name": "Wi-Fi Configuration Setup Service PS",
    "displayName": "Wi-Fi Configuration Setup Service PS",
    "version": "",
    "internalVersion": "1",
    "internalId": "1a0936f840102610f87798b149fd435d",
    "description": "Wi-Fi Configuration Setup Service PS",
    "lastUpdate": "2025-03-13 21:01:14",
    "lifecycleStatus": "Active",
    "isBundle": false,
    "validFor": {
      "startDateTime": "2025-03-12",
      "endDateTime": ""
    },
    "serviceSpecification": [],
    "productSpecificationRelationship": [],
    "resourceSpecification": [],
    "productSpecCharacteristic": [],
    "status": "published"
  }
]

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

    Récupère un enregistrement de spécification de produit spécifié.

    Format d’URL

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

    Paramètres de demande pris en charge

    Tableau 61. Paramètres de chemin d’accès
    Nom Description
    ID Sys_id ou version initiale de la spécification du produit à récupérer.

    Type de données : chaîne

    Table : dans le champ sys_id ou initial_version de la table 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
    • productSpecCharacteristic
    • productSpecificationRelationship
    • Spécification de ressource
    • Spécification de service
    • validFor
    • 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é
    • Mis hors service

    Type de données : chaîne
    Tableau 63. Paramètres du corps de la demande
    Nom Description
    Aucune

    En-têtes

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

    Tableau 64. En-têtes de demandes
    En-tête Description
    Accepter Format des données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 65. En-têtes de réponses
    En-tête Description
    Type de contenu Format des 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 66. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès.
    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 réponse (JSON)

    Nom Description
    description Description de la spécification.

    Type de données : chaîne
    displayName Nom d’affichage de la spécification du produit.

    Type de données : chaîne
    externalId
    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 à l’enregistrement de ressource.

    Type de données : chaîne

    Par défaut : chaîne vide
    id ID Sys_id ou externe de la spécification du produit.

    Type de données : chaîne

    Table : dans le champ sys_id ou external_id de la table Spécification de produit [sn_prd_pm_product_specification].
    internalId
    Sys_id ou ID interne 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 indiquant s’il représente productSpecification un produit unique ou un ensemble de produits.
    Valeurs valides :
    • vrai : la spécification de produit est un lot de produits qui contient plusieurs produits.
    • faux : le cahier des charges contient un seul produit.

    Type de données : booléen

    Valeur par défaut : false
    lastUpdate Date de la dernière mise à jour de la spécification du produit.

    Type de données : chaîne
    lifecycleStatus État actuel du cycle de vie de la spécification du produit.
    Valeurs valides :
    • Actives
    • Brouillon
    • Inactif

    Type de données : chaîne

    Par défaut : chaîne vide
    nom Nom de la spécification du produit.

    Type de données : chaîne
    productSpecCharacteristic Caractéristiques des spécifications du produit.

    Type de données : tableau d’objets

    "productSpecCharacteristic": [
  {
    "description": "String",
    "name": "String",
    "productSpecCharacteristicValue": [Array],
    "validFor": {Object},
    "valueType": "String"
  }
]
    productSpecCharacteristic.Descriptif Description de la caractéristique.

    Type de données : chaîne
    productSpecCharacteristic.Name (Nom) Nom de la caractéristique.

    Type de données : chaîne
    productSpecCharacteristic.productSpecCharacteristicValue
    Liste des valeurs possibles de la caractéristique.

    Type de données : tableau d’objets

    "productSpecCharacteristicValue": [
 {
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "validFor": {Object},
    "value": "String"
 }
]
    productSpecCharacteristic.productSpecCharacteristicValue.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique.
    Valeurs possibles :
    • true : valeur par défaut.
    • false : pas la valeur par défaut.

    Valeur par défaut : false
    productSpecCharacteristic.productSpecCharacteristicValue.isMandatory Marqueur indiquant si la valeur de caractéristique associée est une valeur obligatoire pour la caractéristique.
    Valeurs possibles :
    • true : valeur obligatoire.
    • faux : valeur non obligatoire.

    Valeur par défaut : false
    productSpecCharacteristic.productSpecCharacteristicValue.validFor Date et heure de validité de la caractéristique.

    Type de données : objet

    "validFor": {
  "startDateTime": "String"
}
    productSpecCharacteristic.productSpecCharacteristicValue.validFor.startDateTime Date et heure de début de la validité de la valeur caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    productSpecCharacteristic.productSpecCharacteristicValue.value (valeur) 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": {
  "startDateTime": "String"
}
    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
    productSpecificationRelationship les relations de cette spécification avec d’autres spécifications de produit.

    Type de données : tableau d’objets

    "productSpecificationRelationship": [
  {
    "compatibilityRelationshipType": "String",
    "id": "String",
    "internalId": "String",
    "internalVersion": "String",
    "name": "String",
    "prodSpecRelationshipOption": {Object},
    "type": "String",
    "validFor": {Object},
    "version": "String"
]
    productSpecificationRelationship.compatibilityRelationshipType Type de relation de compatibilité dans les valeurs attendues des spécifications du produit.

    Pour plus d’informations sur les relations de compatibilité, reportez-vous à la section .

    Table : Compatibles [sn_compt_mgmt_compatibles]
    productSpecificationRelationship.id Sys_id de la spécification connexe.

    Type de données : chaîne
    productSpecificationRelationship.ID interne Sys_id (ID interne) de la relation de spécifications du produit.

    Type de données : chaîne
    productSpecificationRelationship.Version interne Version de la relation de spécification de produit.

    Type de données : chaîne
    productSpecificationRelationship.Name (Nom) Nom de la relation de spécification de produit.

    Type de données : chaîne
    productSpecificationRelationship.prodSpecRelationshipOption Cardinalité de la relation de spécification du produit.

    Type de données : objet

    "prodSpecRelationshipOption": {
  "numberSpecRelDefault": "String",
  "numberSpecRelLowerLimit": "String",
  "numberSpecRelUpperLimit": "String"
}
    productSpecificationRelationship.prodSpecRelationshipOption.numberSpecRelDefault Valeur par défaut de la spécification de produit.

    Type de données : chaîne
    productSpecificationRelationship.prodSpecRelationshipOption.numberSpecRelLowerLimit Nombre minimum de commandes pouvant être achetées.

    Type de données : chaîne
    productSpecificationRelationship.prodSpecRelationshipOption.nombreSpecRelUpperLimit Nombre maximal de commandes pouvant être achetées.

    Type de données : chaîne
    productSpecificationRelationship.Type Type de relation de spécification de produit.

    Type de données : chaîne
    productSpecificationRelationship.validFor Plage de dates à laquelle la relation de spécifications du produit est valide.

    Type de données : objet

    "validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}
    productSpecificationRelationship.validFor.endDateTime Date de fin de la relation.

    Type de données : chaîne
    productSpecificationRelationship.validFor.startDateTime Date de début de la relation.

    Type de données : chaîne
    productSpecificationRelationship.version Version de la relation de spécification de produit.

    Type de données : chaîne
    Spécification de ressource 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 ID Sys_id ou 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.ID interne Version initiale (sys_id) de l’enregistrement de 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.Version interne 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) 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écifications de service [sn_prd_pm_service_specification].
    serviceSpecification.ID interne Version initiale de la spécification de service.

    Type de données : chaîne

    Table : dans le champ initial_version de la table Service Specification (Spécification de service) [sn_prd_pm_service_specification].
    serviceSpecification.Version interne 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) 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écification de service [sn_prd_pm_service_specification].
    statut État de la spécification du produit.
    Valeurs possibles :
    • brouillon
    • publié

    Type de données : chaîne
    validFor 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].

    Cet exemple récupère l’enregistrement de spécification du produit spécifié.

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

    Corps de réponse :

    {
  "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
  "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/497a39a7c3d312105acc9e62b540dd14",
  "name": "SD-WAN Service Package",
  "displayName": "SD-WAN Service Package v4",
  "version": "",
  "internalVersion": "4",
  "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
  "description": "SD WAN Service Package",
  "lastUpdate": "2029-04-15 20:05:37",
  "lifecycleStatus": "Active",
  "isBundle": true,
  "validFor": {
    "startDateTime": "2033-04-15",
    "endDateTime": ""
  },
  "serviceSpecification": [],
  "productSpecificationRelationship": [
    {
      "id": "a6514bd3534560102f18ddeeff7b1247",
      "name": "SD-WAN Security",
      "version": "",
      "internalVersion": "2",
      "internalId": "a6514bd3534560102f18ddeeff7b1247",
      "type": "Service",
      "compatibilityRelationshipType": "",
      "validFor": {
        "startDateTime": "2030-09-25",
        "endDateTime": "2035-10-27"
      }
    },
    {
      "id": "39b627aa53702010cd6dddeeff7b1202",
      "name": "SD-WAN Edge Device",
      "version": "",
      "internalVersion": "2",
      "internalId": "39b627aa53702010cd6dddeeff7b1202",
      "type": "Service",
      "compatibilityRelationshipType": "",
      "validFor": {
        "startDateTime": "2030-09-27",
        "endDateTime": "2035-10-27"
      }
    },
    {
      "id": "216663aa53702010cd6dddeeff7b12b5",
      "name": "SD-WAN Controller",
      "version": "",
      "internalVersion": "2",
      "internalId": "216663aa53702010cd6dddeeff7b12b5",
      "type": "Service",
      "compatibilityRelationshipType": "",
      "validFor": {
        "startDateTime": "2029-04-03",
        "endDateTime": ""
      }
    }
  ],
  "resourceSpecification": [],
  "productSpecCharacteristic": [
    {
      "productSpecCharacteristicValue": [
        {
          "value": "0.01",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "0.25",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "0.5",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "1",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        }
      ],
      "name": "Down Time",
      "description": "Down Time",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-12-13 02:36:15"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "1 hr",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "2 hrs",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "4 hrs",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        }
      ],
      "name": "Mean Time to Restore (MTR)",
      "description": "Mean Time to Restore (MTR)",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-12-13 02:39:05"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "1 hr",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "4 hrs",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "2 hrs",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        }
      ],
      "name": "Time to Restore (TTR)",
      "description": "Time to Restore (TTR)",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-12-13 02:37:25"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "99.50",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "99.99",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "99.00",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "99.75",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        }
      ],
      "name": "Up Time",
      "description": "Up time",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-12-13 02:34:30"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "5 Gbps",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "1 Gbps",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "500 Mbps",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "2 Gbps",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        }
      ],
      "name": "Bandwidth",
      "description": "Bandwidth",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-12-13 02:32:11"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "Yes",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "No",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        }
      ],
      "name": "Application Encryption",
      "description": "Application Encryption",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2027-12-13 02:29:08"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "Yes",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        },
        {
          "value": "No",
          "validFor": {
            "startDateTime": ""
          },
          "isDefault": false,
          "isMandatory": false
        }
      ],
      "name": "Application Flow Backup",
      "description": "Application Flow Backup",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2027-12-13 02:30:39"
      }
    }
  ],
  "status": "published"
}

    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
    Aucune
    Tableau 69. Paramètres du corps de la demande
    Nom Description
    bundledGroupProductOffering Groupes enfants des offres de produits. Ceux-ci montrent des sous-groupes hiérarchiques.

    Type de données : tableau d’objets

    "bundledGroupProductOffering": [
  {
    "bundledGroupProductOfferingOption": {Object},
    "bundledProductOffering": [Array],
    "id": "String",
    "name": "String"
  }
]
    bundledGroupProductOffering.bundledGroupProductOfferingOption Plage de nombres qui spécifie les limites inférieure et supérieure du nombre d’offres de produits associée qui peuvent être achetés dans le cadre de l’offre de produits groupés connexe.

    Type de données : objet

    "bundledGroupProductOfferingOption": {
  "numberRelOfferLowerLimit": "String",
  "numberRelOfferUpperLimit": "String"
}
    bundledGroupProductOffering.bundledGroupProductOfferingOption.numberRelOfferLowerLimit Limite inférieure d’une offre de produits qui peut être achetée dans le cadre de l’offre groupée connexe.

    Type de données : chaîne
    bundledGroupProductOffering.bundledGroupProductOfferingOption.numberRelOfferUpperLimit Limite supérieure d’une offre de produits qui peut être achetée dans le cadre de l’offre groupée connexe.

    Type de données : chaîne
    bundledGroupProductOffering.bundledProductOffering Groupes enfants des offres de produits associées à l’ensemble. Même format que bundledProductOffering spécifié ci-dessous.

    Type de données : tableau d’objets
    bundledGroupProductOffering.ID Sys_id de l’enregistrement groupé. Utile dans les cas où l’offre ou le groupe de produits parents comprend plusieurs groupes.

    Type de données : chaîne

    Table : groupe de relations d’offre de produits [sn_prd_pm_product_offering_relationship_group]
    bundledGroupProductOffering.Name (Nom) Nom du groupe d’offres de produits enfants.

    Type de données : chaîne
    bundledProductOffering Liste des offres de produits incluses dans le groupe d’offres de produits. L’offre groupée de produits hérite de tous les attributs des offres de produits incluses.

    Type de données : tableau d’objets

    "bundledProductOffering": [
  {
    "bundledProductOfferingOption": {Object},
    "externalId": "String",
    "id": "String",
    "name": "String",
    "version": Number
  }
]
    bundledProductOffering.bundledProductOfferingOption Options de groupe de produits, telles que le nombre par défaut d’offres de produits et les contraintes d’approvisionnement d’offres de produits supérieures et inférieures.

    Type de données : objet

    "bundledProductOfferingOption": {
  "numberRelOfferDefault": "String",
  "numberRelOfferLowerLimit": "String",
  "numberRelOfferUpperLimit": "String"
}
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferDefault Nombre par défaut d’offres de produits à se procurer dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferLowerLimit Limite inférieure du nombre d’offres de produits associés qui peuvent être obtenus dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferUpperLimit Limite supérieure du nombre d’offres de produits associées qui peuvent être achetées dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.ID ID Sys_id ou externe de l’offre de produits groupés.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]
    bundledProductOffering.ID externe ID externe de la relation d’offre de produits.

    Pour plus d’informations sur les relations d’offre de produits, reportez-vous à la section Create product offering relationships.

    Type de données : chaîne
    bundledProductOffering.Name (Nom) Nom du groupe d’offres de produits.

    Type de données : chaîne
    bundledProductOffering.version Version du catalogue 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].
    catégorie Liste des catégories auxquelles le produit appartient.

    Type de données : tableau d’objets

    "category:" [
  {
    "id": "String",
    "name": "String"
  }
]

    Table : 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

    Table : catégorie [sc_category]
    category.name Nom de la catégorie.

    Type de données : chaîne

    Par défaut : chaîne vide
    canal Requis. Canaux à utiliser pour vendre l’offre de 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

    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

    Par défaut : chaîne vide
    description Requis. Description de l’offre de produit.

    Type de données : chaîne
    displayName Nom d’affichage de l’offre de produit.

    Type de données : chaîne
    externalId ID externe de l’offre de produit.

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

    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 Sys_id ou ID interne de l’enregistrement d’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].
    isBundle Marqueur indiquant si l’offre de produits est un lot.
    Valeurs possibles :
    • vrai : l’offre de produits est un lot.
    • faux : offre de produit unique.

    Type de données : booléen

    Valeur par défaut : false
    isSellable Marqueur indiquant si l’offre de produits associée peut être vendue seule ou si elle doit faire partie d’un ensemble d’offres de produits.
    Valeurs possibles :
    • vrai : Peut être vendu séparément.
    • faux : vendu uniquement dans le cadre d’un lot.

    Type de données : booléen

    Valeur par défaut : false
    lastUpdate Date à laquelle l’offre de produits a été mise à jour pour la dernière fois.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS

    Par défaut : chaîne vide
    lifecycleStatus État du cycle de vie actuel de l’offre de produit.
    Valeurs possibles :
    • Actives
    • Inactif
    • Brouillon

    Type de données : chaîne
    nom Requis. Nom de l’offre de produits.

    Type de données : chaîne
    prodSpecCharValueUse Caractéristiques des offres de produits.

    Type de données : tableau d’objets

    "prodSpecCharValueUse": [
   {
      "description": "String",
      "name": "String",
      "productSpecCharacteristicValue": [Array],
      "validFor": {Object},
      "valueType": "String"
   }
]
    prodSpecCharValueUse.Descriptif 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.productSpecCharacteristicValue
    Liste des valeurs possibles de la caractéristique.

    Type de données : tableau d’objets

    "productSpecCharacteristicValue": [
 {
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "validFor": {Object},
    "value": "String"
 }
]
    prodSpecCharValueUse.productSpecCharacteristicValue.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique.
    Valeurs possibles :
    • true : valeur par défaut.
    • false : pas la valeur par défaut.

    Valeur par défaut : false
    prodSpecCharValueUse.productSpecCharacteristicValue.isMandatory Marqueur indiquant si la valeur de caractéristique associée est une valeur obligatoire pour la caractéristique.
    Valeurs possibles :
    • true : valeur obligatoire.
    • faux : valeur non obligatoire.

    Valeur par défaut : false
    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 la validité de la valeur caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    prodSpecCharValueUse.productSpecCharacteristicValue.value (valeur)
    Valeur 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": {
  "startDateTime": "String"
}
    prodSpecCharValueUse.validFor.startDateTime Date de début de la caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    prodSpecCharValueUse.valueType Type de données du prodSpecCharValueUse.productSpecCharacteristicValue.value paramètre.
    Valeurs possibles :
    • choix
    • e-mail
    • Numéro
    • Texte
    • oui/non

    Type de données : chaîne
    productCharacteristic Liste des caractéristiques du produit.

    Type de données : tableau d’objets

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.name Nom de la caractéristique.

    Type de données : chaîne

    Par défaut : chaîne vide
    produitCaractéristique.valeur Valeur de la caractéristique.

    Type de données : chaîne

    Par défaut : chaîne vide
    productOfferingCharacteristic Qualité caractéristique ou caractéristique distinctive d’une offre de produits. Les caractéristiques peuvent prendre une valeur discrète qui est fixée au moment de la conception (création de catalogue), comme le classement du plan mobile. Ces caractéristiques ne sont généralement pas modifiables au niveau des stocks.

    Pour en savoir plus sur les caractéristiques des offres de produits, reportez-vous à la section Create product characteristics and characteristic options.

    Type de données : tableau d’objets

    productOfferingCharacteristic": [  
  {
    "characteristicValueSpecification": [Array],
    "name": "String",
    "valueType": "String"
  }
]
    productOfferingCharacteristic.characteristicValueSpecification Liste des valeurs de caractéristiques associées à la caractéristique d’offre de produits.

    Type de données : tableau d’objets

    "characteristicValueSpecification": [  
  { 
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "value": "String"
  }  
]
    productOfferingCharacteristic.characteristicValueSpecification.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique associée.
    Valeurs possibles :
    • true : est la valeur par défaut.
    • false : n’est pas la valeur par défaut.

    Type de données : booléen

    Valeur par défaut : false
    productOfferingCharacteristic.characteristicValueSpecification.isMandatory Marqueur indiquant si la valeur de caractéristique associée est obligatoire pour la caractéristique associée.
    Valeurs possibles :
    • true : est obligatoire.
    • false : n’est pas obligatoire.

    Type de données : booléen

    Valeur par défaut : false
    productOfferingCharacteristic.characteristicValueSpecification.value (valeur) Numéro ou texte attribué à la caractéristique de spécification de produit associée.
    Par exemple :
    "characteristicValueSpecification": [
  {
    "value": "choice 1"
  },
  {
    "value": "choice 2"
  }
]

    Type de données : chaîne
    productOfferingCharacteristic.Name (Nom) Nom de la caractéristique de l’offre de produits associée.

    Type de données : chaîne
    productOfferingCharacteristic.valueType Type de données du productOfferingCharacteristic.​characteristicValueSpecification.​value paramètre.
    Valeurs possibles :
    • choix
    • e-mail
    • Numéro
    • Texte
    • oui/non

    Type de données : chaîne
    productOfferingPrice Informations sur les prix de l’offre de produits.

    Type de données : tableau d’objets

    "productOfferingPrice": [
  {
    "price": {Object},
    "priceType": "String"
  }
]
    produitOffrePrix.prix Informations sur les prix de l’offre de produits.

    Type de données : objet

    "price": {
  "taxIncludedAmount": {Object}
}
    offreproduitPrix.prix.taxIncludedMontant Informations sur les prix de l’offre de produits.

    Type de données : objet

    "taxIncludedAmount": {
  "unit": "String",
  "value": "String"
}
    offreproduitPrix.prix.taxeMontantInclus.unité Code de devise pour le prix de l’offre de produits.

    Type de données : chaîne

    Par défaut : chaîne vide
    offreproduitPrix.prix.taxeMontantInclus.valeur Prix de l’offre de produits TTC.

    Type de données : chaîne

    Par défaut : chaîne vide
    productOfferingPrice.priceType Type d’offre de produits. Requis si le productOfferingPrice paramètre est utilisé.
    Valeurs valides :
    • nonRecurring (unique)
    • Récurrent

    Type de données : chaîne
    productOfferingTerm Durée du contrat valide pour l’offre de produit.

    Type de données : chaîne

    Par défaut : chaîne vide
    Spécification du produit Requis. Spécification du produit pour le produit.

    Type de données : objet

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "name": "String",
  "version": "String"
}
    productSpecification.id Requis. ID Sys_id ou externe de la spécification du produit.

    Type de données : chaîne

    Table : dans les champs sys_id ou external_id dans Spécification de produit [sn_prd_pm_product_specification]
    Spécification du produit.ID interne Sys_id ou ID interne de l’enregistrement de 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 du 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].
    Spécification du produit.Name (Nom) Nom de la spécification du produit.

    Type de données : chaîne

    Table : dans le champ Nom de la table Offre de produits [sn_prd_pm_product_offering].
    Spécification du produit.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].
    statut État de l’offre de produit.
    Valeurs possibles :
    • brouillon
    • publié

    Type de données : chaîne
    validFor 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/heure de fin de l’offre de produits.

    Type de données : chaîne

    Format : JJ-MM-AAAA
    validFor.startDateTime Requis. Date et heure de début de l’offre de produits.

    Type de données : chaîne

    Format : JJ-MM-AAAA
    version Version externe de l’offre de produit.

    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 du corps de réponse (JSON)

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 des données du corps de la réponse. Prend uniquement en charge application/json.
    Type de contenu Format des données du corps de la demande. Prend uniquement en charge application/json.
    Tableau 71. En-têtes de réponses
    En-tête Description
    Type de contenu Format des 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 72. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été traitée avec succès.
    400 Demande incorrecte. Un type de demande incorrect ou une demande mal formée a été détecté.
    404 Introuvable. L’élément demandé est introuvable.

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

    Nom Description
    bundledGroupProductOffering Groupes enfants des offres de produits. Ceux-ci montrent des sous-groupes hiérarchiques.

    Type de données : tableau d’objets

    "bundledGroupProductOffering": [
  {
    "bundledGroupProductOfferingOption": {Object},
    "bundledProductOffering": [Array],
    "id": "String",
    "name": "String"
  }
]
    bundledGroupProductOffering.bundledGroupProductOfferingOption Plage de nombres qui spécifie les limites inférieure et supérieure du nombre d’offres de produits associée qui peuvent être achetés dans le cadre de l’offre de produits groupés connexe.

    Type de données : objet

    "bundledGroupProductOfferingOption": {
  "numberRelOfferLowerLimit": "String",
  "numberRelOfferUpperLimit": "String"
}
    bundledGroupProductOffering.bundledGroupProductOfferingOption.numberRelOfferLowerLimit Limite inférieure d’une offre de produits qui peut être achetée dans le cadre de l’offre groupée connexe.

    Type de données : chaîne
    bundledGroupProductOffering.bundledGroupProductOfferingOption.numberRelOfferUpperLimit Limite supérieure d’une offre de produits qui peut être achetée dans le cadre de l’offre groupée connexe.

    Type de données : chaîne
    bundledGroupProductOffering.bundledProductOffering Groupes enfants des offres de produits associées à l’ensemble. Même format que bundledProductOffering spécifié ci-dessous.

    Type de données : tableau d’objets
    bundledGroupProductOffering.ID Sys_id de l’enregistrement groupé. Utile dans les cas où l’offre ou le groupe de produits parents comprend plusieurs groupes.

    Type de données : chaîne

    Table : groupe de relations d’offre de produits [sn_prd_pm_product_offering_relationship_group]
    bundledGroupProductOffering.Name (Nom) Nom du groupe d’offres de produits enfants.

    Type de données : chaîne
    bundledProductOffering Liste des offres de produits incluses dans le groupe d’offres de produits. L’offre groupée de produits hérite de tous les attributs des offres de produits incluses.

    Type de données : tableau d’objets

    "bundledProductOffering": [
  {
    "bundledProductOfferingOption": {Object},
    "externalId": "String",
    "id": "String",
    "name": "String",
    "version": Number
  }
]
    bundledProductOffering.bundledProductOfferingOption Options de groupe de produits, telles que le nombre par défaut d’offres de produits et les contraintes d’approvisionnement d’offres de produits supérieures et inférieures.

    Type de données : objet

    "bundledProductOfferingOption": {
  "numberRelOfferDefault": "String",
  "numberRelOfferLowerLimit": "String",
  "numberRelOfferUpperLimit": "String"
}
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferDefault Nombre par défaut d’offres de produits à se procurer dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferLowerLimit Limite inférieure du nombre d’offres de produits associés qui peuvent être obtenus dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferUpperLimit Limite supérieure du nombre d’offres de produits associées qui peuvent être achetées dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.ID ID Sys_id ou externe de l’offre de produits groupés.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]
    bundledProductOffering.ID externe ID externe de la relation d’offre de produits.

    Pour plus d’informations sur les relations d’offre de produits, reportez-vous à la section Create product offering relationships.

    Type de données : chaîne
    bundledProductOffering.Name (Nom) Nom du groupe d’offres de produits.

    Type de données : chaîne
    bundledProductOffering.version Version du catalogue 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].
    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
    displayName Nom d’affichage de l’offre de produit.

    Type de données : chaîne
    externalId ID externe de l’offre de produit.

    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 à l’enregistrement de ressource.

    Type de données : chaîne

    Par défaut : chaîne vide
    id Requis. Version initiale ou ID externe de l’offre de produit.

    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 Sys_id ou ID interne de l’enregistrement d’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].
    isBundle Marqueur indiquant si l’offre de produits est un lot.
    Valeurs possibles :
    • vrai : l’offre de produits est un lot.
    • faux : offre de produit unique.

    Type de données : booléen

    Valeur par défaut : false
    isSellable Marqueur indiquant si l’offre de produits associée peut être vendue seule ou si elle doit faire partie d’un ensemble d’offres de produits.
    Valeurs possibles :
    • vrai : Peut être vendu séparément.
    • faux : vendu uniquement dans le cadre d’un lot.

    Type de données : booléen

    Valeur par défaut : false
    lastUpdate Date à laquelle l’offre de produits a été mise à jour pour la dernière fois.

    Type de données : chaîne
    liftcycleStatus État actuel du cycle de vie. Valeurs acceptées :
    • Actives
    • Brouillon
    • Inactif

    Type de données : chaîne

    Par défaut : chaîne vide
    nom Nom de l’offre de produits.

    Type de données : chaîne
    prodSpecCharValueUse Caractéristiques des offres de produits.

    Type de données : tableau d’objets

    "prodSpecCharValueUse": [
   {
      "description": "String",
      "name": "String",
      "productSpecCharacteristicValue": [Array],
      "validFor": {Object},
      "valueType": "String"
   }
]
    prodSpecCharValueUse.Descriptif Description de la caractéristique.

    Type de données : chaîne
    prodSpecCharValueUse.Name (Nom)
    Nom de la caractéristique.

    Type de données : chaîne
    prodSpecCharValueUse.productSpecCharacteristicValue
    Liste des valeurs possibles de la caractéristique.

    Type de données : tableau d’objets

    "productSpecCharacteristicValue": [
 {
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "validFor": {Object},
    "value": "String"
 }
]
    prodSpecCharValueUse.productSpecCharacteristicValue.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique.
    Valeurs possibles :
    • true : valeur par défaut.
    • false : pas la valeur par défaut.

    Valeur par défaut : false
    prodSpecCharValueUse.productSpecCharacteristicValue.isMandatory Marqueur indiquant si la valeur de caractéristique associée est une valeur obligatoire pour la caractéristique.
    Valeurs possibles :
    • true : valeur obligatoire.
    • faux : valeur non obligatoire.

    Valeur par défaut : false
    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 la validité de la valeur caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    prodSpecCharValueUse.productSpecCharacteristicValue.value (valeur)
    Valeur 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": {
  "startDateTime": "String"
}
    prodSpecCharValueUse.validFor.startDateTime Date de début de la caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    prodSpecCharValueUse.valueType Type de données du prodSpecCharValueUse.productSpecCharacteristicValue.value paramètre.
    Valeurs possibles :
    • choix
    • e-mail
    • Numéro
    • Texte
    • oui/non

    Type de données : chaîne
    productCharacteristic Liste des caractéristiques du produit.

    Type de données : tableau d’objets

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.Name (Nom) Nom de la caractéristique.

    Type de données : chaîne
    productCharacteristic.value (valeur) Valeur de la caractéristique.

    Type de données : chaîne
    productOfferingCharacteristic Qualité caractéristique ou caractéristique distinctive d’une offre de produits. Les caractéristiques peuvent prendre une valeur discrète qui est fixée au moment de la conception (création de catalogue), comme le classement du plan mobile. Ces caractéristiques ne sont généralement pas modifiables au niveau des stocks.

    Pour en savoir plus sur les caractéristiques des offres de produits, reportez-vous à la section Create product characteristics and characteristic options.

    Type de données : tableau d’objets

    productOfferingCharacteristic": [  
  {
    "characteristicValueSpecification": [Array],
    "name": "String",
    "valueType": "String"
  }
]
    productOfferingCharacteristic.characteristicValueSpecification Liste des valeurs de caractéristiques associées à la caractéristique d’offre de produits.

    Type de données : tableau d’objets

    "characteristicValueSpecification": [  
  { 
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "value": "String"
  }  
]
    productOfferingCharacteristic.characteristicValueSpecification.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique associée.
    Valeurs possibles :
    • true : est la valeur par défaut.
    • false : n’est pas la valeur par défaut.

    Type de données : booléen

    Valeur par défaut : false
    productOfferingCharacteristic.characteristicValueSpecification.isMandatory Marqueur indiquant si la valeur de caractéristique associée est obligatoire pour la caractéristique associée.
    Valeurs possibles :
    • true : est obligatoire.
    • false : n’est pas obligatoire.

    Type de données : booléen

    Valeur par défaut : false
    productOfferingCharacteristic.characteristicValueSpecification.value (valeur) Numéro ou texte attribué à la caractéristique de spécification de produit associée.
    Par exemple :
    "characteristicValueSpecification": [
  {
    "value": "choice 1"
  },
  {
    "value": "choice 2"
  }
]

    Type de données : chaîne
    productOfferingCharacteristic.Name (Nom) Nom de la caractéristique de l’offre de produits associée.

    Type de données : chaîne
    productOfferingCharacteristic.valueType Type de données du productOfferingCharacteristic.​characteristicValueSpecification.​value paramètre.
    Valeurs possibles :
    • choix
    • e-mail
    • Numéro
    • Texte
    • oui/non

    Type de données : chaîne
    productOfferingPrice Informations sur les prix de l’offre de produits.

    Type de données : tableau d’objets

    "productOfferingPrice": [
  {
    "price": {Object},
    "priceType": "String"
  }
]
    productOfferingPrice.Prix Informations sur les prix de l’offre de produits.

    Type de données : objet

    "price": {
  "taxIncludedAmount": {Object}
}
    productOfferingPrice.prix.taxIncludedAmount Informations sur les prix de l’offre de produits.

    Type de données : objet

    "taxIncludedAmount": {
  "unit": "String",
  "value": "String"
}
    productOfferingPrice.prix.MontantInclus.taxe Code de devise pour le prix de l’offre de produits.

    Type de données : chaîne
    productOfferingPrice.prix.taxIncludedAmount.value (valeur) Prix de l’offre de produits TTC.

    Type de données : chaîne
    productOfferingPrice.type de prix 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 du contrat valide pour l’offre de produit.

    Type de données : chaîne
    Spécification du produit Spécification du produit pour le produit.

    Type de données : objet

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "name": "String",
  "status": "String",
  "sys_id": "String",
  "version": "String"
}
    Spécification du produit.ID Sys_id de l’enregistrement de 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 du produit.ID interne Sys_id ou ID interne de l’enregistrement de 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 du 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].
    Spécification du produit.État de État de la spécification du produit, tel que publié ou brouillon.

    Type de données : chaîne
    Spécification du produit.sys_id Sys_id de la spécification du produit.

    Type de données : chaîne

    Table : Spécification de produit [sn_prd_pm_product_specification]
    Spécification du produit.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].
    statut État de l’offre de produit.
    Valeurs possibles :
    • brouillon
    • publié

    Type de données : chaîne
    validFor 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 produit.

    Type de données : chaîne
    validFor.startDateTime Date de début de l’offre de produit.

    Type de données : chaîne
    version Version externe de l’offre de produit.

    Type de données : chaîne

    Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].

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

    curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOffering/313b917843235210a82ed6085bb8f2c7" \ 
--request PATCH\ 
--header "Accept:application/json" \ 
--user 'username':'password'
--data '{
  "id": "313b917843235210a82ed6085bb8f2c7",
  "name": "Internet bundle",
  "displayName": "Internet bundle",
  "description": "Internet bundle",
  "isSellable": false,
  "lifecycleStatus": "Draft",
  "isBundle": true,
  "lastUpdate": "2025-02-05 06:39:45",
  "version": "",
  "internalVersion": "1",
  "internalId": "313b917843235210a82ed6085bb8f2c7",
  "validFor": {
    "startDateTime": "2028-12-15",
    "endDateTime": "2034-01-14"
  },
  "productOfferingTerm": "not_applicable",
  "productOfferingPrice": [
    {
      "priceType": "recurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": "0"
        }
      }
    },
    {
      "priceType": "nonRecurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": "0"
        }
      }
    }
  ],
  "productOfferingCharacteristic": [
    {
      "name": "Firewall Security",
      "valueType": "choice",
      "characteristicValueSpecification": [
        {
          "value": "Premium",
          "isMandatory": false,
          "isDefault": true
        }
      ]
    },
    {
      "name": "Connectivity need",
      "valueType": "choice",
      "characteristicValueSpecification": [
        {
          "value": "When in use",
          "isMandatory": false,
          "isDefault": false
        }
      ]
    }
  ],
  "bundledProductOffering": [
    {
     
      "id": "0f61dd9fd0a63110f8770dbf976be168",
      "name": "Solana Sports streaming channel",
      "version": "1",
      "externalId": "EXT-123",

      "bundledProductOfferingOption": {
        "numberRelOfferDefault": "1",
        "numberRelOfferLowerLimit": "1",
        "numberRelOfferUpperLimit": "1"
      }
    }
  ],
  "bundledGroupProductOffering": [
    {
      "id": "063b957843235210a82ed6085bb8f205",
      "name": "Streaming Channel",
      "bundledProductOffering": [
        {
          "id": "62619d9fd0a63110f8770dbf976be180",
          "name": "Solana Movie streaming channel",
          "version": "1",
          "externalId": "EXT-123",
          "bundledProductOfferingOption": {
            "numberRelOfferDefault": "1",
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "bundledGroupProductOfferingOption": {
        "numberRelOfferLowerLimit": "1",
        "numberRelOfferUpperLimit": "1"
      }
    }
  ],
  "productSpecification": {
    "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
    "name": "SD-WAN Service Package",
    "version": "",
    "internalVersion": "3",
    "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
  },
  "prodSpecCharValueUse": [
    {
      "name": "Tenancy",
      "description": "Tenancy",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2024-12-18 21:04:24"
      },
      "productSpecCharacteristicValue": [
        {
          "value": "Premium (>50 sites)",
          "isDefault": false,
          "isMandatory": false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Base (10 site)",
          "isDefault": false,
          "isMandatory": false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "productSpecification": {
        "id": "216663aa53702010cd6dddeeff7b12b5",
        "name": "SD-WAN Controller",
        "version": "",
        "internalVersion": "1",
        "internalId": "216663aa53702010cd6dddeeff7b12b5"
      }
    }
  ],
  "channel": [
    {
      "id": "58ad5522c3702010df4773ce3640ddb2",
      "name": "Agent Assist"
    }
  ],
  "category": [
    {
      "id": "13e305a143b631105029d1529ab8f267",
      "name": "SD-WAN_all_offers"
    }
  ],
  "status": "draft"
}'

    Corps de réponse :

    {
  "id": "313b917843235210a82ed6085bb8f2c7",
  "href": "/api/sn_tmf_api/catalogmanagement/productOffering/313b917843235210a82ed6085bb8f2c7",
 "name": "Internet",
  "displayName": "Internet",
  "description": "Internet bundle",
  "isSellable": false,
  "lifecycleStatus": "Draft",
  "isBundle": true,
  "lastUpdate": "2025-02-05 06:39:45",
  "version": "",
  "internalVersion": "1",
  "internalId": "313b917843235210a82ed6085bb8f2c7",
  "validFor": {
    "startDateTime": "2028-12-15",
    "endDateTime": "2034-01-14"
  },
  "productOfferingTerm": "not_applicable",
  "productOfferingPrice": [
    {
      "priceType": "recurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": "0"
        }
      }
    },
    {
      "priceType": "nonRecurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": "0"
        }
      }
    }
  ],
  "productOfferingCharacteristic": [
    {
      "name": "Firewall Security",
      "valueType": "choice",
      "characteristicValueSpecification": [
        {
          "value": "Premium",
          "isMandatory": false,
          "isDefault": true
        }
      ]
    },
    {
      "name": "Connectivity need",
      "valueType": "choice",
      "characteristicValueSpecification": [
        {
          "value": "When in use",
          "isMandatory": false,
          "isDefault": false
        }
      ]
    }
  ],
  "bundledProductOffering": [
    {
            "id": "0f61dd9fd0a63110f8770dbf976be168",
      "name": "Solana Sports streaming channel",
      "version": "1",
      "externalId": "EXT-123",
      "bundledProductOfferingOption": {
        "numberRelOfferDefault": "1",
        "numberRelOfferLowerLimit": "1",
        "numberRelOfferUpperLimit": "1"
      }
    },
    {
      "id": "0f61dd9fd0a63110f8770dbf976be16c",
      "name": "Solana TV shows streaming channel",
      "version": "1",
      "externalId": "EXT-456",

      "bundledProductOfferingOption": {
        "numberRelOfferDefault": "1",
        "numberRelOfferLowerLimit": "1",
        "numberRelOfferUpperLimit": "1"
      }
    }
  ],
  "bundledGroupProductOffering": [
    {
      "id": "063b957843235210a82ed6085bb8f205",
      "name": "Streaming Channel",
      "bundledProductOffering": [
        {
          
          "name": "Internet",
          "version": "1",
          "externalId": "EXT-678",
          "bundledProductOfferingOption": {
            "numberRelOfferDefault": "1",
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "bundledGroupProductOfferingOption": {
        "numberRelOfferLowerLimit": "1",
        "numberRelOfferUpperLimit": "3"
      }
    },
    {
      "id": "313b917843235210a82ed6085bb8f2c7",
      "name": "Streaming Channel",
      "bundledProductOffering": [
        {
          "id": "1161a4f8436b1210a82ed6085bb8f216",
          "name": "Internet",
          "version": "1",
          "externalId": "EXT-910",
          "bundledProductOfferingOption": {
            "numberRelOfferDefault": "1",
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "bundledGroupProductOfferingOption": {
        "numberRelOfferLowerLimit": "1",
        "numberRelOfferUpperLimit": "1"
      }
    }
  ],
  "productSpecification": {
    "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
    "name": "SD-WAN Service Package",
    "version": "",
    "internalVersion": "3",
    "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
  },
  "prodSpecCharValueUse": [
    {
      "name": "Tenancy",
      "description": "Tenancy",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2024-12-18 21:04:24"
      },
      "productSpecCharacteristicValue": [
        {
          "value": "Premium (>50 sites)",
          "isDefault": false,
          "isMandatory": false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Advance (50 site)",
          "isDefault": false,
          "isMandatory": false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Base (10 site)",
          "isDefault": false,
          "isMandatory": false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "productSpecification": {
        "id": "216663aa53702010cd6dddeeff7b12b5",
        "name": "SD-WAN Controller",
        "version": "",
        "internalVersion": "1",
        "internalId": "216663aa53702010cd6dddeeff7b12b5"
      }
    }
  ],
  "channel": [
    {
      "id": "58ad5522c3702010df4773ce3640ddb2",
      "name": "Agent Assist"
    }
  ],
  "category": [
    {
      "id": "13e305a143b631105029d1529ab8f267",
      "name": "SD-WAN_all_offers"
    }
  ],
  "status": "draft"
}

    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 des prix [sn_csm_pricing_price_list_line]

    Type de données : chaîne
    Tableau 74. Paramètres de requête
    Nom Description
    Aucune
    Tableau 75. Paramètres du corps de la 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éen

    Valeur par défaut : false
    lastUpdate Requis. Date de dernière mise à jour de la ligne de prix.

    Format : JJ-MM-AAAA

    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 pour donner la ligne de la liste de prix.

    Type de données : chaîne
    price Requis. Détails de prix catalogue de la ligne de liste des 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 des prix.

    Table : Lignes de liste des 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
    type de prix Requis. Filtrez la ligne de liste de prix en fonction de la 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 supplémentaires 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
    productOffering.Version interne Numéro de version interne de l’offre de produits.

    Type de données : chaîne (représentée par un nombre. Par exemple, « 1 ».)
    productOffering.Name (Nom) 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 :
    • Jour et mois de l
    • 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é de mesure.calculer le montant de Montant de l’unité de mesure.

    Type de données : nombre
    unité de mesure.ID Requis. Sys_id de l’unité de mesure dans la table Liste des lignes de prix.

    Table : ligne de liste de prix [sn_csm_pricing_price_list_line]

    Type de données : chaîne
    unité de mesure.Unités Type de l’unité de mesure associée à la ligne de liste des prix. Par exemple, chacun ou lot.

    Type de données : chaîne
    validFor 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 pour 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 : AAAA-MM-JJ HH :mm :ss

    Type de données : chaîne (glide_date)
    validFor.startDate Date de début pour laquelle la ligne de liste de prix est valide.

    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 : AAAA-MM-JJ 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 uniquement à cette action HTTP 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 des 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 des 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é traitée avec succès.
    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 réponse (JSON ou XML)

    Nom Description
    id Sys_id de la ligne de liste des prix.

    Table : Lignes de liste des prix [sn_csm_pricing_price_list_line]

    Type de données : chaîne
    href URL de l’enregistrement de 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 : AAAA-MM-JJ HH :mm :ss

    Type de données : chaîne
    validFor 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éen
    lifecycleStatus État du cycle de vie actuel de la ligne de liste de prix.
    Valeurs valides :
    • Actives
    • 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 produits [sn_prd_pm_product_offering].

    Type de données : chaîne
    productOffering.Version interne Numéro de version interne de l’offre de produits. Par exemple, PRDOF01024. Situé dans la table Offre de produits [sn_prd_pm_product_offering].

    Type de données : chaîne
    productOffering.Name (Nom) Nom de l’offre de produits. Situé dans la table Offre de produits [sn_prd_pm_product_offering].

    Type de données : chaîne
    type de prix Méthode de tarification de l’offre de produit 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 de recurringChargePeriodType indique la fréquence de la facturation.
    • one_time : 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 s’il priceType a été défini sur Récurrent, sinon renvoie une chaîne vide.
    Valeurs possibles :
    • Jour et mois de l
    • 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 Montant de l’unité de mesure.

    Type de données : nombre
    unitOfMeasure.id Sys_id de l’unité de mesure.

    Table : Lignes de liste des prix [sn_csm_pricing_price_list_line]

    Type de données : chaîne
    unité de mesure.Unités Type de l’unité de mesure associée à la ligne de liste des prix. Par exemple, année ou ensemble.

    Type de données : chaîne
    price Détails de prix catalogue de la ligne de liste des 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 3jdd0... 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 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

    Table : Spécification de produit [sn_prd_pm_product_specification]
    Tableau 80. Paramètres de requête
    Nom Description
    Aucune
    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 ID Sys_id ou externe de la spécification du produit.

    Type de données : chaîne

    Table : dans le champ sys_id ou external_id de la table Spécification de produit [sn_prd_pm_product_specification].
    internalId Requis.
    Sys_id ou ID interne 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 indiquant s’il représente productSpecification un produit unique ou un ensemble de produits.
    Valeurs valides :
    • vrai : la spécification de produit est un lot de produits qui contient plusieurs produits.
    • faux : le cahier des charges contient un seul produit.

    Type de données : booléen

    Valeur par défaut : false
    lastUpdate Date de dernière mise à jour de la spécification.

    Type de données : chaîne

    Par défaut : chaîne vide
    nom Requis. Nom de la spécification.

    Type de données : chaîne
    productSpecCharacteristic Caractéristique de spécification.

    Type de données : tableau d’objets

    "productSpecCharacteristic": [
  {
    "description": "String",
    "name": "String",
    "productSpecCharacteristicValue": [Array],
    "validFor": {Object},
    "valueType": "String"
  }
]
    productSpecCharacteristic.Descriptif Description de la caractéristique.

    Type de données : chaîne
    productSpecCharacteristic.Name (Nom) Requis. Nom de la caractéristique.

    Type de données : chaîne
    productSpecCharacteristic.productSpecCharacteristicValue
    Liste des valeurs possibles de la caractéristique.

    Type de données : tableau d’objets

    "productSpecCharacteristicValue": [
 {
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "validFor": {Object},
    "value": "String"
 }
]
    productSpecCharacteristic.productSpecCharacteristicValue.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique.
    Valeurs possibles :
    • true : valeur par défaut.
    • false : pas la valeur par défaut.

    Valeur par défaut : false
    productSpecCharacteristic.productSpecCharacteristicValue.isMandatory Marqueur indiquant si la valeur de caractéristique associée est une valeur obligatoire pour la caractéristique.
    Valeurs possibles :
    • true : valeur obligatoire.
    • faux : valeur non obligatoire.

    Valeur par défaut : false
    productSpecCharacteristic.productSpecCharacteristicValue.validFor Date et heure de validité de la caractéristique.

    Type de données : objet

    "validFor": {
  "startDateTime": "String"
}
    productSpecCharacteristic.productSpecCharacteristicValue.validFor.startDateTime Date et heure de début de la validité de la valeur caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    productSpecCharacteristic.productSpecCharacteristicValue.value (valeur)
    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 et heure de fin de la caractéristique.

    Format : AAAA-MM-JJ HH :mm :SS. 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 : AAAA-MM-JJ HH :mm :SS. 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
    productSpecificationRelationship Détails des relations de la spécification avec d’autres spécifications du produit.

    Type de données : tableau d’objets

    "productSpecificationRelationship": [
  {
    "id": "String",
    "type": "String",
    "validFor": {Object}
  }
]
    productSpecificationRelationship.ID ID de la spécification connexe.

    Type de données : chaîne
    productSpecificationRelationship.Type Requis si le productSpecificationRelationship paramètre est utilisé. Type de relation.
    Valeurs valides :
    • Offres groupées
    • composed_of

    Type de données : chaîne
    productSpecificationRelationship.validFor Plage de dates pour laquelle la relation est valide.

    Type de données : objet

    "validFor": {
  "endDateTime": "String",
  "startDateTime": "String"
}
    productSpecificationRelationship.validFor.endDateTime Date de fin de la relation.

    Format : AAAA-MM-JJ HH :mm :SS. Par exemple, 2025-01-31 09:35:43.

    Type de données : chaîne
    productSpecificationRelationship.validFor.startDateTime Date de début de la relation.

    Format : AAAA-MM-JJ 00:00:00. Par exemple, 2025-01-31 09:35:43.

    Type de données : chaîne
    Spécification de ressource 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.ID interne Version initiale (sys_id) de l’enregistrement de 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.Version interne 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) 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écifications de service [sn_prd_pm_service_specification].
    serviceSpecification.ID interne Version initiale de la spécification de service.

    Type de données : chaîne

    Table : dans le champ initial_version de la table Service Specification (Spécification de service) [sn_prd_pm_service_specification].
    serviceSpecification.Version interne 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) 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écification de service [sn_prd_pm_service_specification].
    validFor 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 : AAAA-MM-JJ 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 : AAAA-MM-JJ 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 uniquement à cette action HTTP 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 des données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 83. En-têtes de réponses
    En-tête Description
    Type de contenu Format des 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 du champ>
    404 Introuvable. L’élément demandé est introuvable.

    Paramètres du corps de réponse

    Nom Description
    description Description de la spécification.

    Type de données : chaîne
    href Lien relatif à l’enregistrement de ressource.

    Type de données : chaîne
    id ID Sys_id ou externe de la spécification du produit.

    Type de données : chaîne

    Table : dans le champ sys_id ou external_id de la table Spécification de produit [sn_prd_pm_product_specification].
    internalId Requis.
    Sys_id ou ID interne 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 : AAAA-MM-JJ 00:00:00.

    Type de données : chaîne
    nom Nom de la spécification.

    Type de données : chaîne
    productSpecCharacteristic 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.Descriptif Description de la caractéristique.

    Type de données : chaîne
    productSpecCharacteristic.Name (Nom) Nom de la caractéristique.

    Type de données : chaîne
    productSpecCharacteristic.productSpecCharacteristicValue
    Liste des valeurs possibles de la caractéristique.

    Type de données : tableau d’objets

    "productSpecCharacteristicValue": [
 {
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "validFor": {Object},
    "value": "String"
 }
]
    productSpecCharacteristic.productSpecCharacteristicValue.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique.
    Valeurs possibles :
    • true : valeur par défaut.
    • false : pas la valeur par défaut.

    Valeur par défaut : false
    productSpecCharacteristic.productSpecCharacteristicValue.isMandatory Marqueur indiquant si la valeur de caractéristique associée est une valeur obligatoire pour la caractéristique.
    Valeurs possibles :
    • true : valeur obligatoire.
    • faux : valeur non obligatoire.

    Valeur par défaut : false
    productSpecCharacteristic.productSpecCharacteristicValue.validFor Date et heure de validité de la caractéristique.

    Type de données : objet

    "validFor": {
  "startDateTime": "String"
}
    productSpecCharacteristic.productSpecCharacteristicValue.validFor.startDateTime Date et heure de début de la validité de la valeur caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    productSpecCharacteristic.productSpecCharacteristicValue.value (valeur)
    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 et heure de fin de la caractéristique.

    Format : AAAA-MM-JJ 00:00:00.

    Type de données : chaîne
    productSpecCharacteristic.validFor.startDateTime Date et heure de début de la caractéristique.

    Format : AAAA-MM-JJ 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
    productSpecificationRelationship les 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"
}
    productSpecificationRelationship.validFor.endDateTime Date de fin et type de relation.

    Format : JJ-MM-AAAA

    Type de données : chaîne
    productSpecificationRelationship.validFor.startDateTime Date de début et type de relation.

    Format : JJ-MM-AAAA

    Type de données : chaîne
    Spécification de ressource 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 ID Sys_id ou 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.ID interne Version initiale (sys_id) de l’enregistrement de 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.Version interne 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) 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écifications de service [sn_prd_pm_service_specification].
    serviceSpecification.ID interne Version initiale de la spécification de service.

    Type de données : chaîne

    Table : dans le champ initial_version de la table Service Specification (Spécification de service) [sn_prd_pm_service_specification].
    serviceSpecification.Version interne 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) 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écification de service [sn_prd_pm_service_specification].
    validFor 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 : AAAA-MM-JJ HH :mm :SS.

    Type de données : chaîne
    validFor.startDateTime Date et heure de début de la spécification.

    Format : AAAA-MM-JJ HH :mm :SS.

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

    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": "cfe5ef6a53702010cd6dddeeff7b12f6",
  "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
  "name": "SD-WAN Service Package",
  "displayName": "SD-WAN Service Package v3",
  "version": "",
  "internalVersion": "3",
  "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
  "description": "SD WAN Service Package",
  "lastUpdate": "2027-10-11 06:58:12",
  "isBundle": true,
  "validFor": {
    "startDateTime": "2029-02-05",
    "endDateTime": ""
  },
  "serviceSpecification": [],
  "productSpecificationRelationship": [
    {
      "id": "216663aa53702010cd6dddeeff7b12b5",
      "name": "SD-WAN Controller",
      "version": "",
      "internalVersion": "1",
      "internalId": "216663aa53702010cd6dddeeff7b12b5",
      "type": "Service",
      "validFor": {
        "startDateTime": "2025-01-24",
        "endDateTime": ""
      },
      "relationshipType": "bundles",
      "ProdSpecRelationshipOption": {
        "numberSpecRelLowerLimit": "1",
        "numberSpecRelDefault": "1",
        "numberSpecRelUpperLimit": "1"
      }
    },
    {
      "id": "39b627aa53702010cd6dddeeff7b1202",
      "name": "SD-WAN Edge Device",
      "version": "",
      "internalVersion": "2",
      "internalId": "39b627aa53702010cd6dddeeff7b1202",
      "type": "Service",
      "validFor": {
        "startDateTime": "2026-06-05",
        "endDateTime": "2031-07-05"
      },
      "relationshipType": "bundles",
      "ProdSpecRelationshipOption": {
        "numberSpecRelLowerLimit": "1",
        "numberSpecRelDefault": "2",
        "numberSpecRelUpperLimit": "4"
      }
    },
    {
      "id": "a6514bd3534560102f18ddeeff7b1247",
      "name": "SD-WAN Security",
      "version": "",
      "internalVersion": "2",
      "internalId": "a6514bd3534560102f18ddeeff7b1247",
      "type": "Service",
      "validFor": {
        "startDateTime": "2026-06-03",
        "endDateTime": "2031-07-05"
      },
      "relationshipType": "bundles",
      "ProdSpecRelationshipOption": {
        "numberSpecRelLowerLimit": "1",
        "numberSpecRelDefault": "4",
        "numberSpecRelUpperLimit": "20"
      }
    }
  ],
  "resourceSpecification": [],
  "productSpecCharacteristic": [
    {
      "productSpecCharacteristicValue": [
        {
          "value": "1",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "0.25",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "0.01",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "0.5",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Down Time",
      "description": "Down Time",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:36:15"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "500 Mbps",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 Gbps",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "5 Gbps",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "1 Gbps",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Bandwidth",
      "description": "Bandwidth",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:32:11"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "4 hrs",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 hrs",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "1 hr",
          "isMandatory":false,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Time to Restore (TTR)",
      "description": "Time to Restore (TTR)",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:37:25"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "1 hr",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 hrs",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "4 hrs",
          "isMandatory":false,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Mean Time to Restore (MTR)",
      "description": "Mean Time to Restore (MTR)",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:39:05"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "No",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Yes",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Application Flow Backup",
      "description": "Application Flow Backup",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2027-10-11 02:30:39"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "99.00",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "99.50",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "99.75",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "99.99",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Up Time",
      "description": "Up time",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:34:30"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "No",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Yes",
          "isMandatory":false,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Application Encryption",
      "description": "Application Encryption",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2027-10-11 02:29:08"
      }
    }
  ],
  "status": "published"
}'

    Corps de réponse :

    { 
  "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
  "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
  "name": "SD-WAN Service Package",
  "displayName": "SD-WAN Service Package v3",
  "version": "",
  "internalVersion": "3",
  "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
  "description": "SD WAN Service Package",
  "lastUpdate": "2027-10-11 06:58:12",
  "isBundle": true,
  "validFor": {
    "startDateTime": "2029-02-05",
    "endDateTime": ""
  },
  "serviceSpecification": [],
  "productSpecificationRelationship": [
    {
      "id": "216663aa53702010cd6dddeeff7b12b5",
      "name": "SD-WAN Controller",
      "version": "",
      "internalVersion": "1",
      "internalId": "216663aa53702010cd6dddeeff7b12b5",
      "type": "Service",
      "validFor": {
        "startDateTime": "2025-01-24",
        "endDateTime": ""
      },
      "relationshipType": "bundles",
      "ProdSpecRelationshipOption": {
        "numberSpecRelLowerLimit": "1",
        "numberSpecRelDefault": "1",
        "numberSpecRelUpperLimit": "1"
      }
    },
    {
      "id": "39b627aa53702010cd6dddeeff7b1202",
      "name": "SD-WAN Edge Device",
      "version": "",
      "internalVersion": "2",
      "internalId": "39b627aa53702010cd6dddeeff7b1202",
      "type": "Service",
      "validFor": {
        "startDateTime": "2026-06-05",
        "endDateTime": "2031-07-05"
      },
      "relationshipType": "bundles",
      "ProdSpecRelationshipOption": {
        "numberSpecRelLowerLimit": "1",
        "numberSpecRelDefault": "2",
        "numberSpecRelUpperLimit": "4"
      }
    },
    {
      "id": "a6514bd3534560102f18ddeeff7b1247",
      "name": "SD-WAN Security",
      "version": "",
      "internalVersion": "2",
      "internalId": "a6514bd3534560102f18ddeeff7b1247",
      "type": "Service",
      "validFor": {
        "startDateTime": "2026-06-03",
        "endDateTime": "2031-07-05"
      },
      "relationshipType": "bundles",
      "ProdSpecRelationshipOption": {
        "numberSpecRelLowerLimit": "1",
        "numberSpecRelDefault": "4",
        "numberSpecRelUpperLimit": "20"
      }
    }
  ],
  "resourceSpecification": [],
  "productSpecCharacteristic": [
    {
      "productSpecCharacteristicValue": [
        {
          "value": "1",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "0.25",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "0.01",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "0.5",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Down Time",
      "description": "Down Time",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:36:15"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "500 Mbps",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 Gbps",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "5 Gbps",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "1 Gbps",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Bandwidth",
      "description": "Bandwidth",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:32:11"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "4 hrs",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 hrs",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "1 hr",
          "isMandatory":false,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Time to Restore (TTR)",
      "description": "Time to Restore (TTR)",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:37:25"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "1 hr",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 hrs",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "4 hrs",
          "isMandatory":false,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Mean Time to Restore (MTR)",
      "description": "Mean Time to Restore (MTR)",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:39:05"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "No",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Yes",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Application Flow Backup",
      "description": "Application Flow Backup",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2027-10-11 02:30:39"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "99.00",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "99.50",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "99.75",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "99.99",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Up Time",
      "description": "Up time",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:34:30"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "No",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Yes",
          "isMandatory":false,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Application Encryption",
      "description": "Application Encryption",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2027-10-11 02:29:08"
      }
    }
  ],
  "status": "published"
}'

    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
    Aucune
    Tableau 86. Paramètres de requête
    Nom Description
    Aucune
    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

    Par défaut : chaîne vide
    externalId Identificateur unique du catalogue d’offres de produits du système externe.

    Type de données : chaîne

    Par défaut : chaîne vide
    nom Requis. Nom du catalogue d’offres de produits.

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 des données du corps de la réponse. Prend uniquement en charge application/json.
    Type de contenu Format des 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 des 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. Cela peut être l’une des raisons suivantes :
    • Charge utile vide.
    • Charge utile non valide. Champ obligatoire manquant : <nom du champ>

    Paramètres du 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 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 et des offres groupées de produits connexes.

    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
    Aucune
    Tableau 92. Paramètres de requête
    Nom Description
    Aucune
    Tableau 93. Paramètres du corps de la demande (JSON)
    Nom Description
    bundledGroupProductOffering Groupes enfants des offres de produits. Ceux-ci montrent des sous-groupes hiérarchiques.

    Type de données : tableau d’objets

    "bundledGroupProductOffering": [
  {
    "bundledGroupProductOfferingOption": {Object},
    "bundledProductOffering": [Array],
    "id": "String",
    "name": "String"
  }
]
    bundledGroupProductOffering.bundledGroupProductOfferingOption Plage de nombres qui spécifie les limites inférieure et supérieure du nombre d’offres de produits associée qui peuvent être achetés dans le cadre de l’offre de produits groupés connexe.

    Type de données : objet

    "bundledGroupProductOfferingOption": {
  "numberRelOfferLowerLimit": "String",
  "numberRelOfferUpperLimit": "String"
}
    bundledGroupProductOffering.bundledGroupProductOfferingOption.numberRelOfferLowerLimit Limite inférieure d’une offre de produits qui peut être achetée dans le cadre de l’offre groupée connexe.

    Type de données : chaîne
    bundledGroupProductOffering.bundledGroupProductOfferingOption.numberRelOfferUpperLimit Limite supérieure d’une offre de produits qui peut être achetée dans le cadre de l’offre groupée connexe.

    Type de données : chaîne
    bundledGroupProductOffering.bundledProductOffering Groupes enfants des offres de produits associées à l’ensemble. Même format que bundledProductOffering spécifié ci-dessous.

    Type de données : tableau d’objets
    bundledGroupProductOffering.ID Sys_id de l’enregistrement groupé. Utile dans les cas où l’offre ou le groupe de produits parents comprend plusieurs groupes.

    Type de données : chaîne

    Table : groupe de relations d’offre de produits [sn_prd_pm_product_offering_relationship_group]
    bundledGroupProductOffering.Name (Nom) Nom du groupe d’offres de produits enfants.

    Type de données : chaîne
    bundledProductOffering Liste des offres de produits incluses dans le groupe d’offres de produits. L’offre groupée de produits hérite de tous les attributs des offres de produits incluses.

    Type de données : tableau d’objets

    "bundledProductOffering": [
  {
    "bundledProductOfferingOption": {Object},
    "externalId": "String",
    "id": "String",
    "name": "String",
    "version": Number
  }
]
    bundledProductOffering.bundledProductOfferingOption Options de groupe de produits, telles que le nombre par défaut d’offres de produits et les contraintes d’approvisionnement d’offres de produits supérieures et inférieures.

    Type de données : objet

    "bundledProductOfferingOption": {
  "numberRelOfferDefault": "String",
  "numberRelOfferLowerLimit": "String",
  "numberRelOfferUpperLimit": "String"
}
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferDefault Nombre par défaut d’offres de produits à se procurer dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferLowerLimit Limite inférieure du nombre d’offres de produits associés qui peuvent être obtenus dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferUpperLimit Limite supérieure du nombre d’offres de produits associées qui peuvent être achetées dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.ID externe ID externe de la relation d’offre de produits.

    Pour plus d’informations sur les relations d’offre de produits, reportez-vous à la section Create product offering relationships.

    Type de données : chaîne
    bundledProductOffering.ID ID Sys_id ou externe de l’offre de produits groupés.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]
    bundledProductOffering.Name (Nom) Nom du groupe d’offres de produits.

    Type de données : chaîne
    bundledProductOffering.version Version du catalogue 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].
    catégorie Liste des catégories auxquelles le produit appartient.

    Type de données : tableau d’objets

    "category:" [
  {
    "id": "String",
    "name": "String"
  }
]
    category.id Requis si le category paramètre est utilisé. ID de la catégorie.

    Type de données : chaîne

    Table : catégorie [sc_category]
    category.name Nom de la catégorie.

    Type de données : chaîne

    Table : catégorie [sc_category]
    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
    displayName Nom d’affichage de l’offre de produit.

    Type de données : chaîne
    externalId Identificateur unique de l’offre de produit provenant du système externe.

    Type de données : chaîne
    href Lien relatif à l’enregistrement de ressource.

    Type de données : chaîne
    id Requis. Version initiale ou ID externe de l’offre de produit.

    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 Sys_id ou ID interne de l’enregistrement d’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].
    isBundle Marqueur indiquant si l’offre de produits est un lot.
    Valeurs possibles :
    • vrai : l’offre de produits est un lot.
    • faux : offre de produit unique.

    Type de données : booléen

    Valeur par défaut : false
    isSellable Marqueur indiquant si l’offre de produits associée peut être vendue seule ou si elle doit faire partie d’un ensemble d’offres de produits.
    Valeurs possibles :
    • vrai : Peut être vendu séparément.
    • faux : vendu uniquement dans le cadre d’un lot.

    Type de données : booléen

    Valeur par défaut : false
    lastUpdate Date à laquelle l’offre de produits a été mise à jour pour la dernière fois.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    lifecycleStatus État actuel du cycle de vie.
    Valeurs valides :
    • Actives
    • Brouillon
    • Inactif

    Type de données : chaîne
    nom Requis. Nom de l’offre de produits.

    Type de données : chaîne
    prodSpecCharValueUse Caractéristiques des offres de produits.

    Type de données : tableau d’objets

    "prodSpecCharValueUse": [
   {
      "description": "String",
      "name": "String",
      "productSpecCharacteristicValue": [Array],
      "validFor": {Object},
      "valueType": "String"
   }
]
    prodSpecCharValueUse.Descriptif Description de la caractéristique.

    Type de données : chaîne
    prodSpecCharValueUse.Name (Nom)
    Nom de la caractéristique.

    Type de données : chaîne
    prodSpecCharValueUse.productSpecCharacteristicValue
    Liste des valeurs possibles de la caractéristique.

    Type de données : tableau d’objets

    "productSpecCharacteristicValue": [
 {
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "validFor": {Object},
    "value": "String"
 }
]
    prodSpecCharValueUse.productSpecCharacteristicValue.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique.
    Valeurs possibles :
    • true : valeur par défaut.
    • false : pas la valeur par défaut.

    Valeur par défaut : false
    prodSpecCharValueUse.productSpecCharacteristicValue.isMandatory Marqueur indiquant si la valeur de caractéristique associée est une valeur obligatoire pour la caractéristique.
    Valeurs possibles :
    • true : valeur obligatoire.
    • faux : valeur non obligatoire.

    Valeur par défaut : false
    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 la validité de la valeur caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    prodSpecCharValueUse.productSpecCharacteristicValue.value (valeur)
    Valeur 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": {
  "startDateTime": "String"
}
    prodSpecCharValueUse.validFor.startDateTime Date de début de la caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    prodSpecCharValueUse.valueType Type de données du prodSpecCharValueUse.productSpecCharacteristicValue.value paramètre.
    Valeurs possibles :
    • choix
    • e-mail
    • Numéro
    • Texte
    • oui/non

    Type de données : chaîne
    productCharacteristic 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
    produitCaractéristique.valeur Valeur de la caractéristique.

    Type de données : chaîne
    productOfferingCharacteristic Qualité caractéristique ou caractéristique distinctive d’une offre de produits. Les caractéristiques peuvent prendre une valeur discrète qui est fixée au moment de la conception (création de catalogue), comme le classement du plan mobile. Ces caractéristiques ne sont généralement pas modifiables au niveau des stocks.

    Pour en savoir plus sur les caractéristiques des offres de produits, reportez-vous à la section Create product characteristics and characteristic options.

    Type de données : tableau d’objets

    productOfferingCharacteristic": [  
  {
    "characteristicValueSpecification": [Array],
    "name": "String",
    "valueType": "String"
  }
]
    productOfferingCharacteristic.characteristicValueSpecification Liste des valeurs de caractéristiques associées à la caractéristique d’offre de produits.

    Type de données : tableau d’objets

    "characteristicValueSpecification": [  
  { 
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "value": "String"
  }  
]
    productOfferingCharacteristic.characteristicValueSpecification.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique associée.
    Valeurs possibles :
    • true : est la valeur par défaut.
    • false : n’est pas la valeur par défaut.

    Type de données : booléen

    Valeur par défaut : false
    productOfferingCharacteristic.characteristicValueSpecification.isMandatory Marqueur indiquant si la valeur de caractéristique associée est obligatoire pour la caractéristique associée.
    Valeurs possibles :
    • true : est obligatoire.
    • false : n’est pas obligatoire.

    Type de données : booléen

    Valeur par défaut : false
    productOfferingCharacteristic.characteristicValueSpecification.value (valeur) Numéro ou texte attribué à la caractéristique de spécification de produit associée.
    Par exemple :
    "characteristicValueSpecification": [
  {
    "value": "choice 1"
  },
  {
    "value": "choice 2"
  }
]

    Type de données : chaîne
    productOfferingCharacteristic.Name (Nom) Nom de la caractéristique de l’offre de produits associée.

    Type de données : chaîne
    productOfferingCharacteristic.valueType Type de données du productOfferingCharacteristic.​characteristicValueSpecification.​value paramètre.
    Valeurs possibles :
    • choix
    • e-mail
    • Numéro
    • Texte
    • oui/non

    Type de données : chaîne
    productOfferingPrice Informations sur les prix de l’offre de produits.

    Type de données : tableau d’objets

    "productOfferingPrice": [
  {
    "price": {Object},
    "priceType": "String"
  }
]
    produitOffrePrix.prix Informations sur les prix de l’offre de produits.

    Type de données : objet

    "price": {
  "taxIncludedAmount": {Object}
}
    offreproduitPrix.prix.taxIncludedMontant Informations sur les prix de l’offre de produits.

    Type de données : objet

    "taxIncludedAmount": {
  "unit": "String",
  "value": "String"
}
    offreproduitPrix.prix.taxeMontantInclus.unité Code de devise pour le prix de l’offre de produits.

    Type de données : chaîne

    Format : ISO 4217
    offreproduitPrix.prix.taxeMontantInclus.valeur 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 produit, par exemple 12 mois, 24 mois ou not_applicable.

    Type de données : chaîne
    Spécification du produit Requis. Spécification du produit pour le produit.

    Type de données : objet

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "name"
  "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].
    Spécification du produit.ID interne Sys_id ou ID interne de l’enregistrement de 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 du 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].
    Spécification du produit.Name (Nom) Nom de la spécification du produit.

    Type de données : chaîne

    Table : dans le champ Nom de la table Offre de produits [sn_prd_pm_product_offering].
    Spécification du produit.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].
    validFor 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 produit.

    Type de données : chaîne

    Format : JJ-MM-AAAA
    validFor.startDateTime Date de début de l’offre de produit.

    Type de données : chaîne

    Format : JJ-MM-AAAA
    version Version externe de l’offre de produit.

    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 uniquement à cette action HTTP 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 des données du corps de la réponse. Prend uniquement en charge application/json.
    Type de contenu Format des 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 des 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 96. Codes d'état
    Code d'état Description
    201 Réussi. La demande a été traitée avec succès.
    400 Demande incorrecte. Raisons possibles :
    • Charge utile vide.
    • Charge utile non valide. Champ obligatoire manquant : <nom du champ>

    Paramètres du corps de réponse

    Nom Description
    bundledGroupProductOffering Groupes enfants des offres de produits. Ceux-ci montrent des sous-groupes hiérarchiques.

    Type de données : tableau d’objets

    "bundledGroupProductOffering": [
  {
    "bundledGroupProductOfferingOption": {Object},
    "bundledProductOffering": [Array],
    "id": "String",
    "name": "String"
  }
]
    bundledGroupProductOffering.bundledGroupProductOfferingOption Plage de nombres qui spécifie les limites inférieure et supérieure du nombre d’offres de produits associée qui peuvent être achetés dans le cadre de l’offre de produits groupés connexe.

    Type de données : objet

    "bundledGroupProductOfferingOption": {
  "numberRelOfferLowerLimit": "String",
  "numberRelOfferUpperLimit": "String"
}
    bundledGroupProductOffering.bundledGroupProductOfferingOption.numberRelOfferLowerLimit Limite inférieure d’une offre de produits qui peut être achetée dans le cadre de l’offre groupée connexe.

    Type de données : chaîne
    bundledGroupProductOffering.bundledGroupProductOfferingOption.numberRelOfferUpperLimit Limite supérieure d’une offre de produits qui peut être achetée dans le cadre de l’offre groupée connexe.

    Type de données : chaîne
    bundledGroupProductOffering.bundledProductOffering Groupes enfants des offres de produits associées à l’ensemble. Même format que bundledProductOffering spécifié ci-dessous.

    Type de données : tableau d’objets
    bundledGroupProductOffering.ID Sys_id de l’enregistrement groupé. Utile dans les cas où l’offre ou le groupe de produits parents comprend plusieurs groupes.

    Type de données : chaîne

    Table : groupe de relations d’offre de produits [sn_prd_pm_product_offering_relationship_group]
    bundledGroupProductOffering.Name (Nom) Nom du groupe d’offres de produits enfants.

    Type de données : chaîne
    bundledProductOffering Liste des offres de produits incluses dans le groupe d’offres de produits. L’offre groupée de produits hérite de tous les attributs des offres de produits incluses.

    Type de données : tableau d’objets

    "bundledProductOffering": [
  {
    "bundledProductOfferingOption": {Object},
    "externalId": "String",
    "href": "String",
    "id": "String",
    "name": "String",
    "version": Number
  }
]
    bundledProductOffering.bundledProductOfferingOption Options de groupe de produits, telles que le nombre par défaut d’offres de produits et les contraintes d’approvisionnement d’offres de produits supérieures et inférieures.

    Type de données : objet

    "bundledProductOfferingOption": {
  "numberRelOfferDefault": "String",
  "numberRelOfferLowerLimit": "String",
  "numberRelOfferUpperLimit": "String"
}
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferDefault Nombre par défaut d’offres de produits à se procurer dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferLowerLimit Limite inférieure du nombre d’offres de produits associés qui peuvent être obtenus dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.bundledProductOfferingOption.numberRelOfferUpperLimit Limite supérieure du nombre d’offres de produits associées qui peuvent être achetées dans le cadre de l’offre groupée connexe.

    Type de données : chaîne

    Valeurs possibles : 0 à non lié.
    bundledProductOffering.ID externe ID externe de la relation d’offre de produits.

    Pour plus d’informations sur les relations d’offre de produits, reportez-vous à la section Create product offering relationships.

    Type de données : chaîne
    bundledProductOffering.href Lien relatif à l’offre de produits associée.

    Type de données : chaîne
    bundledProductOffering.ID ID Sys_id ou externe de l’offre de produits groupés.

    Type de données : chaîne

    Table : Offre de produits [sn_prd_pm_product_offering]
    bundledProductOffering.Name (Nom) Nom du groupe d’offres de produits.

    Type de données : chaîne
    bundledProductOffering.version Version du catalogue 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].
    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.Descriptif 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 produit.

    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 à l’enregistrement de ressource.

    Type de données : chaîne

    Par défaut : chaîne vide
    id Requis. Version initiale ou ID externe de l’offre de produit.

    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 Sys_id ou ID interne de l’enregistrement d’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].
    isBundle Marqueur indiquant si l’offre de produits est un lot.
    Valeurs possibles :
    • vrai : l’offre de produits est un lot.
    • faux : offre de produit unique.

    Type de données : booléen

    Valeur par défaut : false
    isSellable Marqueur indiquant si l’offre de produits associée peut être vendue seule ou si elle doit faire partie d’un ensemble d’offres de produits.
    Valeurs possibles :
    • vrai : Peut être vendu séparément.
    • faux : vendu uniquement dans le cadre d’un lot.

    Type de données : booléen

    Valeur par défaut : false
    lastUpdate Date à laquelle l’offre de produits a été mise à jour pour la dernière fois.

    Type de données : chaîne
    lifecycleStatus État du cycle de vie actuel de l’offre de produit.

    Valeurs valides :

    • Actives
    • Brouillon
    • Inactif

    Type de données : chaîne

    Par défaut : chaîne vide
    nom Nom de l’offre de produits.

    Type de données : chaîne
    prodSpecCharValueUse Caractéristiques des offres de produits.

    Type de données : tableau d’objets

    "prodSpecCharValueUse": [
   {
      "description": "String",
      "name": "String",
      "productSpecCharacteristicValue": [Array],
      "validFor": {Object},
      "valueType": "String"
   }
]
    prodSpecCharValueUse.Descriptif Description de la caractéristique.

    Type de données : chaîne
    prodSpecCharValueUse.Name (Nom)
    Nom de la caractéristique.

    Type de données : chaîne
    prodSpecCharValueUse.productSpecCharacteristicValue
    Liste des valeurs possibles de la caractéristique.

    Type de données : tableau d’objets

    "productSpecCharacteristicValue": [
 {
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "validFor": {Object},
    "value": "String"
 }
]
    prodSpecCharValueUse.productSpecCharacteristicValue.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique.
    Valeurs possibles :
    • true : valeur par défaut.
    • false : pas la valeur par défaut.

    Valeur par défaut : false
    prodSpecCharValueUse.productSpecCharacteristicValue.isMandatory Marqueur indiquant si la valeur de caractéristique associée est une valeur obligatoire pour la caractéristique.
    Valeurs possibles :
    • true : valeur obligatoire.
    • faux : valeur non obligatoire.

    Valeur par défaut : false
    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 la validité de la valeur caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    prodSpecCharValueUse.productSpecCharacteristicValue.value (valeur)
    Valeur 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": {
  "startDateTime": "String"
}
    prodSpecCharValueUse.validFor.startDateTime Date de début de la caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    prodSpecCharValueUse.valueType Type de données du prodSpecCharValueUse.productSpecCharacteristicValue.value paramètre.
    Valeurs possibles :
    • choix
    • e-mail
    • Numéro
    • Texte
    • oui/non

    Type de données : chaîne
    productCharacteristic Liste des caractéristiques du produit.

    Type de données : tableau d’objets

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.Name (Nom) Nom de la caractéristique.

    Type de données : chaîne
    productCharacteristic.value (valeur) Valeur de la caractéristique.

    Type de données : chaîne
    productOfferingCharacteristic Qualité caractéristique ou caractéristique distinctive d’une offre de produits. Les caractéristiques peuvent prendre une valeur discrète qui est fixée au moment de la conception (création de catalogue), comme le classement du plan mobile. Ces caractéristiques ne sont généralement pas modifiables au niveau des stocks.

    Pour en savoir plus sur les caractéristiques des offres de produits, reportez-vous à la section Create product characteristics and characteristic options.

    Type de données : tableau d’objets

    productOfferingCharacteristic": [  
  {
    "characteristicValueSpecification": [Array],
    "name": "String",
    "valueType": "String"
  }
]
    productOfferingCharacteristic.characteristicValueSpecification Liste des valeurs de caractéristiques associées à la caractéristique d’offre de produits.

    Type de données : tableau d’objets

    "characteristicValueSpecification": [  
  { 
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "value": "String"
  }  
]
    productOfferingCharacteristic.characteristicValueSpecification.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique associée.
    Valeurs possibles :
    • true : est la valeur par défaut.
    • false : n’est pas la valeur par défaut.

    Type de données : booléen

    Valeur par défaut : false
    productOfferingCharacteristic.characteristicValueSpecification.isMandatory Marqueur indiquant si la valeur de caractéristique associée est obligatoire pour la caractéristique associée.
    Valeurs possibles :
    • true : est obligatoire.
    • false : n’est pas obligatoire.

    Type de données : booléen

    Valeur par défaut : false
    productOfferingCharacteristic.characteristicValueSpecification.value (valeur) Numéro ou texte attribué à la caractéristique de spécification de produit associée.
    Par exemple :
    "characteristicValueSpecification": [
  {
    "value": "choice 1"
  },
  {
    "value": "choice 2"
  }
]

    Type de données : chaîne
    productOfferingCharacteristic.Name (Nom) Nom de la caractéristique de l’offre de produits associée.

    Type de données : chaîne
    productOfferingCharacteristic.valueType Type de données du productOfferingCharacteristic.​characteristicValueSpecification.​value paramètre.
    Valeurs possibles :
    • choix
    • e-mail
    • Numéro
    • Texte
    • oui/non

    Type de données : chaîne
    productOfferingPrice Informations sur les prix de l’offre de produits.

    Type de données : tableau d’objets

    "productOfferingPrice": [
  {
    "price": {Object},
    "priceType": "String"
  }
]
    productOfferingPrice.Prix Informations sur les prix de l’offre de produits.

    Type de données : objet

    "price": {
  "taxIncludedAmount": {Object}
}
    productOfferingPrice.prix.taxIncludedAmount Informations sur les prix de l’offre de produits.

    Type de données : objet

    "taxIncludedAmount": {
  "unit": "String",
  "value": "String"
}
    productOfferingPrice.prix.MontantInclus.taxe Code de devise pour le prix de l’offre de produits.

    Type de données : chaîne
    productOfferingPrice.prix.taxIncludedAmount.value (valeur) Prix de l’offre de produits TTC.

    Type de données : chaîne
    productOfferingPrice.type de prix 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 du contrat valide pour l’offre de produit.

    Type de données : chaîne
    Spécification du produit Spécification du produit pour le produit.

    Type de données : objet

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "name": "String",
  "version": "String"
}
    Spécification du produit.ID Sys_id de l’enregistrement de 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 du produit.ID interne Sys_id ou ID interne de l’enregistrement de 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 du 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].
    Spécification du produit.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].
    statut État de l’offre de produit.
    Valeurs possibles :
    • brouillon
    • publié

    Type de données : chaîne
    validFor 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 produit.

    Type de données : chaîne
    validFor.startDateTime Date de début de l’offre de produit.

    Type de données : chaîne
    version Version externe de l’offre de produit.

    Type de données : chaîne

    Table : dans le champ external_version de la table Offre de produits [sn_prd_pm_product_offering].

    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" \
--header "Accept:application/json" \
--data-raw '{
  "id": "313b917843235210a82ed6085bb8f2c7",
  "name": "Internet bundle",
  "displayName": "Internet bundle",
  "description": "Internet bundle",
  "isSellable": false,
  "lifecycleStatus": "Draft",
  "isBundle": true,
  "lastUpdate": "2025-02-05 06:39:45",
  "version": "",
  "internalVersion": "1",
  "internalId": "313b917843235210a82ed6085bb8f2c7",
  "validFor": {
    "startDateTime": "2028-12-15",
    "endDateTime": "2034-01-14"
  },
  "productOfferingTerm": "not_applicable",
  "productOfferingPrice": [
    {
      "priceType": "recurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": "0"
        }
      }
    },
    {
      "priceType": "nonRecurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": "0"
        }
      }
    }
  ],
  "productOfferingCharacteristic": [
    {
      "name": "Firewall Security",
      "valueType": "choice",
      "characteristicValueSpecification": [
        {
          "value": "Premium",
          "isMandatory": false,
          "isDefault": true
        }
      ]
    },
    {
      "name": "Connectivity need",
      "valueType": "choice",
      "characteristicValueSpecification": [
        {
          "value": "When in use",
          "isMandatory": false,
          "isDefault": false
        }
      ]
    }
  ],
  "bundledProductOffering": [
    {
      

      "id": "0f61dd9fd0a63110f8770dbf976be168",
      "name": "Solana Sports streaming channel",
      "version": "1",
      "externalId": "EXT-123",
      "bundledProductOfferingOption": {
        "numberRelOfferDefault": "1",
        "numberRelOfferLowerLimit": "1",
        "numberRelOfferUpperLimit": "1"
      }
    }
  ],
  "bundledGroupProductOffering": [
    {
      "id": "063b957843235210a82ed6085bb8f205",
      "name": "Streaming Channel",
      "bundledProductOffering": [
        { 
        

          "id": "62619d9fd0a63110f8770dbf976be180",
          "name": "Solana Movie streaming channel",
          "version": "1",
          "externalId": "EXT-345",
          "bundledProductOfferingOption": {
            "numberRelOfferDefault": "1",
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "bundledGroupProductOfferingOption": {
        "numberRelOfferLowerLimit": "1",
        "numberRelOfferUpperLimit": "1"
      }
    }
  ],
  "productSpecification": {
    "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
    "name": "SD-WAN Service Package",
    "version": "",
    "internalVersion": "3",
    "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
  },
  "prodSpecCharValueUse": [
    {
      "name": "Tenancy",
      "description": "Tenancy",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2024-12-18 21:04:24"
      },
      "productSpecCharacteristicValue": [
        {
          "value": "Premium (>50 sites)",
          "isDefault": false,
          "isMandatory": false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Base (10 site)",
          "isDefault": false,
          "isMandatory": false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "productSpecification": {
        "id": "216663aa53702010cd6dddeeff7b12b5",
        "name": "SD-WAN Controller",
        "version": "",
        "internalVersion": "1",
        "internalId": "216663aa53702010cd6dddeeff7b12b5"
      }
    }
  ],
  "channel": [
    {
      "id": "58ad5522c3702010df4773ce3640ddb2",
      "name": "Agent Assist"
    }
  ],
  "category": [
    {
      "id": "13e305a143b631105029d1529ab8f267",
      "name": "SD-WAN_all_offers"
    }
  ],
  "status": "draft"
}'
--user 'username':'password'

    Corps de réponse :

    {
  "id": "313b917843235210a82ed6085bb8f2c7",
  "name": "Internet bundle",
  "displayName": "Internet bundle",
  "description": "Internet bundle",
  "isSellable": false,
  "lifecycleStatus": "Draft",
  "isBundle": true,
  "lastUpdate": "2025-04-09 15:59:09",
  "version": "",
  "internalVersion": "1",
  "validFor": {
    "startDateTime": "2028-12-15",
    "endDateTime": "2034-01-14"
  },
  "productOfferingTerm": "not_applicable",
  "productOfferingPrice": [
    {
      "priceType": "recurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": "0"
        }
      }
    },
    {
      "priceType": "nonRecurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": "0"
        }
      }
    }
  ],
  "productOfferingCharacteristic": [
    {
      "name": "Firewall Security",
      "valueType": "choice",
      "characteristicValueSpecification": [
        {
          "value": "Premium",
          "isMandatory": false,
          "isDefault": true
        }
      ]
    },
    {
      "name": "Connectivity need",
      "valueType": "choice",
      "characteristicValueSpecification": [
        {
          "value": "When in use",
          "isMandatory": false,
          "isDefault": false
        }
      ]
    }
  ],
  "bundledProductOffering": [
    {
      "id": "0f61dd9fd0a63110f8770dbf976be168",
      "name": "Solana Sports streaming channel",
      "version": "1",
      "externalId": "EXT-123",
      "bundledProductOfferingOption": {
        "numberRelOfferDefault": "1",
        "numberRelOfferLowerLimit": "1",
        "numberRelOfferUpperLimit": "1"
      }
    }
  ],
  "bundledGroupProductOffering": [
    {
      "id": "063b957843235210a82ed6085bb8f205",
      "name": "Streaming Channel",
      "bundledProductOffering": [
        {
          "id": "62619d9fd0a63110f8770dbf976be180",
          "name": "Solana Movie streaming channel",
          "version": "1",
          "externalId": "EXT-345",
          "bundledProductOfferingOption": {
            "numberRelOfferDefault": "1",
            "numberRelOfferLowerLimit": "1",
            "numberRelOfferUpperLimit": "1"
          }
        }
      ],
      "bundledGroupProductOfferingOption": {
        "numberRelOfferLowerLimit": "1",
        "numberRelOfferUpperLimit": "1"
      }
    }
  ],
  "productSpecification": {
    "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
    "name": "SD-WAN Service Package",
    "version": "",
    "internalVersion": "3",
    "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
  },
  "prodSpecCharValueUse": [
    {
      "name": "Tenancy",
      "description": "Tenancy",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2024-12-18 21:04:24"
      },
      "productSpecCharacteristicValue": [
        {
          "value": "Premium (>50 sites)",
          "isDefault": false,
          "isMandatory": false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Base (10 site)",
          "isDefault": false,
          "isMandatory": false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "productSpecification": {
        "id": "216663aa53702010cd6dddeeff7b12b5",
        "name": "SD-WAN Controller",
        "version": "",
        "internalVersion": "1",
        "internalId": "216663aa53702010cd6dddeeff7b12b5"
      }
    }
  ],
  "channel": [
    {
      "id": "58ad5522c3702010df4773ce3640ddb2",
      "name": "Agent Assist"
    }
  ],
  "category": [
    {
      "id": "13e305a143b631105029d1529ab8f267",
      "name": "SD-WAN_all_offers"
    }
  ],
  "status": "draft",
  "externalId": "313b917843235210a82ed6085bb8f2c7",
  "internalId": "03c99cb53bf066509b48d69a04e45a11",
  "href": "/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11"
}

    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
    Aucune
    Tableau 98. Paramètres de requête
    Nom Description
    Aucune
    Tableau 99. Paramètres du corps de la 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éen

    Valeur par défaut : false
    lastUpdate Requis. Date de dernière mise à jour de la ligne de prix.

    Format : JJ-MM-AAAA

    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 pour donner la ligne de la liste de prix.

    Type de données : chaîne
    price Requis. Détails de prix catalogue de la ligne de liste des 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 des prix.

    Table : Lignes de liste des 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
    type de prix Requis. Filtrez la ligne de liste de prix en fonction de la 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 supplémentaires 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
    productOffering.Version interne Numéro de version interne de l’offre de produits.

    Type de données : chaîne (représentée par un nombre. Par exemple, « 1 ».)
    productOffering.Name (Nom) 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 :
    • Jour et mois de l
    • 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é de mesure.calculer le montant de Montant de l’unité de mesure.

    Type de données : nombre
    unité de mesure.ID Requis. Sys_id de l’unité de mesure dans la table Liste des lignes de prix.

    Table : ligne de liste de prix [sn_csm_pricing_price_list_line]

    Type de données : chaîne
    unité de mesure.Unités Type de l’unité de mesure associée à la ligne de liste des prix. Par exemple, chacun ou lot.

    Type de données : chaîne
    validFor 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 pour 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 : AAAA-MM-JJ HH :mm :ss

    Type de données : chaîne (glide_date)
    validFor.startDate Date de début pour laquelle la ligne de liste de prix est valide.

    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 : AAAA-MM-JJ 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 uniquement à cette action HTTP 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 des 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 des 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é traitée avec succès.
    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 réponse (JSON ou XML)

    Nom Description
    id Sys_id de la ligne de liste des prix.

    Table : Lignes de liste des prix [sn_csm_pricing_price_list_line]

    Type de données : chaîne
    href URL de l’enregistrement de 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 : AAAA-MM-JJ HH :mm :ss

    Type de données : chaîne
    validFor 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éen
    lifecycleStatus État du cycle de vie actuel de la ligne de liste de prix.
    Valeurs valides :
    • Actives
    • 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 produits [sn_prd_pm_product_offering].

    Type de données : chaîne
    productOffering.Version interne Numéro de version interne de l’offre de produits. Par exemple, PRDOF01024. Situé dans la table Offre de produits [sn_prd_pm_product_offering].

    Type de données : chaîne
    productOffering.Name (Nom) Nom de l’offre de produits. Situé dans la table Offre de produits [sn_prd_pm_product_offering].

    Type de données : chaîne
    type de prix Méthode de tarification de l’offre de produit 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 de recurringChargePeriodType indique la fréquence de la facturation.
    • one_time : 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 s’il priceType a été défini sur Récurrent, sinon renvoie une chaîne vide.
    Valeurs possibles :
    • Jour et mois de l
    • 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 Montant de l’unité de mesure.

    Type de données : nombre
    unitOfMeasure.id Sys_id de l’unité de mesure.

    Table : Lignes de liste des prix [sn_csm_pricing_price_list_line]

    Type de données : chaîne
    unité de mesure.Unités Type de l’unité de mesure associée à la ligne de liste des prix. Par exemple, année ou ensemble.

    Type de données : chaîne
    price Détails de prix catalogue de la ligne de liste des 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 href paramètre de 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 un enregistrement de spécification de produit avec les valeurs spécifiées.

    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
    Aucune
    Tableau 104. Paramètres de requête
    Nom Description
    Aucune
    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 pour la spécification du produit à partir du système externe.

    Type de données : chaîne

    Par défaut : chaîne vide
    id Requis. ID Sys_id ou externe de la spécification du produit.

    Type de données : chaîne

    Tableau : dans le initial_version ou le external_id du tableau des spécifications de produit [sn_prd_pm_product_specification].
    internalId Requis.
    Sys_id ou ID interne 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 : AAAA-MM-JJ HH :mm :SS. Par exemple, 2025-01-31 09:35:43.

    Par défaut : chaîne vide
    nom Requis. Nom de la spécification.

    Type de données : chaîne
    productSpecCharacteristic Caractéristique de spécification.

    Type de données : tableau d’objets

    "productSpecCharacteristic": [
  {
    "description": "String",
    "name": "String",
    "productSpecCharacteristicValue": [Array],
    "validFor": {Object},
    "valueType": "String"
  }
]
    productSpecCharacteristic.Descriptif Description de la caractéristique.

    Type de données : chaîne

    Par défaut : chaîne vide
    productSpecCharacteristic.Name (Nom) Requis. Nom de la caractéristique.

    Type de données : chaîne
    productSpecCharacteristic.productSpecCharacteristicValue Requis.
    Liste des valeurs possibles de la caractéristique.

    Type de données : tableau d’objets

    "productSpecCharacteristicValue": [
 {
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "validFor": {Object},
    "value": "String"
 }
]
    productSpecCharacteristic.productSpecCharacteristicValue.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique.
    Valeurs possibles :
    • true : valeur par défaut.
    • false : pas la valeur par défaut.

    Valeur par défaut : false
    productSpecCharacteristic.productSpecCharacteristicValue.isMandatory Marqueur indiquant si la valeur de caractéristique associée est une valeur obligatoire pour la caractéristique.
    Valeurs possibles :
    • true : valeur obligatoire.
    • faux : valeur non obligatoire.

    Valeur par défaut : false
    productSpecCharacteristic.productSpecCharacteristicValue.validFor Date et heure de validité de la caractéristique.

    Type de données : objet

    "validFor": {
  "startDateTime": "String"
}
    productSpecCharacteristic.productSpecCharacteristicValue.validFor.startDateTime Date et heure de début de la validité de la valeur caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    productSpecCharacteristic.productSpecCharacteristicValue.value (valeur)
    Valeur de la caractéristique.

    Type de données : chaîne
    productSpecCharacteristic.productSpecCharacteristicValue.value (valeur) 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 : AAAA-MM-JJ HH :mm :SS. Par exemple, 2025-01-31 09:35:43.

    Par défaut : chaîne vide
    productSpecCharacteristic.validFor.startDateTime Date de début de la caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS. Par exemple, 2025-01-31 09:35:43.

    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

    Par défaut : chaîne vide
    productSpecificationRelationship les 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 connexe.

    Type de données : chaîne

    Par défaut : chaîne vide
    productSpecificationRelationship.Type Requis si le productSpecificationRelationship paramètre est utilisé. Type de relation.
    Valeurs valides :
    • Offres groupées
    • composed_of

    Type de données : chaîne
    productSpecificationRelationship.validFor Plage de dates pour laquelle la relation est valide.

    Type de données : objet

    "validFor": {
   "endDateTime": "String",
   "startDateTime": "String"
}
    productSpecificationRelationship.validFor.endDateTime Date de fin de la relation.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS. Par exemple, 2025-01-31 09:35:43.

    Par défaut : chaîne vide
    productSpecificationRelationship.validFor.startDateTime Date de début de la relation.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS. Par exemple, 2025-01-31 09:35:43.

    Par défaut : chaîne vide
    Spécification de ressource 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.ID interne Version initiale (sys_id) de l’enregistrement de 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.Version interne 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) 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écifications de service [sn_prd_pm_service_specification].
    serviceSpecification.ID interne Version initiale de la spécification de service.

    Type de données : chaîne

    Table : dans le champ initial_version de la table Service Specification (Spécification de service) [sn_prd_pm_service_specification].
    serviceSpecification.Version interne 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) 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écification de service [sn_prd_pm_service_specification].
    validFor 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 : AAAA-MM-JJ HH :mm :SS. Par exemple, 2025-01-31 09:35:43.

    Par défaut : chaîne vide
    validFor.startDateTime Date de début de la spécification.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS. Par exemple, 2025-01-31 09:35:43.

    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 uniquement à cette action HTTP 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 des données du corps de la réponse. Prend uniquement en charge application/json.
    Type de contenu Format des données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 107. En-têtes de réponses
    En-tête Description
    Type de contenu Format des 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 du champ>

    Paramètres du corps de réponse

    Nom Description
    description Description de la spécification.

    Type de données : chaîne
    href Lien relatif à l’enregistrement de ressource.

    Type de données : chaîne

    Par défaut : chaîne vide
    id ID Sys_id ou externe de la spécification du produit.

    Type de données : chaîne

    Table : dans le champ sys_id ou external_id de la table Spécification de produit [sn_prd_pm_product_specification].
    internalId Requis.
    Sys_id ou ID interne 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 indiquant s’il représente productSpecification un produit unique ou un ensemble de produits.
    Valeurs valides :
    • vrai : la spécification de produit est un lot de produits qui contient plusieurs produits.
    • faux : le cahier des charges contient un seul produit.

    Type de données : booléen

    Valeur par défaut : false
    lastUpdate Date de dernière mise à jour de la spécification.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    lifecycleStatus État actuel du cycle de vie de la spécification du produit.
    Valeurs possibles :
    • Actives
    • Brouillon
    • Inactif

    Type de données : chaîne

    Par défaut : chaîne vide
    nom Nom de la spécification.

    Type de données : chaîne
    productSpecCharacteristic Caractéristique de spécification.

    Type de données : tableau d’objets

    "productSpecCharacteristic": [
  {
    "description": "String",
    "name": "String",
    "productSpecCharacteristicValue": [Array],
    "validFor": {Object},
    "valueType": "String"
  }
]
    productSpecCharacteristic.Descriptif Description de la caractéristique.

    Type de données : chaîne
    productSpecCharacteristic.Name (Nom) Nom de la caractéristique.

    Type de données : chaîne
    productSpecCharacteristic.productSpecCharacteristicValue
    Liste des valeurs possibles de la caractéristique.

    Type de données : tableau d’objets

    "productSpecCharacteristicValue": [
 {
    "isDefault": Boolean,
    "isMandatory": Boolean,
    "validFor": {Object},
    "value": "String"
 }
]
    productSpecCharacteristic.productSpecCharacteristicValue.isDefault Marqueur indiquant si la valeur de caractéristique associée est la valeur par défaut de la caractéristique.
    Valeurs possibles :
    • true : valeur par défaut.
    • false : pas la valeur par défaut.

    Valeur par défaut : false
    productSpecCharacteristic.productSpecCharacteristicValue.isMandatory Marqueur indiquant si la valeur de caractéristique associée est une valeur obligatoire pour la caractéristique.
    Valeurs possibles :
    • true : valeur obligatoire.
    • faux : valeur non obligatoire.

    Valeur par défaut : false
    productSpecCharacteristic.productSpecCharacteristicValue.validFor Date et heure de validité de la caractéristique.

    Type de données : objet

    "validFor": {
  "startDateTime": "String"
}
    productSpecCharacteristic.productSpecCharacteristicValue.validFor.startDateTime Date et heure de début de la validité de la valeur caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    productSpecCharacteristic.productSpecCharacteristicValue.value (valeur)
    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 : AAAA-MM-JJ HH :mm :SS
    productSpecCharacteristic.validFor.startDateTime Date de début de la caractéristique.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    productSpecCharacteristic.valueType Type de valeur de la caractéristique, tel que choix ou e-mail.

    Type de données : chaîne
    productSpecificationRelationship les 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"
}
    productSpecificationRelationship.validFor.endDateTime Date de fin de la relation.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    productSpecificationRelationship.validFor.startDateTime Date de début de la relation.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    Spécification de ressource 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 ID Sys_id ou 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.ID interne Version initiale (sys_id) de l’enregistrement de 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.Version interne 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) 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écifications de service [sn_prd_pm_service_specification].
    serviceSpecification.ID interne Version initiale de la spécification de service.

    Type de données : chaîne

    Table : dans le champ initial_version de la table Service Specification (Spécification de service) [sn_prd_pm_service_specification].
    serviceSpecification.Version interne 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) 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écification de service [sn_prd_pm_service_specification].
    validFor 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 : AAAA-MM-JJ HH :mm :SS
    validFor.startDateTime Date de début de la spécification.

    Type de données : chaîne

    Format : AAAA-MM-JJ HH :mm :SS
    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].

    Cet exemple crée un enregistrement de spécification de produit avec les valeurs spécifiées.

    curl --location --request POST "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification" \
--header "Content-Type: application/json" \
--data-raw '{
  "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
  "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
  "name": "SD-WAN Service Package",
  "displayName": "SD-WAN Service Package v3",
  "version": "",
  "internalVersion": "3",
  "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
  "description": "SD WAN Service Package",
  "lastUpdate": "2027-10-11 06:58:12",
  "isBundle": true,
  "validFor": {
    "startDateTime": "2029-02-05",
    "endDateTime": ""
  },
  "serviceSpecification": [],
  "productSpecificationRelationship": [
    {
      "id": "216663aa53702010cd6dddeeff7b12b5",
      "name": "SD-WAN Controller",
      "version": "",
      "internalVersion": "1",
      "internalId": "216663aa53702010cd6dddeeff7b12b5",
      "type": "Service",
      "validFor": {
        "startDateTime": "2025-01-24",
        "endDateTime": ""
      },
      "relationshipType": "bundles",
      "ProdSpecRelationshipOption": {
        "numberSpecRelLowerLimit": "1",
        "numberSpecRelDefault": "1",
        "numberSpecRelUpperLimit": "1"
      }
    },
    {
      "id": "39b627aa53702010cd6dddeeff7b1202",
      "name": "SD-WAN Edge Device",
      "version": "",
      "internalVersion": "2",
      "internalId": "39b627aa53702010cd6dddeeff7b1202",
      "type": "Service",
      "validFor": {
        "startDateTime": "2026-06-05",
        "endDateTime": "2031-07-05"
      },
      "relationshipType": "bundles",
      "ProdSpecRelationshipOption": {
        "numberSpecRelLowerLimit": "1",
        "numberSpecRelDefault": "2",
        "numberSpecRelUpperLimit": "4"
      }
    },
    {
      "id": "a6514bd3534560102f18ddeeff7b1247",
      "name": "SD-WAN Security",
      "version": "",
      "internalVersion": "2",
      "internalId": "a6514bd3534560102f18ddeeff7b1247",
      "type": "Service",
      "validFor": {
        "startDateTime": "2026-06-03",
        "endDateTime": "2031-07-05"
      },
      "relationshipType": "bundles",
      "ProdSpecRelationshipOption": {
        "numberSpecRelLowerLimit": "1",
        "numberSpecRelDefault": "4",
        "numberSpecRelUpperLimit": "20"
      }
    }
  ],
  "resourceSpecification": [],
  "productSpecCharacteristic": [
    {
      "productSpecCharacteristicValue": [
        {
          "value": "1",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "0.25",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "0.01",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "0.5",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Down Time",
      "description": "Down Time",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:36:15"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "500 Mbps",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 Gbps",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "5 Gbps",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "1 Gbps",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Bandwidth",
      "description": "Bandwidth",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:32:11"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "4 hrs",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 hrs",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "1 hr",
          "isMandatory":false,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Time to Restore (TTR)",
      "description": "Time to Restore (TTR)",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:37:25"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "1 hr",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 hrs",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "4 hrs",
          "isMandatory":false,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Mean Time to Restore (MTR)",
      "description": "Mean Time to Restore (MTR)",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:39:05"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "No",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Yes",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Application Flow Backup",
      "description": "Application Flow Backup",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2027-10-11 02:30:39"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "99.00",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "99.50",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "99.75",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "99.99",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Up Time",
      "description": "Up time",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:34:30"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "No",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Yes",
          "isMandatory":false,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Application Encryption",
      "description": "Application Encryption",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2027-10-11 02:29:08"
      }
    }
  ],
  "status": "published"
}'

--user 'username':'password'

    Corps de la réponse.

    {
  "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
  "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
  "name": "SD-WAN Service Package",
  "displayName": "SD-WAN Service Package v3",
  "version": "",
  "internalVersion": "3",
  "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
  "description": "SD WAN Service Package",
  "lastUpdate": "2027-10-11 06:58:12",
  "isBundle": true,
  "validFor": {
    "startDateTime": "2029-02-05",
    "endDateTime": ""
  },
  "serviceSpecification": [],
  "productSpecificationRelationship": [
    {
      "id": "216663aa53702010cd6dddeeff7b12b5",
      "name": "SD-WAN Controller",
      "version": "",
      "internalVersion": "1",
      "internalId": "216663aa53702010cd6dddeeff7b12b5",
      "type": "Service",
      "validFor": {
        "startDateTime": "2025-01-24",
        "endDateTime": ""
      },
      "relationshipType": "bundles",
      "ProdSpecRelationshipOption": {
        "numberSpecRelLowerLimit": "1",
        "numberSpecRelDefault": "1",
        "numberSpecRelUpperLimit": "1"
      }
    },
    {
      "id": "39b627aa53702010cd6dddeeff7b1202",
      "name": "SD-WAN Edge Device",
      "version": "",
      "internalVersion": "2",
      "internalId": "39b627aa53702010cd6dddeeff7b1202",
      "type": "Service",
      "validFor": {
        "startDateTime": "2026-06-05",
        "endDateTime": "2031-07-05"
      },
      "relationshipType": "bundles",
      "ProdSpecRelationshipOption": {
        "numberSpecRelLowerLimit": "1",
        "numberSpecRelDefault": "2",
        "numberSpecRelUpperLimit": "4"
      }
    },
    {
      "id": "a6514bd3534560102f18ddeeff7b1247",
      "name": "SD-WAN Security",
      "version": "",
      "internalVersion": "2",
      "internalId": "a6514bd3534560102f18ddeeff7b1247",
      "type": "Service",
      "validFor": {
        "startDateTime": "2026-06-03",
        "endDateTime": "2031-07-05"
      },
      "relationshipType": "bundles",
      "ProdSpecRelationshipOption": {
        "numberSpecRelLowerLimit": "1",
        "numberSpecRelDefault": "4",
        "numberSpecRelUpperLimit": "20"
      }
    }
  ],
  "resourceSpecification": [],
  "productSpecCharacteristic": [
    {
      "productSpecCharacteristicValue": [
        {
          "value": "1",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "0.25",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "0.01",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "0.5",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Down Time",
      "description": "Down Time",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:36:15"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "500 Mbps",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 Gbps",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "5 Gbps",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "1 Gbps",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Bandwidth",
      "description": "Bandwidth",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:32:11"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "4 hrs",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 hrs",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "1 hr",
          "isMandatory":false,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Time to Restore (TTR)",
      "description": "Time to Restore (TTR)",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:37:25"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "1 hr",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 hrs",
          "isMandatory":true,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "4 hrs",
          "isMandatory":false,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Mean Time to Restore (MTR)",
      "description": "Mean Time to Restore (MTR)",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:39:05"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "No",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Yes",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Application Flow Backup",
      "description": "Application Flow Backup",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2027-10-11 02:30:39"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "99.00",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "99.50",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "99.75",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "99.99",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Up Time",
      "description": "Up time",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2027-10-11 02:34:30"
      }
    },
    {
      "productSpecCharacteristicValue": [
        {
          "value": "No",
          "isMandatory":true,
          "isDefault":true,
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "Yes",
          "isMandatory":false,
          "isDefault":false,
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "name": "Application Encryption",
      "description": "Application Encryption",
      "valueType": "yes_no",
      "validFor": {
        "startDatetime": "2027-10-11 02:29:08"
      }
    }
  ],
  "status": "published"
}'