1.7.21

プロパティ取得

概要

Cellのプロパティを取得する

必要な権限

propfind

  • ACLの設定状況を取得する場合は、合わせてacl-readが必要

制限事項

V1.0版での制限

  • 対象リソースが返却出来るプロパティの一覧を返却する機能
  • レスポンスボディで返却するプロパティを指定する機能
    • 現状allpropとなる

リクエスト

リクエストURL

{CellURL}

メソッド

PROPFIND

リクエストクエリ

クエリ名概要有効値必須備考
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:

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

XMLの構造

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

ノード名Namespaceノードタイプ概要備考
propfindD:要素propfindのルート要素を表し、allpropが子となる。
allprop要素全プロパティを取得設定を表すallprop・・・すべてのプロパティを取得する
リクエストボディが空の場合も、allpropとして扱う
allprop以外の要素はv1.2系、v1.1系未対応

DTD表記

<!ELEMENT propfind (allprop) >
<!ELEMENT allprop ENPTY >

リクエストサンプル

<?xml version="1.0" encoding="utf-8"?>
<D:propfind xmlns:D="DAV:">
  <D:allprop/>
</D:propfind>

レスポンス

ステータスコード

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

レスポンスヘッダ

項目名概要備考
Content-Type返却されるデータの形式
DataServiceVersionODataのバージョン情報正常にEntityが取得できた場合のみ返却する

レスポンスボディ

名前空間

項目名概要備考
Content-Type返却されるデータの形式D:
urn:x-personium:xmlnsPersoniumの名前空間p:

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

XMLの構造

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

ノード名Namespaceノードタイプ概要備考
multistatusD:要素multistatusのルートを表し、1つ以上複数のresponseが子となる
responseD:要素リソース取得のレスポンスを表し、hrefとpropstatが子となる
hrefD:要素リソースのurl
propstatD:要素リソースのプロパティ情報を表し、statusとpropが子となる
propD:要素プロパティ詳細情報を表し、creationdateとresourcetypeとaclとproppatch設定値が子となる
creationdateD:要素リソース作成時刻
getcontentlengthD:要素リソースのサイズリソースがファイルの場合のみ
getcontenttypep:要素リソースのcontenttypeリソースがファイルの場合のみ
getlastmodifiedp:要素リソース更新時刻
resourcetypep:要素リソースのタイプを表す。 collection、odata、serviceのいずれかが子となるか、子は空となる
collectionp:要素リソースのタイプがコレクションであることを表す
リソースがWebDAVの場合、この要素のみが表示される
odatap:要素リソースのタイプがODataコレクションであることを表すODataコレクションの場合表示
servicep:要素リソースのタイプがサービスコレクションであることを表すServiceコレクションの場合表示
cellstatusp:要素Cellのステータスを表す
normal:正常
import failed:Cell Import失敗		Cellのステータスがimport failedの場合は以下のAPI以外は実行不可
- Unit Level API
- OAuth2.0 トークンエンドポイント
- Cellインポート
aclp:要素リソースに設定されているACL設定ACL設定を取得するためには、対象リソースに対するacl-read権限が必要
ACL要素以下の内容については、Cell Level アクセス制御設定APIを参照
basep:要素ACLのPrivilegeのBaseURLCellへのPROPFINDの場合、デフォルトBox（"__"）のリソースURL
statusD:要素リソース取得のレスポンスコードを表す

DTD表記

名前空間：D:

<!ELEMENT multistatus (response*)>
<!ELEMENT response (href, propstat)>
<!ELEMENT href (#PCDATA)>
<!ELEMENT propstat (status, prop)>
<!ELEMENT status (#PCDATA)>
<!ELEMENT prop (creationdate, resourcetype, acl, ANY)>
<!ELEMENT creationdate (#PCDATA)>
<!ELEMENT getcontentlength (#PCDATA)>
<!ELEMENT getcontenttype (#PCDATA)>
<!ELEMENT getlastmodified (#PCDATA)>
<!ELEMENT resourcetype ((collection, (odata or service) or EMPTY))>
<!ELEMENT collection EMPTY>
<!ELEMENT acl (ace*)>

名前空間:p:

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

名前空間：xml:

<!ATTLIST acl base CDATA #IMPLIED>

エラーメッセージ一覧

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

レスポンスサンプル

<multistatus xmlns="DAV:">
  <response>
    <href>https://cell1.unit1.example/</href>
    <propstat>
      <prop>
        <creationdate>2017-02-03T01:27:31.130+0000</creationdate>
        <getlastmodified>Fri, 03 Feb 2017 01:27:31 GMT</getlastmodified>
        <resourcetype>
          <collection/>
        </resourcetype>
        <p:cellstatus xmlns:p="urn:x-personium:xmlns">normal</p:cellstatus>
        <acl xmlns:p="urn:x-personium:xmlns"/>
      </prop>
      <status>HTTP/1.1 200 OK</status>
    </propstat>
  </response>
</multistatus>

cURLサンプル

curl "https://cell1.unit1.example/" -X PROPFIND -i -H 'Depth:1' \
-H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' \
-d '<?xml version="1.0" encoding="utf-8"?><D:propfind xmlns:D="DAV:"><D:allpop/></D:propfind>'
← Cell Level アクセス制御設定プロパティ変更 →