取得¶
GET /api/v1/notes/{notes_uuid}/get
概要¶
旧版ノートの詳細とチャートを取得します。
呼び出し前の確認と使用手順¶
ノート一覧で提供される UUID を使用します。結果の charts から、チャート名、タイプ、クエリ定義を含む現在アクティブなチャートを読み取ります。結果はノート内のチャート順を優先し、その後、順序リストに含まれない所属チャートを追加します。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 を取得します。 |
パラメータ補足¶
詳細内の charts は、所属ノートに基づいてクエリされたチャートオブジェクトです。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/notes/note_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
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.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.charts | array<object> |
現在ノートに属する有効なチャート。 |
| content.declaration | object または null | ワークスペースの公開宣言。 |
| content.charts[].id | integer | チャートレコード番号。 |
| content.charts[].uuid | string | チャート UUID。 |
| content.charts[].name | string | チャート名。 |
| content.charts[].type | string | チャートタイプ。 |
| content.charts[].notesUUID | string | チャートが所属するノート UUID。 |
| content.charts[].workspaceUUID | string | 所属ワークスペース。 |
| content.charts[].chartGroupUUID | string | 所属チャートグループ。空文字列の場合があります。 |
| content.charts[].dashboardUUID | string | 関連付けられたダッシュボード識別子。空文字列の場合があります。 |
| content.charts[].isWorkspaceKeyIndicator | integer | ワークスペースの重要指標としてマークされているか。0 はいいえ、1 ははい。 |
| content.charts[].queries | array<object> |
クエリまたはノート内容の定義。 |
| content.charts[].extend | object | チャートの拡張設定。 |
| content.charts[].status | integer | チャートの現在のステータス。 |
| content.charts[].creator | string | 作成者のアイデンティティ ID。 |
| content.charts[].updator | string | 最終更新者のアイデンティティ ID。未更新の場合は空です。 |
| content.charts[].createAt | number | 作成日時(Unix 秒)。 |
| content.charts[].updateAt | number | 最終更新日時(Unix 秒)。未更新の場合は -1 です。 |
| content.charts[].deleteAt | number | 削除日時(Unix 秒)。未削除の場合は -1 です。 |
{
"code": 200,
"content": {
"id": 11,
"uuid": "note_example",
"name": "生产巡检笔记",
"workspaceUUID": "wksp_example",
"isPublic": 1,
"extend": {},
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"creatorInfo": {},
"updatorInfo": {},
"charts": [
{
"name": "巡检说明",
"type": "text",
"queries": [
{
"query": {
"content": "按仪表板核对生产状态。"
}
}
],
"extend": {},
"id": 40,
"uuid": "chrt_example",
"workspaceUUID": "wksp_example",
"notesUUID": "note_example",
"chartGroupUUID": "",
"dashboardUUID": "",
"isWorkspaceKeyIndicator": 0,
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.NotFoundNote | UUID が削除済み、存在しない、または現在の API Key のワークスペースにない | 指定されたノートが見つかりません | 同じワークスペースのノート一覧で UUID を確認します。 |