Link other objects with ExtRole
Overview
Link ExtRole with OData resource of Role specified by $ links
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
{CellURL}__ctl/ExtRole(ExtRole='https%3A%2F%2F{CellName}.{UnitFQDN}%2F__role%2F__%2F{RoleName}',
_Relation.Name='{RelationName}',_Relation._Box.Name='{BoxName}')/$links/_Role
or
{CellURL}__ctl/ExtRole(ExtRole='https%3A%2F%2F{CellName}.{UnitFQDN}%2F__role%2F__%2F{RoleName}',
_Relation.Name='{RelationName}')/$links/_Role
* If the _Box.Name 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} | 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
Format
JSON
| Item Name | Overview | Effective Value | Required | Notes |
|---|---|---|---|---|
| Url | URL to Cell | Number of digits: 1-1024 Follow URI format scheme:http, https | Yes |
Request Sample
{"uri":"https://cell2.unit1.example/__ctl/Role(Name='role2',_Box.Name='box2')"}
Response
Response Code
204
Response Header
| Header Name | Overview | Notes |
|---|---|---|
| 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
None
Error Messages
Refer to Error Message List
cURL Command
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')/\$links/_Role" \
-X POST -i -H 'Authorization: Bearer AA~PBDc...(snip)...FrTjA' \
-H 'Accept: application/json' \
-d "{\"uri\":\"https://cell2.unit1.example/__ctl/Role(Name='role2')\"}"