インポート¶
POST /api/v1/notes/{notes_uuid}/import
概要¶
テンプレートを使用して、指定した旧版ノートのチャート内容を再構築します。
呼び出し前の準備と使用手順¶
まずノートのエクスポートで対象ノートをバックアップします。完全なテンプレートを templateInfo に渡します。パス内のノート UUID は保持され、元の pos で参照されていたチャートは論理削除され、インポートされたチャートには新しい UUID が再生成されます。templateInfo または main.charts がない場合、正常に実行されるとチャートはクリアされます。extend がない場合は {} で上書きされます。事前にテンプレートを検証し、完了後にノート詳細でチャートと名前を確認してください。
ルートパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| notes_uuid | string | Y | 対象となる旧版ノートの UUID。 例: note_example取得または入力方法: ノート一覧 の content.data[].uuid から取得します。作成レスポンスの content.uuid を使用することもできます。 |
リクエストヘッダー¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証クレデンシャル。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作の権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| templateInfo.name | string | 空でない場合は現在のノート名を上書きします。省略または空文字列の場合は保持します。 例: 本番インスペクションノート取得または入力方法: エクスポートしたテンプレートの name から値を取得し、必要に応じて名前を変更します。 |
|
| templateInfo.extend | object | ノートの拡張オブジェクト。省略した場合は {} で上書きされます。 例: {}取得または入力方法: エクスポートしたテンプレートの extend から取得します。 |
|
| templateInfo.main | object | コンテンツ本体。ない場合は既存のチャートがクリアされます。 例: {"charts": [{"name": "インスペクション説明", "type": "text", "queries": [{"query": {"content": "ダッシュボードで本番状態を確認します。"}}], "extend": {}}]}取得または入力方法: エクスポートしたテンプレートの main から取得します。 |
|
| templateInfo.main.charts | array | インポートする完全なチャートリスト。ない場合または [] を渡した場合はチャートがクリアされます。 例: [{"name": "インスペクション説明", "type": "text", "queries": [{"query": {"content": "ダッシュボードで本番状態を確認します。"}}], "extend": {}}]取得または入力方法: main.charts の完全なチャート配列を使用し、順序を確定します。 |
|
| templateInfo.main.charts[].name | string | チャート名。最大 256 文字。省略時は空文字列がデフォルトです。 例: インスペクション説明取得または入力方法: エクスポートしたチャートの名前を使用するか、新しい名前を入力します。 |
|
| templateInfo.main.charts[].type | string | チャートタイプ。省略時は line を使用します。 例: text取得または入力方法: エクスポートしたチャートの type を優先して使用します。テキスト本文の例では text を使用します。 |
|
| templateInfo.main.charts[].queries | array | チャートクエリまたは本文定義。省略時はデフォルトで [] です。 例: [{"query": {"content": "ダッシュボードで本番状態を確認します。"}}]取得または入力方法: 同じタイプのチャートの元の queries をコピーします。 |
|
| templateInfo.main.charts[].queries[].query.content | string | text チャート本文例の content フィールド。 例: ダッシュボードで本番状態を確認します。取得または入力方法: テキスト型チャートには表示する本文を入力します。その他のタイプはエクスポートした内容を使用します。 |
|
| templateInfo.main.charts[].extend | object | 拡張設定。省略時は {} です。 例: {}取得または入力方法: エクスポートしたチャートの extend 設定を使用します。 |
|
| templateInfo | json | インポートするテンプレートオブジェクト。name が空でない場合はノート名を上書きできます。完全なテンプレートを明示的に送信してください。 null を許可: False 例: {"name": "本番インスペクションノート", "extend": {}, "main": {"charts": [{"name": "インスペクション説明", "type": "text", "queries": [{"query": {"content": "ダッシュボードで本番状態を確認します。"}}], "extend": {}}]}}取得または入力方法: ノートのエクスポートから main.charts を含む content を取得します。テンプレートのチャート順序とパラメーターが正しいことを確認してください。 |
パラメーターの補足説明¶
この操作は元のチャートを上書きします。テンプレート形式にはエクスポートインターフェースで取得した JSON を使用し、必要に応じて名前とチャート内容を置き換えます。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/notes/note_example/import' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"templateInfo":{"name":"本番インスペクションノート","extend":{},"main":{"charts":[{"name":"インスペクション説明","type":"text","queries":[{"query":{"content":"ダッシュボードで本番状態を確認します。"}}],"extend":{}}]}}}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer | ノートレコード番号。 |
| content.uuid | string | ノート UUID。照会、変更、インポート、削除に使用します。 |
| content.name | string | ノート名。 |
| content.workspaceUUID | string | 所属ワークスペース。 |
| content.isPublic | integer | 公開範囲。1 は公開、0 は作成者のみ。 |
| content.extend | 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.pos | array<object> |
チャートの順序参照配列。 |
| content.pos[].chartUUID | string | チャート UUID。 |
| content.declaration | object または null | ワークスペースのパブリック宣言。 |
{
"code": 200,
"content": {
"id": 11,
"uuid": "note_example",
"name": "本番インスペクションノート",
"workspaceUUID": "wksp_example",
"isPublic": 1,
"pos": [
{
"chartUUID": "chrt_example"
}
],
"extend": {},
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通のリクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対応方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | templateInfo が null、型エラー、または未宣言のトップレベルリクエストフィールドを含む | パラメーターの解析に失敗しました | リクエストパラメーター表に従ってオブジェクトを送信し、エクスポートインターフェースが返す完全なテンプレートを使用します。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正します。 |
| 400 | ft.JsonFormatError | JSON 構文は有効だが、リクエストのトップレベルがオブジェクトでない | 一部の json ファイル形式エラー | パラメーターを JSON オブジェクトに入れてから再試行します。 |
| 404 | ft.NotFoundNote | UUID が削除済み、存在しない、または現在の API Key のワークスペースにない | 指定されたノートが見つかりません | 同じワークスペースのノート一覧で UUID を確認します。 |
| 403 | ft.ForbiddenFreeEditionLimit | ワークスペースで該当するクォータが有効になっており、旧版ノートの数が上限に達している | 無料プランワークスペース {} は上限( {} 個)に達したため、新規作成できません。商用プランを開通すると制限が解除されます | ワークスペースのプランとノート数を確認し、クォータまたはリソースを調整します。 |
| 406 | ft.ExceedMaxCharacterLimit | テンプレート内のチャート名がサポートされる長さを超えている | {}が最大文字数制限を超えています | チャート名を最大 256 文字に変更してから、テンプレートとバックアップを確認します。 |