一覧表示¶
GET /api/v1/tag/list
概要¶
グローバルタグリストを取得します。
Query リクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| search | string | タグ名検索 空を許可: False |
|
| filter | string | フィルター条件 空を許可: False 選択可能な値: ['BoardRefTagObject', 'ViewerRefTagObject', 'CheckerRefTagObject', 'DialingRefTagObject'] |
|
| pageIndex | integer | ページ番号 空を許可: False 例: 10 $minValue: 1 |
|
| pageSize | integer | 1ページあたりの返却数 空を許可: 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"
}