1.7.21

Streamコレクションソース設定変更

概要

Streamコレクションソースの設定を変更する

必要な権限

write-properties

リクエスト

リクエストURL

{CellURL}{BoxName}/{CollectionName}

メソッド

PROPPATCH

リクエストクエリ

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

リクエストヘッダ

ヘッダ名概要有効値必須備考
AuthorizationOAuth2.0形式で、認証情報を指定するBearer {AccessToken}×※認証トークンは認証トークン取得APIで取得したトークン
Content-Typeコンテンツ形式を指定するapplication/xml×
Acceptレスポンスで受け入れ可能なメディアタイプを指定するapplication/xml×

リクエストボディ

名前空間

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

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

XMLの構造
ボディは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>

Streamコレクション設定固有定義

ノード名名前空間ノードタイプ概要備考
queuesp:要素queue設定を表し、1つ以上複数のqueue要素を子とする
queuep:要素queue名の設定を表す。
topicsp:要素topic設定を表し、1つ以上複数のtopic要素を子とする
topicp:要素topic名の設定を表す。

DTD表記

<!ELEMENT queues (queue*)>
<!ELEMENT queue (#PCDATA)>
<!ELEMENT topics (topic*)>
<!ELEMENT topic (#PCDATA)>

リクエストサンプル

<D:propertyupdate xmlns:D="DAV:"
    xmlns:p="urn:x-personium:xmlns">
  <D:set>
    <D:prop>
      <p:queues>
        <p:queue>queueName</p:queue>
      </p:queues>
      <p:topics>
        <p:topic>topicName</p:topic>
      </p:topics>
    </D:prop>
  </D:set>
</D:propertyupdate>

レスポンス

ステータスコード

207

レスポンスヘッダ

なし

レスポンスボディ

名前空間

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表記

<!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/stream-collection1</href>
    <propstat>
      <prop>
        <p:queues xmlns:p="urn:x-personium:xmlns" xmlns:D="DAV:">
          <p:queue>queueName</p:queue>
        </p:queues>
        <p:topics xmlns:p="urn:x-personium:xmlns" xmlns:D="DAV:">
          <p:topic>topicName</p:topic>
        </p:topics>
      </prop>
      <status>HTTP/1.1 200 OK</status>
    </propstat>
  </response>
</multistatus>

エラーメッセージ一覧

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

cURLサンプル

curl "https://cell1.unit1.example/box1/stream-collection1" -X PROPPATCH -i -H \
"Authorization:Bearer AA~PBDc...(省略)...FrTjA" -H "Accept:application/xml" -d "<?xml version=\"1.0\" \
encoding=\"utf-8\" ?><D:propertyupdate xmlns:D=\"DAV:\" xmlns:p=\"urn:x-personium:xmlns\"><D:set>\
<D:prop><p:queues><p:queue>queueName</p:queue></p:queues><p:topics><p:topic>topicName</p:topic></p:topics>\
</D:prop></D:set></D:propertyupdate>"
← サービス実行Streamコレクションの操作可能メソッド取得 →