Delen via

Product - List

  • Referentie
Service:
Azure Sphere Public API
API Version:
v2

Hiermee haalt u alle producten op.

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-parameters

Name In Vereist Type Description
tenantId
 path True

string

uuid

De Tenant-id van Azure Sphere.
maxPageSize
 query

integer

int32

Het maximum aantal resultaten dat in het antwoord moet worden opgenomen.

Aanvraagkoptekst

Name Vereist Type Description
Sphere-Continuation

string

Een vervolgtoken dat wordt gebruikt om door te gaan vanaf een vorige pagina met resultaten.

Antwoorden

Name Type Description
200 OK

ProductItemCollectionResponse

Voltooid.

Voorbeelden

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
}

Definities

Name Description
Product
ProductItemCollectionResponse

Product

Name Type Description
Description

string

De beschrijving van het product.
Id

string

De unieke id van het product.
Name

string

De naam van het product.
TenantId

string

De unieke id van de tenant die eigenaar is van het product.

ProductItemCollectionResponse

Name Type Description
ContinuationToken

string

Vervolgtoken dat kan worden gebruikt om de volgende set items op te halen.
Items

Product[]

Lijst met items.