変更¶
POST /api/v1/notes/{notes_uuid}/modify
概要¶
旧バージョンのノートの名前と指定された設定を更新します。
呼び出し前の準備と使用手順¶
まずノート詳細で対象と現在の名前を確認します。リクエストには引き続き name を含める必要がありますが、元の値をそのまま送信してもかまいません。chartUUIDs を省略した場合は元の参照が保持され、完全な配列を送信した場合は順序が置き換えられ、除外された既存のチャートは論理削除されます。[] を送信すると、元の参照がすべて削除されます。チャートを再作成する必要がある場合は、インポート API を使用してください。送信前にバックアップをエクスポートしてください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 を取得します。 |
リクエストボディパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| name | string | Y | 必須。更新後のノート名。最大 128 文字。 null 許可: False 最大長: 128 例: 生产巡检笔记 v2取得・入力方法: 名前を変更しない場合は、ノート詳細から content.name を取得し、そのまま送信します。 |
| chartUUIDs | array | 最大で合計 32 個。チャート参照を変更する必要がある場合にのみ指定します。 null 許可: False 最大長: 32 例: ["chrt_example"]取得・入力方法: 対象ノートのノート詳細の content.charts[].uuid から取得し、希望する順序で完全なリストを送信します。 |
|
| extend | json | 送信時は拡張オブジェクト全体を置き換えます。省略した場合は元の値が保持されます。 null 許可: False 例: {}取得・入力方法: ノート詳細の content.extend またはテンプレートの extend から既存の設定をコピーすることを推奨します。 |
パラメータの補足説明¶
更新レスポンスは変更前の名前を oldName として返します。現在のチャートリストを確認するには、引き続きノート詳細を照会してください。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/notes/note_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"生产巡检笔记 v2"}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要なフィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer | ノートレコードの ID。 |
| 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.oldName | string | 変更前の名前。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"id": 11,
"uuid": "note_example",
"name": "生产巡检笔记 v2",
"workspaceUUID": "wksp_example",
"isPublic": 1,
"extend": {},
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427320,
"deleteAt": -1,
"oldName": "生产巡检笔记",
"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.NotFoundNote | UUID が削除済み、存在しない、または現在の API Key のワークスペースに属していない | 指定されたノートが見つかりません | 同じワークスペースのノートリストで UUID を確認してください。 |