next

コレクション設定変更

概要

コレクションの設定を変更する

必要な権限

write-properties

リクエスト

リクエストURL

{CellURL}{BoxName}/{CollectionName}
パス概要備考
{CellName}Cell名
{BoxName}Box名
{CollectionName}コレクション名有効値 桁数:1～256

メソッド

PROPPATCH

リクエストクエリ

共通リクエストクエリ

クエリ名概要有効値必須備考
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/xml×
Acceptレスポンスで受け入れ可能なメディアタイプを指定するapplication/xml×

リクエストボディ

名前空間

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

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

XMLの構造

ノード名名前空間ノードタイプ概要備考
propertyupdateD:要素propertyupdateのルートを表し、setとremoveが子となる
setD:要素プロパティ設定を表し、1つ以上複数のpropが子となる
removeD:要素プロパティ削除設定を表し、1つ以上複数のpropが子となる
propD:要素プロパティ値を表し、1つ以上複数の任意の要素が子となるset時：子のノード名がキーとなる
remove時：子のノードを名キーとして削除を行う

DTD表記

<!ELEMENT propertyupdate (set, remove) >
<!ELEMENT set (prop*) >
<!ELEMENT remove (prop*) >
<!ELEMENT prop ANY>

リクエストサンプル

<D:propertyupdate xmlns:D="DAV:"
    xmlns:p="urn:x-personium:xmlns">
  <D:set>
    <D:prop>
      <p:property-key1>property-value1</p:property-key1>
    </D:prop>
  </D:set>
  <D:remove>
    <D:prop>
      <p:property-key2/>
    </D:prop>
  </D:remove>
</D:propertyupdate>

レスポンス

ステータスコード

コードメッセージ概要
207Multi-Status成功

レスポンスボディ

名前空間

URI概要参考prefix
DAV:WebDAVの名前空間D:

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

XMLの構造

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

ノード名名前空間ノードタイプ概要備考
multistatusD:要素multistatusのルートを表し、1つ以上複数のresponseが子となる
responseD:要素multistatusの内容を表し、hrefとpropstatが子となる
hrefD:要素PROPPATCHを実行したリソースのURL
propstatD:要素プロパティ設定結果を表し、propとstatusが子となる
propD:要素プロパティ設定内容を表すリソース設定の結果を以下のように表示する
設定成功：設定したキーと値
削除成功：削除したキー
statusD:要素プロパティ設定ステータスコード設定成功の場合200(OK)が返る

DTD表記

名前空間 D:

<!ELEMENT multistatus (response*)>
<!ELEMENT response (href, propstat)>
<!ELEMENT href (#PCDATA)>
<!ELEMENT propstat (prop, status)>
<!ELEMENT prop ANY>
<!ELEMENT status (#PCDATA)

エラーメッセージ一覧

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

レスポンスサンプル

<multistatus xmlns="DAV:">
  <response>
    <href>https://cell1.unit1.example/box1/collection1</href>
    <propstat>
      <prop>
        <p:property-key1 xmlns:p="urn:x-personium:xmlns" xmlns:D="DAV:">\
          property-value1
        </p:property-key1>
        <p:property-key2 xmlns:p="urn:x-personium:xmlns" xmlns:D="DAV:"/>
      </prop>
      <status>HTTP/1.1 200 OK</status>
    </propstat>
  </response>
</multistatus>

cURLサンプル

curl "https://cell1.unit1.example/box1/collection1" -X PROPPATCH -i \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' \
-d '<?xml version="1.0" encoding="utf-8" ?><D:propertyupdate xmlns:D="DAV:" xmlns:p=\
"urn:x-personium:xmlns"><D:set><D:prop><p:property-key1>property-value1</p:property-key1>\
</D:prop></D:set><D:remove><D:prop><p:property-key2/></D:prop></D:remove></D:propertyupdate>'
← コレクション設定取得コレクション移動名称変更 →