list_formats
Get a tenant's formats (device models) by tenant ID. The response includes format metadata and item counts, but not field definitions.
Instructions
テナントのフォーマット(機種)一覧を取得します。
tenant_id は list_tenants で取得してください。
必要な権限レベル: システム管理者(user_level=1) のみ。 テナント管理者以下の API ユーザーでは 403 になります。 403 が返った場合、パラメータではなく API ユーザーの権限レベルを疑ってください。
項目定義そのもの(各フォーマットの項目一覧)は含まれません。項目数は koumoku_count で分かります。 個々の項目定義が必要な場合は list_devices を include_format_detail=true で呼んでください。 間引きは行いません。
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lang | No | レスポンスの言語(ja / en) | ja |
| page | No | ページ番号(1始まり)。0 を指定すると全件取得になるが、件数が多いと応答が非常に大きくなるため通常は指定しない | |
| per_page | No | 1ページあたりの件数(1〜999) | |
| tenant_id | Yes | テナントID(UUID)。list_tenants で取得できる |