次の方法で共有

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 パラメーター

名前 / 必須 型 説明
tenantId
 path True

string

uuid

Azure Sphere テナント ID。
maxPageSize
 query

integer

int32

応答に含める必要がある結果の最大数。

要求ヘッダー

名前 必須 型 説明
Sphere-Continuation

string

結果の前のページから続行するために使用される継続トークン。

応答

名前 型 説明
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
}

定義

名前 説明
Product
ProductItemCollectionResponse

Product

名前 型 説明
Description

string

製品の説明。
Id

string

製品の一意の ID。
Name

string

製品の名前です。
TenantId

string

製品を所有するテナントの一意の ID。

ProductItemCollectionResponse

名前 型 説明
ContinuationToken

string

次の項目セットを取得するために使用できる継続トークン。
Items

Product[]

項目の一覧。