next

Cellエクスポート

概要

Cell内の全てのデータをCellスナップショットファイルとしてエクスポートする。 スナップショットファイルはPersoniumUnit内の特殊な領域(Cellスナップショット領域)に作成される。
処理成功時は拡張子が".zip"のファイルを、失敗時は".error"のファイルを生成する。(".error"ファイルにはJSON形式で失敗原因を記載) Cellスナップショット領域はCellエクスポートの対象外。
本APIは非同期通信方式を採用しているため、APIを受け付けた後、即復帰する。
Cellエクスポートの状況を確認するにはCellエクスポート状態取得、Cellスナップショットファイル設定取得を使用する。
クライアントにおける受付から処理完了までの呼び出し例を以下に示す。

Cellエクスポートの呼び出し例（クライアントでのポーリングを10秒とした場合)
 1. Cellエクスポート受付
    -- POST https://cell1.unit1.example/__export
 2. Cellエクスポート状態確認
    -- GET https://cell1.unit1.example/__export -> "処理中"で返却。
    -- 10秒ポーリング
 3. Cellエクスポート完了
    -- GET https://cell1.unit1.example/__export -> "受付可能"で返却。
 4. Cellエクスポート正常終了確認
    -- PROPFIND /cell1/__snapshot -> ファイル拡張子が".zip"の場合正常終了。".error"の場合異常終了。
 ※上記 2. の処理はループして処理完了までポーリングする。
 ※異常終了時、詳細を取得したい場合は".error"ファイルの内容を参照する。

必要な権限

root

制限事項

  • リクエストヘッダのContent-Typeは全てapplication/jsonとして扱う
  • リクエストボディはJSON形式のみ受け付ける

エラーファイル

概要

Cellエクスポートに失敗した場合、Cellスナップショット領域に拡張子".error"のファイルが生成される。(ファイル名はボディで指定した名前)
".error"ファイルにはエラーの内容がJSON形式で記載される。
".error"ファイルのフォーマットを以下に示す。

オブジェクトキー型値備考
ルートcodestring
ルートmessageobject
messagelangstring
messagevaluestring

サンプル

{
  "code":"PR503-SV-0001",
  "message":
  {
    "lang":"en",
    "value":"Too many concurrent requests."
  }
}

リクエスト

リクエストURL

{CellURL}__export

メソッド

POST

リクエストクエリ

クエリ名概要有効値必須備考
p_cookie_peerクッキー認証値認証時にサーバから返却されたクッキー認証値×Authorizationヘッダの指定が無い場合のみ有効
クッキーの認証情報を利用する場合に指定する

リクエストヘッダ

ヘッダ名概要有効値必須備考
X-HTTP-Method-Overrideメソッドオーバーライド機能任意×POSTメソッドでリクエスト時にこの値を指定すると、指定した値がメソッドとして使用される。
X-Overrideヘッダオーバライド機能${上書きするヘッダ名}:${値}×通常のHTTPヘッダの値を上書きする。複数のヘッダを上書きする場合はX-Overrideヘッダを複数指定する。
X-Personium-RequestKeyイベントログに出力するRequestKeyフィールドの値半角英数、-(半角ハイフン)と_(半角アンダーバー)
最大128文字		×指定がない場合は、UUIDの独自短縮表現として${4桁}_${18桁}の形式のBase64url文字列を自動採番
AuthorizationOAuth2.0形式で、認証情報を指定するBearer {AccessToken}×※認証トークンは認証トークン取得APIで取得したトークン
Content-Typeリクエストボディの形式を指定するapplication / json×省略時は[application/json]として扱う

リクエストボディ

Format

JSON

項目名概要有効値必須備考
Nameスナップショットファイル名(拡張子は除く)桁数：1～192
文字種:半角英数字と-(半角ハイフン)と_(半角アンダーバー)		×省略時は[{CellName}_yyyyMMdd_HHmmss]

リクエストサンプル

{"Name":"CellExport_2017_01"}

レスポンス

ステータスコード

コードメッセージ概要
202Accepted処理受付

レスポンスヘッダ

ヘッダ名概要備考
Content-Type返却されるデータの形式作成に失敗した場合のみ返却する
LocationCellエクスポート状態取得用のURL
Access-Control-Allow-Originクロスドメイン通信許可ヘッダ返却値は"*"固定
X-Personium-VersionAPIの実行バージョンリクエストが処理されたAPIバージョン

レスポンスボディ

作成に失敗した場合のみエラーメッセージを返却する

エラーメッセージ一覧

エラーメッセージ一覧を参照

cURLサンプル

curl "https://cell1.unit1.example/__export" -X POST -i -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' \
-H 'Accept: application/json' -d '{"Name":"CellExport_2017_01"}'
← Cellメタデータ取得Cellエクスポート状態取得 →