Skip to content

Feature Menu Settings (old)


POST /api/v1/workspace/menu/set

Overview

Set the feature menu for the current workspace

Body Request Parameters

Parameter Name Type Required Description
menu array Y List of configured menu items
Can be empty: False
menu[*] json Y Menu item
Can be empty: False
menu[*].key string Y Menu item
Example: CloudDial
Can be empty: False
Options: ['Scene', 'Events', 'Incident', 'Objectadmin', 'Metrics', 'LogIndi', 'APM', 'RUM', 'CloudDial', 'Security Check', 'GitLabCI', 'Monitor', 'Integration', 'Workspace', 'Billing']
menu[*].value int Y Whether the menu item is enabled: 1 enabled, 0 disabled
Example: 1
Can be empty: False
Options: [0, 1]

Additional Parameter Explanation

Parameter Description

Parameter Name Type Required Description
menu array[json] Y List of menu items
key string Y Menu item
value int Y Whether enabled: 0 disabled, 1 enabled

Menu Item Description

Key Description
Scene Scenes
Events Events
Incident Incident Tracking
Objectadmin Infrastructure
Metrics Metrics
LogIndi Logs
APM Application Performance Monitoring
RUM User Access Monitoring
CloudDial Synthetic Tests
Security Check Security Check
GitLabCI CI Visualization
Monitor Monitoring
Integration Integration
Workspace Management
Billing Paid Plans and Billing

Note:

  1. If not configured, the frontend treats it as a new menu and defaults to enabled.
  2. The configuration of menus in the management backend affects the final display effect of the space configuration.

Request Example

curl 'https://us1-openapi.truewatch.com/api/v1/workspace/menu/set' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \

--data-raw '{"menu":[{"key":"Scene","value":1},{"key":"Events","value":1},{"key":"Incident","value":1},{"key":"Objectadmin","value":1},{"key":"Metrics","value":1},{"key":"LogIndi","value":1},{"key":"APM","value":1},{"key":"RUM","value":1},{"key":"CloudDial","value":1},{"key":"Security Check","value":1},{"key":"GitLabCI","value":1},{"key":"Monitor","value":1},{"key":"Integration","value":1},{"key":"Workspace","value":1},{"key":"Billing","value":1}]}' \

Response

{
    "code": 200,
    "content": {
        "config": [
            {
                "key": "Scene",
                "value": 1
            },
            {
                "key": "Events",
                "value": 1
            },
            {
                "key": "Incident",
                "value": 1
            },
            {
                "key": "Objectadmin",
                "value": 1
            },
            {
                "key": "Metrics",
                "value": 1
            },
            {
                "key": "LogIndi",
                "value": 1
            },
            {
                "key": "APM",
                "value": 1
            },
            {
                "key": "RUM",
                "value": 1
            },
            {
                "key": "CloudDial",
                "value": 1
            },
            {
                "key": "Security Check",
                "value": 1
            },
            {
                "key": "GitLabCI",
                "value": 1
            },
            {
                "key": "Monitor",
                "value": 1
            },
            {
                "key": "Integration",
                "value": 1
            },
            {
                "key": "Workspace",
                "value": 1
            },
            {
                "key": "Billing",
                "value": 1
            }
        ],
        "createAt": 1697627382,
        "creator": "acnt_xxxx32",
        "deleteAt": -1,
        "id": 763,
        "keyCode": "WsMenuCfg",
        "status": 0,
        "updateAt": 1697627382,
        "updator": "acnt_xxxx32",
        "uuid": "ctcf_xxxx32",
        "workspaceUUID": "wksp_xxxx20"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "475074598825122309"
}