목록¶
GET /api/v1/tag/list
개요¶
전역 태그 목록을 가져옵니다.
Query 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| search | string | 태그 이름 검색 비워 두기 허용: False |
|
| filter | string | 필터 조건 비워 두기 허용: False 선택 가능 값: ['BoardRefTagObject', 'ViewerRefTagObject', 'CheckerRefTagObject', 'DialingRefTagObject'] |
|
| pageIndex | integer | 페이지 번호 비워 두기 허용: False 예: 10 $minValue: 1 |
|
| pageSize | integer | 페이지당 반환 개수 비워 두기 허용: False 예: 10 $minValue: 1 $maxValue: 10000 |
매개변수 추가 설명¶
데이터 설명
- 요청 매개변수 설명
| 매개변수명 | type | 설명 |
|---|---|---|
| filter | string | 열거형 값 (대시보드 연결 태그: BoardRefTagObject, 탐색기 연결 태그: ViewerRefTagObject, 모니터 연결 태그: CheckerRefTagObject) |
- 응답 매개변수 설명
| 매개변수명 | type | 설명 |
|---|---|---|
| name | string | 태그 이름 |
| description | string | 태그 설명 정보 |
| color | string | 프론트엔드와 백엔드 간에 약속된 색상 유형 (default, style_key1, style_key2 ...) |
- color 필드 유형별 색상 대조표:
{ "default": {"background": "#CCE6FF", "color": "rgba(0,0,0,0.8)"}, "style_key1": {"background": "#3333FE", "color": "#FFFFFF"}, "style_key2": {"background": "#428BCA", "color": "#FFFFFF"}, "style_key3": {"background": "#364450", "color": "#FFFFFF"}, "style_key4": {"background": "#E0E1FF", "color": "rgba(0,0,0,0.8)"}, "style_key5": {"background": "#9400D3", "color": "#FFFFFF"}, "style_key6": {"background": "#EDDBFF", "color": "rgba(0,0,0,0.8)"}, "style_key7": {"background": "#CC328B", "color": "#FFF"}, "style_key8": {"background": "#FCDEF0", "color": "rgba(0,0,0,0.8)"}, "style_key9": {"background": "#DC143D", "color": "#FFFFFF"}, "style_key10": {"background": "#FCBABA", "color": "rgba(0,0,0,0.8)"}, "style_key11": {"background": "#BD0B48", "color": "#FFFFFF"}, "style_key12": {"background": "#FDECD2", "color": "rgba(0,0,0,0.8)"}, "style_key13": {"background": "#FFC29C", "color": "rgba(0,0,0,0.8)"}, "style_key14": {"background": "#ED9120", "color": "#FFFFFF"}, "style_key15": {"background": "#CD5B44", "color": "#FFFFFF"}, "style_key16": {"background": "#FAF570", "color": "rgba(0,0,0,0.8)"}, "style_key17": {"background": "#C29953", "color": "#FFFFFF"}, "style_key18": {"background": "#02B140", "color": "#FFFFFF"}, "style_key19": {"background": "#D5F4D5", "color": "rgba(0,0,0,0.8)"}, "style_key20": {"background": "#009966", "color": "#FFFFFF"}, "style_key21": {"background": "#023220", "color": "#FFFFFF"}, "style_key22": {"background": "#E7E7E7", "color": "rgba(0,0,0,0.8)"}, "style_key23": {"background": "#808080", "color": "#FFFFFF"} }
요청 예시¶
curl 'https://openapi.guance.com/api/v1/tag/list?pageIndex=1&pageSize=2' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed
응답¶
{
"code": 200,
"content": [
{
"colour": "style_key3",
"description": "temp_test",
"id": "tag_xxxx32",
"name": "test_ha"
},
{
"colour": "default",
"description": "",
"id": "tag_xxxx32",
"name": "ssssooooo"
}
],
"errorCode": "",
"message": "",
"pageInfo": {
"count": 2,
"pageIndex": 1,
"pageSize": 2,
"totalCount": 101
},
"success": true,
"traceId": "TRACE-F2F9D0F5-FEF4-4C37-AB9E-B901CD0E5931"
}