コンテンツにスキップ

取得



GET /api/v1/viewer/{viewer_uuid}/get

概要

指定したエクスプローラーの詳細とレイアウトを取得します。

呼び出し前の準備と使用手順

エクスプローラー一覧から現在のワークスペースの UUID を選択します。詳細ではレイアウトと関連情報が返されます。移植可能な完全なテンプレートが必要な場合はエクスプローラーのエクスポートを使用します。showTemplate=true を設定すると、デフォルトテンプレートの情報を確認できます。

ルートパラメータ

パラメータ名 型 必須 説明
viewer_uuid string Y 現在のワークスペースにおける対象エクスプローラーの UUID。
例: dsbd_view_example
取得または入力方法: エクスプローラー一覧の content.data[].uuid から取得します。作成レスポンスの content.uuid を使用することもできます。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
showTemplate boolean 省略した場合、デフォルトテンプレートは追加で読み込まれません。
例: true
取得または入力方法: 関連するデフォルトテンプレートを読み込む場合は true を指定します。1 も受け付けます。

パラメータ補足説明

テンプレート情報はエクスプローラーのデフォルトテンプレート設定から取得されます。エクスプローラー自体の移植可能な JSON 構造はエクスポート API から返されます。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/viewer/dsbd_view_example/get' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode showTemplate=true

レスポンス

HTTP 200、application/json。以下の例は直接読み取れる主要なフィールドを示しています。

