next

コレクション作成

概要

コレクションを作成する

必要な権限

write

リクエスト

リクエストURL

{CellURL}{BoxName}/{CollectionName}
パス概要備考
{CollectionName}コレクション名有効値 桁数:1～256
パーセントエンコードした文字列を指定する(文字コード:UTF-8)

メソッド

MKCOL

リクエストクエリ

クエリ名概要有効値必須備考
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で取得したトークン

リクエストボディ

名前空間

URI概要参考prefix
DAV:WebDAVの名前空間D:
urn:x-personium:xmlnsPersoniumの名前空間p:

※ 参考prefixは以下表の可読性を高めるためのもので、このprefix文字列の使用を保証するものでも要求するものでもありません。

XMLの構造

ボディはXMLで、以下のスキーマに従っています。

ノード名名前空間ノードタイプ概要備考
mkcolD:要素mkcolのルート要素を表し、setが子となる
setD:要素プロパティ設定を表し、propが子となる
propD:要素プロパティ設定値を表し、resourcetypeが子となる
resourcetypeD:要素リソースタイプ設定を表し、collection・odata・service・streamのいずれかが子となる
collectionD:要素コレクションを表すcollectionノードのみ指定されている場合WebDAVコレクション作成となる
odatap:要素ODataコレクションを表すcollectionノードとodataノードが指定されている場合ODataコレクション作成となる
servicep:要素Serviceコレクションを表すcollectionノードとserviceノードが指定されている場合Serviceコレクション作成となる
streamp:要素Streamコレクションを表すcollectionノードとstreamノードが指定されている場合Streamコレクション作成となる

DTD表記

名前空間D:

<!ELEMENT mkcol (set) >
<!ELEMENT set (prop) >
<!ELEMENT prop (resourcetype) >
<!ELEMENT resourcetype (collection or odata or service or stream) >
<!ELEMENT collection EMPTY>

名前空間 p:

<!ELEMENT odata EMPTY>
<!ELEMENT service EMPTY>
<!ELEMENT stream EMPTY>

リクエストサンプル

WebDAVコレクション作成

<?xml version="1.0" encoding="utf-8"?>
<D:mkcol xmlns:D="DAV:" xmlns:p="urn:x-personium:xmlns">
  <D:set>
    <D:prop>
      <D:resourcetype>
        <D:collection/>
      </D:resourcetype>
    </D:prop>
  </D:set>
</D:mkcol>

ODataコレクション作成

<?xml version="1.0" encoding="utf-8"?>
<D:mkcol xmlns:D="DAV:" xmlns:p="urn:x-personium:xmlns">
  <D:set>
    <D:prop>
      <D:resourcetype>
        <D:collection/>
        <p:odata/>
      </D:resourcetype>
    </D:prop>
  </D:set>
</D:mkcol>

Serviceコレクション作成

<?xml version="1.0" encoding="utf-8"?>
<D:mkcol xmlns:D="DAV:" xmlns:p="urn:x-personium:xmlns">
  <D:set>
    <D:prop>
      <D:resourcetype>
        <D:collection/>
        <p:service/>
      </D:resourcetype>
    </D:prop>
  </D:set>
</D:mkcol>

Streamコレクション作成

<?xml version="1.0" encoding="utf-8"?>
<D:mkcol xmlns:D="DAV:" xmlns:p="urn:x-personium:xmlns">
  <D:set>
    <D:prop>
      <D:resourcetype>
        <D:collection/>
        <p:stream/>
      </D:resourcetype>
    </D:prop>
  </D:set>
</D:mkcol>

レスポンス

ステータスコード

201

レスポンスヘッダ

共通レスポンスヘッダ

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

WebDAV共通レスポンスヘッダ

ヘッダ名概要備考
ETagリソースのバージョン情報正常にコレクションが作成できた場合のみ返却する

レスポンスボディ

なし

エラーメッセージ一覧

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

cURLサンプル

WebDAVコレクション作成

curl "https://cell1.unit1.example/box1/collection1" -X MKCOL -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' \
-d '<?xml version="1.0" encoding="utf-8"?><D:mkcol xmlns:D="DAV:" xmlns:p="urn:x-personium:xmlns">\
<D:set><D:prop><D:resourcetype><D:collection/></D:resourcetype></D:prop></D:set></D:mkcol>'

ODataコレクション作成

curl "https://cell1.unit1.example/box1/collection1" -X MKCOL -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' \
-d '<?xml version="1.0" encoding="utf-8"?><D:mkcol xmlns:D="DAV:" xmlns:p="urn:x-personium:xmlns">\
<D:set><D:prop><D:resourcetype><D:collection/><p:odata/>\
</D:resourcetype></D:prop></D:set></D:mkcol>'

Serviceコレクション作成

curl "https://cell1.unit1.example/box1/collection1" -X MKCOL -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' \
-d '<?xml version="1.0" encoding="utf-8"?><D:mkcol xmlns:D="DAV:" xmlns:p="urn:x-personium:xmlns">\
<D:set><D:prop><D:resourcetype><D:collection/><p:service/></D:resourcetype></D:prop></D:set>\
</D:mkcol>'

Streamコレクション作成

curl "https://cell1.unit1.example/box1/collection1" -X MKCOL -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' \
-d '<?xml version="1.0" encoding="utf-8"?><D:mkcol xmlns:D="DAV:" xmlns:p="urn:x-personium:xmlns">\
<D:set><D:prop><D:resourcetype><D:collection/><p:stream/></D:resourcetype></D:prop></D:set>\
</D:mkcol>'
← Cellスナップショットファイル削除コレクション設定取得 →