Inventaire des produits Ouvrir l’API

Inventaire des produits Ouvrir l’API : 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

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

Tableau 2. Paramètres de requête
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 3. Paramètres du corps de la demande (JSON)
Nom	Description
Aucun

En-têtes

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

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

Tableau 5. En-têtes de réponses
En-tête	Description
Plage de contenu	Spécifie la plage de contenu renvoyée dans un appel paginé. Par exemple, si `offset=2` et `limit=3`, la valeur de l’en-tête Content-Range est `les éléments 3 à 5`.
Type de contenu	Format de données du corps de la réponse. Ne prend en charge application/jsonque les fichiers .
Lien	Contient les liens suivants pour parcourir les résultats de la requête. premier dernier suivant previous
X-Total-Count	Pour les requêtes paginées, cet en-tête indique le nombre total d’enregistrements disponibles sur le serveur.

Codes d'état

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

Tableau 6. Codes d'état
Code d'état	Description
200	Demande traitée avec succès. Ressource complète renvoyée en réponse (aucune pagination).
206	Ressource partielle renvoyée en réponse (avec pagination).
400	Demande incorrecte. Raisons possibles : Paramètre de chemin d’accès non valide URI non valide
404	Enregistrement introuvable. Aucun enregistrement correspondant aux paramètres de requête n’a été trouvé dans la table.

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


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

Récupère un enregistrement d’inventaire de produits spécifié.