Create Custom Entity

POST

/v1/entities

Create a custom Entity. A custom Entiy can be used to define how a Campaign, Schema, and other data relate. Entities are can be used across many Datasets and Datatables.

Request

This endpoint expects an object.

externalIdstringRequired

namestringRequired

campaignIdstringOptional

datamap from strings to anyOptional

isControlbooleanOptionalDefaults to false

schemaNamestringOptional

Response

This endpoint returns an object.

campaignIdstring

createdAtdatetime

creatorobject

idstring

isControlboolean

namestring

updatedAtdatetime

datamap from strings to anyOptional

externalIdstringOptional

modelstringOptional

parentIdstringOptional

Built with

1	curl -X POST https://api.sphinxbio.com/v1/entities \
2	-H "Content-Type: application/json" \
3	-d '{
4	"externalId": "ext_12345",
5	"name": "BRCA1 High Expression",
6	"campaignId": "camp_67890",
7	"data": {
8	"gene": "BRCA1",
9	"expressionLevel": "High"
10	},
11	"isControl": false,
12	"schemaName": "Plasmid"
13	}'

1	{
2	"campaignId": "camp_67890",
3	"createdAt": "2023-01-01T00:00:00Z",
4	"creator": {
5	"id": "user_123",
6	"email": "researcher@example.com"
7	},
8	"id": "custent_12345",
9	"isControl": false,
10	"name": "MOUSE-1",
11	"updatedAt": "2023-01-02T00:00:00Z",
12	"data": {
13	"cage": "Cage 01",
14	"genotype": "WT"
15	}
16	}