Domains/Records REST API

Load records REST endpoint

Load records

Concepts

  • Entities have records.
  • Field names must be in camelCase.

The load-many endpoint

Go to the project page to get your:

  • User profile id
  • Project environment id

Go the the entity's details page to get the:

  • Entity id

You must also know the record's id to use this endpoint.

Send a POST request to https://server-name/api/v1/records/load-many with the following JSON in the body:

NameTypeRequiredDescription
userProfileIdstringyesThe internal user profile id.
projectEnvIdstringyesThe project's environment id.
recordsjson[]yesAn array of records. Each record is a map of field names (in camelCase to values) and must have an entityId field.
optionsjsonnoOptions for the load

Parameters for options:

NameTypeRequiredDescription
onFieldDoesntExistValuesstringnoWhat to do if a field doesn't exist for the entity: strict or ignore

If successful returns an array of records with id fields included.

On this page