取得¶
GET /api/v1/tag/{tag_uuid}/get
概要¶
指定したタグの保存済みエンティティ全体とスコープを読み取ります。
呼び出し前の準備と使用手順¶
このワークスペースの未削除タグを返します。エンティティのステータスと時刻を含みますが、リストの tagPermissionInfo や識別情報のサマリーは含みません。存在しない場合、別ワークスペースの場合、削除済みの場合は ObjectNotExists を返します。scope の過去の空値は ["all"] に正規化されますが、新規リクエストで null を渡せることを意味するものではありません。
パスパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| tag_uuid | string | Y | このワークスペースのタグ UUID です。タグ名、リストの数値ページ番号、リソース UUID ではありません。 例: tag_example取得・入力方法: タグリスト の content.data[].uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報です。 例: <DF-API-KEY>取得・入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメータの補足説明¶
データについて
- レスポンスパラメータの説明
| パラメータ名 | 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"} }
リクエスト例¶
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer | エンティティレコード番号です。リストの id は UUID 文字列です。リストのフィールドを参照してください。 |
| content.uuid | string | tag_ タグ UUID。 |
| content.workspaceUUID | string | 所属ワークスペース。 |
| content.name | string | タグ名。 |
| content.description | string | 用途の説明。 |
| content.colour | string | 色表現。 |
| content.scope | array<string> |
正規化されたスコープです。過去の null または空の scope は ["all"] として返されます。 |
| content.scope[] | string | all/scene/monitor/dialing/security/infrastructure/catalog のいずれかです。 |
| content.status | integer | 0 は有効、3 は削除済みです。その他の過去のステータスは実際のデータに従います。 |
| content.creator | string | 作成者の識別子。 |
| content.updator | string | 最終更新者の識別子。 |
| content.createAt | integer | 作成日時の Unix 秒。 |
| content.updateAt | integer | 更新日時の Unix 秒です。未更新の場合は -1。 |
| content.deleteAt | integer | 削除日時の Unix 秒です。未削除の場合は -1。 |
| content.declaration | object | 共通宣言。 |
{
"code": 200,
"content": {
"id": 100,
"uuid": "tag_example",
"workspaceUUID": "wksp_example",
"name": "production",
"description": "本番リソースを統一的にマークします。",
"colour": "default",
"scope": [
"scene",
"monitor"
],
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストのエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.ObjectNotExists | このワークスペースに対応する有効なタグがない、または削除済み | 指定されたオブジェクトが存在しません | 現在のワークスペースのリストから有効な UUID を取得してください。 |
| 500 | ft.InternalServerError | タグ、参照/権限、または識別情報の読み取りとレスポンスのフォーマットに失敗 | 内部エラー | ワークスペースとクエリ条件を確認し、しばらくしてから再試行してください。継続的に失敗する場合は traceId を提供してください。 |