Create other objects via Box's Navigation Property
Overview
Register the following Cell control object via Navigation Property of Box.
- Role
- Relation
- Rule
Required Privileges
| NavigationProperty Object | Required Privileges |
|---|---|
| Role | box auth |
| Relation | box social |
| Rule | box rule |
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
- If _Box.Name in the request URL is different from _Box.Name in the request body, _Box.Name of the request body is ignored
Request
Request URL
Navigation Property to Role
{CellURL}__ctl/Box(Name='{BoxName}',Schema='SchemaURL')/_Role
or
{CellURL}__ctl/Box(Name='{BoxName}')/_Role
or
{CellURL}__ctl/Box('{BoxName}')/_Role
NavigationProperty to Relation
{CellURL}__ctl/Box(Name='{BoxName}',Schema='SchemaURL')/_Relation
or
{CellURL}__ctl/Box(Name='{BoxName}')/_Relation
or
{CellURL}__ctl/Box('{BoxName}')/_Relation
NavigationProperty to Rule
{CellURL}__ctl/Box(Name='{BoxName}',Schema='SchemaURL')/_Rule
or
{CellURL}__ctl/Box(Name='{BoxName}')/_Rule
or
{CellURL}__ctl/Box('{BoxName}')/_Rule
If the Schema is omitted, it is assumed that null is specified
Request Method
POST
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}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 |
| Content-Type | Specifies the request body format | application/json | No | [application/json] by default |
| Accept | Specifies the response body format | application/json | No | [application/json] by default |
Request Body
When registering Relation
JSON
| Item Name | Overview | Effective Value | Required | Notes |
|---|---|---|---|---|
| Name | Relation Name | Number of digits: 1 - 128 Character type: Single-byte alphanumeric characters, hyphens ("-"), and underscores ("_"), plus, : However, the string cannot start with a underscore ("_") or colon (:) | Yes | |
| _Box.Name | Box name to be related | Number of digits: 1 - 128 Character type: Single-byte alphanumeric characters, hyphens ("-"), and underscores ("_") However, the string cannot start with a single-byte hyphen ("-") or underscore ("_") Description: Specify Name of Box registered with Box registration API Specify null if not associated with specific Box | No |
Request Sample
{
"Name":"relation1",
"_Box.Name":"box1"
}
Response
Response Code
201
Response Header
| Header Name | Overview | Notes |
|---|---|---|
| Content-Type | Format of data to be returned | |
| Location | URL to the resource that was created | |
| DataServiceVersion | OData version | |
| ETag | Resource version information | |
| 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 registered Relation
| Object | Item Name | Data Type | Notes |
|---|---|---|---|
| {3} | type | string | CellCtl. Relation |
| {2} | Name | string | Relation 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/Relation(Name='relation1',_Box.Name='box1')",
"etag": "W/\"2-1486953408036\"",
"type": "CellCtl.Relation"
},
"Name": "relation1",
"__published": "/Date(1486953408036)/",
"__updated": "/Date(1486953408036)/",
"_Box.Name": "box1"
}
}
}
cURL Command
When registering Role
curl
"https://cell1.unit1.example/__ctl/Box('box1')/_Role" -X POST -i \
-H 'Authorization: Bearer AA~PBDc...(snip)...FrTjA' -H 'Accept: application/json' \
-d '{"Name":"role1"}'
When registering Relation
curl "https://cell1.unit1.example/__ctl/Box('box1')/_Relation" -X POST -i \
-H 'Authorization: Bearer AA~PBDc...(snip)...FrTjA' -H 'Accept: application/json' \
-d '{"Name":"relation1"}'
When registering Rule
curl
"https://cell1.unit1.example/__ctl/Box('box1')/_Rule" -X POST -i \
-H 'Authorization: Bearer AA~PBDc...(snip)...FrTjA' -H 'Accept: application/json' \
-d '{"Name":"rule1","Action":"log"}'