Create Entity

POST

entities

Create Entity

curl --request POST \
  --url https://public.api.serval.com/v2/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "entityTypeId": "<string>",
  "key": "<string>",
  "name": "<string>",
  "fieldValues": [
    {
      "boolValue": true,
      "entityRefValue": "<string>",
      "enumValue": "<string>",
      "numberValue": 123,
      "textValue": "<string>",
      "timestampValue": "2023-11-07T05:31:56Z",
      "userRefValue": "<string>"
    }
  ]
}
'

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "entityTypeId": "<string>",
    "key": "<string>",
    "name": "<string>",
    "number": 123,
    "createdByUserId": "<string>",
    "updatedByUserId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "document": "<string>",
    "entityTypeKey": "<string>",
    "entitySchemaKey": "<string>",
    "entitySchemaId": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

teamId

string

The ID of the team.

entityTypeId

string

The ID of the entity type.

key

string

The unique key for the entity.

name

string

The name of the entity.

fieldValues

EntityFieldValue · object[]

The field values for the entity.

Show child attributes

fieldValues.boolValue

boolean

Option: bool_value

fieldValues.entityRefValue

string

Option: entity_ref_value

fieldValues.enumValue

string

Option: enum_value

fieldValues.numberValue

number<double>

Option: number_value

fieldValues.textValue

string

Option: text_value

fieldValues.timestampValue

string<date-time>

Option: timestamp_value

fieldValues.userRefValue

string

Option: user_ref_value

Response

Success

data

data · object

The created entity.

Show child attributes

data.id

string

The ID of the entity.

data.teamId

string

The ID of the team that the entity belongs to.

data.entityTypeId

string

The ID of the entity type.

data.key

string

The unique key for the entity within its type.

data.name

string

The name of the entity.

data.number

integer<int32>

The sequential number for the entity within the team.

data.createdByUserId

string

The ID of the user who created the entity.

data.updatedByUserId

string

The ID of the user who last updated the entity.

data.createdAt

string<date-time>

The timestamp when the entity was created.

data.updatedAt

string<date-time>

The timestamp when the entity was last updated.

data.document

string

The entity's document data as a JSON string.

data.entityTypeKey

string

The key of the entity type.

data.entitySchemaKey

string

The key of the entity schema.

data.entitySchemaId

string

The ID of the entity schema.

Search EntitiesSearch entities with advanced filtering, sorting, and pagination. Supports filtering by entity type, name search, field filters (with OR between filter groups and AND within groups), and custom sorting.

⌘I

Create Entity

curl --request POST \
  --url https://public.api.serval.com/v2/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "entityTypeId": "<string>",
  "key": "<string>",
  "name": "<string>",
  "fieldValues": [
    {
      "boolValue": true,
      "entityRefValue": "<string>",
      "enumValue": "<string>",
      "numberValue": 123,
      "textValue": "<string>",
      "timestampValue": "2023-11-07T05:31:56Z",
      "userRefValue": "<string>"
    }
  ]
}
'

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "entityTypeId": "<string>",
    "key": "<string>",
    "name": "<string>",
    "number": 123,
    "createdByUserId": "<string>",
    "updatedByUserId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "document": "<string>",
    "entityTypeKey": "<string>",
    "entitySchemaKey": "<string>",
    "entitySchemaId": "<string>"
  }
}

Authentication

Endpoints

Development

Authorizations

Body

Response