Get The Field Definition For The Specified Object

You can use this request to retrieve the definition for a specific object. Submit the name of the object and the system will return the field definitions.

The Method

API Method
RESTGEThttp://[Your URL]/api/2.0/defintions/$name
Your URL is the address of your Everlytic install.

Your method must be structured as follows:

GetDefinition(string $name) : object


$namestringThe name of the object definition you need to retrieve.yes

The definition contains a number of fields with the following properties:

typestringThe type of field.
requiredbooleanIf the field is required.
readonlybooleanIf the field is read only.
valuesarrayPossible values for the field.
defaultstringThe default value for the field.


objectThe definition object.

Code Samples

PHP (using the REST API)


The rest of this document describes the example above, step-by-step.

In our Getting Started section we covered the four important components of an API request; URL, method, headers, and body.


Let's analyse the code sample above to determine where each line fits into this outline.

1. Load the Everlytic API

The following line of code tells the server which API URL to access for the request:

$url = '(Your URL)/api/2.0/defintions/:name';

2. Method

In this line of code, you tell the API which REST function to use:

$method = ‘GET’;

3. cURL

cURL is a tool for sending and receiving files from a web server. This line of code initialises the cURL session.

$cSession = curl_init();

4. Initiate the headers

This section of the code opens the headers section and passes the authentication (including your API key).

$headers = array();

$auth = base64_encode($username . ':' . $apikey);

$headers[] = 'Authorization: Basic ' . $auth;

5. Set various cURL options for the session

The first line uses the $url to get your specified url
The second line returns the string (text) of the return value.
The third line tells the server not to include the header in the ouput.
The fourth line calls the $method specified above, which is to ‘GET’ (read) the data from the server.

curl_setopt($cSession, CURLOPT_URL, $url);

curl_setopt($cSession, CURLOPT_RETURNTRANSFER, true);

curl_setopt($cSession, CURLOPT_HEADER, false);

curl_setopt($cSession, CURLOPT_CUSTOMREQUEST, strtoupper($method));

6. Headers

Call the headers using the $headers method.

curl_setopt($cSession, CURLOPT_HTTPHEADER, $headers);

7. Output the API response to test authentication

$result = curl_exec($cSession);

8. Close the cURL session

Translate »