Skip to main content
POST
/
v2
/
entity-type-fields
Create Entity Type Field
curl --request POST \
  --url https://public.api.serval.com/v2/entity-type-fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityTypeId": "<string>",
  "key": "<string>",
  "name": "<string>",
  "enumOptions": [
    {
      "value": "<string>",
      "displayName": "<string>",
      "displayOrder": 123
    }
  ],
  "isKeyField": true,
  "isNameField": true,
  "refEntityTypeId": "<string>"
}
'
{
  "data": {
    "schemaMigrationId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
entityTypeId
string

The entity type to create the field on (required).

​
key
string | null

The unique key for the field. If omitted, derived from the name.

​
name
string

The display name of the field (required).

​
dataType
enum<string>

The data type of the field (required).

Available options:
DATA_TYPE_UNSPECIFIED,
TEXT,
NUMBER,
BOOL,
TIMESTAMP,
ENUM,
ENTITY_REF,
USER_REF,
UNIQUE,
MULTI_SELECT,
FILE
​
enumOptions
EnumOptionInput · object[]

Options for ENUM / MULTI_SELECT fields (required for those data types).

​
isKeyField
boolean

Whether this field is the entity type's key (dedup identity) field.

​
isNameField
boolean

Whether this field is the entity type's display-name field.

​
refEntityTypeId
string | null

For ENTITY_REF fields: the entity type this field references.

Response

Success

​
data
data · object

Reference to the (COMPLETED) create migration; its details.create_field.field_id is the new field id.