Space/documents

社内 Space ドキュメントを ID、ハッシュ、リビジョン付きのブロックとして読み取ります。アウトライン、1つのテーブルまたはリスト、検索、特定のリビジョン以降の変更点、または過去のリビジョンを取得できます

GET
/v1/space/documents/{document_id}/view
curl -X GET "https://api.orchestor.io/v1/space/documents/%3Cdocument_id%3E/view" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123"
{  "data": {    "latest": 0,    "rev": 0,    "xml": "<string>"  }}

Orchestor API キーを取得

ワークスペースの設定から API キーを作成します。

認証

次のいずれかの条件を満たしてください。

  • Session cookie
  • API key

認証の詳細

cookie
wos-session

ウェブアプリにサインインすることで確立されるブラウザセッションです。サーバーは、ワークスペースのメンバーシップと権限を確認します。ワークスペーススコープの操作には X-Workspace-ID を指定してください。サーバー間リクエストの場合、操作がサポートしていれば API キーを使用します。

パスパラメータ

document_idstringpath必須
パターン
^doc_[a-f0-9]{24}$

クエリパラメータ

projectionstringenum<string>query

outline: トップレベルのブロックのみ。リストとテーブルは <gap/> に折りたたまれます。

許可される値
outline
parent_idstringquery

行、セル、またはアイテムを含む、1つのブロック(テーブルまたはリスト)の全体です。

パターン
^\d+\.\d+$

文字範囲を含む、これらの単語を含むテキストブロックのみです。

文字数
≥ 1, ≤ 1000
since_revinteger | nullquery

このリビジョン以降に変更されたブロックのみです。変更されていない連続部分は <gap/>、削除されたブロックは <gone/> となります。

値の範囲
≥ 0
at_revintegerquery

このリビジョン時点のドキュメントです。

値の範囲
≥ 1

ヘッダー

X-Workspace-IDstringheader

アクセスするワークスペースです。ワークスペーススコープの API キーを使用する場合、サーバーはキーからこの値を導出するため、ヘッダーは任意です。指定する場合、認証情報のワークスペースと一致する必要があり、一致しない場合リクエストは 403 workspace_mismatch を返します。インタラクティブなセッションリクエストの場合、メンバーになっているワークスペースを選択するためにこのヘッダーを指定します。プロジェクト ID をワークスペース ID として使用することはできません。

例"wks_abc123"

レスポンス

application/json

ブロック XML(<doc rev=…>)およびそれが反映するリビジョンです。

dataSpaceDocumentView必須
data.latestinteger
data.revinteger必須
data.xmlstring必須