Skip to content

Modify Single User View


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

Overview

Modify a single user view

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
Maximum length: 256
desc string Description
Example: Description 1
Allow empty: False
Maximum length: 2048
identifier string Identifier ID -- Added on 2024.12.25
Example: xxxx
Allow empty: False
Allow empty string: True
Maximum length: 128
dashboardBidding json Mapping, defaults to {}
Example: {}
Allow empty: False

Additional Parameter Notes

Request Body Structure Explanation

Parameter Name Type Description
name string View name
desc string Description
identifier string Identifier ID -- Added on 2024.12.25
dashboardBidding dict Dashboard binding information

Explanation of Built-in View Fields dashboardBidding

Internal support for op values in/wildcard

Example of dashboardBidding fields:

{
    "service": [
        {
            "value": [
                "*"
            ],
            "op": "in"
        }
    ],
    "app_id": [
        {
            "value": [
                "test0"
            ],
            "op": "wildcard"
        }
    ],
    "label": [
        {
            "value": [
                "Do Not Delete"
            ],
            "op": "in"
        }
    ]
}

Request Example

curl 'https://us1-openapi.truewatch.com/api/v1/dashboard/dsbd_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Accept-Language: en' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"test_Redis Monitoring View","dashboardBidding":{"app_id":[{"value":["cccc"],"op":"in"}]}}' \
--compressed

Response

{
  "code": 200,
  "content": {
    "chartGroupPos": ["chtg_xxxx32", "chtg_xxxx32", "chtg_xxxx32"],
    "chartPos": [
      {
        "chartUUID": "chrt_xxxx32",
        "pos": {
          "h": 8,
          "i": "chrt_xxxx32",
          "w": 8,
          "x": 0,
          "y": 2
        }
      },
      {
        "chartUUID": "chrt_xxxx32",
        "pos": {
          "h": 8,
          "i": "chrt_xxxx32",
          "w": 6,
          "x": 0,
          "y": 12.5
        }
      },
      {
        "chartUUID": "chrt_xxxx32",
        "pos": {
          "h": 8,
          "i": "chrt_xxxx32",
          "w": 8,
          "x": 0,
          "y": 23
        }
      },
      {
        "chartUUID": "chrt_xxxx32",
        "pos": {
          "h": 8,
          "i": "chrt_xxxx32",
          "w": 6,
          "x": 18,
          "y": 12.5
        }
      },
      {
        "chartUUID": "chrt_xxxx32",
        "pos": {
          "h": 8,
          "i": "chrt_xxxx32",
          "w": 8,
          "x": 8,
          "y": 2
        }
      },
      {
        "chartUUID": "chrt_xxxx32",
        "pos": {
          "h": 8,
          "i": "chrt_xxxx32",
          "w": 8,
          "x": 8,
          "y": 23
        }
      },
      {
        "chartUUID": "chrt_xxxx32",
        "pos": {
          "h": 8,
          "i": "chrt_xxxx32",
          "w": 8,
          "x": 0,
          "y": 31
        }
      },
      {
        "chartUUID": "chrt_xxxx32",
        "pos": {
          "h": 8,
          "i": "chrt_xxxx32",
          "w": 8,
          "x": 16,
          "y": 23
        }
      },
      {
        "chartUUID": "chrt_xxxx32",
        "pos": {
          "h": 8,
          "i": "chrt_xxxx32",
          "w": 6,
          "x": 12,
          "y": 12.5
        }
      },
      {
        "chartUUID": "chrt_xxxx32",
        "pos": {
          "h": 8,
          "i": "chrt_xxxx32",
          "w": 8,
          "x": 16,
          "y": 31
        }
      },
      {
        "chartUUID": "chrt_xxxx32",
        "pos": {
          "h": 8,
          "i": "chrt_xxxx32",
          "w": 6,
          "x": 6,
          "y": 12.5
        }
      },
      {
        "chartUUID": "chrt_xxxx32",
        "pos": {
          "h": 8,
          "i": "chrt_xxxx32",
          "w": 8,
          "x": 16,
          "y": 2
        }
      },
      {
        "chartUUID": "chrt_xxxx32",
        "pos": {
          "h": 8,
          "i": "chrt_xxxx32",
          "w": 8,
          "x": 8,
          "y": 31
        }
      }
    ],
    "createAt": 1698732345,
    "createdWay": "manual",
    "creator": "wsak_xxxxx",
    "dashboardBidding": {
      "app_id": [
        {
          "op": "in",
          "value": ["cccc"]
        }
      ]
    },
    "dashboardBindSet": [],
    "deleteAt": -1,
    "extend": {},
    "iconSet": {
      "icon": "http://testing-static-res.truewatch.com/dataflux-template/dashboard/en/aws_redis/icon.svg",
      "url": "http://testing-static-res.truewatch.com/dataflux-template/dashboard/en/aws_redis/aws_redis.png"
    },
    "id": 4615,
    "isPublic": 1,
    "mapping": [],
    "name": "test_Redis Monitoring View",
    "old_name": "test_Redis Monitoring View",
    "ownerType": "inner",
    "status": 0,
    "tag_info": {
      "tagInfo": []
    },
    "type": "CUSTOM",
    "updateAt": 1698732854,
    "updator": "wsak_xxxxx",
    "updatorInfo": {
      "acntWsNickname": "",
      "email": "wsak_xxxxx",
      "iconUrl": "",
      "name": "a",
      "username": "xxx"
    },
    "uuid": "dsbd_xxxx32",
    "workspaceUUID": "wksp_xxxx32"
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-CEA33BA0-68C7-499B-83D7-F59015192DBB"
}