ダッシュボードタブ画面の作成

指定したダッシュボードにタブ画面を追加します。

必要な権限

MEMBER以上のロールが必要です。

HTTPリクエスト

POST /api/sonar/dashboards/:dashboard_guid/tabs

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     -d name="ダッシュボードタブ作成" \
     -d widget_guids="9e3da276-ebcc-4798-a406-fc7712ddd322,d6b1b212-6b2c-4ff2-9fb9-099fa3b6997e" \
     -X POST /api/sonar/dashboards/da6d8458-b906-4049-a16f-157c789606fe/tabs
リクエストパラメータ
キー必須タイプ説明備考
guidX文字列タブGUID36文字。未設定の場合はランダム生成
dashboard_guidO文字列ダッシュボードGUID36文字
nameO文字列タブ画面名最小1文字、最大255文字
layoutX文字列キー/値ウィジェットレイアウトlayoutまたはwidget_guidsのいずれかは必須
widget_guidsX文字列ウィジェットGUIDリストカンマ(,)区切りのウィジェットGUIDリスト。layoutまたはwidget_guidsのいずれかは必須

正常応答

{}

エラー応答

必須パラメータが不足している場合

HTTPステータスコード 400 応答

{
    "error_code": "null-argument",
    "error_msg": "layout should be not null"
}
パラメータ値の長さが不正な場合

HTTPステータスコード 400 応答

{
    "error_code": "invalid-argument",
    "error_msg": "'name' must be less than or equal to 255 characters."
}
識別子がGUID形式でない場合

HTTPステータスコード 400 応答

{
    "error_code": "invalid-param-type",
    "error_msg": "dashboard_guid should be guid type."
}
ダッシュボードが存在しない場合

HTTPステータスコード 500 応答

{
    "error_code": "illegal-state",
    "error_msg": "dashboard not found: d6b1b212-6b2c-4ff2-9fb9-099fa3b6997e"
}
ダッシュボードタブ作成権限がない場合

HTTPステータスコード 500 応答

{
    "error_code": "illegal-state",
    "error_msg": "no-permission"
}