作成¶
POST /api/v1/notes/create
概要¶
レガシーノートを1件作成し、ノート UUID を返します。
呼び出し前の準備と使用手順¶
最小限のリクエストでは名前のみが必要です。レスポンスの content.uuid から新しいノートの UUID を取得し、その後ノートのインポートを呼び出してチャートを再構築できます。chartUUIDs は順序付き参照を保存します。チャートの内容を実際にノートへインポートする場合は、テンプレートインポートを使用してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| name | string | Y | ノート名。最大 128 文字です。 null を許可: False 最大長: 128 例: 生产巡检笔记取得または入力方法: 新しいノート名を入力するか、既存ノートの名前を再利用します。 |
| chartUUIDs | array | チャート UUID の順序配列。最大 32 項目です。省略時は空です。ここでは参照を保存するだけで、既存のチャートの所属を再設定しません。 null を許可: False 最大長: 32 例: []取得または入力方法: 新しいノートでは空配列を指定できます。既存チャートの UUID は、対応する旧バージョンのノート詳細の content.charts[].uuid で確認できます。 |
|
| extend | json | ノートの拡張設定。省略時は {} です。 null を許可: False 例: {}取得または入力方法: ノート詳細の content.extend またはテンプレートの extend から既存設定をコピーすることを優先します。 |
パラメータの補足説明¶
デフォルトでは、名前を指定して空のノートを作成できます。レガシーノートテンプレートからインポートする必要がある場合は、先に新しいノートの UUID を保存してください。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/notes/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"生产巡检笔记"}'
レスポンス¶
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": [],
"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 | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反しています | パラメータ解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効です | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON 構文は有効ですが、リクエストのトップレベルがオブジェクトではありません | 一部の JSON ファイルの形式エラー | パラメータを JSON オブジェクトに入れてから再試行してください。 |
| 403 | ft.ForbiddenFreeEditionLimit | ワークスペースで該当するクォータが有効になっており、旧バージョンのノート数が上限に達しています | 無料プランワークスペース {} は上限( {} 個)に達したため、新規作成できません。商用プランを契約すると制限を解除できます | ワークスペースのプランとノート数を確認してから、クォータまたはリソースを調整してください。 |