Space/documents

​
社内 Space ドキュメント（タブ）を Markdown、HTML、Word（docx）、または PDF としてエクスポート

ファイルを返します。チャートはデータテーブルとして、ダイアグラムはコネクタとしてエクスポートされます。執筆中のセクション（pending）は除外されます。ファイルを保存するには --output を使用してください。

GET
/v1/space/documents/{document_id}/export
curl -X GET "https://api.orchestor.io/v1/space/documents/%3Cdocument_id%3E/export?format=markdown&paper=a4" \  -H "Authorization: Bearer $API_KEY" \  -H "X-Workspace-ID: wks_abc123"
// エクスポートされたファイルです。

Orchestor API キーを取得

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

認証

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

  • Session cookie
  • API key

認証の詳細

cookie
wos-session

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

パスパラメータ

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

クエリパラメータ

formatstringenum<string>queryデフォルト:markdown

Markdown、HTML、docx（Word）、または PDF です。

許可される値
markdownhtmldocxpdf
at_revintegerquery

このリビジョン時点（履歴内のバージョン）のドキュメントをエクスポートします。

値の範囲
≥ 1
paperstringenum<string>queryデフォルト:a4

docx および PDF のページサイズです。

許可される値
a4letter

ヘッダー

X-Workspace-IDstringheader

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

例"wks_abc123"

レスポンス

エクスポートされたファイルです。

valuestring形式:binary