Skip to main content
GET
オブジェクト定義を取得

Supported products

承認

hapikey
string
query
必須

パスパラメータ

appId
integer<int32>
必須

設定が取得されているアプリの一意の識別子。

mediaType
enum<string>
必須

オブジェクト定義が取得されているメディアの種類。有効な値は、VIDEO、AUDIO、DOCUMENT、OTHER、IMAGEです。

利用可能なオプション:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO

クエリパラメータ

includeFullDefinition
boolean

オブジェクトの完全な定義を含めるかどうかを示すブール値。指定しない場合、デフォルトの動作は部分的な定義を返します。

レスポンス

successful operation

objectTypeId
string
必須

オブジェクトタイプの固有IDを表す文字列。

objectTypeName
string
必須

オブジェクトタイプの名前を表す文字列。

properties
object[]
必須

オブジェクトタイプに属するプロパティーの配列で、それぞれがオブジェクトの特定の属性を定義します。

propertyGroups
object[]
必須

オブジェクトタイプに関連付けられたプロパティーグループの配列で、プロパティーのグループ化方法を詳述します。

schema
object
最終更新日 2026年10月6日