Share via

Product - List

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

Obtiene todos los productos.

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 identificador URI

Nombre En Requerido Tipo Description
tenantId
 path True

string

uuid

Identificador de inquilino de Azure Sphere.
maxPageSize
 query

integer

int32

Número máximo de resultados que se deben incluir en la respuesta.

Encabezado de la solicitud

Nombre Requerido Tipo Description
Sphere-Continuation

string

Token de continuación que se usa para continuar desde una página anterior de resultados.

Respuestas

Nombre Tipo Description
200 OK

ProductItemCollectionResponse

Correcto.

Ejemplos

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
}

Definiciones

Nombre Description
Product
ProductItemCollectionResponse

Product

Nombre Tipo Description
Description

string

Descripción del producto.
Id

string

Identificador único del producto.
Name

string

Nombre del producto.
TenantId

string

Identificador único del inquilino que posee el producto.

ProductItemCollectionResponse

Nombre Tipo Description
ContinuationToken

string

Token de continuación que se puede usar para obtener el siguiente conjunto de elementos.
Items

Product[]

Lista de elementos.