Get field

1 min

GET

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

List the details of a single field for a specific object.

Path Parameters

field_namestringrequired
Description
The name of the field.
object_namestringrequired
Description
The name of the object.

Responses

200OK

Field
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"
        }
      ]
    }
  ]
}
```
- namestringrequired
  Description
  The name of the field (for example, ticket_id).
- display_namestringrequired
  Description
  The human-readable name of the field (for example, Ticket ID).
- public_readboolean
  Description
  Enable access with the API public key.
  Default
  false
- descriptionstring[]
  Description
  Detailed description of the field's purpose.
- typestring<number | timestamp | string | boolean>required
  Description
  An array of relations field data type. Options are number, timestamp, string, boolean.
  Allowed
  numbertimestampstringboolean
- access_policiesobject
  Description
  Set access policies, like PII, for the field.
  - PIIobject
    Description
    Mark the field as Personally Identifiable Information (PII).
    - enableboolean
      Description
      Set to true to mark the field as Personally Identifiable Information (PII); false to indicate the field is not PII. Default is true.
    - suggestibleboolean
      Description
      Set to true to enable autosuggestions for the field; false to disable autosuggestions. Default is false.

400Bad Request

object

403Forbidden

curl

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

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}/fields/{field_name}"

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,
  "description": [
    ""
  ],
  "type": "",
  "access_policies": {
    "PII": {
      "enable": false,
      "suggestible": false
    }
  }
}

400

// Bad Request
{}

403

// Forbidden