Link other objects with Entity

Overview

Link OData resource specified by $links to the Entity of the user data.
It can be linked with the following OData resources.

• User data

Required Privileges

No

Restrictions

• 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
• Response body data is not ensured if atom or xml is specified in the $format query option, although it does not result in an error

User data restrictions

• Property scope of Edm.DateTime type is not properly checked
• Array of Edm.DateTime type is not supported
• If SYSUTCDATETIME () is specified as the property of Edm.DateTime type, the set system time may be different
• When setting in request body and setting with DefaultValue (__published, __ updated is the latter timing)
• For EntityType, you can create up to 400 DynamicProperty / DeclaredProperty / ComplexTypeProperty

Request

Request URL

$links with user data

{CellURL}{BoxName}/{CollectionName}/{EntityTypeName}('{EntityID}')/$links/_{EntityTypeName}

Request Method

POST

Request Query

Common 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

OData Common Request Query

None

Request Header

Common Request Header

Header Name	Overview	Effective Value	Required	Notes
X-HTTP-Method-Override	Method override function	User-defined	No	Specifying this value in a request with the POST method indicates that the specified value is used as the method
X-Override	Header override function	${OverwrittenHeaderName}:${Value}	No	The normal HTTP header value is overwritten. Specify multiple X-Override headers for the overwriting of multiple 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

OData Common Request Header

Header Name	Overview	Effective Value	Required	Notes
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

OData Create Request Header

Header Name	Overview	Effective Value	Required	Notes
Content-Type	Specifies the request body format	application/json	No	When omitted, treat it as [application/json]
Accept	Specify the format of the response body	application/json	No	When omitted, treat it as [application/json]

Request Body

Format

JSON

Item Name	Overview	Effective Value	Required	Notes
uri	URI of the OData resource to be linked	Number of digits: 1-1024 Follow URI format scheme:http / https / urn	Yes

Request Sample

{"uri":"https://cell1.unit1.example/box1/odata-collection1/entity-type1('{100-1_20101108-111352093}')"}

Response

Response Code

204

Response Header

Common Response Header

Header Name	Overview	Notes
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

OData $links Response Header

Header Name	Overview	Notes
DataServiceVersion	OData version

Response Body

None

Error Messages

Refer to Error Message List

cURL Command

curl "https://cell1.unit1.example/box1/odata-collection1/entity-type1('{100-1_20101108-111352093}')\
/\$links/_entity-type1" -X POST -i -H 'Authorization: Bearer {AA~PBDc...(snip)...FrTjA}' -H \
'Accept: application/json' -d "{\"uri\":\"https://cell1.unit1.example/box1/odata-collection1\
/entity-type1('{100-1_20101108-111352093}')\"}"