Domains/Records REST API
Get record by id REST endpoint
Get a record by id
Concepts
- Entities have records.
- Every record in AI Construx has a unique id.
The get by id 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/get-by-id 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. |
| id | string | yes | The record's id |
If successful returns an array of records.