機能メニューの取得¶
GET /api/v1/workspace/menu/get
概要¶
ワークスペースの第1階層メニューの互換設定を読み取ります。
呼び出し前の準備と使用手順¶
routine.defaultAccess などの許可権限を持つ現在のワークスペース Key を使用します。ワークスペースのメニュー設定またはデフォルトのプロジェクションを返すものであり、現在の ID が最終的にアクセスできるメニューではありません。可視性はページ/API/データの認可の代わりにはなりません。未保存の場合はメモリ上でのみサイトのデフォルトを継承して変換し、設定は作成しません。v3 が既に存在する場合は互換プロジェクションを返し、システム/履歴互換メニューのみを含み、カスタムカタログとリソースは含まず、ロール別の設定も完全には表現しません。
v1 は第1階層の key/value のみを返し、非表示値はプラットフォームの isHide とワークスペースの isShow を合成済みです。第2階層、またはプラットフォーム/ワークスペースの表示・非表示を区別する場合は v2 を、完全なツリーとロールは v3 を使用します。
Owner の ID で受け入れテストを行う際は注意が必要です。有効メニューの計算ではワークスペースの isShow による非表示を無視します(区切り線を除く)が、プラットフォームの非表示と実際の権限による制約は依然として受けます。一般ロールと Owner では最終的な表示が異なる場合があります。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト例¶
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.workspaceUUID | string | 現在の Key が属するワークスペースの UUID。 |
| content.config | array<object> |
メニュー設定の配列。空の結果は [] でも構いません。 |
| content.keyCode | string | 互換メタデータ。保存済み/v3 互換プロジェクションでは通常 WsMenuCfg。新しいワークスペースの旧読み取り分岐では省略される場合があります。 |
| content.updated | boolean | ワークスペース設定または v3 互換プロジェクションが存在する場合、通常 true。今回の書き込みで変化したかどうかの信頼できる指標ではなく、新しいワークスペースでは省略される場合があります。 |
| content.id | integer または null | 保存済み設定のデータベース番号。省略可能。 |
| content.uuid | string | ctcf_ 設定 UUID。省略可能で、メニューノード ID としては使用しません。 |
| content.creator | string | 設定の作成 ID。省略可能。 |
| content.updator | string | 設定の更新 ID。省略可能。 |
| content.status | integer | 設定エンティティのステータス。省略可能。 |
| content.createAt | integer | 作成 Unix 秒。省略可能。 |
| content.updateAt | integer | 更新 Unix 秒。省略可能。 |
| content.deleteAt | integer | 削除 Unix 秒。未削除の場合は -1。省略可能。 |
| content.declaration | object | 現在のワークスペースの共通宣言。 |
| content.config[].key | string | 第1階層のシステムメニュー Key。現在の旧プロトコル GET の値を取得し、表示名や v3 ノード ID は使用しません。 |
| content.config[].value | integer | 最終プロジェクションの表示/非表示: 1=表示、0=非表示。ワークスペースの isShow とプラットフォームの isHide を合成したものです。 |
{
"code": 200,
"content": {
"workspaceUUID": "wksp_example",
"config": [
{
"key": "Scene",
"value": 1
},
{
"key": "Notebook",
"value": 1
},
{
"key": "Events",
"value": 1
},
{
"key": "ExceptionsTracking",
"value": 1
},
{
"key": "Incident",
"value": 1
},
{
"key": "Error",
"value": 1
},
{
"key": "Objectadmin",
"value": 1
},
{
"key": "Entity",
"value": 1
},
{
"key": "DataObservability",
"value": 1
},
{
"key": "MetricQuery",
"value": 1
},
{
"key": "LogIndi",
"value": 1
},
{
"key": "Tracing",
"value": 1
},
{
"key": "Rum",
"value": 1
},
{
"key": "CloudBilling",
"value": 1
},
{
"key": "CloudDial",
"value": 1
},
{
"key": "Security",
"value": 1
},
{
"key": "AIMonitor",
"value": 1
},
{
"key": "GitLabCI",
"value": 1
},
{
"key": "Monitor",
"value": 1
},
{
"key": "Integration",
"value": 1
},
{
"key": "Workspace",
"value": 1
},
{
"key": "Billing",
"value": 1
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対応方法 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | 設定の重複/形式破損、データベースの読み取りまたは返却フォーマットの失敗 | 内部エラー | traceId を提供して管理者が設定を確認できるようにしてください。設定を空にすることで破損を覆い隠さないでください。 |