コンテンツにスキップ

インポート



POST /api/v1/viewer/{viewer_uuid}/import

概要

既存のソースビューまたはテンプレートを、指定したエクスプローラーに上書きします。

呼び出し前と使用時の手順

先にエクスプローラーのエクスポートを呼び出して、対象をバックアップしてください。インポートするテンプレートを選択するか、現在のワークスペース内に存在することが確認済みのソースビューを参照します。sourceDashboardUUID を送信した場合は、そのソースビューからテンプレートを生成します。空文字列または無効になったソースではエクスポート結果が空になり、そのまま対象を上書きする可能性があるため、送信前に必ず検証してください。対象の UUID は保持され、古いチャート、グループ、変数は先に削除されてから、テンプレートに従って作成されます。templateInfo={} または main の省略により、これらの古い内容はクリアされます。例では空のテンプレートを使用しています。実際の移行では完全なテンプレートを渡してください。テンプレートは最初に検証され、削除と再作成は同一トランザクション内で実行されます。エラーが発生した場合は、まず現在の内容とバックアップを確認してから、復元するかどうかを判断してください。

ルートパラメータ

パラメータ名 型 必須 説明
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 を取得します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
ownerType string インポート後のリソースの帰属。デフォルトは viewer です。
null を許可: False
例: viewer
取得または入力方法: エクスプローラーとしての用途を維持する場合は省略するか、viewer を入力します。
sourceDashboardUUID string このフィールドを指定すると、サーバーはソースビューからテンプレートを優先的にエクスポートします。
null を許可: False
例: dsbd_source_example
取得または入力方法: エクスプローラー一覧 または ダッシュボード一覧 から、エクスポート可能であることを確認済みの実際のソース UUID を取得します。templateInfo を使用する場合はこのフィールドを省略します。
templateInfo json ソースビュー方式とは二者択一です。テンプレートオブジェクトには完全な main を含める必要があります。
null を許可: False
例: {"title": "主机巡检查看器", "summary": "主机巡检与状态核对", "identifier": "", "dashboardType": "CUSTOM", "dashboardExtend": {}, "dashboardMapping": [], "dashboardBindSet": [], "iconSet": {}, "main": {"type": "template", "charts": [], "vars": [], "groups": [], "chartGroupPos": []}}
取得または入力方法: 先にエクスプローラーのエクスポートを呼び出して content オブジェクトを取得します。そのまま使用するか、調整が必要なテンプレートフィールドを変更してください。

パラメータの補足説明

インポートでは単数の templateInfo を使用します。ダッシュボードテンプレートのフィールド説明 でテンプレートフィールドを説明します。空でない title、summary、identifier などは、既存の属性を上書きできます。dashboardExtend、dashboardMapping、dashboardType を省略した場合、それぞれ空のオブジェクト、空の配列、CUSTOM として処理されます。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/viewer/dsbd_view_example/import' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"templateInfo":{"title":"主机巡检查看器","summary":"主机巡检与状态核对","identifier":"","dashboardType":"CUSTOM","dashboardExtend":{},"dashboardMapping":[],"dashboardBindSet":[],"iconSet":{},"main":{"type":"template","charts":[],"vars":[],"groups":[],"chartGroupPos":[]}}}'

レスポンス

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.skippedTags array<object> スコープが一致しないためスキップされたタグ。
content.skippedTags[].name string スキップされた名前。
content.skippedTags[].scope array<string> 既存のタグスコープ。
content.skippedTags[].expectedScope string 期待されるタグスコープ。
content.skippedTags[].reason string スキップ理由。
content.skippedTags[].resourceUUID string 存在する場合は関連リソースの UUID。
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": "import",
    "openPermissionSet": false,
    "permissionSet": [],
    "readPermissionSet": [],
    "tagInfo": [],
    "status": 0,
    "creator": "wsak_example",
    "updator": "",
    "createAt": 1785427200,
    "updateAt": -1,
    "deleteAt": -1,
    "creatorInfo": {},
    "updatorInfo": {},
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

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

HTTP ステータス errorCode 発生条件 メッセージまたは応答の説明 対処方法
406 ft.ParameterValidationFailed フィールドの型または値が宣言に一致しない、または宣言されていないトップレベルフィールドが含まれている パラメータの解析に失敗しました パラメータの位置、フィールド名、型、値を確認してください。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効です リクエスト JSON の形式エラー content.reason、line、column に従って JSON を修正してください。
400 ft.JsonFormatError JSON 構文は有効ですが、リクエストのトップレベルがオブジェクトではありません 一部の JSON ファイルの形式エラー パラメータを JSON オブジェクトとして渡してください。
404 ft.NotFoundView 対象が存在しない、削除済み、または現在のワークスペースに存在しません 指定されたビューが見つかりません 同じワークスペースのエクスプローラー一覧で有効な UUID を再確認してください。
403 ft.ForbiddenFreeEditionLimit ワークスペースで数量制限が有効になっており、上限に達しています 無料プランのワークスペース {} は上限( {} 個)に達したため、新規作成できません。商用プランにアップグレードすると制限を解除できます 現在のプランとエクスプローラー数を確認してください。
406 ft.ExceedMaxCharacterLimit テンプレート内のチャート名またはグループ名が 256 文字を超えている、またはタグ名が 128 文字を超えています {} が最大文字長の制限を超えています フィールドの長さ制限に従ってテンプレートを修正してください。
400 ft.IdentificationIdExists テンプレート識別子が対象タイプで他のビューによって既に使用されています 識別子 ID は既に存在します テンプレート識別子を変更して再試行してください。
406 ft.MissingImportTemplateResourceUUID ソース UUID が送信されておらず、テンプレートもありません インポートテンプレート/インポート元ビュー UUID がありません 確認可能な実際のソース UUID またはエクスポート済みのテンプレートオブジェクトを渡してください。
406 ft.InvalidParameter テンプレート構造が無効です。たとえば、main がオブジェクトではない、charts、vars、groups が配列ではない、またはチャートクエリ構造が無効です パラメータ {} が無効です エラーで示されたフィールドパスに従ってテンプレートを修正してください。本バージョンのエクスポート API が返す完全なテンプレートを優先して使用してください。

フィードバック

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