Skip to content

[Object Classification Configuration] List¶

GET /api/v1/objc_cfg/list

Overview¶

Retrieve a list of object classification configurations. The current API does not support pagination.

Query Request Parameters¶

Parameter Name	Type	Required	Description
targetWorkspaceUUIDs	commaArray	No	Authorized workspaces, multiple workspaces separated by commas. Allow empty: False Allow empty string: False
objcGroupUUID	string	No	Business group UUID Allow empty: False Example: objcg_xxxx Allow empty string: True Maximum length: 64
sourceType	string	Yes	Source type Allow empty: False Example: custom_object Options: ['object', 'custom_object']
search	string	No	Search object classification name Allow empty: False Example: xxx
timeRange	string	No	Time range Example: [1734402721237, 1734575521237] Allow empty: False

Additional Parameter Notes¶

Request Example¶

curl 'https://openapi.guance.com/api/v1/objc_cfg/list?sourceType=custom_object&timeRange=[1734573756731]' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

Response¶

{
    "code": 200,
    "content": [
        {
            "uuid": "objc_xxxx",
            "name": "test",
            "alias": "",
            "fields": [
                {
                    "name": "name1"
                },
                {
                    "name": "name2"
                }
            ],
            "filters": [],
            "tableColumns": [],
            "tableDetailViews": [
                {
                    "keys": {},
                    "title": "demo",
                    "required": true,
                    "viewName": "NtpQ Monitoring View",
                    "viewType": "dashboard",
                    "timerange": "default"
                }
            ],
            "iconSet": {},
            "objcGroupUUID": "objcg_xxxx",
            "objcGroupInfo": {
                "workspaceUUID": "wksp_xxx",
                "name": "eeee",
                "id": 86,
                "uuid": "objcg_xxxx",
                "status": 0,
                "creator": "acnt_xxxx",
                "updator": "",
                "createAt": 1734512088,
                "deleteAt": -1,
                "updateAt": -1
            }
        }
    ],
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "868484794797253491"
}