Domains/Records REST API
Load record REST endpoint
Load record
Concepts
- Entities have records.
- Field names must be in camelCase.
The load 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 with the
following JSON in the body:
| Name | Type | Required | Description |
|---|---|---|---|
| userProfileId | string | yes | The internal user profile id. |
| projectEnvId | string | yes | The project's environment id. |
| record | json | yes | A map of field names (in camelCase to values). The record must have an entityId field. |
| options | json | no | Options for the load |
Parameters for options:
| Name | Type | Required | Description |
|---|---|---|---|
| onFieldDoesntExistValues | string | no | What to do if a field doesn't exist for the entity: strict or ignore |
If successful returns the record with an id field included.