Product - List

Service:

Azure Sphere Public API

API Version:

v2

Ruft alle Produkte ab.

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}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
tenantId	path	True	string uuid	Die Azure Sphere-Mandanten-ID.
maxPageSize	query		integer int32	Die maximale Anzahl von Ergebnissen, die in die Antwort eingeschlossen werden sollen.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Sphere-Continuation		string	Ein Fortsetzungstoken, das verwendet wird, um von einer vorherigen Ergebnisseite fortzufahren.

Antworten

Name	Typ	Beschreibung
200 OK	ProductItemCollectionResponse	Erfolg.

Beispiele

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
}

Definitionen

Name	Beschreibung
Product
ProductItemCollectionResponse

Product

Name	Typ	Beschreibung
Description	string	Die Beschreibung des Produkts.
Id	string	Die eindeutige ID des Produkts.
Name	string	Der Name des Produkts.
TenantId	string	Die eindeutige ID des Mandanten, der das Produkt besitzt.

ProductItemCollectionResponse

Name	Typ	Beschreibung
ContinuationToken	string	Fortsetzungstoken, das verwendet werden kann, um den nächsten Satz von Elementen abzurufen.
Items	Product[]	Liste der Elemente.