フィールド 型 説明
content.id integer エクスプローラーのレコード番号。
content.uuid string エクスプローラーの UUID。
content.workspaceUUID string 所属ワークスペース。
content.name string エクスプローラー名。
content.desc string エクスプローラーの説明。
content.identifier string カスタム識別子。空の場合があります。
content.ownerType string エクスプローラーのリソース所属。通常は viewer です。
content.type string エクスプローラーのタイプ。例えば CUSTOM です。
content.isPublic integer 現在のリソースの可視範囲。1 は公開、0 は作成したアイデンティティのみ参照可能です。
content.chartPos array<object> チャートレイアウトの配列。chartUUID とレイアウトオブジェクト pos を含みます。
content.chartPos[].chartUUID string 参照されるチャートの UUID。
content.chartPos[].pos object レイアウトの位置とサイズ。x、y、w、h など。
content.chartGroupPos array<string> チャートグループの並び順。
content.iconSet object アイコン設定。
content.extend object エクスプローラーの拡張情報。
content.mapping array<object> 変数フィールドのマッピング情報。
content.dashboardBindSet array ビューのバインド設定。
content.createdWay string リソースの作成元。
content.openPermissionSet boolean エンティティレコードの権限設定スイッチ。
content.permissionSet array<string> レコード内の操作権限主体 UUID。
content.readPermissionSet array<string> レコード内の読み取り権限主体 UUID。
content.tagInfo array<object> 関連タグ情報。
content.tagInfo[].id string タグ UUID と同じ識別子。
content.tagInfo[].uuid string タグ UUID。
content.tagInfo[].name string タグ名。
content.tagInfo[].description string タグの説明。
content.tagInfo[].colour string タグの色。
content.tagInfo[].scope array<string> タグが有効となるスコープ。
content.tagInfo[].tagPermissionInfo object 存在する場合は読み書きの認可情報。
content.status integer レコードのステータス。
content.creator string 作成者のアイデンティティ ID。
content.updator string 最終更新者のアイデンティティ ID。空の場合があります。
content.createAt number 作成日時。Unix 秒。
content.updateAt number 更新日時。Unix 秒。未更新の場合は -1 になることがあります。
content.deleteAt number 削除日時。Unix 秒。未削除の場合は -1 です。
content.creatorInfo object 作成者のアイデンティティ情報。取得できない場合は空のオブジェクトです。
content.updatorInfo object 最終更新者のアイデンティティ情報。取得できない場合は空のオブジェクトです。
content.creatorInfo.uuid string 対応するアイデンティティが取得できた場合に提供されることがあります。アイデンティティ識別子。
content.creatorInfo.status integer 対応するアイデンティティが取得できた場合に提供されることがあります。アカウントのステータス。
content.creatorInfo.wsAccountStatus integer 対応するアイデンティティが取得できた場合に提供されることがあります。ワークスペースメンバーのステータス。
content.creatorInfo.username string 対応するアイデンティティが取得できた場合に提供されることがあります。ログイン名。
content.creatorInfo.name string 対応するアイデンティティが取得できた場合に提供されることがあります。表示名。
content.creatorInfo.iconUrl string 対応するアイデンティティが取得できた場合に提供されることがあります。アバター URL。
content.creatorInfo.email string 対応するアイデンティティが取得できた場合に提供されることがあります。アカウントのメールアドレス。API Key のアイデンティティの場合はその識別子が返されることがあります。
content.creatorInfo.mobile string 対応するアイデンティティが取得できた場合に提供されることがあります。連絡先。
content.creatorInfo.countryCode string 対応するアイデンティティが取得できた場合に提供されることがあります。電話番号の国または地域コード。
content.creatorInfo.acntWsNickname string 対応するアイデンティティが取得できた場合に提供されることがあります。ワークスペース内のニックネーム。
content.updatorInfo.uuid string 対応するアイデンティティが取得できた場合に提供されることがあります。アイデンティティ識別子。
content.updatorInfo.status integer 対応するアイデンティティが取得できた場合に提供されることがあります。アカウントのステータス。
content.updatorInfo.wsAccountStatus integer 対応するアイデンティティが取得できた場合に提供されることがあります。ワークスペースメンバーのステータス。
content.updatorInfo.username string 対応するアイデンティティが取得できた場合に提供されることがあります。ログイン名。
content.updatorInfo.name string 対応するアイデンティティが取得できた場合に提供されることがあります。表示名。
content.updatorInfo.iconUrl string 対応するアイデンティティが取得できた場合に提供されることがあります。アバター URL。
content.updatorInfo.email string 対応するアイデンティティが取得できた場合に提供されることがあります。アカウントのメールアドレス。API Key のアイデンティティの場合はその識別子が返されることがあります。
content.updatorInfo.mobile string 対応するアイデンティティが取得できた場合に提供されることがあります。連絡先。
content.updatorInfo.countryCode string 対応するアイデンティティが取得できた場合に提供されることがあります。電話番号の国または地域コード。
content.updatorInfo.acntWsNickname string 対応するアイデンティティが取得できた場合に提供されることがあります。ワークスペース内のニックネーム。
content.isFavorite boolean 現在のアイデンティティのお気に入り状態。詳細が未お気に入りの場合は返されないことがあります。
content.isIndexDashboard boolean 現在のワークスペースのホームビューかどうか。
content.refCheckerUUIDs array<string> 関連するモニターの識別子。
content.integrationInfo object showTemplate=true または 1 の場合に付属するデフォルトテンプレート情報。該当項目がない場合は空のオブジェクトです。
content.extend.defaultTargetWorkspaceName string 旧来の単一ワークスペース ID が設定されている場合、対応する名前が返されることがあります。
content.extend.defaultTargetWorkspaceNames array<string> デフォルトのクエリ対象ワークスペース一覧が設定されている場合、ワークスペース名の一覧が返されることがあります。
content.declaration object または null ワークスペースのパブリック宣言。
{
  "code": 200,
  "content": {
    "id": 25,
    "uuid": "dsbd_view_example",
    "name": "ホストインスペクションエクスプローラー",
    "desc": "ホストインスペクションとステータス確認",
    "workspaceUUID": "wksp_example",
    "identifier": "",
    "ownerType": "viewer",
    "type": "CUSTOM",
    "isPublic": 1,
    "chartPos": [],
    "chartGroupPos": [],
    "iconSet": {},
    "extend": {},
    "mapping": [],
    "dashboardBindSet": [],
    "createdWay": "manual",
    "openPermissionSet": false,
    "permissionSet": [],
    "readPermissionSet": [],
    "tagInfo": [],
    "status": 0,
    "creator": "wsak_example",
    "updator": "",
    "createAt": 1785427200,
    "updateAt": -1,
    "deleteAt": -1,
    "creatorInfo": {},
    "updatorInfo": {},
    "isIndexDashboard": false,
    "refCheckerUUIDs": [],
    "integrationInfo": {},
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、および共通リクエストのエラーについては共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
404 ft.NotFoundView 対象が存在しない、削除済み、または現在のワークスペースに存在しない 指定されたビューが見つかりません 同じワークスペースのエクスプローラー一覧で有効な UUID を再確認してください。

フィードバック

このページは役に立ちましたか?