API ouverte de l’inventaire des produits
L’API ouverte Product Inventory 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 des produits entre les systèmes externes et le Now Platform.
Cette API est incluse dans l’application Product Inventory Advanced, disponible sur le 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 des 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]
L’API Product Inventory Open est une ServiceNow® implémentation de la spécification REST de l’API Product Inventory Management du TM Forum. Cette implémentation est basée sur la spécification REST de l’API TMF637 Product Inventory Management, version 19 d’août 2019. L’API ouverte Product Inventory est certifiée conforme par TM Forum.
API ouverte d’inventaire des produits : GET /sn_prd_invt/product
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
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| customer | Filtrez 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 offset paramètre pour paginer la récupération des enregistrements. Par défaut : 20 Maximum : 100 Type de données : nombre |
| décalage | Index de départ auquel commencer la récupération d’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 |
| Endroit | Filtrez 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 | Filtrez les sourcesde 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 |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Aucun |
| En-tête | Description |
|---|---|
| Plage de contenu | Spécifie la plage de contenu renvoyée dans un appel paginé. Par exemple, si |
| Type de contenu | Format de 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.
|
| X-Total-Count | Pour les requêtes paginées, cet en-tête spécifie le nombre total d’enregistrements disponibles sur le serveur. |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Demande traitée avec succès. Ressource entière renvoyée en réponse (aucune pagination). |
| 206 | Ressource partielle renvoyée en réponse (avec pagination). |
| 400 | Demande incorrecte. Raisons possibles :
|
| 404 | Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| href | Lien relatif à l’enregistrement de l’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 |
| Endroit | 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 | Nom de la caractéristique. Type de données : chaîne |
| valeur.CaractéristiqueProduit | Valeur de la caractéristique. Type de données : chaîne |
| productOffering | Offre de produit à laquelle l’inventaire de produits est associé. Type de données : objet |
| productOffering.id | Initial_version ou external_id de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne |
| productOffering.internalId | Initial_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.internalVersion | 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 produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne |
| version.offre.produit | External_version de l’offre de produit. 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 | Sys_id du produit connexe issu de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| RelationProduit.Type de relation | Type de relation. Type de données : chaîne |
| Spécification du produit | Spécifications du produit. Type de données : objet |
| productSpecification.id | Initial_version ou external_id de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| productSpecification.internalId | Initial_version de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| productSpecification.internalVersion | Version de la spécification de 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 de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| realizingResource (en anglais seulement) | Ressource qui réalise le produit. La ressource de réalisation est un inventaire de produit enfant de cet inventaire de produits. Type de données : objet |
| realizingResource.id | Sys_id de la ressource réalisatrice. Situé dans la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| realizingResource.type | Type de la ressource en cours 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 produit enfant de ce stock de produits. Type de données : objet |
| realizingService.id | Sys_id de la réalisation du service. Situé dans la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| realizingService.type | Type de la prestation réalisée. Valeur valide : enfant Type de données : chaîne |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau |
| relatedParty.id | Sys_id du compte ou du contact du 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 :
Type de données : chaîne |
| État | État actuel du produit. Type de données : chaîne |
Demande cURL
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 la 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 Ouvrir l’API : GET /sn_prd_invt/product/{id}
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
| 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 |
| Nom | Description |
|---|---|
| customer | Filtrez 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 |
| Endroit | Filtrez 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 | Filtrez les inventaires de produits par état. 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 |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Néant |
| En-tête | Description |
|---|---|
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Demande traitée avec succès. |
| 400 | Demande incorrecte. Cela peut être l’une des raisons suivantes :
|
| 404 | Enregistrement introuvable. L’enregistrement associé à l’ID ne se trouve pas dans la table. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| href | Lien relatif à l’enregistrement de l’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 |
| Endroit | 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 | Nom de la caractéristique. Type de données : chaîne |
| valeur.CaractéristiqueProduit | Valeur de la caractéristique. Type de données : chaîne |
| productOffering | Offre de produit à laquelle l’inventaire de produits est associé. Type de données : objet |
| productOffering.id | Initial_version ou external_id de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne |
| productOffering.internalId | Initial_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.internalVersion | 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 produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne |
| version.offre.produit | External_version de l’offre de produit. 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 | Sys_id du produit connexe issu de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| RelationProduit.Type de relation | Type de relation. Type de données : chaîne |
| Spécification du produit | Spécifications du produit. Type de données : objet |
| productSpecification.id | Initial_version ou external_id de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| productSpecification.internalId | Initial_version de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| productSpecification.internalVersion | Version de la spécification de 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 de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| realizingResource (en anglais seulement) | Ressource qui réalise le produit. La ressource de réalisation est un inventaire de produit enfant de cet inventaire de produits. Type de données : objet |
| realizingResource.id | Sys_id de la ressource réalisatrice. Situé dans la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| realizingResource.type | Type de la ressource en cours 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 produit enfant de ce stock de produits. Type de données : objet |
| realizingService.id | Sys_id de la réalisation du service. Situé dans la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| realizingService.type | Type de la prestation réalisée. Valeur valide : enfant Type de données : chaîne |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau |
| relatedParty.id | Sys_id du compte ou du contact du 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 |
Demande cURL
Cet exemple récupère un inventaire de produits 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
Récupère une liste de tous les inventaires de produits.
Important :
À partir de la Tokyo version, ce point de terminaison est déconseillé. La nouvelle version de ce point de terminaison est API ouverte d’inventaire des produits : GET /sn_prd_invt/product.
Format d'URL
URL par défaut : api/sn_prd_invt/productinventory
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| customer | Filtrez 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 offset paramètre pour paginer la récupération des enregistrements. Par défaut : 20 Maximum : 100 Type de données : nombre |
| décalage | Index de départ auquel commencer la récupération d’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 |
| Endroit | Filtrez 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 | Filtrez les inventaires de produits par état. 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 |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Aucun |
| En-tête | Description |
|---|---|
| Plage de contenu | Spécifie la plage de contenu renvoyée dans un appel paginé. Par exemple, si |
| Type de contenu | Format de 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.
|
| X-Total-Count | Pour les requêtes paginées, cet en-tête spécifie le nombre total d’enregistrements disponibles sur le serveur. |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Demande traitée avec succès. Ressource entière renvoyée en réponse (aucune pagination). |
| 206 | Ressource partielle renvoyée en réponse (avec pagination). |
| 400 | Demande incorrecte. Raisons possibles :
|
| 404 | Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table. |
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| 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 |
| Endroit | 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 | Nom de la caractéristique. Type de données : chaîne |
| valeur.CaractéristiqueProduit | Valeur de la caractéristique. Type de données : chaîne |
| productOffering | Offre de produit à laquelle l’inventaire de produits est associé. Type de données : objet |
| productOffering.id | Sys_id 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 produit. 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 | Sys_id du produit connexe issu de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| RelationProduit.Type de relation | Type de relation. Type de données : chaîne |
| Spécification du produit | Spécifications du produit. Type de données : objet |
| productSpecification.id | Sys_id de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| realizingResource (en anglais seulement) | Réaliser les ressources. Type de données : objet |
| realizingResource.id | Sys_id de la ressource de réalisation depuis la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| realizingResource.type | Type de la ressource en cours de réalisation. Type de données : chaîne |
| realizingService | Réalisation du service. Type de données : objet |
| 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 de la prestation réalisée. Type de données : chaîne |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau |
| relatedParty.id | Sys_id du compte ou du contact du 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 :
Type de données : chaîne |
| État | État actuel du produit. Type de données : chaîne |
Demande cURL
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 la 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}
Récupère un inventaire de produits.
Important :
À partir de la Tokyo version, ce point de terminaison est déconseillé. La nouvelle version de ce point de terminaison est Inventaire des produits Ouvrir l’API : GET /sn_prd_invt/product/{id}.
Format d'URL
URL par défaut : /api/sn_prd_invt/productinventory/{inventoryId}
Paramètres de demande pris en charge
| 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 |
| Nom | Description |
|---|---|
| customer | Filtrez 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 |
| Endroit | Filtrez 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 | Filtrez les inventaires de produits par état. 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 |
| Nom | Description |
|---|---|
| Néant |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Néant |
| En-tête | Description |
|---|---|
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Demande traitée avec succès. |
| 400 | Demande incorrecte. Cela peut être l’une des raisons suivantes :
|
| 404 | Enregistrement introuvable. L’enregistrement associé à l’ID ne se trouve pas dans la table. |
Paramètres de corps de réponse (JSON)
| 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 |
| Endroit | 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 | Nom de la caractéristique. Type de données : chaîne |
| valeur.CaractéristiqueProduit | Valeur de la caractéristique. Type de données : chaîne |
| productOffering | Offre de produit à laquelle l’inventaire de produits est associé. Type de données : objet |
| productOffering.id | Sys_id 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 produit. 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 | Sys_id du produit connexe issu de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| RelationProduit.Type de relation | Type de relation. Type de données : chaîne |
| Spécification du produit | Spécifications du produit. Type de données : objet |
| productSpecification.id | Sys_id de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| realizingResource (en anglais seulement) | Réaliser les ressources. Type de données : objet |
| realizingResource.id | Sys_id de la ressource de réalisation depuis la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| realizingResource.type | Type de la ressource en cours de réalisation. Type de données : chaîne |
| realizingService | Réalisation du service. Type de données : objet |
| 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 de la prestation réalisée. Type de données : chaîne |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau |
| relatedParty.id | Sys_id du compte ou du contact du 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 :
Type de données : chaîne |
| État | État actuel du produit. Type de données : chaîne |
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": []
}API ouverte d’inventaire des produits : POST /sn_prd_invt/product
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
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| Néant |
| 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 Valeur par défaut : chaîne vide |
| Caractéristique du produit | Liste des caractéristiques du produit. Type de données : tableau |
| productCharacteristic.name | Nom de la caractéristique. Type de données : chaîne Valeur par défaut : chaîne vide |
| valeur.CaractéristiqueProduit | Valeur de la caractéristique. Type de données : chaîne Valeur par défaut : chaîne vide |
| productOffering | Requis. Offre de produit à laquelle l’inventaire de produits est associé. Type de données : objet |
| productOffering.id | Requis. Initial_version ou external_id de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne |
| productOffering.internalVersion | 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 produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne Valeur par défaut : chaîne vide |
| version.offre.produit | External_version de l’offre de produit. 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 | Requis si vous utilisez le productRelationship paramètre. Sys_id du produit connexe issu de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| RelationProduit.Type de relation | Type de relation. La seule valeur valide est enfant. Type de données : chaîne Valeur par défaut : chaîne vide |
| Spécification du produit | Requis. Spécifications du produit. Type de données : objet |
| productSpecification.id | Requis. Initial_version ou external_id de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| productSpecification.internalVersion | Version de la spécification de 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 de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| realizingResource (en anglais seulement) | Ressource qui réalise le produit. La ressource de réalisation est un inventaire de produit enfant de cet inventaire de produits. Type de données : objet |
| realizingResource.id | Requis si vous utilisez le realizingResource paramètre. Sys_id de la ressource réalisatrice. Situé dans la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| realizingResource.type | Type de la ressource en cours 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 produit enfant de ce stock de produits. Type de données : objet |
| realizingService.id | Requis si vous utilisez le realizingService paramètre. Sys_id de la réalisation du service. Situé dans la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| realizingService.type | Type de la prestation réalisée. Valeur valide : enfant Type de données : chaîne |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau |
| relatedParty.id | Requis si vous utilisez le relatedParty paramètre. Sys_id du compte ou du contact du 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 :
Type de données : chaîne Valeur par défaut : chaîne vide |
| État | État actuel du produit. Valeurs possibles :
Type de données : chaîne Valeur par défaut : installation_pending |
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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| 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. |
| En-tête | Description |
|---|---|
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 201 | Demande traitée avec succès. |
| 400 | Demande incorrecte. Cela peut être l’une des raisons suivantes :
|
Paramètres de corps de réponse (JSON)
| Nom | Description |
|---|---|
| href | Lien relatif à l’enregistrement de l’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 | Nom de la caractéristique. Type de données : chaîne |
| valeur.CaractéristiqueProduit | Valeur de la caractéristique. Type de données : chaîne |
| productOffering | Offre de produit à laquelle l’inventaire de produits est associé. Type de données : objet |
| productOffering.id | Initial_version ou external_id de l’offre de produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne |
| productOffering.internalId | Initial_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.internalVersion | 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 produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne |
| version.offre.produit | External_version de l’offre de produit. 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 | Sys_id du produit connexe issu de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| RelationProduit.Type de relation | Type de relation. Type de données : chaîne |
| Spécification du produit | Spécifications du produit. Type de données : objet |
| productSpecification.id | Initial_version ou external_id de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| productSpecification.internalId | Initial_version de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| productSpecification.internalVersion | Version de la spécification de 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 de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| realizingResource (en anglais seulement) | Ressource qui réalise le produit. La ressource de réalisation est un inventaire de produit enfant de cet inventaire de produits. Type de données : objet |
| realizingResource.id | Sys_id de la ressource réalisatrice. Situé dans la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| realizingResource.type | Type de la ressource en cours 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 produit enfant de ce stock de produits. Type de données : objet |
| realizingService.id | Sys_id de la réalisation du service. Situé dans la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| realizingService.type | Type de la prestation réalisée. Valeur valide : enfant Type de données : chaîne |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau |
| relatedParty.id | Sys_id du compte ou du contact du 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 :
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 la 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"
}API ouverte de l’inventaire des produits : POST /sn_prd_invt/productinventory
Crée un inventaire des produits.
Important :
À partir de la Tokyo version, ce point de terminaison est déconseillé. La nouvelle version de ce point de terminaison est API ouverte d’inventaire des produits : POST /sn_prd_invt/product.
Format d'URL
URL par défaut : /api/sn_prd_invt/productinventory
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| Aucun |
| Nom | Description |
|---|---|
| Néant |
| 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 Valeur par défaut : chaîne vide |
| Caractéristique du produit | Liste des caractéristiques du produit. Type de données : tableau |
| productCharacteristic.name | Nom de la caractéristique. Type de données : chaîne Valeur par défaut : chaîne vide |
| valeur.CaractéristiqueProduit | Valeur de la caractéristique. Type de données : chaîne Valeur par défaut : chaîne vide |
| productOffering | Requis. Offre de produit à laquelle l’inventaire de produits est associé. Type de données : objet |
| productOffering.id | Requis. Sys_id 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 produit. Situé dans la table Offre de produits [sn_prd_pm_product_offering]. Type de données : chaîne Valeur par défaut : chaîne vide |
| Relation produit | Liste des produits connexes. Type de données : tableau |
| productRelationship.productId | Requis si vous utilisez le productRelationship paramètre. Sys_id du produit connexe issu de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| RelationProduit.Type de relation | Type de relation. La seule valeur valide est enfant. Type de données : chaîne Valeur par défaut : chaîne vide |
| Spécification du produit | Requis. Spécifications du produit. Type de données : objet |
| productSpecification.id | Requis. Sys_id de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| realizingResource (en anglais seulement) | Réaliser les ressources. Type de données : objet |
| realizingResource.id | Requis si vous utilisez le realizingResource paramètre. Sys_id de la ressource de réalisation depuis la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| realizingResource.type | Type de la ressource en cours de réalisation. La seule valeur valide est enfant. Type de données : chaîne Valeur par défaut : chaîne vide |
| realizingService | Réalisation du service. Type de données : objet |
| realizingService.id | Requis si vous utilisez le realizingService paramètre. 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 de la prestation réalisée. La seule valeur valide est enfant. Type de données : chaîne Valeur par défaut : chaîne vide |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau |
| relatedParty.id | Requis si vous utilisez le relatedParty paramètre. Sys_id du compte ou du contact du 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 :
Type de données : chaîne Valeur par défaut : chaîne vide |
| État | État actuel du produit. Valeurs possibles :
Type de données : chaîne Valeur par défaut : installation_pending |
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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| 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. |
| En-tête | Description |
|---|---|
| Type de contenu | Format de données du corps de la réponse. Prend uniquement en charge application/json. |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 201 | Demande traitée avec succès. |
| 400 | Demande incorrecte. Cela peut être l’une des raisons suivantes :
|
Paramètres de corps de réponse (JSON)
| 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 | Nom de la caractéristique. Type de données : chaîne |
| valeur.CaractéristiqueProduit | Valeur de la caractéristique. Type de données : chaîne |
| productOffering | Offre de produit à laquelle l’inventaire de produits est associé. Type de données : objet |
| productOffering.id | Sys_id 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 produit. 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 | Sys_id du produit connexe issu de la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| RelationProduit.Type de relation | Type de relation. Type de données : chaîne |
| Spécification du produit | Spécifications du produit. Type de données : objet |
| productSpecification.id | Sys_id de la spécification de produit. Situé dans la table Spécification de produit [sn_prd_pm_product_specification]. Type de données : chaîne |
| realizingResource (en anglais seulement) | Réaliser les ressources. Type de données : objet |
| realizingResource.id | Sys_id de la ressource de réalisation depuis la table Inventaire des produits [sn_prd_invt_product_inventory]. Type de données : chaîne |
| realizingResource.type | Type de la ressource en cours de réalisation. Type de données : chaîne |
| realizingService | Réalisation du service. Type de données : objet |
| 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 de la prestation réalisée. Type de données : chaîne |
| relatedParty | Liste des parties associées au ticket. Type de données : tableau |
| relatedParty.id | Sys_id du compte ou du contact du 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 :
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 la 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"
}