Entity Type API

Preview Entity Type Field Formula

Check a formula for an entity type field without saving it. Returns compile_error when the formula is invalid for the field’s data type, and the field IDs it reads. Pass entity_id to also evaluate it on that entity: value is the result, or runtime_error says why it failed. Set default_formula to check it as a create-time default. Nothing is written. Evaluating on an entity requires access to every field the formula reads there. Formulas are CEL over the entity’s own fields, each named by its key with hyphens written as underscores (item-cost is item_cost). An empty field is null: test it with has(x) or supply a fallback with x.orValue(d). A single-target ENTITY_REF field reads one level through the reference (owner.email); an ENUM field reads as . Functions: join_nonempty(sep, list), round(x), round(x, digits), string, today(), days_between(a, b), lower, upper, the ? : operator, and the exists and all macros. A computed field may read another computed field only when that one reads none, cycles are refused, and a formula reads at most 10 referenced fields. FILE and MULTI_SELECT fields cannot be read or produced.

POST

entity-type-fields

{id}

formula

preview

Preview Entity Type Field Formula

curl --request POST \
  --url https://public.api.serval.com/v2/entity-type-fields/{id}/formula/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "formula": "<string>",
  "defaultFormula": true,
  "entityId": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/entity-type-fields/{id}/formula/preview"

payload = {
    "formula": "<string>",
    "defaultFormula": True,
    "entityId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({formula: '<string>', defaultFormula: true, entityId: '<string>'})
};

fetch('https://public.api.serval.com/v2/entity-type-fields/{id}/formula/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public.api.serval.com/v2/entity-type-fields/{id}/formula/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'formula' => '<string>',
    'defaultFormula' => true,
    'entityId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/entity-type-fields/{id}/formula/preview"

	payload := strings.NewReader("{\n  \"formula\": \"<string>\",\n  \"defaultFormula\": true,\n  \"entityId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public.api.serval.com/v2/entity-type-fields/{id}/formula/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"formula\": \"<string>\",\n  \"defaultFormula\": true,\n  \"entityId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/entity-type-fields/{id}/formula/preview")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"formula\": \"<string>\",\n  \"defaultFormula\": true,\n  \"entityId\": \"<string>\"\n}"

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

{
  "compileError": "<string>",
  "runtimeError": "<string>",
  "value": 123,
  "readFieldIds": [
    "<string>"
  ]
}

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

Credential	Access requirements
Organization-scoped API key	`entities:read`
Team-scoped API key	`entities:read`
User-based token (OAuth)	Supported, subject to permissions

Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Check a field’s formula in a team’s database: The permission is checked on the team that owns the field’s database. Previewing on an entity also requires access to that entity and to every field the formula reads on it.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The ID of the output entity type field. Its data type is the type the formula must produce.

Body

application/json

formula

string

The formula to check.

defaultFormula

boolean

Check the formula as a create-time default instead of a computed formula. Defaults may read only entered fields.

entityId

string | null

Also evaluate the formula against this entity. Omit to compile only.

Response

200 - application/json

Success

compileError

string | null

Why the formula does not compile. Unset when it compiles.

runtimeError

string | null

Why evaluating on entity_id failed. A saved formula leaves the field empty on such a record.

value

The result on entity_id: a string, number or bool, an RFC 3339 timestamp, or the option ID for an ENUM output. Unset when the result is empty, evaluation failed, or entity_id was omitted.

readFieldIds

string[]

The entity type field IDs on this type the formula reads.

Preview Entity Type Field Formula

curl --request POST \
  --url https://public.api.serval.com/v2/entity-type-fields/{id}/formula/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "formula": "<string>",
  "defaultFormula": true,
  "entityId": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/entity-type-fields/{id}/formula/preview"

payload = {
    "formula": "<string>",
    "defaultFormula": True,
    "entityId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({formula: '<string>', defaultFormula: true, entityId: '<string>'})
};

fetch('https://public.api.serval.com/v2/entity-type-fields/{id}/formula/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public.api.serval.com/v2/entity-type-fields/{id}/formula/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'formula' => '<string>',
    'defaultFormula' => true,
    'entityId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/entity-type-fields/{id}/formula/preview"

	payload := strings.NewReader("{\n  \"formula\": \"<string>\",\n  \"defaultFormula\": true,\n  \"entityId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public.api.serval.com/v2/entity-type-fields/{id}/formula/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"formula\": \"<string>\",\n  \"defaultFormula\": true,\n  \"entityId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/entity-type-fields/{id}/formula/preview")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"formula\": \"<string>\",\n  \"defaultFormula\": true,\n  \"entityId\": \"<string>\"\n}"

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

{
  "compileError": "<string>",
  "runtimeError": "<string>",
  "value": 123,
  "readFieldIds": [
    "<string>"
  ]
}

Get started

Authentication

Endpoints

Development

Preview Entity Type Field Formula

Authentication and permissions

Authorizations

Path Parameters

Body

Response

​Authentication and permissions

Authorizations

Path Parameters

Body

Response

Authentication and permissions