Product - List

  • Referência
Service:
Azure Sphere Public API
API Version:
v2

Obtém todos os Produtos.

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}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
tenantId
 path True

string

uuid

A ID do locatário do Azure Sphere.
maxPageSize
 query

integer

int32

O número máximo de resultados que devem ser incluídos na resposta.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Sphere-Continuation

string

Um token de continuação usado para continuar de uma página anterior de resultados.

Respostas

Nome Tipo Description
200 OK

ProductItemCollectionResponse

Êxito.

Exemplos

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
}

Definições

Nome Description
Product
ProductItemCollectionResponse

Product

Nome Tipo Description
Description

string

A descrição do produto.
Id

string

A ID exclusiva do produto.
Name

string

O nome do produto.
TenantId

string

A ID exclusiva do locatário que possui o produto.

ProductItemCollectionResponse

Nome Tipo Description
ContinuationToken

string

Token de continuação que pode ser usado para obter o próximo conjunto de itens.
Items

Product[]

Lista de itens.