メタデータ階層
メタデータ階層のリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
next_marker | string | いいえ | 次の検索結果ページの開始場所のマーカー。 null を指定できます。 |
prev_marker | string | いいえ | 前の検索結果ページの開始場所のマーカー。 null を指定できます。 |
entries | array of メタデータ階層 | いいえ | メタデータ階層のリスト。 |
例
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"entries": [
{
"id": "822227e0-47a5-921b-88a8-494760b2e6d2",
"key": "geography",
"displayName": "Geography",
"namespace": "enterprise_123456",
"levels": [
{
"displayName": "Continent",
"description": "Continent",
"level": 1
}
]
}
]
}
メタデータ階層
メタデータテンプレートで使用可能なメタデータ階層のオブジェクト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | メタデータ階層の一意の識別子。 |
key | string | いいえ | メタデータ階層の一意の識別子。この識別子は、そのメタデータ階層が属する名前空間内で一意である必要があります。 |
displayName | string | はい | メタデータ階層の表示名。Boxウェブアプリに表示されます。 |
namespace | string | はい | メタデータ階層が関連付けられている名前空間。 |
levels | array of メタデータ階層レベル | いいえ | メタデータ階層のレベル。 |
例
{
"id": "822227e0-47a5-921b-88a8-494760b2e6d2",
"key": "geography",
"displayName": "Geography",
"namespace": "enterprise_123456",
"levels": [
{
"displayName": "Continent",
"description": "Continent",
"level": 1
}
]
}
メタデータ階層ノード
メタデータテンプレートで使用可能なメタデータ階層のノードオブジェクト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | メタデータ階層ノードの一意の識別子。 |
displayName | string | はい | メタデータ階層ノードの表示名。 |
level | integer | はい | ノードが属するレベルのインデックス。 |
parentId | string | いいえ | 親ノードの識別子。 |
nodePath | array of string | いいえ | すべての先祖ノードの識別子の配列。\ ルートレベルのノードの場合は返されません。 |
ancestors | array of 先祖メタデータ階層 | いいえ | すべての先祖ノードのオブジェクトの配列。\ ルートレベルのノードの場合は返されません。 |
例
{
"id": "14d3d433-c77f-49c5-b146-9dea370f6e32",
"displayName": "France",
"level": 2,
"parentId": "99df4513-7102-4896-8228-94635ee9d330",
"nodePath": [
"99df4513-7102-4896-8228-94635ee9d330"
],
"ancestors": [
{
"id": "14d3d433-c77f-49c5-b146-9dea370f6e32",
"displayName": "France",
"level": 2
}
]
}
メタデータ階層ノード
メタデータ階層ノードのリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
limit | integer | いいえ | これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。最大値はAPIによって異なります。 |
next_marker | string | いいえ | 次の検索結果ページの開始場所のマーカー。 null を指定できます。 |
prev_marker | string | いいえ | 前の検索結果ページの開始場所のマーカー。 null を指定できます。 |
entries | array of メタデータ階層ノード | いいえ | メタデータ階層ノードのリスト。 |
例
{
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
"prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
"entries": [
{
"id": "14d3d433-c77f-49c5-b146-9dea370f6e32",
"displayName": "France",
"level": 2,
"parentId": "99df4513-7102-4896-8228-94635ee9d330",
"nodePath": [
"99df4513-7102-4896-8228-94635ee9d330"
],
"ancestors": [
{
"id": "14d3d433-c77f-49c5-b146-9dea370f6e32",
"displayName": "France",
"level": 2
}
]
}
]
}
メタデータ階層レベル
メタデータ階層のレベルは、メタデータ階層構造内の階層カテゴリを表します。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
displayName | string | いいえ | ユーザーに表示されるレベルの表示名。 |
description | string | いいえ | レベルの説明。 |
level | integer | いいえ | メタデータ階層内のレベルのインデックス。レベルのインデックスは1から始まります。 |
例
{
"displayName": "Continent",
"description": "Continent",
"level": 1
}
メタデータ階層レベル
メタデータ階層のレベルは、メタデータ階層構造内の階層カテゴリを表します。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
entries | array of メタデータ階層レベル | いいえ | すべてのメタデータ階層レベルの配列。 |
例
{
"entries": [
{
"displayName": "Continent",
"description": "Continent",
"level": 1
}
]
}