Retrieve links list from AssociationEnd to other objects
Overview
Obtain a list of OData resources associated with AssociationEnd
You can specify the following OData resources
- AssociationEnd
Required Privileges
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
Request
Request URL
{CellURL}{BoxName}/{CollectionName}/AssociationEnd(Name='{AssociationEndName}',
_EntityType.Name='{EntityTypeName}')/$links/_AssociationEnd
Request Method
GET
Request Query
The following query parameters are available
| 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
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 ListRequest Header
| Header Name | Overview | Effective Value | Required | Notes |
|---|---|---|---|---|
| Accept | Specifies the response body format | application/json | No | [application/json] by default |
Request Body
None
Response
Response Code
200
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 Response Header
| Item Name | Overview | Notes |
|---|---|---|
| Content-Type | Format of data to be returned | |
| DataServiceVersion | OData version information |
Response Body
OData $links Response body
The response is a JSON object, the correspondence between the key (name) and type defined in the object (subobject) and the value are as follows
| Object | Name(Key) | Type | Value |
|---|---|---|---|
| Root | d | object | Object{1} |
| {1} | results | array | Array object {2} |
| {2} | uri | string | URI of the linked OData resource |
Error Messages
Refer to Error Message List
Response Sample
{
"d": {
"results": [
{
"uri": "https://cell1.unit1.example/box1/odata-collection2/$metadata/AssociationEnd
(Name='association-end2',_EntityType.Name='entity-type2')"
}
]
}
}
cURL Command
curl "https://cell1.unit1.example/box1/odata-collection1/\$metadata/AssociationEnd\
(Name='association-end1',_EntityType.Name='entity-type1')/\$links/_AssociationEnd" -X GET -i \
-H 'Authorization: Bearer AA~PBDc...(snip)...FrTjA' -H 'Accept: application/json'