Skip to main content
POST
/
v2
/
entity-field-mappings
Create Entity Field Mapping
curl --request POST \
  --url https://public.api.serval.com/v2/entity-field-mappings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ingestionConfigId": "<string>",
  "internalFieldId": "<string>",
  "externalFieldPath": "<string>",
  "priority": 123
}
'
{
  "data": {
    "id": "<string>",
    "ingestionConfigId": "<string>",
    "internalFieldId": "<string>",
    "externalFieldPath": "<string>",
    "priority": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
ingestionConfigId
string

The ingestion config that provides the source data (required). The mapping binds to this config's most recently discovered external schema; a sync must have run first (otherwise NOT_FOUND).

​
internalFieldId
string

The internal entity-type field to populate (required).

​
externalFieldPath
string

Dot-notation path into the external record, e.g. "general.platform" (required). Read the available paths via GetExternalEntitySchema.

​
priority
number<double> | null

Precedence when multiple sources map to the same internal field (higher wins). Defaults to 1.0.

Response

Success

​
data
data · object

The created field mapping.