next

Cellスナップショットファイル登録更新

概要

Cellスナップショットを登録・更新する。

必要な権限

root

リクエスト

リクエストURL

{CellURL}__snapshot/{FileName}

メソッド

PUT

リクエストクエリ

クエリ名概要有効値必須備考
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で取得したトークン
If-Match対象ETag値を指定するETag値×省略時は[*]として扱う
Content-Type登録・更新ファイルのコンテンツ形式を指定するString×ZIP形式で登録・更新する場合
Content-Type:application/zip

リクエストボディ

概要有効値必須備考
登録・更新するコンテキスト情報をバイナリでリクエストボディに指定するContent-Typeヘッダで指定した方式○

レスポンス

ステータスコード

コードメッセージ概要
201Created登録成功
204No Content更新成功

レスポンスヘッダ

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

レスポンスボディ

更新・作成時に失敗した場合のみ返却する

エラーメッセージ一覧

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

cURLサンプル

curl "https://cell1.unit1.example/__snapshot/CellExport_2017_01.zip" -X PUT -i -H \
'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' -d '{ファイル内容}'

curl "https://cell1.unit1.example/__snapshot/CellExport_2017_01.zip" -X PUT -i -H \
'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' -T "/home/user/CellExport.zip"
← Cellインポート状態取得Cellスナップショットファイル取得 →