エクスポート
ワークスペース全体の zip。
エクスポートのツール
| ツール | 機能 |
|---|---|
| getExportPreview | エクスポートを今すぐ始められるか、次はいつ始められるか、まだ作成中のエクスポート、エクスポートにどれだけ含まれるか。 |
| listExports | ワークスペースのエクスポートを新しい順に、状態、進み具合、サイズ付きで示す。 |
| getExport | ID で指定した 1 件のエクスポート。 |
| startExport | ワークスペース全体の zip の作成を 1 日 1 回開始する。確認コードを求め、アプリのチャットでは必ず先に確認する。 |
エクスポートできるのはワークスペースのオーナーか、すべての権限を持つロールのメンバーだけで、すべてのアドレスで接続したクライアントを使う。どのツールにも threads:read が必要。
zip を返すツールはない。アプリの「エクスポート」ページ、REST API の GET /exports/{id}/content、SDK の exports.download、コマンドラインの openemail exports download でダウンロードすること。
このサーバーの一部のツールは、REST API が確認コードで保護している変更を行うため、同じコードを求めます。クライアントが直近 60 分以内にコードを確認しておらず、本人がアカウント → 接続済みアプリでそのクライアントに「60分間、変更を許可」を選んでもいない間、これらのツールは Refused (step_up_required): で始まる結果を返し、何も変更しません。emptyAudience がコードを求めることはありません。コードを求めるツールの一覧と、コードの要求と確認の方法は API の認証ページにあります。
リファレンス
getExportPreview
Whether this workspace can be exported now, when the next export can start, the export still being made, and how much an export would hold: conversations, attachments, contacts, audiences, calendar events, templates, rules, labels, notes and addresses.
入力
入力はありません。
ほかの提供先
listExports
The exports of this workspace, newest first, with their status, progress, size and when each is deleted. A ready one is downloaded on the Export page of the app or with GET /exports/{id}/content on the REST API.
入力
limitinteger- 1以上100以下
offsetinteger- 0以上
ほかの提供先
getExport
One export by its id: its status, its progress through the conversations, its size and when it is deleted.
入力
idstring必須- 1〜128文字
ほかの提供先
startExport
Start making a zip of the whole workspace, as Export now on the Export page does. It is made in the background, one at a time and once a day, and kept for a year. Ask the person first.
- 確認コードが必要
POST /exports
入力
入力はありません。