Domains/Records REST API
Filter records REST endpoint
Filter records
Concepts
- Entities have records.
- Field names must be in camelCase.
The filter 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/filter 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. |
| entityId | string | yes | The entity's id. |
| where | json | no | A map of field names (in camelCase) to specific values. |
If successful returns an array of records.