Partager via

Product - List

  • Référence
Service:
Azure Sphere Public API
API Version:
v2

Obtient tous les produits.

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/products
With optional parameters: 
GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/products?maxPageSize={maxPageSize}

Paramètres URI

Nom Dans Obligatoire Type Description
tenantId
 path True

string

uuid

ID de locataire Azure Sphere.
maxPageSize
 query

integer

int32

Nombre maximal de résultats à inclure dans la réponse.

En-tête de la demande

Nom Obligatoire Type Description
Sphere-Continuation

string

Jeton de continuation utilisé pour continuer à partir d’une page de résultats précédente.

Réponses

Nom Type Description
200 OK

ProductItemCollectionResponse

Opération réussie.

Exemples

List the products

Sample Request

GET https://prod.core.sphere.azure.net/v2/tenants/768c2cd6-1bf0-4521-9f53-084a331d81cb/products

Sample Response

Status code:
200 
{
  "Items": [
    {
      "Id": "b0ba65bc-648f-4213-a910-cbeb6024c744",
      "TenantId": "768c2cd6-1bf0-4521-9f53-084a331d81cb",
      "Name": "Dishwasher",
      "Description": "Contoso dishwashers"
    },
    {
      "Id": "258e9e1d-a16d-4459-be5d-38420a8c43ad",
      "TenantId": "768c2cd6-1bf0-4521-9f53-084a331d81cb",
      "Name": "Refrigerator",
      "Description": "Contoso refrigerators"
    }
  ],
  "ContinuationToken": null
}

Définitions

Nom Description
Product
ProductItemCollectionResponse

Product

Nom Type Description
Description

string

Description du produit.
Id

string

ID unique du produit.
Name

string

Nom du produit.
TenantId

string

ID unique du locataire propriétaire du produit.

ProductItemCollectionResponse

Nom Type Description
ContinuationToken

string

Jeton de continuation qui peut être utilisé pour obtenir l’ensemble d’éléments suivant.
Items

Product[]

Liste des éléments.