next

コレクション移動名称変更

概要

WebDAVコレクションの名前の変更及びWebDAVファイルの移動/名前の変更。
※ プロパティの変更は出来ない

必要な権限

write

リクエスト

リクエストURL

{CellURL}{BoxName}/{ResourcePath}/

メソッド

MOVE

リクエストクエリ

共通リクエストクエリ

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

WebDav 共通リクエストクエリ

なし

リクエストヘッダ

共通リクエストヘッダ

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

個別リクエストヘッダ

ヘッダ名概要有効値必須備考
Destination変更先Absolute URI○移動/名前を変更するファイル名を指定する。
Overwrite上書き"T" or "F"×上書き可("T")、上書き不可("F")を指定する。(初期値は"F")
Depth移動階層"infinity"×移動するコレクション階層の深さを指定する。(初期値は無限)
AuthorizationOAuth2.0形式で、認証情報を指定するBearer {AccessToken}×※認証トークンは認証トークン取得APIで取得したトークン

リクエストボディ

なし

レスポンス

ステータスコード

コード概要備考
201Created移動または名称変更に成功(作成)
204No Content移動または名称変更に成功(上書き)

レスポンスヘッダ

ヘッダ名概要備考
Location作成したコレクションのリソースURL正常にコレクションが作成できた場合のみ返却する
ETagリソースのバージョン情報正常にコレクションが作成できた場合のみ返却する
Access-Control-Allow-Originクロスドメイン通信許可ヘッダ返却値は"*"固定
X-Personium-VersionAPIの実行バージョンリクエストが処理されたAPIバージョン

レスポンスボディ

なし

エラーメッセージ一覧

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

cURLサンプル

コレクション名変更(終端の"/"は必須)

curl "https://cell1.unit1.example/box1/collection1/" -X MOVE -i \
-H 'Destination:https://cell1.unit1.example/box1/collection2/' \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA'

ファイル名変更

curl "https://cell1.unit1.example/box1/collection1/file1/" -X MOVE -i \
-H 'Destination:https://cell1.unit1.example/box1/collection1/file2/' \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA'

ファイル移動

curl  "https://cell1.unit1.example/box1/collection1/file1/" -X MOVE -i \
-H 'Destination:https://cell1.unit1.example/box1/collection2/file1/' \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA'
← コレクション設定変更コレクション削除 →