---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference
Release :
- xanadu
ft:locale :
- fr-FR
ft:publication_title :
- Référence de l’API Xanadu
ft:clusterId :
- crapiref
bundleId :
- crapiref
workflow :
- Creator
---
# Inventaire des produits Ouvrir l'API
# Inventaire des produits Ouvrir l'API {#ariaid-title1}
* Rversion finale: Xanadu
*
* Mis à jour 1 août 2024
*
*  35 minutes de lecture
L'API ouverte d'inventaire de produits fournit des points de terminaison pour créer et récupérer des inventaires de produits.
Utilisez cette API pour gérer les informations d'inventaire de produits entre les systèmes externes et le Now Platform.
Cette API est incluse dans l'application Product Inventory Advanced, disponible sur .ServiceNow Store
Cette API est fournie dans l'espace de noms `sn_prd_invt ` .
L'utilisateur appelant doit avoir le rôle sn_prd_invt.product_inventory_integrator.
Cette API crée et met à jour les données dans les tables suivantes.
* Caractéristiques du produit \[sn_prd_invt_product_characteristics\]
* Inventaire des produits \[sn_prd_invt_product_inventory\]
* Modèle de produit \[cmdb_model\]
* Caractéristique du modèle de produit \[sn_prd_pm_product_model_characteristic\]
{#product-inventory-open-api__ul_fhn_pjj_hsb}
L'API ouverte Product Inventory est une ServiceNow® implémentation de la spécification REST de l'API Product Inventory Management TM Forum. Cette implémentation est basée sur la [spécification REST de l'API de gestion d'inventaire des produits TMF637 version 19, août](https://www.tmforum.org/resources/standard/tmf637-product-inventory-management-api-rest-specification-r19-0-0/) 2019. L'API ouverte d'inventaire des produits est certifiée de conformité par TM Forum.
## Inventaire des produits Ouvrir l'API : GET /sn_prd_invt/product {#ariaid-title2}
Récupère une liste de tous les inventaires de produits.
### Format d'URL
URL par défaut : api/sn_prd_invt/product
### Paramètres de demande pris en charge
{#tmf_prod_inv-GET-product__table_ofr_vgy_fsb__entry__2}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 1. Paramètres de chemin d'accès]
{#tmf_prod_inv-GET-product__table_ofr_vgy_fsb} {#tmf_prod_inv-GET-product__table_pfr_vgy_fsb__entry__2}
| Nom | Description |
|-|-|
| customer | Filtrer les inventaires de produits par client. Seules les offres de produits avec un sys_id client ou un ID externe correspondant à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne |
| champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Si ce paramètre n'est pas utilisé, tous les champs sont renvoyés. Type de données : chaîne |
| limite | Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d'enregistrements, utilisez le paramètre pour paginer la récupération de l'enregistrement offset . Par défaut : 20 Maximum : 100 Type de données : nombre |
| décalage | Index de départ auquel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Par défaut : 0 Type de données : nombre |
| lieu | Filtrer les inventaires de produits par lieu. Seules les offres de produits avec un sys_id de lieu ou un ID externe correspondant à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne |
| statut | Filtrer les produitspar statut. Seuls les inventaires de produits dont l'état correspond à la valeur de ce paramètre sont renvoyés dans la réponse. Type de données : chaîne |
[Tableau 2. Paramètres de requête]
{#tmf_prod_inv-GET-product__table_pfr_vgy_fsb} {#tmf_prod_inv-GET-product__table_gld_vkz_gsb__entry__2}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 3. Paramètres du corps de la demande (JSON)]
{#tmf_prod_inv-GET-product__table_gld_vkz_gsb}
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#tmf_prod_inv-GET-product__table_kqy_wgy_fsb__entry__2}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 4. En-têtes de demandes]
{#tmf_prod_inv-GET-product__table_kqy_wgy_fsb} {#tmf_prod_inv-GET-product__table_idy_qgm_lsb__entry__2}{#tmf_prod_inv-GET-product__content-range-row}{#tmf_prod_inv-GET-product__content-type-row}{#tmf_prod_inv-GET-product__links-pagination-row}{#tmf_prod_inv-GET-product__x-total-count-descr}
| En-tête | Description |
|-|-|
| Plage de contenu | Spécifie la plage de contenu renvoyée dans un appel paginé. Par exemple, si `offset=2` et `limit=3`, la valeur de l'en-tête Content-Range est `les éléments 3 à 5`. |
| Type de contenu | Format de données du corps de la réponse. Ne prend en charge application/jsonque les fichiers . |
| Lien | Contient les liens suivants pour parcourir les résultats de la requête. * premier * dernier * suivant * previous {#tmf_prod_inv-GET-product__ul_zzk_sdm_lsb} |
| X-Total-Count | Pour les requêtes paginées, cet en-tête indique le nombre total d'enregistrements disponibles sur le serveur. |
[Tableau 5. En-têtes de réponses]
{#tmf_prod_inv-GET-product__table_idy_qgm_lsb}
### Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#tmf_prod_inv-GET-product__table_hl1_rcm_lsb__entry__2}{#tmf_prod_inv-GET-product__tmf-get-status-200-p}{#tmf_prod_inv-GET-product__tmf-get-status-206-entry}{#tmf_prod_inv-GET-product__tmf-get-status-400-entry}{#tmf_prod_inv-GET-product__tmf-get-status-404-entry}
| Code d'état | Description |
|-|-|
| 200 | Demande traitée avec succès. Ressource complète renvoyée en réponse (aucune pagination). |
| 206 | Ressource partielle renvoyée en réponse (avec pagination). |
| 400 | Demande incorrecte. Raisons possibles : * Paramètre de chemin d'accès non valide * URI non valide {#tmf_prod_inv-GET-product__ul_rys_1gy_fsb} |
| 404 | Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n'a été trouvé dans la table. |
[Tableau 6. Codes d'état]
{#tmf_prod_inv-GET-product__table_hl1_rcm_lsb}
### Paramètres de corps de réponse (JSON) {#tmf_prod_inv-GET-product__section_rhr_nvy_3sb}
{#tmf_prod_inv-GET-product__table_shr_nvy_3sb__entry__2}{#tmf_prod_inv-GET-product__realRes-id-entry}{#tmf_prod_inv-GET-product__realServ-id-entry}
| Nom | Description |
|-|-|
| href | Lien relatif à l'enregistrement d'inventaire des produits. Type de données : chaîne |
| id | Sys_id de l'inventaire des produits à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| nom | Nom de l'inventaire des produits. Type de données : chaîne |
| lieu | Lieu associé au produit. Type de données : chaîne |
| caractéristique du produit | Liste des caractéristiques du produit. Type de données : tableau "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | Nom de la caractéristique. Type de données : chaîne |
| productCharacteristic.value | Valeur de la caractéristique. Type de données : chaîne |
| productOffering | Offre de produits à laquelle l'inventaire de produits est associé. Type de données : objet "productOffering": { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } |
| productOffering.id | Initial_version ou external_id de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| offreproduit.internalId | Initial_version de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| OffreProduit.Version Interne | Version de l'offre de produit. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| productOffering.name | Nom de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| offredeproduits.version | External_version de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| productPrice | Renvoie un tableau vide. Type de données : tableau |
| Relation produit | Liste des produits connexes. Type de données : tableau "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | Sys_id du produit connexe à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| RelationshipProduit.Type de relation | Type de relation. Type de données : chaîne |
| Spécification du produit | Spécification du produit pour le produit. Type de données : objet "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" } |
| productSpecification.id | Initial_version ou external_id des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| Spécification produit.internalId | Initial_version des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| Spécification produit.Version interne | Version de la spécification du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| spécification produit.version | External_version des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| realizingResource | Ressource qui réalise le produit. La ressource de réalisation est un inventaire de produits enfants de cet inventaire de produits. Type de données : objet "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | Sys_id de la ressource de réalisation. Situé dans la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingResource.type | Type de la ressource de réalisation. Valeur valide : enfant Type de données : chaîne |
| realizingService | Service qui réalise le produit. Le service de réalisation est un inventaire de produits enfants de cet inventaire de produits. Type de données : objet "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | Sys_id du service de réalisation. Situé dans la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingService.type | Type du service de réalisation. Valeur valide : enfant Type de données : chaîne |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | Sys_id du compte ou du contact client associé au ticket. Situé dans la table Compte \[customer_account\], Contact \[customer_contact\] ou Consommateur \[csm_consumer\]. Type de données : chaîne |
| relatedParty.@referredType | Type de client. Valeurs possibles : * Client * Contact du client * Consommateur {#tmf_prod_inv-GET-product__ul_jqs_vbh_fwb} Type de données : chaîne |
| État | État actuel du produit. Type de données : chaîne |
[ ]
{#tmf_prod_inv-GET-product__table_shr_nvy_3sb}
### Demande cURL {#tmf_prod_inv-GET-product__example_ld5_lnz_3sb}
Cet exemple récupère tous les inventaires de produits.
curl --location --request GET "https://instance.service-now.com/api/sn_prd_invt/product" \
--user 'username':'password'
Corps de réponse.
[
{
"id": "037fd87ec3603010abc8b5183c40ddf2",
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Example Company",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"name": "Routing and Configuration PI0000318",
"productSpecification": {
"id": "aec57e981bb420106ba59acf034bcb08",
"name": "Routing and Configuration",
"version": "",
"internalVersion": "1",
"internalId": "aec57e981bb420106ba59acf034bcb08"
},
"status": "Active",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "",
"internalVersion": "1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"product": "ce0b52c7532520103b6bddeeff7b12f5",
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"name": "100 South Charles Street, Baltimore,MD"
},
"productCharacteristic": [],
"productRelationship": [],
"realizingService": [],
"realizingResource": [
{
"id": "9b2fa60b536520103b6bddeeff7b1233",
"name": "Route Target"
}
],
"productPrice": [],
"href": "/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2",
"billingAccount": "Not Specified."
}
]
## Inventaire des produits API ouverte : GET /sn_prd_invt/product/{id} {#ariaid-title3}
Récupère un enregistrement d'inventaire de produits spécifié.
### Format d'URL
URL par défaut : /api/sn_prd_invt/product/{id}
### Paramètres de demande pris en charge {#tmf_prod_inv-GET-product-id__section_esr_w5y_3sb}
{#tmf_prod_inv-GET-product-id__table_apt_nkz_gsb__entry__2}
| Nom | Description |
|-|-|
| id | Sys_id de l'inventaire des produits à récupérer. Situé dans la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
[Tableau 7. Paramètres de chemin d'accès]
{#tmf_prod_inv-GET-product-id__table_apt_nkz_gsb} {#tmf_prod_inv-GET-product-id__table_pfr_vgy_fsb__entry__2}
| Nom | Description |
|-|-|
| customer | Filtrer les inventaires de produits par client. Seules les offres de produits avec un sys_id client ou un ID externe correspondant à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne |
| champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Si ce paramètre n'est pas utilisé, tous les champs sont renvoyés. Type de données : chaîne |
| lieu | Filtrer les inventaires de produits par lieu. Seules les offres de produits avec un sys_id de lieu ou un ID externe correspondant à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne |
| statut | Filtrer les inventaires de produits par statut. Seuls les inventaires de produits dont l'état correspond à la valeur de ce paramètre sont renvoyés dans la réponse. Type de données : chaîne |
[Tableau 8. Paramètres de requête]
{#tmf_prod_inv-GET-product-id__table_pfr_vgy_fsb} {#tmf_prod_inv-GET-product-id__table_gld_vkz_gsb__entry__2}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 9. Paramètres du corps de la demande (JSON)]
{#tmf_prod_inv-GET-product-id__table_gld_vkz_gsb}
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#tmf_prod_inv-GET-product-id__table_kqy_wgy_fsb__entry__2}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 10. En-têtes de demandes]
{#tmf_prod_inv-GET-product-id__table_kqy_wgy_fsb} {#tmf_prod_inv-GET-product-id__table_tzy_thy_ksb__entry__2}
| En-tête | Description |
|-|-|
| Type de contenu | Format de données du corps de la réponse. Ne prend en charge application/jsonque les fichiers . |
[Tableau 11. En-têtes de réponses]
{#tmf_prod_inv-GET-product-id__table_tzy_thy_ksb}
### Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#tmf_prod_inv-GET-product-id__table_nxj_ykz_gsb__entry__2}
| Code d'état | Description |
|-|-|
| 200 | Demande traitée avec succès. |
| 400 | Demande incorrecte. L'une des raisons suivantes peut être l'une des suivantes : * Paramètre de chemin d'accès non valide * URI non valide {#tmf_prod_inv-GET-product-id__ul_rys_1gy_fsb} |
| 404 | Enregistrement introuvable. L'enregistrement associé à l'ID est introuvable dans la table. |
[Tableau 12. Codes d'état]
{#tmf_prod_inv-GET-product-id__table_nxj_ykz_gsb}
### Paramètres de corps de réponse (JSON) {#tmf_prod_inv-GET-product-id__section_rhr_nvy_3sb}
{#tmf_prod_inv-GET-product-id__table_shr_nvy_3sb__entry__2}{#tmf_prod_inv-GET-product-id__realRes-id-entry}{#tmf_prod_inv-GET-product-id__realServ-id-entry}
| Nom | Description |
|-|-|
| href | Lien relatif à l'enregistrement d'inventaire des produits. Type de données : chaîne |
| id | Sys_id de l'inventaire des produits à partir de latable Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| nom | Nom de l'inventaire des produits. Type de données : chaîne |
| lieu | Lieu associé au produit. Type de données : chaîne |
| caractéristique du produit | Liste des caractéristiques du produit. Type de données : tableau "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | Nom de la caractéristique. Type de données : chaîne |
| productCharacteristic.value | Valeur de la caractéristique. Type de données : chaîne |
| productOffering | Offre de produits à laquelle l'inventaire de produits est associé. Type de données : objet "productOffering": { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } |
| productOffering.id | Initial_version ou external_id de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| offreproduit.internalId | Initial_version de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| OffreProduit.Version Interne | Version de l'offre de produit. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| productOffering.name | Nom de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| offredeproduits.version | External_version de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| productPrice | Renvoie un tableau vide. Type de données : tableau |
| Relation produit | Liste des produits connexes. Type de données : tableau "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | Sys_id du produit connexe à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| RelationshipProduit.Type de relation | Type de relation. Type de données : chaîne |
| Spécification du produit | Spécification du produit pour le produit. Type de données : objet "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" } |
| productSpecification.id | Initial_version ou external_id des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| Spécification produit.internalId | Initial_version des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| Spécification produit.Version interne | Version de la spécification du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| spécification produit.version | External_version des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| realizingResource | Ressource qui réalise le produit. La ressource de réalisation est un inventaire de produits enfants de cet inventaire de produits. Type de données : objet "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | Sys_id de la ressource de réalisation. Situé dans la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingResource.type | Type de la ressource de réalisation. Valeur valide : enfant Type de données : chaîne |
| realizingService | Service qui réalise le produit. Le service de réalisation est un inventaire de produits enfants de cet inventaire de produits. Type de données : objet "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | Sys_id du service de réalisation. Situé dans la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingService.type | Type du service de réalisation. Valeur valide : enfant Type de données : chaîne |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | Sys_id du compte ou du contact client associé au ticket. Situé dans la table Compte \[customer_account\], Contact \[customer_contact\] ou Consommateur \[csm_consumer\]. Type de données : chaîne |
| relatedParty.@referredType | Type de client. Type de données : chaîne |
| État | État actuel du produit. Type de données : chaîne |
[ ]
{#tmf_prod_inv-GET-product-id__table_shr_nvy_3sb}
### Demande cURL
Cet exemple récupère l'inventaire d'un produit spécifié.
curl -X GET 'https://instance.service-now.com/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2' \
--user 'username':'password'
Sortie :
{
"id": "037fd87ec3603010abc8b5183c40ddf2",
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Example Company",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"name": "Routing and Configuration PI0000318",
"productSpecification": {
"id": "aec57e981bb420106ba59acf034bcb08",
"name": "Routing and Configuration",
"version": "",
"internalVersion": "1",
"internalId": "aec57e981bb420106ba59acf034bcb08"
},
"status": "Active",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"version": "",
"internalVersion": "1",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"product": "ce0b52c7532520103b6bddeeff7b12f5",
"place": {
"id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
"name": "100 South Charles Street, Baltimore,MD"
},
"productCharacteristic": [],
"productRelationship": [],
"realizingService": [],
"realizingResource": [
{
"id": "9b2fa60b536520103b6bddeeff7b1233",
"name": "Route Target"
}
],
"productPrice": [],
"href": "/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2",
"billingAccount": "Not Specified."
}
## Inventaire des produits Ouvrir l'API : GET /sn_prd_invt/productinventory {#ariaid-title4}
Récupère une liste de tous les inventaires de produits.
Important :
Ce point de terminaison est obsolète à partir de la Tokyo mise en production. La nouvelle version de ce point de terminaison est [Inventaire des produits Ouvrir l'API : GET /sn_prd_invt/product](https://servicenow-prod.fluidtopics.net/fAs~xeJ40u9gpVUptM_yBA#tmf_prod_inv-GET-product "Récupère une liste de tous les inventaires de produits.").
### Format d'URL
URL par défaut : api/sn_prd_invt/productinventory
### Paramètres de demande pris en charge
{#tmf_prod_inv-GET-prodinv__table_ofr_vgy_fsb__entry__2}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 13. Paramètres de chemin d'accès]
{#tmf_prod_inv-GET-prodinv__table_ofr_vgy_fsb} {#tmf_prod_inv-GET-prodinv__table_pfr_vgy_fsb__entry__2}
| Nom | Description |
|-|-|
| customer | Filtrer les inventaires de produits par client. Seules les offres de produits avec un sys_id client ou un ID externe correspondant à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne |
| champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Si ce paramètre n'est pas utilisé, tous les champs sont renvoyés. Type de données : chaîne |
| limite | Nombre maximal d'enregistrements à renvoyer. Pour les demandes qui dépassent ce nombre d'enregistrements, utilisez le paramètre pour paginer la récupération de l'enregistrement offset . Par défaut : 20 Maximum : 100 Type de données : nombre |
| décalage | Index de départ auquel commencer à récupérer des enregistrements. Utilisez cette valeur pour paginer la récupération des enregistrements. Cette fonctionnalité permet de récupérer tous les enregistrements, quel que soit le nombre d'enregistrements, par petits blocs gérables. Par défaut : 0 Type de données : nombre |
| lieu | Filtrer les inventaires de produits par lieu. Seules les offres de produits avec un sys_id de lieu ou un ID externe correspondant à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne |
| statut | Filtrer les inventaires de produits par statut. Seuls les inventaires de produits dont l'état correspond à la valeur de ce paramètre sont renvoyés dans la réponse. Type de données : chaîne |
[Tableau 14. Paramètres de requête]
{#tmf_prod_inv-GET-prodinv__table_pfr_vgy_fsb} {#tmf_prod_inv-GET-prodinv__table_gld_vkz_gsb__entry__2}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 15. Paramètres du corps de la demande (JSON)]
{#tmf_prod_inv-GET-prodinv__table_gld_vkz_gsb}
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#tmf_prod_inv-GET-prodinv__table_kqy_wgy_fsb__entry__2}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 16. En-têtes de demandes]
{#tmf_prod_inv-GET-prodinv__table_kqy_wgy_fsb} {#tmf_prod_inv-GET-prodinv__table_idy_qgm_lsb__entry__2}{#tmf_prod_inv-GET-prodinv__content-range-row}{#tmf_prod_inv-GET-prodinv__content-type-row}{#tmf_prod_inv-GET-prodinv__links-pagination-row}{#tmf_prod_inv-GET-prodinv__x-total-count-descr}
| En-tête | Description |
|-|-|
| Plage de contenu | Spécifie la plage de contenu renvoyée dans un appel paginé. Par exemple, si `offset=2` et `limit=3`, la valeur de l'en-tête Content-Range est `les éléments 3 à 5`. |
| Type de contenu | Format de données du corps de la réponse. Ne prend en charge application/jsonque les fichiers . |
| Lien | Contient les liens suivants pour parcourir les résultats de la requête. * premier * dernier * suivant * previous {#tmf_prod_inv-GET-prodinv__ul_zzk_sdm_lsb} |
| X-Total-Count | Pour les requêtes paginées, cet en-tête indique le nombre total d'enregistrements disponibles sur le serveur. |
[Tableau 17. En-têtes de réponses]
{#tmf_prod_inv-GET-prodinv__table_idy_qgm_lsb}
### Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#tmf_prod_inv-GET-prodinv__table_hl1_rcm_lsb__entry__2}{#tmf_prod_inv-GET-prodinv__tmf-get-status-200-p}{#tmf_prod_inv-GET-prodinv__tmf-get-status-206-entry}{#tmf_prod_inv-GET-prodinv__tmf-get-status-400-entry}{#tmf_prod_inv-GET-prodinv__tmf-get-status-404-entry}
| Code d'état | Description |
|-|-|
| 200 | Demande traitée avec succès. Ressource complète renvoyée en réponse (aucune pagination). |
| 206 | Ressource partielle renvoyée en réponse (avec pagination). |
| 400 | Demande incorrecte. Raisons possibles : * Paramètre de chemin d'accès non valide * URI non valide {#tmf_prod_inv-GET-prodinv__ul_rys_1gy_fsb} |
| 404 | Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n'a été trouvé dans la table. |
[Tableau 18. Codes d'état]
{#tmf_prod_inv-GET-prodinv__table_hl1_rcm_lsb}
### Paramètres de corps de réponse (JSON) {#tmf_prod_inv-GET-prodinv__section_rhr_nvy_3sb}
{#tmf_prod_inv-GET-prodinv__table_shr_nvy_3sb__entry__2}
| Nom | Description |
|-|-|
| id | Sys_id de l'inventaire des produits à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| nom | Nom de l'inventaire des produits. Type de données : chaîne |
| lieu | Lieu associé au produit. Type de données : chaîne |
| caractéristique du produit | Liste des caractéristiques du produit. Type de données : tableau "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | Nom de la caractéristique. Type de données : chaîne |
| productCharacteristic.value | Valeur de la caractéristique. Type de données : chaîne |
| productOffering | Offre de produits à laquelle l'inventaire de produits est associé. Type de données : objet "productOffering": { "id": "String", "name": "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.name | Nom de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| Relation produit | Liste des produits connexes. Type de données : tableau "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | Sys_id du produit connexe à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| RelationshipProduit.Type de relation | Type de relation. 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" } |
| productSpecification.id | Sys_id des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| realizingResource | Réalisation de la ressource. Type de données : objet "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | Sys_id de la ressource de réalisation à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingResource.type | Type de la ressource de réalisation. Type de données : chaîne |
| realizingService | Réalisation du service. Type de données : objet "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | Sys_id du service de réalisation à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingService.type | Type du service de réalisation. Type de données : chaîne |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | Sys_id du compte ou du contact client associé au ticket. Situé dans la table Compte \[customer_account\], Contact \[customer_contact\] ou Consommateur \[csm_consumer\]. Type de données : chaîne |
| relatedParty.@referredType | Type de client. Valeurs possibles : * customer * contact client * consommateur {#tmf_prod_inv-GET-prodinv__ul_jqs_vbh_fwb} Type de données : chaîne |
| État | État actuel du produit. Type de données : chaîne |
[ ]
{#tmf_prod_inv-GET-prodinv__table_shr_nvy_3sb}
### Demande cURL {#tmf_prod_inv-GET-prodinv__example_ld5_lnz_3sb}
Cet exemple récupère tous les inventaires de produits.
curl "https://instance.servicenow.com/api/sn_prd_invt/productinventory" \
--request GET \
--user 'username':'password'
Corps de réponse.
[
{
"id": "075072aec3a83010abc8b5183c40dd44",
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"name": "Firewall Administration PI0000300",
"productSpecification": {
"id": "31c5caff07266010a7955b7e0ad3006b",
"name": "Firewall Administration"
},
"status": "Active",
"productOffering": {
"id": "",
"name": ""
},
"place": {
"id": "920cf6ac73d423002728660c4cf6a799",
"name": "200 South James street,Atlanta, GA"
},
"productCharacteristic": [
{
"name": "Firewall Administration CPE Type",
"valueType": "Choice",
"value": "Physical"
},
{
"name": "Configuration and Policy backup",
"valueType": "Choice",
"value": ""
},
{
"name": "Firewall Administration CPE ID",
"valueType": "Single Line Text",
"value": "CPE123456789"
},
{
"name": "Remote CLI troubleshoot support",
"valueType": "Choice",
"value": ""
},
{
"name": "Firewall Administration CPE Model",
"valueType": "Choice",
"value": "9300 series"
}
],
"productRelationship": [],
"realizingService": [],
"realizingResource": [
{
"id": "3546463307666010a7955b7e0ad3005d",
"name": "Cisco Firewall Management system"
}
]
},
{
"id": "0303a8ea74418510f877ca57242ff96d",
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"name": "SD-WAN Edge Device PI0001114",
"productSpecification": {
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device"
},
"status": "Installation Pending",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"place": "",
"productCharacteristic": [],
"productRelationship": [],
"realizingService": [
{
"id": "bf65eadc1b7420106ba59acf034bcb57",
"name": "SD-WAN Routing"
},
{
"id": "16d79ec3532520103b6bddeeff7b12a6",
"name": "SD WAN Optimization Service"
},
{
"id": "16d79ec3532520103b6bddeeff7b12a6",
"name": "SD WAN Optimization Service"
},
{
"id": "bf65eadc1b7420106ba59acf034bcb57",
"name": "SD-WAN Routing"
},
{
"id": "bf65eadc1b7420106ba59acf034bcb57",
"name": "SD-WAN Routing"
},
{
"id": "bf65eadc1b7420106ba59acf034bcb57",
"name": "SD-WAN Routing"
}
],
"realizingResource": [
{
"id": "493fa60b536520103b6bddeeff7b12b6",
"name": "Customer Premise SD-WAN Router"
}
]
}
]
## Inventaire des produits Ouvrir l'API : GET /sn_prd_invt/productinventory/{inventoryId} {#ariaid-title5}
Récupère un inventaire de produits.
Important :
Ce point de terminaison est obsolète à partir de la Tokyo mise en production. La nouvelle version de ce point de terminaison est [Inventaire des produits API ouverte : GET /sn_prd_invt/product/{id}](https://servicenow-prod.fluidtopics.net/fAs~xeJ40u9gpVUptM_yBA#tmf_prod_inv-GET-product-id "Récupère un enregistrement d’inventaire de produits spécifié.").
### Format d'URL
URL par défaut : /api/sn_prd_invt/productinventory/{inventoryId}
### Paramètres de demande pris en charge {#tmf_prod_inv-GET-prodinv-id__section_esr_w5y_3sb}
{#tmf_prod_inv-GET-prodinv-id__table_apt_nkz_gsb__entry__2}
| Nom | Description |
|-|-|
| ID inventaire | Sys_id de l'inventaire des produits à récupérer. Situé dans la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
[Tableau 19. Paramètres de chemin d'accès]
{#tmf_prod_inv-GET-prodinv-id__table_apt_nkz_gsb} {#tmf_prod_inv-GET-prodinv-id__table_pfr_vgy_fsb__entry__2}
| Nom | Description |
|-|-|
| customer | Filtrer les inventaires de produits par client. Seules les offres de produits avec un sys_id client ou un ID externe correspondant à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne |
| champs | Liste des champs à renvoyer dans la réponse. Les champs non valides sont ignorés. Si ce paramètre n'est pas utilisé, tous les champs sont renvoyés. Type de données : chaîne |
| lieu | Filtrer les inventaires de produits par lieu. Seules les offres de produits avec un sys_id de lieu ou un ID externe correspondant à la valeur de ce paramètre sont renvoyées dans la réponse. Type de données : chaîne |
| statut | Filtrer les inventaires de produits par statut. Seuls les inventaires de produits dont l'état correspond à la valeur de ce paramètre sont renvoyés dans la réponse. Type de données : chaîne |
[Tableau 20. Paramètres de requête]
{#tmf_prod_inv-GET-prodinv-id__table_pfr_vgy_fsb} {#tmf_prod_inv-GET-prodinv-id__table_gld_vkz_gsb__entry__2}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 21. Paramètres du corps de la demande (JSON)]
{#tmf_prod_inv-GET-prodinv-id__table_gld_vkz_gsb}
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#tmf_prod_inv-GET-prodinv-id__table_kqy_wgy_fsb__entry__2}
| En-tête | Description |
|-|-|
| Aucun | |
[Tableau 22. En-têtes de demandes]
{#tmf_prod_inv-GET-prodinv-id__table_kqy_wgy_fsb} {#tmf_prod_inv-GET-prodinv-id__table_tzy_thy_ksb__entry__2}
| En-tête | Description |
|-|-|
| Type de contenu | Format de données du corps de la réponse. Ne prend en charge application/jsonque les fichiers . |
[Tableau 23. En-têtes de réponses]
{#tmf_prod_inv-GET-prodinv-id__table_tzy_thy_ksb}
### Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#tmf_prod_inv-GET-prodinv-id__table_nxj_ykz_gsb__entry__2}
| Code d'état | Description |
|-|-|
| 200 | Demande traitée avec succès. |
| 400 | Demande incorrecte. L'une des raisons suivantes peut être l'une des suivantes : * Paramètre de chemin d'accès non valide * URI non valide {#tmf_prod_inv-GET-prodinv-id__ul_rys_1gy_fsb} |
| 404 | Enregistrement introuvable. L'enregistrement associé à l'ID est introuvable dans la table. |
[Tableau 24. Codes d'état]
{#tmf_prod_inv-GET-prodinv-id__table_nxj_ykz_gsb}
### Paramètres de corps de réponse (JSON) {#tmf_prod_inv-GET-prodinv-id__section_rhr_nvy_3sb}
{#tmf_prod_inv-GET-prodinv-id__table_shr_nvy_3sb__entry__2}
| Nom | Description |
|-|-|
| id | Sys_id de l'inventaire des produits à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| nom | Nom de l'inventaire des produits. Type de données : chaîne |
| lieu | Lieu associé au produit. Type de données : chaîne |
| caractéristique du produit | Liste des caractéristiques du produit. Type de données : tableau "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | Nom de la caractéristique. Type de données : chaîne |
| productCharacteristic.value | Valeur de la caractéristique. Type de données : chaîne |
| productOffering | Offre de produits à laquelle l'inventaire de produits est associé. Type de données : objet "productOffering": { "id": "String", "name": "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.name | Nom de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| Relation produit | Liste des produits connexes. Type de données : tableau "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | Sys_id du produit connexe à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| RelationshipProduit.Type de relation | Type de relation. 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" } |
| productSpecification.id | Sys_id des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| realizingResource | Réalisation de la ressource. Type de données : objet "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | Sys_id de la ressource de réalisation à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingResource.type | Type de la ressource de réalisation. Type de données : chaîne |
| realizingService | Réalisation du service. Type de données : objet "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | Sys_id du service de réalisation à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingService.type | Type du service de réalisation. Type de données : chaîne |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | Sys_id du compte ou du contact client associé au ticket. Situé dans la table Compte \[customer_account\], Contact \[customer_contact\] ou Consommateur \[csm_consumer\]. Type de données : chaîne |
| relatedParty.@referredType | Type de client. Valeurs possibles : * Client * Contact du client * Consommateur {#tmf_prod_inv-GET-prodinv-id__ul_jqs_vbh_fwb} Type de données : chaîne |
| État | État actuel du produit. Type de données : chaîne |
[ ]
{#tmf_prod_inv-GET-prodinv-id__table_shr_nvy_3sb}
### Demande cURL
Cet exemple récupère un inventaire de produits pour un package de services SD-WAN.
curl --location --request GET 'https:// instance.servicenow.com/api/sn_prd_invt/productinventory/074450fc74918d10f877ca57242ff9e3' \
--user 'username':'password'
Sortie :
{
"id": "074450fc74918d10f877ca57242ff9e3",
"relatedParty": [
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
},
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
}
],
"name": "SD-WAN Service Package PI0001576",
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package"
},
"status": "Installation Pending",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering"
},
"place": "",
"productCharacteristic": [],
"productRelationship": [
{
"id": "a74490fc74918d10f877ca57242ff942",
"name": "SD-WAN Edge Device PI0001582",
"relationshipType": "Bundles"
},
{
"id": "b85414fc74918d10f877ca57242ff90e",
"name": "SD-WAN Controller PI0001602",
"relationshipType": "Bundles"
},
{
"id": "d74490fc74918d10f877ca57242ff907",
"name": "SD-WAN Security PI0001577",
"relationshipType": "Bundles"
}
],
"realizingService": [],
"realizingResource": []
}
## Inventaire des produits API ouverte : POST /sn_prd_invt/product {#ariaid-title6}
Crée un enregistrement d'inventaire de produits.
### Format d'URL
URL par défaut : /api/sn_prd_invt/product
### Paramètres de demande pris en charge
{#tmf_prod_inv-POST-product__table_o3n_mvf_hsb__entry__2}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 25. Paramètres de chemin d'accès]
{#tmf_prod_inv-POST-product__table_o3n_mvf_hsb} {#tmf_prod_inv-POST-product__table_nbq_zds_3sb__entry__2}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 26. Paramètres de requête]
{#tmf_prod_inv-POST-product__table_nbq_zds_3sb} {#tmf_prod_inv-POST-product__entry__10}
| Nom | Description |
|-|-|
| nom | Requis. Nom de l'inventaire des produits. Type de données : chaîne |
| pid | Identificateur unique pour l'inventaire des produits provenant du système externe. Type de données : chaîne Par défaut : chaîne vide |
| caractéristique du produit | Liste des caractéristiques du produit. Type de données : tableau "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | Nom de la caractéristique. Type de données : chaîne Par défaut : chaîne vide |
| productCharacteristic.value | Valeur de la caractéristique. Type de données : chaîne Par défaut : chaîne vide |
| productOffering | Requis. Offre de produits à laquelle l'inventaire de produits est associé. Type de données : objet "productOffering": { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } |
| productOffering.id | Requis. Initial_version ou external_id de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| OffreProduit.Version Interne | Version de l'offre de produit. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| productOffering.name | Nom de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne Par défaut : chaîne vide |
| offredeproduits.version | External_version de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| Relation produit | Liste des produits connexes. Type de données : tableau "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | Requis si le productRelationship paramètre est utilisé. Sys_id du produit connexe à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| RelationshipProduit.Type de relation | Type de relation. La seule valeur valide est enfant. 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", "internalVersion": "String", "version": "String" } |
| productSpecification.id | Requis. Initial_version ou external_id des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| Spécification produit.Version interne | Version de la spécification du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| spécification produit.version | External_version des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| realizingResource | Ressource qui réalise le produit. La ressource de réalisation est un inventaire de produits enfants de cet inventaire de produits. Type de données : objet "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | Requis si le realizingResource paramètre est utilisé. Sys_id de la ressource de réalisation. Situé dans la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingResource.type | Type de la ressource de réalisation. Valeur valide : enfant Type de données : chaîne |
| realizingService | Service qui réalise le produit. Le service de réalisation est un inventaire de produits enfants de cet inventaire de produits. Type de données : objet "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | Requis si le realizingService paramètre est utilisé. Sys_id du service de réalisation. Situé dans la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingService.type | Type du service de réalisation. Valeur valide : enfant Type de données : chaîne |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | Requis si le relatedParty paramètre est utilisé. Sys_id du compte ou du contact client associé au ticket. Situé dans la table Compte \[customer_account\], Contact \[customer_contact\] ou Consommateur \[csm_consumer\]. Type de données : chaîne |
| relatedParty.@referredType | Type de client. Valeurs possibles : * customer * customer_contact * consommateur {#tmf_prod_inv-POST-product__ul_dhg_ngs_3sb} Type de données : chaîne Par défaut : chaîne vide |
| État | État actuel du produit. Valeurs possibles : * Actif * change_pending * inactivation_pending * inactif * installation_pending {#tmf_prod_inv-POST-product__ul_blq_yw5_4sb} Type de données : chaîne Par défaut : installation_pending |
[Tableau 27. Paramètres du corps de la demande (JSON)]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#tmf_prod_inv-POST-product__table_ett_h3z_gsb__entry__2}{#tmf_prod_inv-POST-product__accept-JSON-only-entry-RESTAPI}{#tmf_prod_inv-POST-product__content_type-JSON-only-entry-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
[Tableau 28. En-têtes de demandes]
{#tmf_prod_inv-POST-product__table_ett_h3z_gsb} {#tmf_prod_inv-POST-product__table_tzy_thy_ksb__entry__2}
| En-tête | Description |
|-|-|
| Type de contenu | Format de données du corps de la réponse. Ne prend en charge application/jsonque les fichiers . |
[Tableau 29. En-têtes de réponses]
{#tmf_prod_inv-POST-product__table_tzy_thy_ksb}
### Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#tmf_prod_inv-POST-product__table_fbw_k3z_gsb__entry__2}
| Code d'état | Description |
|-|-|
| 201 | Demande traitée avec succès. |
| 400 | Demande incorrecte. L'une des raisons suivantes peut être l'une des suivantes : * Charge utile vide. * Charge utile non valide. Champ obligatoire manquant : \ {#tmf_prod_inv-POST-product__ul_nc5_myx_fsb} |
[Tableau 30. Codes d'état]
{#tmf_prod_inv-POST-product__table_fbw_k3z_gsb}
### Paramètres de corps de réponse (JSON)
{#tmf_prod_inv-POST-product__entry__82}{#tmf_prod_inv-POST-product__realRes-id-entry}{#tmf_prod_inv-POST-product__realServ-id-entry}
| Nom | Description |
|-|-|
| href | Lien relatif à l'enregistrement d'inventaire des produits. Type de données : chaîne |
| id | Sys_id de l'inventaire des produits à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| nom | Nom de l'inventaire des produits. Type de données : chaîne |
| pid | Identificateur unique pour l'inventaire des produits provenant du système externe. Type de données : chaîne |
| caractéristique du produit | Liste des caractéristiques du produit. Type de données : tableau "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | Nom de la caractéristique. Type de données : chaîne |
| productCharacteristic.value | Valeur de la caractéristique. Type de données : chaîne |
| productOffering | Offre de produits à laquelle l'inventaire de produits est associé. Type de données : objet "productOffering": { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } |
| productOffering.id | Initial_version ou external_id de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| offreproduit.internalId | Initial_version de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| OffreProduit.Version Interne | Version de l'offre de produit. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| productOffering.name | Nom de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| offredeproduits.version | External_version de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| productPrice | Renvoie un tableau vide. Type de données : tableau |
| Relation produit | Liste des produits connexes. Type de données : tableau "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | Sys_id du produit connexe à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| RelationshipProduit.Type de relation | Type de relation. Type de données : chaîne |
| Spécification du produit | Spécification du produit pour le produit. Type de données : objet "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" } |
| productSpecification.id | Initial_version ou external_id des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| Spécification produit.internalId | Initial_version des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| Spécification produit.Version interne | Version de la spécification du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| spécification produit.version | External_version des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| realizingResource | Ressource qui réalise le produit. La ressource de réalisation est un inventaire de produits enfants de cet inventaire de produits. Type de données : objet "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | Sys_id de la ressource de réalisation. Situé dans la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingResource.type | Type de la ressource de réalisation. Valeur valide : enfant Type de données : chaîne |
| realizingService | Service qui réalise le produit. Le service de réalisation est un inventaire de produits enfants de cet inventaire de produits. Type de données : objet "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | Sys_id du service de réalisation. Situé dans la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingService.type | Type du service de réalisation. Valeur valide : enfant Type de données : chaîne |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | Sys_id du compte ou du contact client associé au ticket. Situé dans la table Compte \[customer_account\], Contact \[customer_contact\] ou Consommateur \[csm_consumer\]. Type de données : chaîne |
| relatedParty.@referredType | Type de client. Valeurs possibles : * Client * Contact du client * Consommateur {#tmf_prod_inv-POST-product__ul_jqs_vbh_fwb} Type de données : chaîne |
| État | État actuel du produit. Type de données : chaîne |
[ ]
### Demande cURL
Cet exemple crée un inventaire de produits pour une solution de voix sur IP pour un utilisateur.
curl -X POST "https://instance.service-now.com/api/sn_prd_invt/product" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password" \
--data "[
{
"pid": "PO-456",
"description": "inventory description",
"isBundle": false,
"name": "Voice Over IP Basic instance for Jean",
"productOffering": {
"@referredType": "ProductOffering",
"name": "Premium SD-WAN Offering",
"id": "69017a0f536520103b6bddeeff7b127d"
},
"productCharacteristic": [],
"productRelationship": [
{
"productId": "fa6d13f45b5620102dff5e92dc81c77f",
"relationshipType": "child"
}
],
"realizingService": {
"id": "fe6d13f45b5620102dff5e92dc81c786",
"relationshipType": "child"
},
"realizingResource": {
"id": "326d13f45b5620102dff5e92dc81c78c",
"relationshipType": "child"
},
"relatedParty": [
{
"@referredType": "CustomerContact",
"@type": "RelatedParty",
"name": "Sally Thomas",
"id": "eaf68911c35420105252716b7d40ddde"
},
{
"@referredType": "Customer",
"@type": "RelatedParty",
"name": "Funco Intl",
"id": "ffc68911c35420105252716b7d40dd55"
}
],
"productSpecification": {
"@referredType": "ProductSpecification",
"@type": null,
"name": null,
"id": "3ee1fdb1c3331010d216b5183c40dd81",
"internalVersion": "1"
},
"bundle": false
}
]"
Corps de réponse.
{
"pid": "PO-456",
"description": "inventory description",
"isBundle": false,
"name": "Voice Over IP Basic instance for Jean",
"productOffering": {
"@referredType": "ProductOffering",
"name": "Premium SD-WAN Offering",
"id": "69017a0f536520103b6bddeeff7b127d",
"internalVersion": "1",
"version": null,
"status": "published",
"internalId": "69017a0f536520103b6bddeeff7b127d"
},
"productCharacteristic": [],
"productRelationship": [
{
"productId": "fa6d13f45b5620102dff5e92dc81c77f",
"relationshipType": "child"
}
],
"realizingService": {
"id": "fe6d13f45b5620102dff5e92dc81c786",
"relationshipType": "child"
},
"realizingResource": {
"id": "326d13f45b5620102dff5e92dc81c78c",
"relationshipType": "child"
},
"relatedParty": [
{
"@referredType": "CustomerContact",
"@type": "RelatedParty",
"name": "Sally Thomas",
"id": "eaf68911c35420105252716b7d40ddde"
},
{
"@referredType": "Customer",
"@type": "RelatedParty",
"name": "Example Company",
"id": "ffc68911c35420105252716b7d40dd55"
}
],
"productSpecification": {
"@referredType": "ProductSpecification",
"@type": null,
"name": null,
"id": "3ee1fdb1c3331010d216b5183c40dd81",
"internalVersion": "1",
"version": null,
"status": "published",
"internalId": "3ee1fdb1c3331010d216b5183c40dd81"
},
"bundle": false,
"productPrice": [],
"id": "25b07475471789108761b955d36d439d",
"href": "/api/sn_prd_invt/product/25b07475471789108761b955d36d439d"
}
## Inventaire des produits API ouverte : POST /sn_prd_invt/productinventory {#ariaid-title7}
Crée un inventaire des produits.
Important :
Ce point de terminaison est obsolète à partir de la Tokyo mise en production. La nouvelle version de ce point de terminaison est [Inventaire des produits API ouverte : POST /sn_prd_invt/product](https://servicenow-prod.fluidtopics.net/fAs~xeJ40u9gpVUptM_yBA#tmf_prod_inv-POST-product "Crée un enregistrement d’inventaire de produits.").
### Format d'URL
URL par défaut : /api/sn_prd_invt/productinventory
### Paramètres de demande pris en charge
{#tmf_prod_inv-POST-prodinv__table_o3n_mvf_hsb__entry__2}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 31. Paramètres de chemin d'accès]
{#tmf_prod_inv-POST-prodinv__table_o3n_mvf_hsb} {#tmf_prod_inv-POST-prodinv__table_nbq_zds_3sb__entry__2}
| Nom | Description |
|-|-|
| Aucun | |
[Tableau 32. Paramètres de requête]
{#tmf_prod_inv-POST-prodinv__table_nbq_zds_3sb} {#tmf_prod_inv-POST-prodinv__entry__10}
| Nom | Description |
|-|-|
| nom | Requis. Nom de l'inventaire des produits. Type de données : chaîne |
| pid | Identificateur unique pour l'inventaire des produits provenant du système externe. Type de données : chaîne Par défaut : chaîne vide |
| caractéristique du produit | Liste des caractéristiques du produit. Type de données : tableau "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | Nom de la caractéristique. Type de données : chaîne Par défaut : chaîne vide |
| productCharacteristic.value | Valeur de la caractéristique. Type de données : chaîne Par défaut : chaîne vide |
| productOffering | Requis. Offre de produits à laquelle l'inventaire de produits est associé. Type de données : objet "productOffering": { "id": "String", "name": "String" } |
| productOffering.id | Requis. 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.name | Nom de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne Par défaut : chaîne vide |
| Relation produit | Liste des produits connexes. Type de données : tableau "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | Requis si le productRelationship paramètre est utilisé. Sys_id du produit connexe à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| RelationshipProduit.Type de relation | Type de relation. La seule valeur valide est enfant. 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" } |
| productSpecification.id | Requis. Sys_id des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| realizingResource | Réalisation de la ressource. Type de données : objet "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | Requis si le realizingResource paramètre est utilisé. Sys_id de la ressource de réalisation à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingResource.type | Type de la ressource de réalisation. La seule valeur valide est enfant. Type de données : chaîne Par défaut : chaîne vide |
| realizingService | Réalisation du service. Type de données : objet "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | Requis si le realizingService paramètre est utilisé. Sys_id du service de réalisation à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingService.type | Type du service de réalisation. La seule valeur valide est enfant. Type de données : chaîne Par défaut : chaîne vide |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | Requis si le relatedParty paramètre est utilisé. Sys_id du compte ou du contact client associé au ticket. Situé dans la table Compte \[customer_account\], Contact \[customer_contact\] ou Consommateur \[csm_Consumer\]. Type de données : chaîne |
| relatedParty.@referredType | Type de client. Valeurs possibles : * customer * customer_contact * consommateur {#tmf_prod_inv-POST-prodinv__ul_dhg_ngs_3sb} Type de données : chaîne Par défaut : chaîne vide |
| État | État actuel du produit. Valeurs possibles : * Actif * change_pending * inactivation_pending * inactif * installation_pending {#tmf_prod_inv-POST-prodinv__ul_blq_yw5_4sb} Type de données : chaîne Par défaut : installation_pending |
[Tableau 33. Paramètres du corps de la demande (JSON)]
### En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l'API REST, consultez [En-têtes d'API REST pris en charge](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#tmf_prod_inv-POST-prodinv__table_ett_h3z_gsb__entry__2}{#tmf_prod_inv-POST-prodinv__accept-JSON-only-entry-RESTAPI}{#tmf_prod_inv-POST-prodinv__content_type-JSON-only-entry-RESTAPI}
| En-tête | Description |
|-|-|
| Accepter | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
| Content-Type | Format de données du corps de la demande. Prend uniquement en charge application/json. |
[Tableau 34. En-têtes de demandes]
{#tmf_prod_inv-POST-prodinv__table_ett_h3z_gsb} {#tmf_prod_inv-POST-prodinv__table_tzy_thy_ksb__entry__2}
| En-tête | Description |
|-|-|
| Type de contenu | Format de données du corps de la réponse. Ne prend en charge application/jsonque les fichiers . |
[Tableau 35. En-têtes de réponses]
{#tmf_prod_inv-POST-prodinv__table_tzy_thy_ksb}
### Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d'état possibles utilisés dans l'API REST, consultez [Codes de réponse HTTP de l'API REST](https://servicenow-prod.fluidtopics.net/CFQa7z9NIrhoOq1u1cRN7g "REST (REpresentational State Transfer) est une architecture simple sans état qui fournit des normes entre les systèmes informatiques sur le Web, ce qui leur permet de communiquer plus facilement les uns avec les autres.").
{#tmf_prod_inv-POST-prodinv__table_fbw_k3z_gsb__entry__2}
| Code d'état | Description |
|-|-|
| 201 | Demande traitée avec succès. |
| 400 | Demande incorrecte. L'une des raisons suivantes peut être l'une des suivantes : * Charge utile vide. * Charge utile non valide. Champ obligatoire manquant : \ {#tmf_prod_inv-POST-prodinv__ul_nc5_myx_fsb} |
[Tableau 36. Codes d'état]
{#tmf_prod_inv-POST-prodinv__table_fbw_k3z_gsb}
### Paramètres de corps de réponse (JSON)
{#tmf_prod_inv-POST-prodinv__entry__74}
| Nom | Description |
|-|-|
| id | Sys_id de l'inventaire des produits à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| nom | Nom de l'inventaire des produits. Type de données : chaîne |
| pid | Identificateur unique pour l'inventaire des produits provenant du système externe. Type de données : chaîne |
| caractéristique du produit | Liste des caractéristiques du produit. Type de données : tableau "productCharacteristic": [ { "name": "String", "value": "String" } ] |
| productCharacteristic.name | Nom de la caractéristique. Type de données : chaîne |
| productCharacteristic.value | Valeur de la caractéristique. Type de données : chaîne |
| productOffering | Offre de produits à laquelle l'inventaire de produits est associé. Type de données : objet "productOffering": { "id": "String", "name": "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.name | Nom de l'offre de produits. Situé dans la table Offre de produits \[sn_prd_pm_product_offering\]. Type de données : chaîne |
| Relation produit | Liste des produits connexes. Type de données : tableau "productRelationship": [ { "productId": "String", "relationshipType": "String" } ] |
| productRelationship.productId | Sys_id du produit connexe à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| RelationshipProduit.Type de relation | Type de relation. 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" } |
| productSpecification.id | Sys_id des spécifications du produit. Situé dans la table Spécification de produit \[sn_prd_pm_product_specification\]. Type de données : chaîne |
| realizingResource | Réalisation de la ressource. Type de données : objet "realizingResource": { "id": "String", "type": "String" } |
| realizingResource.id | Sys_id de la ressource de réalisation à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingResource.type | Type de la ressource de réalisation. Type de données : chaîne |
| realizingService | Réalisation du service. Type de données : objet "realizingService": { "id": "String", "type": "String" } |
| realizingService.id | Sys_id du service de réalisation à partir de la table Inventaire des produits \[sn_prd_invt_product_inventory\]. Type de données : chaîne |
| realizingService.type | Type du service de réalisation. Type de données : chaîne |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau "relatedParty": [ { "id": "String", "@referredType": "String" } ] |
| relatedParty.id | Sys_id du compte ou du contact client associé au ticket. Situé dans la table Compte \[customer_account\], Contact \[customer_contact\] ou Consommateur \[csm_consumer\]. Type de données : chaîne |
| relatedParty.@referredType | Type de client. Valeurs possibles : * Client * Contact du client * Consommateur {#tmf_prod_inv-POST-prodinv__ul_jqs_vbh_fwb} Type de données : chaîne |
| État | État actuel du produit. Type de données : chaîne |
[ ]
### Demande cURL
Cet exemple crée un inventaire de produits pour une solution de voix sur IP pour un utilisateur.
curl --location --request POST "https://instance.servicenow.com/api/sn_prd_invt/productinventory" \
--header "Content-Type: application/json" \
--data-raw '[
{
"pid": "demoInventory",
"description": "inventory description",
"isBundle": false,
"name": "Voice Over IP Basic instance for Jean",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"@referredType": "ProductOffering"
},
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "choice",
"value": "Virtual"
},
{
"name":"Routing",
"valueType": "choice",
"value": "Premium"
}
],
"productRelationship": [
{
"productId": "7e6d13f45b5620102dff5e92dc81c787",
"relationshipType": "child"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"role": "User",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@referredType": "ProductSpecification",
"version": "1"
}
}
]'
--user 'username':'password'
Corps de réponse.
{
"pid": "demoInventory",
"description": "inventory description",
"isBundle": false,
"name": "Voice Over IP Basic instance for Jean",
"productOffering": {
"id": "69017a0f536520103b6bddeeff7b127d",
"name": "Premium SD-WAN Offering",
"@referredType": "ProductOffering"
},
"productCharacteristic": [
{
"name": "CPE Type",
"valueType": "choice",
"value": "Virtual"
},
{
"name": "Routing",
"valueType": "choice",
"value": "Premium"
}
],
"productRelationship": [
{
"productId": "7e6d13f45b5620102dff5e92dc81c787",
"relationshipType": "child"
}
],
"relatedParty": [
{
"id": "eaf68911c35420105252716b7d40ddde",
"name": "Sally Thomas",
"role": "User",
"@type": "RelatedParty",
"@referredType": "CustomerContact"
},
{
"id": "ffc68911c35420105252716b7d40dd55",
"name": "Funco Intl",
"@type": "RelatedParty",
"@referredType": "Customer"
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"@referredType": "ProductSpecification",
"version": "1"
},
"id": "3ac715c6745d8150f877ca57242ff97a"
}