Retrieve Properties
Overview
Get cell properties
Required Privileges
propfind
- In order to acquire ACL setting status, acl-read is required together
Restrictions
Restrictions in V 1.0
- Ability to return a list of properties for which target resources can be returned
- A function that specifies the property to be returned in the response body
- It becomes current allprop
Request
Request URL
{CellURL}
Request Method
PROPFIND
Request Query
| Query Name | Overview | Effective Value | Required | Notes |
|---|---|---|---|---|
| p_cookie_peer | Cookie Authentication Value | The cookie authentication value returned from the server during authentication | No | Valid only if no Authorization header specified Specify this when cookie authentication information is to be used |
Request Header
| Header Name | Overview | Effective Value | Required | Notes |
|---|---|---|---|---|
| X-HTTP-Method-Override | Method override function | User-defined | No | If you specify this value when requesting with the POST method, the specified value will be used as a method. |
| X-Override | Header override function | ${OverwrittenHeaderName}:${Value} | No | Overwrite normal HTTP header value. To overwrite multiple headers, specify multiple X-Override headers. |
| X-Personium-RequestKey | RequestKey field value output in the event log | Single-byte alphanumeric characters, hyphens ("-"), and underscores ("_") Maximum of 128 characters | No | When not specified, default value given with ${4 digits}_${22 digits} Base64url characters format representing an UUID for each request |
| Authorization | Specifies authentication information in the OAuth 2.0 format | Bearer {AccessToken} | No | * Authentication tokens are the tokens acquired using the Authentication Token Acquisition API |
Request Body
Namespace
| URI | Overview | Notes |
|---|---|---|
| DAV: | WebDAV Namespace | D: |
* Reference The prefixes are for making it easier to read the following table, but the use of these prefix strings is not ensured or requested.
Structure of XML
The body is XML and follows the following schema.
| Node name | Namespace | Node type | Overview | Notes |
|---|---|---|---|---|
| propfind | D: | Element | Represents the root element of propfind, and allprop is a child. | |
| allprop | Element | Represent setting to retrieve all properties | allprop : get all properties Even if the request body is empty, treat it as allprop Elements other than allprop are not supported for v1.2 , v1.1 |
DTD notation
<!ELEMENT propfind (allprop) >
<!ELEMENT allprop ENPTY >
Request Sample
<?xml version="1.0" encoding="utf-8"?>
<D:propfind xmlns:D="DAV:">
<D:allprop/>
</D:propfind>
Response
Response Code
| Code | Message | Overview |
|---|---|---|
| 207 | Multi-Status | Success |
Response Header
| Item Name | Overview | Notes |
|---|---|---|
| Content-Type | Format of data to be returned | |
| DataServiceVersion | OData Version | Return only when Entity can be successfully acquired |
Response Body
Namespace
| Item Name | Overview | Notes |
|---|---|---|
| Content-Type | Format of data to be returned | D: |
| urn:x-personium:xmlns | Personium namespace | p: |
* Reference The prefixes are for making it easier to read the following table, but the use of these prefix strings is not ensured or requested.
Structure of XML
The body is XML and follows the following schema.
| Node name | Namespace | Node type | Overview | Notes |
|---|---|---|---|---|
| multistatus | D: | Element | Represents the route of multistatus and one or more responses are children | |
| response | D: | Element | Represents a response to resource acquisition, href and propstat are children | |
| href | D: | Element | Resource url | |
| propstat | D: | Element | Represents property information of a resource, status and prop are children | |
| prop | D: | Element | Property detailed information, creationdate, resourcetype, acl, and proppatch setting values are children | |
| creationdate | D: | Element | Resource creation time | |
| getcontentlength | D: | Element | Resource size | Resource is only file |
| getcontenttype | p: | Element | Contenttype of resources | Resource is only file |
| getlastmodified | p: | Element | Resource update time | |
| resourcetype | p: | Element | Represents the type of resource. Either one of collection, odata, or service is a child, or the child is empty | |
| collection | p: | Element | Represents that the type of resource is a collection Displays, if resource is collection | |
| odata | p: | Element | Represents that the type of resource is a OData service collection | Displays, if resource is OData collection |
| service | p: | Element | Represents that the type of resource is a service collection | Displays, if resource is service collection |
| cellstatus | p: | Element | Cell status normal:Cell imported successfuly import failed:Cell import failed | When the status of Cell is import failed, execution other than the following API can not be executed - Unit Level API - OAuth2.0 token endpoint - Cell Import |
| acl | p: | Element | ACL setting set for resource | In order to acquire the ACL setting, acl-read authority for the target resource is required ACL Element Refer to the cell level access control setting API for the following contents |
| base | p: | Element | ACL Privilege BaseURL | When PROPFIND to Cell, default box ("__") resource URL |
| status | D: | Element | Represents the response code of resource acquisition |
DTD notation
Namespace: 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*)>
Namespace:p:
<!ELEMENT odata EMPTY>
<!ELEMENT service EMPTY>
Namespace: xml:
<!ATTLIST acl base CDATA #IMPLIED>
Error Messages
Refer to Error Message List
Response Sample
<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 Command
curl "https://cell1.unit1.example/" -X PROPFIND -i -H 'Depth:1' \
-H 'Authorization: Bearer AA~PBDc...(snip)...FrTjA' \
-d '<?xml version="1.0" encoding="utf-8"?><D:propfind xmlns:D="DAV:"><D:allpop/></D:propfind>'