Skip to content

Modify a Dashboard¶

POST /api/v1/dashboards/{dashboard_uuid}/modify

Overview¶

Modify the properties of a dashboard.

Route Parameters¶

Parameter Name	Type	Required	Description
dashboard_uuid	string	Y	View UUID

Body Request Parameters¶

Parameter Name	Type	Required	Description
name	string		View name Example: Test View 1 Allow empty: False
desc	string		Description Example: Description 1 Allow empty: False Allow empty string: True Maximum length: 2048
identifier	string		Identifier ID -- Added on December 25, 2024 Example: xxxx Allow empty: False Allow empty string: True Maximum length: 128
extend	json		Additional view information Example: {} Allow empty: False
mapping	array		Mapping, defaults to [] Example: [] Allow empty: False
tagNames	array		Tag names, note that this field is fully updated Allow empty: False
isPublic	int		Whether it is publicly displayed, 1 for public, 0 for private, -1 for custom Example: 1 Allow empty: False
permissionSet	array		Custom operation permissions when isPublic is -1, configurable (roles except owner, member UUID, team UUID) Example: ['wsAdmin', 'acnt_xxxx', 'group_yyyy'] Allow empty: False
readPermissionSet	array		Custom read permissions when isPublic is -1, configurable (roles except owner, member UUID, team UUID) Example: ['wsAdmin', 'acnt_xxxx', 'group_yyyy'] Allow empty: False

Additional Parameter Notes¶

Response¶

{
    "code": 200,
    "content": {
        "chartGroupPos": [],
        "chartPos": [
            {
                "chartUUID": "chrt_xxxx32",
                "pos": {
                    "h": 11,
                    "i": "chrt_xxxx32",
                    "w": 11,
                    "x": 0,
                    "y": 0
                }
            }
        ],
        "createAt": 1642587228,
        "createdWay": "import",
        "creator": "acnt_xxxx32",
        "dashboardBidding": {},
        "dashboardBindSet": [],
        "deleteAt": -1,
        "extend": {},
        "iconSet": {},
        "id": 2494,
        "mapping": [],
        "name": "testt",
        "old_name": "openapi",
        "ownerType": "node",
        "status": 0,
        "tag_info": {
            "sceneInfo": [],
            "tagInfo": []
        },
        "type": "CUSTOM",
        "updateAt": 1642587908.306098,
        "updator": "wsak_xxxxx",
        "updatorInfo": {
            "iconUrl": "",
            "name": "First Key",
            "username": "AK(wsak_xxxxx)"
        },
        "uuid": "dsbd_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-5F0F4D27-0A77-41B3-9E05-227648467853"
}