Create object

1 min

POST

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

Create a new Object within Optimizely Data Platform (ODP), define its fields and how it relates to other objects.

Body Parameters

bodyObjectrequired
Examples
Example Payload:
{ "name": "objects", "display_name": "Object", "public_read": false, "alias": "object", "fields": [ { "name": "object_id", "display_name": "New Object Identifier", "public_read": false, "type": "string", "primary": true }, { "name": "another_field", "display_name": "Another Fields", "type": "string" }, { "name": "child_id", "display_name": "Child Identifier", "type": "number" } ], "relations": [ { "name": "my_relation", "display_name": "My Relationship", "public_read": false, "child_object": "child", "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

Responses

200OK

Object
Example
```
{
  "name": "objects",
  "display_name": "Object",
  "alias": "object",
  "fields": [
    {
      "name": "object_id",
      "display_name": "New Object Identifier",
      "type": "string",
      "primary": true
    },
    {
      "name": "another_field",
      "display_name": "Another Fields",
      "type": "string"
    },
    {
      "name": "child_id",
      "display_name": "Child Identifier",
      "type": "number"
    }
  ],
  "relations": [
    {
      "name": "my_relation",
      "display_name": "My Relationship",
      "child_object": "child",
      "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

Error

Example

{
  "title": "Bad Request",
  "status": 400,
  "timestamp": "2018-08-07T13:44:17.659Z",
  "detail": {
    "invalids": [
      {
        "field": "name",
        "reason": "already used by another object"
      },
      {
        "field": "alias",
        "reason": "already used by another object"
      },
      {
        "field": "display_name",
        "reason": "already used by another object"
      },
      {
        "field": "fields",
        "reason": "at least one primary key field required"
      },
      {
        "field": "relations[0].child_object",
        "reason": "does not exist"
      }
    ]
  }
}

titlestring
Example
Bad Request
statusinteger
Example
400
Default
0
timestampstring
Example
2018-08-07T13:44:17.659Z
detailobject
- invalidsobject[]
  - fieldstring
    Example
    name
  - reasonstring
    Example
    already used by another object

403Forbidden

curl

curl --request POST \
     --url https://api.us1.odp.optimizely.com/v3/schema/objects \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "name": "",
     "display_name": "",
     "public_read": false,
     "alias": "",
     "fields": [
     {
     "primary": true
     }
     ]
     }'

javascript

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

var raw = JSON.stringify({
   "name": "",
   "display_name": "",
   "public_read": false,
   "alias": "",
   "fields": [
      {
         "primary": true
      }
   ]
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   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::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "name": "",
   "display_name": "",
   "public_read": false,
   "alias": "",
   "fields": [
      {
         "primary": true
      }
   ]
})

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

python

import requests
import json

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

payload = json.dumps({
   "name": "",
   "display_name": "",
   "public_read": False,
   "alias": "",
   "fields": [
      {
         "primary": True
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", 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
{
  "title": "Bad Request",
  "status": 400,
  "timestamp": "2018-08-07T13:44:17.659Z",
  "detail": {
    "invalids": [
      {
        "field": "name",
        "reason": "already used by another object"
      }
    ]
  }
}

403

// Forbidden