next

サービスコレクションソース設定適用

概要

サービスコレクションソースの設定を適用する

必要な権限

write-properties

リクエスト

リクエストURL

{CellURL}{BoxName}/{CollectionName}

メソッド

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

サービスコレクション設定固有定義

ノード名名前空間ノードタイプ概要備考
servicep:要素サービス設定を表し、1つ以上複数のpath要素を子とする
languagep:属性サービスソース言語設定を表し、"JavaScript"を固定で属性値とする
subjectp:属性サービスサブジェクト設定を表し、属するCellに登録済みのAccount名を属性値とするロジック内のPersonium APIを設定したAccountに紐付くRole権限で実行する
pathp:要素サービスコレクション設定を表す。
namep:属性サービス呼び出し名を表し、任意の文字を属性値とするこの設定値がサービス実行時のリクエストURLの"__src/"直下パス名になります。
srcp:属性サービスソースファイル名を表し、__src配下に配備されているファイル名を属性値とする

DTD表記

<!ELEMENT service (path*)>
<!ATTLIST service language CDATA "JavaScript">
<!ATTLIST service subject CDATA #IMPLIED>
<!ELEMENT path EMPTY>
<!ATTLIST path name CDATA #REQUIRED>
<!ATTLIST path src CDATA #REQUIRED>

リクエストサンプル

<D:propertyupdate xmlns:D="DAV:"
    xmlns:p="urn:x-personium:xmlns">
  <D:set>
    <D:prop>
      <p:service language="JavaScript">
        <p:path name="${name}" src="${src}"/>
      </p:service>
    </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/odata-collection1</href>
    <propstat>
      <prop>
        <p:service language="JavaScript" xmlns:p="urn:x-personium:xmlns" xmlns:D="DAV:">
          <p:path name="sample" src="sample.js"/>
        </p:service>
      </prop>
      <status>HTTP/1.1 200 OK</status>
    </propstat>
  </response>
</multistatus>

エラーメッセージ一覧

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

cURLサンプル

curl "https://cell1.unit1.example/box1/odata-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:service language=\"JavaScript\"><p:path name=\"sample\" src=\"sample.js\"/></p:service>\
</D:prop></D:set></D:propertyupdate>"
← サービスコレクションソース取得サービスコレクションソース削除 →