1.7.21

Cellエクスポート状態取得

概要

Cellエクスポートの状態を取得する。Cellエクスポート状態には、以下の情報が含まれる。

  • Cellエクスポートの状態
    • Cellエクスポート受付可能
    • Cellエクスポート処理中
  • エクスポート開始日時
  • 進捗率
  • エクスポートファイル名

必要な権限

root

リクエスト

リクエストURL

{CellURL}__export

メソッド

GET

リクエストクエリ

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

リクエストヘッダ

ヘッダ名概要有効値必須備考
X-Overrideヘッダオーバライド機能${上書きするヘッダ名}:${値} override} $: $ {value}×通常のHTTPヘッダの値を上書きします。複数のヘッダを上書きする場合はX-Overrideヘッダを複数指定します。
X-Personium-RequestKeyイベントログに出力するRequestKeyフィールドの値半角英数、-(半角ハイフン)と_(半角アンダーバー)
最大128文字		×指定がない場合は、UUIDの独自短縮表現として${4桁}_${18桁}の形式のBase64url文字列を自動採番
AuthorizationOAuth2.0形式で、認証情報を指定するBearer {AccessToken}×※認証トークンは認証トークン取得APIで取得したトークン

リクエストボディ

なし

レスポンス

ステータスコード

コードメッセージ概要備考
200OK成功時Cellエクスポートの状態はレスポンスボディを参照

レスポンスヘッダ

ヘッダ名概要備考
Access-Control-Allow-Originクロスドメイン通信許可ヘッダ返却値は"*"固定
X-Personium-VersionAPIの実行バージョンリクエストが処理されたAPIバージョン
Content-Type返却されるデータの形式

レスポンスボディ

レスポンスはJSON形式で、オブジェクト（サブオブジェクト）に定義される。 キー(名前)と型、並びに値の対応は以下のとおり。

オブジェクトキー型値備考
ルートstatusstring以下のいずれかの文字列:
"ready"
"exportation in progress"		"ready":Cellエクスポート受付可能
"exportation in progress":Cellエクスポート処理中
ルートstarted_atstringStart time (ISO 8610 UTC format)statusが以下の場合は出力しない。
"ready"
ルートprogressstringProgress rate (for example, "30%")statusが以下の場合は出力しない。
"ready"
ルートexportation_namestringエクスポートファイル名(拡張子は除く)statusが以下の場合は出力しない。
"ready"

エラーメッセージ一覧

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

レスポンスサンプル

Cellエクスポート受付可能（Cellエクスポート完了時を含む）

{
  "status": "ready"
}

Cellエクスポート処理中の場合

{
  "status": "exportation in progress",
  "started_at": "2017-02-13T09:00:00.000Z",
  "progress": "81%",
  "exportation_name": "CellExport_2017_01"
}

cURLサンプル

curl "https://cell1.unit1.example/__export" -X GET -i -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA'
← CellエクスポートCellインポート →