Entity Type API

Set Entity Type Field Formula

Set how an entity type field gets its value. value_source COMPUTED with formula makes the formula own the value: callers can no longer write it, it reruns whenever a field it reads changes, and saving it recomputes every existing entity in the background, overwriting entered values (an empty result clears them). AUTO_NUMBER with auto_number numbers every entity, existing ones without a value included, as prefix plus a zero-padded counter; only TEXT and UNIQUE fields can be auto-numbered. ENTERED makes the field writable again, keeping the last values; add default_formula to fill it on create when the caller leaves it empty. Call on the field ID of the type that defines the field, not a child type that inherits it. Fields used by an ingestion mapping or a normalization rule, the key field of an ingested type, and formulas that read a sensitive field into a non-sensitive one are refused. Check a formula first with Preview Entity Type Field Formula, and follow the recompute with Get Entity Type Field Formula Status. 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.

PUT

entity-type-fields

{id}

formula

Set Entity Type Field Formula

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

import requests

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

payload = {
    "formula": "<string>",
    "defaultFormula": "<string>",
    "autoNumber": {
        "prefix": "<string>",
        "digits": 123
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    formula: '<string>',
    defaultFormula: '<string>',
    autoNumber: {prefix: '<string>', digits: 123}
  })
};

fetch('https://public.api.serval.com/v2/entity-type-fields/{id}/formula', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'formula' => '<string>',
    'defaultFormula' => '<string>',
    'autoNumber' => [
        'prefix' => '<string>',
        'digits' => 123
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"formula\": \"<string>\",\n  \"defaultFormula\": \"<string>\",\n  \"autoNumber\": {\n    \"prefix\": \"<string>\",\n    \"digits\": 123\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://public.api.serval.com/v2/entity-type-fields/{id}/formula")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"formula\": \"<string>\",\n  \"defaultFormula\": \"<string>\",\n  \"autoNumber\": {\n    \"prefix\": \"<string>\",\n    \"digits\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

{
  "data": {
    "id": "<string>",
    "entityTypeId": "<string>",
    "key": "<string>",
    "name": "<string>",
    "dataType": "DATA_TYPE_UNSPECIFIED",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "updatedAt": "2025-01-15T01:30:15.000Z",
    "createdByUserId": "<string>",
    "updatedByUserId": "<string>",
    "enumOptions": [
      {
        "id": "<string>",
        "value": "<string>",
        "displayName": "<string>",
        "displayOrder": 123,
        "description": "<string>"
      }
    ],
    "isKeyField": true,
    "isNameField": true,
    "fieldId": "<string>",
    "refEntityTypeId": "<string>",
    "refEntityTypeIds": [
      "<string>"
    ],
    "description": "<string>",
    "sourceEntityTypeId": "<string>",
    "viewerCanViewValues": true,
    "viewerCanEdit": true,
    "helpAgentVisible": true,
    "sensitive": true,
    "sectionId": "<string>",
    "displayOptions": {
      "boolean": {
        "style": "STYLE_UNSPECIFIED"
      }
    },
    "valueSource": "FIELD_VALUE_SOURCE_UNSPECIFIED",
    "formula": "<string>",
    "defaultFormula": "<string>",
    "formulaDisabledAt": "2025-01-15T01:30:15.000Z",
    "autoNumber": {
      "prefix": "<string>",
      "digits": 123,
      "scope": "AUTO_NUMBER_SCOPE_UNSPECIFIED"
    },
    "timestampRange": {
      "allowsOpenEnd": true
    }
  }
}

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:write`
Team-scoped API key	`entities:write`
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.

Change how a field in a team’s database gets its value: The permission is checked on the team that owns the field’s database. A caller admitted to the database only through a share cannot change its formulas.

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 entity type field on the type that defines it. A field a type inherits takes its formula from the parent's placement.

Body

application/json

valueSource

enum<string>

ENTERED (callers write the value), COMPUTED (formula owns the value) or AUTO_NUMBER (a counter numbers each record).

Available options:

FIELD_VALUE_SOURCE_UNSPECIFIED,

FIELD_VALUE_SOURCE_ENTERED,

FIELD_VALUE_SOURCE_COMPUTED,

FIELD_VALUE_SOURCE_AUTO_NUMBER

formula

string | null

The formula. Required when value_source is COMPUTED; refused otherwise.

defaultFormula

string | null

A formula that fills the field on create when the caller leaves it empty. ENTERED only; omit to clear the field's default.

autoNumber

AutoNumberSettings · object | null

How an auto-numbered field builds its values: the prefix followed by the next number, zero-padded to digits.

Show child attributes

Response

200 - application/json

Success

data

data · object

The field as saved.

Show child attributes

Set Entity Type Field Formula

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

import requests

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

payload = {
    "formula": "<string>",
    "defaultFormula": "<string>",
    "autoNumber": {
        "prefix": "<string>",
        "digits": 123
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    formula: '<string>',
    defaultFormula: '<string>',
    autoNumber: {prefix: '<string>', digits: 123}
  })
};

fetch('https://public.api.serval.com/v2/entity-type-fields/{id}/formula', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'formula' => '<string>',
    'defaultFormula' => '<string>',
    'autoNumber' => [
        'prefix' => '<string>',
        'digits' => 123
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"formula\": \"<string>\",\n  \"defaultFormula\": \"<string>\",\n  \"autoNumber\": {\n    \"prefix\": \"<string>\",\n    \"digits\": 123\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://public.api.serval.com/v2/entity-type-fields/{id}/formula")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"formula\": \"<string>\",\n  \"defaultFormula\": \"<string>\",\n  \"autoNumber\": {\n    \"prefix\": \"<string>\",\n    \"digits\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

{
  "data": {
    "id": "<string>",
    "entityTypeId": "<string>",
    "key": "<string>",
    "name": "<string>",
    "dataType": "DATA_TYPE_UNSPECIFIED",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "updatedAt": "2025-01-15T01:30:15.000Z",
    "createdByUserId": "<string>",
    "updatedByUserId": "<string>",
    "enumOptions": [
      {
        "id": "<string>",
        "value": "<string>",
        "displayName": "<string>",
        "displayOrder": 123,
        "description": "<string>"
      }
    ],
    "isKeyField": true,
    "isNameField": true,
    "fieldId": "<string>",
    "refEntityTypeId": "<string>",
    "refEntityTypeIds": [
      "<string>"
    ],
    "description": "<string>",
    "sourceEntityTypeId": "<string>",
    "viewerCanViewValues": true,
    "viewerCanEdit": true,
    "helpAgentVisible": true,
    "sensitive": true,
    "sectionId": "<string>",
    "displayOptions": {
      "boolean": {
        "style": "STYLE_UNSPECIFIED"
      }
    },
    "valueSource": "FIELD_VALUE_SOURCE_UNSPECIFIED",
    "formula": "<string>",
    "defaultFormula": "<string>",
    "formulaDisabledAt": "2025-01-15T01:30:15.000Z",
    "autoNumber": {
      "prefix": "<string>",
      "digits": 123,
      "scope": "AUTO_NUMBER_SCOPE_UNSPECIFIED"
    },
    "timestampRange": {
      "allowsOpenEnd": true
    }
  }
}

Get started

Authentication

Endpoints

Development

Set Entity Type Field Formula

Authentication and permissions

Authorizations

Path Parameters

Body

Response

​Authentication and permissions

Authorizations

Path Parameters

Body

Response

Authentication and permissions