共用方式為

Product - List

  • 參考
Service:
Azure Sphere Public API
API Version:
v2

取得所有產品。

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 參數

名稱 位於 必要 類型 Description
tenantId
 path True

string

uuid

Azure Sphere 租使用者識別碼。
maxPageSize
 query

integer

int32

回應中應包含的結果數目上限。

要求標頭

名稱 必要 類型 Description
Sphere-Continuation

string

用來繼續上一頁結果的接續權杖。

回應

名稱 類型 Description
200 OK

ProductItemCollectionResponse

成功。

範例

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
}

定義

名稱 Description
Product
ProductItemCollectionResponse

Product

名稱 類型 Description
Description

string

產品的描述。
Id

string

產品的唯一識別碼。
Name

string

產品的名稱。
TenantId

string

擁有產品之租使用者的唯一識別碼。

ProductItemCollectionResponse

名稱 類型 Description
ContinuationToken

string

可用來取得下一組專案的接續權杖。
Items

Product[]

專案清單。