Blueprint Entities API

Endpoints for CRUD operations on blueprint entity data. Each blueprint defines a data model, and entities are the records within that model.

SDK equivalent: sdk.blueprints.entitiesOf(blueprintKey)

List Entities

Retrieve a list of entities for a specific blueprint.

GET /api/blueprints/{blueprintKey}/entities

Path Parameters

Parameter	Type	Description
blueprintKey	string	The blueprint identifier

Query Parameters

Parameter	Type	Description
$limit	number	Maximum number of results
$skip	number	Number of results to skip
$sort	string	Sort field (prefix with - for descending)
$flat	boolean	Return flat entity structure
$populate	boolean	Populate related references
$q	string	Search string for metadata search
$qProps	string	Comma-separated metadata keys to search within
$outerPopulate	string	Populate related entities from other blueprints (format: setKey:blueprintName:scope)
{field}	any	Filter by exact field value
{field}[$lt]	any	Filter: less than
{field}[$gt]	any	Filter: greater than
{field}[$lte]	any	Filter: less than or equal
{field}[$gte]	any	Filter: greater than or equal

Response

[
  {
    "_id": "entity-id",
    "name": "Product A",
    "price": 99.99,
    "category": "electronics",
    "created": "2025-01-01T00:00:00.000Z",
    "updated": "2025-01-15T00:00:00.000Z"
  }
]

Example: Filtered Query

GET /api/blueprints/product/entities?$limit=10&$sort=-created&category=electronics&price[$lt]=100

Example: Metadata Search

GET /api/blueprints/product/entities?$q=Premium&$qProps=name,description&$limit=20

Example: Outer Population

GET /api/blueprints/product/entities?$outerPopulate=relatedOrders:orders:workspace

SDK: sdk.blueprints.entitiesOf(blueprintKey).getList(query)

---

Get Entity

Retrieve a specific entity by its identifier.

GET /api/blueprints/{blueprintKey}/entities/{identifier}

Path Parameters

Parameter	Type	Description
blueprintKey	string	The blueprint identifier
identifier	string	The entity ID

Response

Returns the entity object.

SDK: sdk.blueprints.entitiesOf(blueprintKey).getEntity(identifier)

---

Create Entity

Create a new entity within a blueprint.

POST /api/blueprints/{blueprintKey}/entities

Path Parameters

Parameter	Type	Description
blueprintKey	string	The blueprint identifier

Request Body

{
  "name": "New Product",
  "price": 99.99,
  "category": "electronics"
}

The request body should contain the entity fields as defined by the blueprint schema.

Response

Returns the created entity object with generated _id, created, and updated timestamps.

SDK: sdk.blueprints.entitiesOf(blueprintKey).create(entity)

---

Update Entity

Update an existing entity.

PUT /api/blueprints/{blueprintKey}/entities/{identifier}

Path Parameters

Parameter	Type	Description
blueprintKey	string	The blueprint identifier
identifier	string	The entity ID

Request Body

{
  "price": 89.99,
  "inStock": true
}

Only the fields to be updated need to be included.

Response

Returns the updated entity object.

SDK: sdk.blueprints.entitiesOf(blueprintKey).update(identifier, changes)

---

Delete Entity

Remove an entity from a blueprint.

DELETE /api/blueprints/{blueprintKey}/entities/{identifier}

Path Parameters

Parameter	Type	Description
blueprintKey	string	The blueprint identifier
identifier	string	The entity ID

Response

Returns 200 OK on success.

SDK: sdk.blueprints.entitiesOf(blueprintKey).remove(identifier)