Retrieve other objects list via ExtRole's Navigation Property

Overview

Retrieve cell control object via Navigation Property

Required Privileges

When acquire Role
auth-read
When acquire Relation
social-read

Restrictions

Accept in the request header is ignored
Always handles Content-Type in the request header as application/json
Only accepts the request body in the JSON format
Only application/json is supported for Content-Type in the request header and the JSON format for the response body
$formatQuery options ignored

Request

Request URL

Navigation Property to Role

{CellURL}__ctl/ExtRole(ExtRole='https%3A%2F%2F{CellName}.{UnitFQDN}%2F__role%2F__%2F{RoleName}',
_Relation.Name='{RelationName},_Relation._Box.Name='{BoxName}')/_Role

NavigationProperty to Relation

{CellURL}__ctl/ExtRole(ExtRole='https%3A%2F%2F{CellName}.{UnitFQDN}%2F__role%2F__%2F{RoleName}',
_Relation.Name='{RelationName},_Relation._Box.Name='{BoxName}')/_Relation

If the _Relation._Box.Name parameter is omitted, it is assumed that null is specified
* Registration via NavProp of ExtRole only enables registration of Role

Request Method

GET

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

Full-text Search (q) Query

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}override} $: $ {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
Accept	Specifies the response body format	application/json	No	[application/json] by default

Request Body

None

Response

Response Code

200

Response Header

Header Name	Overview	Notes
Content-Type	Format of data to be returned
DataServiceVersion	OData version
Access-Control-Allow-Origin	Cross domain communication permission header	Return value fixed to "*"
X-Personium-Version	API version that the request is processed	Version of the API used to process the request

Response Body

Object	Item Name	Data Type	Notes
Root	d	object	Object{1}
{1}	results	array	Array object {2}
{2}	__metadata	object	Object{3}
{3}	uri	string	URL to the resource that was created
{3}	etag	string	Etag value
{2}	__published	string	Creation date (UNIX time)
{2}	__updated	string	Update date (UNIX time)
{1}	__count	string	Get number of results in $inlinecount query

When acquired Role

Object	Item Name	Data Type	Notes
{3}	type	string	CellCtl. Role
{2}	Name	string	Role Name
{2}	_Box.Name	string	Box name to be related

Error Messages

Refer to Error Message List

Response Sample

{
  "d": {
    "results": [
      {
        "__metadata": {
          "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')",
          "etag": "W/\"1-1486950269621\"",
          "type": "CellCtl.Role"
        },
        "Name": "role1",
        "_Box.Name": "box1",
        "__published": "/Date(1486950269621)/",
        "__updated": "/Date(1486950269621)/",
        "_Box": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')/_Box"
          }
        },
        "_Account": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')/_Account"
          }
        },
        "_ExtCell": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')/_ExtCell"
          }
        },
        "_ExtRole": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')/_ExtRole"
          }
        },
        "_Relation": {
          "__deferred": {
            "uri": "https://cell1.unit1.example/__ctl/Role(Name='role1',_Box.Name='box1')/_Relation"
          }
        }
      }
    ]
  }
}

cURL Command

Through Role's Navigation Property list

curl "https://cell1.unit1.example/__ctl/ExtRole(ExtRole='https%3A%2F%2Fcell2.unit1.example%2F\
__role%2F__%2Frole1',_Relation.Name='relation1',_Relation._Box.Name='box1')/_Role" -X GET -i \
-H 'Authorization: Bearer AA~PBDc...(snip)...FrTjA' -H 'Accept: application/json'