取得¶
GET /api/v1/notes_v2/{note_uuid}/get
概要¶
指定した新しいバージョンのノートのメタデータと Markdown 本文を読み取ります。
呼び出し前と使用手順¶
新しいバージョンのノート一覧で提供される UUID を使用します。公開ノートには読み取り権限を持つキーを使用でき、プライベートノートは作成元のアイデンティティのみが読み取れます。編集または削除の前にレスポンスの etag を記録し、後続の ifMatch として使用します。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| note_uuid | string | Y | 新しいバージョンのノート UUID。 例: nbnote_example取得または入力方法: 新しいバージョンのノート一覧の content.data[].noteUUID、または作成結果の content.noteUUID からコピーします。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメータの補足説明¶
JSON オブジェクトを返します。本文は content.content に格納され、バージョン検証には content.etag を使用します。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/notes_v2/nbnote_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer | ノートレコード番号。 |
| content.uuid | string | Studio ノート識別子。noteUUID と同じです。 |
| content.noteUUID | string | 詳細、変更、削除のパスで使用するノート UUID。 |
| content.title | string | ノートタイトル。 |
| content.name | string | title と同じエンティティフィールド。 |
| content.workspaceUUID | string | ノートが所属するワークスペース UUID。 |
| content.isPublic | integer | 1 は公開、0 はプライベート。 |
| content.tags | array<string> |
通常タグ。 |
| content.tagKV | object | キーと値のタグ。 |
| content.extend | object | ビジネス拡張設定。 |
| content.createdSource | string | 作成元。例: manual または ai。 |
| content.noteType | string | normal、runbook または statuspages。 |
| content.etag | string | 現在の ETag。変更または削除時に ifMatch として使用できます。 |
| content.version | integer | 現在のコンテンツバージョン番号。 |
| content.nbookETag | string | etag と同じエンティティフィールド。 |
| content.nbookVersion | integer | version と同じエンティティフィールド。 |
| content.lastSyncAt | integer | 前回の同期時刻(Unix 秒)。 |
| content.syncStatus | string | コンテンツ同期ステータス。例: synced。 |
| content.syncError | string | 同期エラーの説明。同期済みの場合は通常空です。 |
| content.status | integer | ノートステータス。 |
| content.isFavourited | boolean | 現在のアイデンティティでお気に入りに登録されているか。 |
| content.creator | string | 作成者のアイデンティティ識別子。 |
| content.updator | string | 最終更新者のアイデンティティ識別子。 |
| 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.path | string | サービスが生成するノートドキュメントのパス。インターフェースの呼び出しでは noteUUID を使用します。 |
| content.content | string | 完全な Markdown 本文。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"id": 42,
"uuid": "nbnote_example",
"noteUUID": "nbnote_example",
"title": "生产巡检说明",
"name": "生产巡检说明",
"workspaceUUID": "wksp_example",
"isPublic": 1,
"tags": [
"ops"
],
"tagKV": {
"service": "checkout"
},
"extend": {},
"createdSource": "manual",
"noteType": "runbook",
"etag": "etag-example-1",
"version": 1,
"nbookETag": "etag-example-1",
"nbookVersion": 1,
"lastSyncAt": 1785427200,
"syncStatus": "synced",
"syncError": "",
"status": 0,
"isFavourited": false,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"path": "manual/nbnote_example.md",
"content": "# 生产巡检\n\n先查看服务可用性,再核对最近告警。",
"creatorInfo": {},
"updatorInfo": {},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
HTTP 424 を受け取った場合、content.upstreamStatus はダウンストリームが返したステータスです。接続異常時は 0 になる場合があります。content.upstreamPath は該当する失敗リクエストのパス、content.responseBody はダウンストリームのエラー内容です。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.NotFoundNote | アクティブなノートが存在しない、現在のワークスペースに属していない、または現在のアイデンティティが他者のプライベートノートを読み取った場合 | 指定されたノートが見つかりません | 同じワークスペースの一覧で noteUUID を確認してください。プライベートノートは作成元のアイデンティティで読み取ってください。 |
| 424 | ft.NbookDBApiError | ノートサービスへのリクエスト失敗、応答異常、またはサービス利用不可 | ノートサービスの呼び出しに失敗しました | まず content.upstreamStatus と応答内容を確認してください。traceId を保持し、その後、具体的な原因に応じて再試行するか管理者に連絡してください。 |