1.7.21

プロパティ変更

概要

プロパティを変更する

必要な権限

Unitユーザのみ可能

リクエスト

リクエストURL

{CellURL}

メソッド

PROPPATCH

リクエストクエリ

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

リクエストヘッダ

ヘッダ名概要有効値必須備考
X-HTTP-Method-Overrideメソッドオーバーライド機能任意×POSTメソッドでリクエスト時にこの値を指定すると、指定した値がメソッドとして使用されます。
X-Overrideヘッダオーバライド機能${上書きするヘッダ名}:${値}×通常のHTTPヘッダの値を上書きします。複数のヘッダを上書きする場合はX-Overrideヘッダを複数指定します。
AuthorizationOAuth2.0形式で、認証情報を指定するBearer {AccessToken}×※認証トークンは認証トークン取得APIで取得したトークン
Content-Typeコンテンツ形式を指定するapplication / xml×
Acceptレスポンスで受け入れ可能なメディアタイプを指定するapplication / xml×

リクエストボディ

項目名Namespace概要必須有効値備考
DAV:XML名前空間設定○"DAV:"
urn: x-personium: xmlnsXML名前空間設定○"Urn: x-personium: xmlns"
propertyupdateDAV:propertyupdate（アクセス制御リスト）のルート○<ELEMENT propertyupdate! (Set | remove)>
setDAV:プロパティ設定×<! ELEMENT set (prop *)>
removeDAV:プロパティ削除×<! ELEMENT set (prop *)>
propDAV:プロパティ×<! ELEMENT prop ANY>ANYに指定したXMLタグをキーとして設定または削除を行う

※ 下記はシステムで予約されています。

リクエストサンプル

<D:propertyupdate xmlns:D="DAV:"  
    xmlns:p="urn:x-personium:xmlns">
  <D:set>
    <D:prop>
      <p:foo>bar</p:foo>
    </D:prop>
  </D:set>
  <D:remove>
    <D:prop>
      <p:foo/>
    </D:prop>
  </D:remove>
</D:propertyupdate>

レスポンス

ステータスコード

コードメッセージ概要
207MULTI_STATUS成功

レスポンスヘッダ

なし

レスポンスボディ

項目名Namespace概要備考
multistatusDAV:レスポンスボディのルート<! ELEMENT multistatus (response *)>
responseDAV:responseのルート<! ELEMENT response (href, propstat)>
hrefDAV:PROPPATCHを実行したリソースのURLPROPPATCHを実行したリソースのURL
propstatDAV:プロパティ設定結果<! ELEMENT propstat (prop, status)>
propDAV:プロパティ設定内容リソース設定の結果を以下のように表示する
設定成功：設定したキーと値
削除成功：削除したキー
statusDAV:プロパティ設定ステータスコード設定成功の場合200(OK)が返る

エラーメッセージ一覧

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

レスポンスサンプル

<multistatus xmlns="DAV:">
  <response>
    <href>https://cell1.unit1.example/</href>
    <propstat>
      <prop>
        <p:foo xmlns:p="urn:x-personium:xmlns" xmlns:D="DAV:">bar</p:foo>
        <p:foo 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/" -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:foo>bar</p:foo></D:prop></D:set><D:remove><D:prop><p:foo/></D:prop>\
</D:remove></D:propertyupdate>'
← プロパティ取得Role登録 →