List relations

1 min

GET

https://api.us1.odp.optimizely.com/v3/schema/objects/{object_name}/relations

List the details of all relationships of a specific object.

Path Parameters

object_namestringrequired
Description
The name of the object.

Responses

200OK

Relation[]
Example
```
[
  {
    "name": "my_relation",
    "display_name": "My Relationship",
    "child_object": "child",
    "join_fields": [
      {
        "parent": "child_id",
        "child": "child_id"
      }
    ]
  },
  {
    "name": "my_relation2",
    "display_name": "My Relationship 2",
    "child_object": "child",
    "join_fields": [
      {
        "parent": "child_id",
        "child": "child_id"
      }
    ]
  }
]
```
- child_objectstringrequired
  Example
  child
  Description
  The name of the child object.
- namestringrequired
  Example
  relation_name
  Description
  The name of the relationship (for example, ticket).
- display_namestringrequired
  Example
  Relation Display Name
  Description
  The human-readable name of the field (for example, Ticket).
- public_readstringrequired
  Description
  Enable access with the API public key.
  Default
  false
- join_fieldsobject[]
  - parentstringrequired
    Example
    id
    Description
    The name of the object that links to the child object (for example, id).
  - childstring
    Example
    child_id
    Description
    The name of the child object that links to this object (for example, ticket_id).

400Bad Request

object

403Forbidden

curl

curl --request GET \
     --url https://api.us1.odp.optimizely.com/v3/schema/objects/{object_name}/relations \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.us1.odp.optimizely.com/v3/schema/objects/{object_name}/relations", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.us1.odp.optimizely.com/v3/schema/objects/{object_name}/relations")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.us1.odp.optimizely.com/v3/schema/objects/{object_name}/relations"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// OK
[
  {
    "child_object": "child",
    "name": "relation_name",
    "display_name": "Relation Display Name",
    "public_read": "",
    "join_fields": [
      {
        "parent": "id",
        "child": "child_id"
      }
    ]
  }
]

400

// Bad Request
{}

403

// Forbidden