作成¶
POST /api/v1/dashboard/add
概要¶
単一のユーザービューを作成します
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| sourceDashboardUUID | string | ソースビュー UUID 空を許可: False 空文字列を許可: True 最大長: 128 |
|
| name | string | Y | ビュー名 空を許可: False 最大長: 256 |
| desc | string | 説明 例: 説明1 空を許可: False 最大長: 2048 |
|
| recoverIdentifier | boolean | 重複する識別子 ID/名前の関連オブジェクトを上書きするかどうか。false-重複グループのみを返す、true-重複グループ内の関連オブジェクトを削除してから作成を続行 空を許可: False |
|
| identifier | string | 識別子 ID — 2024.12.25 新規追加 例: xxxx 空を許可: False 空文字列を許可: True 最大長: 128 |
|
| templateInfos | json | カスタムテンプレートデータ 例: {} 空を許可: False 空文字列を許可: False |
|
| dashboardBidding | json | マッピング、デフォルトは{} 例: {} 空を許可: False |
|
| specifyDashboardUUID | string | 新規ダッシュボードの UUID を指定。dsbd_custom_ をプレフィックスとし、その後に32桁の小文字英数字を続ける必要があります例: dsbd_custom_xxxx32 空を許可: False 空文字列を許可: False $matchRegExp: ^dsbd_custom_[a-z0-9]{32}$ |
パラメータ補足説明¶
1. API の動作
API はまず、作成しようとしているビューの名前と識別子 ID の競合をチェックします。競合結果は以下の3種類で返されます。
name_and_identifier：名前と識別子 ID が両方重複identifier：識別子 ID のみ重複name：名前のみ重複
recoverIdentifier=false または未指定の場合：
- ビューは作成されません
- repeatInfo を直接返します
recoverIdentifier=true の場合：
- 上記3種類の重複グループに該当する関連ビューが削除されます
- その後、新しいビューが作成されます
2. 返却例
2.1 作成成功
2.2 重複がある場合、重複グループを返却
{
"repeatInfo": {
"name_and_identifier": [
{
"name": "システム概要",
"identifier": "system_overview",
"importName": "システム概要",
"importIdentifier": "system_overview",
"existName": "システム概要",
"existIdentifier": "system_overview",
"conflictUUIDs": ["dsbd_xxxx01"]
}
],
"identifier": [],
"name": []
}
}
3. リクエストボディの構造説明
| パラメータ名 | type | 説明 |
|---|---|---|
| name | string | 名前 |
| desc | string | 説明 |
| identifier | string | 識別子 ID — 2024.12.25 新規追加 |
| recoverIdentifier | boolean | 重複グループ内の関連ビューを削除して作成を続行するかどうか |
| dashboardBidding | dict | ダッシュボードのバインディング情報 |
| sourceDashboardUUID | string | クローン元のダッシュボードまたは組み込みユーザービューの UUID |
| templateInfos | dict | クローン元の組み込みシステムビューのテンプレート情報 |
組み込みビューのバインディングフィールド dashboardBidding の説明
内部でサポートされる op 値は in/wildcard です。
dashboardBidding フィールドの例:
{
"service": [
{
"value": [
"*"
],
"op": "in"
}
],
"app_id": [
{
"value": [
"test0"
],
"op": "wildcard"
}
],
"label": [
{
"value": [
"削除禁止"
],
"op": "in"
}
]
}
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/dashboard/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Accept-Language: zh' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Accept: application/json, text/plain, */*' \
--data-raw '{"name":"001Bind Built-in View","dashboardBidding":{"service":[{"value":["*"],"op":"in"}],"app_id":[{"value":["test0"],"op":"wildcard"}],"label":[{"value":["Do Not Delete"],"op":"in"}]}}' \
--compressed
レスポンス¶
{
"code": 200,
"content": {
"chartGroupPos": [],
"chartPos": [],
"createAt": 1713513331,
"createdWay": "manual",
"creator": "wsak_xxxx32",
"identifier": "",
"dashboardBidding": {
"app_id": [
{
"op": "wildcard",
"value": [
"test0"
]
}
],
"label": [
{
"op": "in",
"value": [
"Do Not Delete"
]
}
],
"service": [
{
"op": "in",
"value": [
"*"
]
}
]
},
"dashboardBindSet": [],
"declaration": {
"b": [
"asfawfgajfasfafgafwba",
"asfgahjfaf"
],
"business": "aaa",
"organization": "64fe7b4062f74d0007b46676"
},
"deleteAt": -1,
"desc": "",
"extend": {},
"iconSet": {},
"id": 5091,
"isPublic": 1,
"mapping": [],
"name": "001Bind Built-in View",
"ownerType": "inner",
"status": 0,
"type": "CUSTOM",
"updateAt": 1713513331,
"updator": "wsak_xxxx32",
"uuid": "dsbd_xxxx32",
"workspaceUUID": "wksp_xxxx32"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-2FB0228E-1660-4557-AF7B-688176108C28"
}