List objects

1 min

GET

https://api.us1.odp.optimizely.com/v3/schema/objects

List the details of all objects within an Optimizely Data Platform (ODP) account.

Responses

200OK

Object[]

Example

[
  {
    "name": "tickets",
    "display_name": "Tickets",
    "alias": "ticket",
    "fields": [
      {
        "name": "field_name",
        "type": "number",
        "display_name": "Display Name",
        "primary": true
      }
    ],
    "relations": [
      {
        "name": "my_relation",
        "display_name": "My Relationship",
        "child_object": "target_object_name",
        "join_fields": [
          {
            "parent": "child_id",
            "child": "child_id"
          }
        ]
      }
    ]
  },
  {
    "name": "concerts",
    "display_name": "Concerts",
    "alias": "concert",
    "fields": [
      {
        "name": "field_name",
        "type": "number",
        "display_name": "Display Name",
        "primary": true
      }
    ],
    "relations": [
      {
        "name": "my_relation",
        "display_name": "My Relationship",
        "child_object": "target_object_name",
        "join_fields": [
          {
            "parent": "child_id",
            "child": "child_id"
          }
        ]
      }
    ]
  }
]

namestringrequired
Description
the plural name of the object (for example, tickets)
display_namestringrequired
Description
the human-readable name of the object (for example, Tickets)
public_readbooleanrequired
Description
enable access with the API public key
Default
false
aliasstringrequired
Description
the singular name of the object (for example, ticket)
fieldsobject[]required
Description
an array of fields objects
- namestring
  Example
  object_id
- display_namestring
  Example
  New Object Identifier
- typestring
  Example
  string
- primaryboolean
  Example
  true
  Default
  true
relationsobject[]
Description
an array of relations objects
- namestring
  Example
  my_relation
- display_namestring
  Example
  My Relationship
- child_objectstring
  Example
  child
- join_fieldsobject[]
  - parentstring
    Example
    child_id
  - childstring
    Example
    child_id

400Bad Request

object

403Forbidden

curl

curl --request GET \
     --url https://api.us1.odp.optimizely.com/v3/schema/objects \
     --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", 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")

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"

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

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

print(response.text)

200

// OK
[
  {
    "name": "",
    "display_name": "",
    "public_read": false,
    "alias": "",
    "fields": [
      {
        "name": "object_id",
        "display_name": "New Object Identifier",
        "type": "string",
        "primary": true
      }
    ],
    "relations": [
      {
        "name": "my_relation",
        "display_name": "My Relationship",
        "child_object": "child",
        "join_fields": [
          {
            "parent": "child_id",
            "child": "child_id"
          }
        ]
      }
    ]
  }
]

400

// Bad Request
{}

403

// Forbidden