Entity store

Internal List Definitions

Path Parameters

instance_idInstance Id

Formatuuid

Response Body

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-definitions"

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-definitions"

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Internal Get Definition

Path Parameters

instance_idInstance Id

Formatuuid

slugSlug

Response Body

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-definitions/string"

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-definitions/string"

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Internal Kv Get

Path Parameters

instance_idInstance Id

Formatuuid

Query Parameters

customer_idCustomer Id

Formatuuid

namespaceNamespace

keyKey

Response Body

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&namespace=string&key=string"

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&namespace=string&key=string"

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Internal Kv Delete

Path Parameters

instance_idInstance Id

Formatuuid

Query Parameters

customer_idCustomer Id

Formatuuid

namespaceNamespace

keyKey

Response Body

curl -X DELETE "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&namespace=string&key=string"

curl -X DELETE "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&namespace=string&key=string"

Empty

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Internal Kv Set

Path Parameters

instance_idInstance Id

Formatuuid

Request Body

customer_idCustomer Id

Formatuuid

expires_at?Expires At

keyKey

Length1 <= length <= 255

namespaceNamespace

Length1 <= length <= 100

valueValue

Empty Object

Response Body

curl -X PUT "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
    "key": "string",
    "namespace": "string",
    "value": {}
  }'

curl -X PUT "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv" \  -H "Content-Type: application/json" \  -d '{    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",    "key": "string",    "namespace": "string",    "value": {}  }'

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Internal Kv Batch Set

Path Parameters

instance_idInstance Id

Formatuuid

Request Body

customer_idCustomer Id

Formatuuid

entriesEntries

List of {key, value, expires_at?}

namespaceNamespace

Length1 <= length <= 100

Response Body

curl -X POST "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv/batch" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
    "entries": [
      {}
    ],
    "namespace": "string"
  }'

curl -X POST "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv/batch" \  -H "Content-Type: application/json" \  -d '{    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",    "entries": [      {}    ],    "namespace": "string"  }'

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Internal Kv List

Path Parameters

instance_idInstance Id

Formatuuid

Query Parameters

customer_idCustomer Id

Formatuuid

namespaceNamespace

Response Body

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv/list?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&namespace=string"

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-kv/list?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&namespace=string"

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Internal List Records

Path Parameters

instance_idInstance Id

Formatuuid

Query Parameters

customer_idCustomer Id

Formatuuid

definition_slug?Definition Slug

definition_id?Definition Id

status?Status

tag?Tag

search?Search

Full-text search via tsvector (indexed, requires searchable_fields on definition)

limit?Limit

Default50

Range1 <= value <= 200

offset?Offset

Default0

Range0 <= value

Response Body

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&definition_slug=string&definition_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&status=string&tag=string&search=string&limit=50&offset=0"

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&definition_slug=string&definition_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&status=string&tag=string&search=string&limit=50&offset=0"

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Internal Create Record

Path Parameters

instance_idInstance Id

Formatuuid

Request Body

created_by?Created By

customer_idCustomer Id

Formatuuid

data?Data

Empty Object

definition_id?Definition Id

definition_slug?Definition Slug

tags?Tags

Response Body

curl -X POST "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e"
  }'

curl -X POST "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records" \  -H "Content-Type: application/json" \  -d '{    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e"  }'

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Internal Get Record

Path Parameters

instance_idInstance Id

Formatuuid

record_idRecord Id

Formatuuid

Response Body

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records/497f6eca-6276-4993-bfeb-53cbbbba6f08"

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records/497f6eca-6276-4993-bfeb-53cbbbba6f08"

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Internal Update Record

Path Parameters

instance_idInstance Id

Formatuuid

record_idRecord Id

Formatuuid

Request Body

data?Data

status?Status

tags?Tags

Response Body

curl -X PATCH "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PATCH "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Internal Delete Record

Path Parameters

instance_idInstance Id

Formatuuid

record_idRecord Id

Formatuuid

Response Body

curl -X DELETE "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records/497f6eca-6276-4993-bfeb-53cbbbba6f08"

curl -X DELETE "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-records/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Internal List Relationships

Path Parameters

instance_idInstance Id

Formatuuid

Query Parameters

record_idRecord Id

Find relationships for this record

Formatuuid

relationship_type?Relationship Type

direction?Direction

Default"both"

Match^(from|to|both)$

Response Body

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-relationships?record_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&relationship_type=string&direction=both"

curl -X GET "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-relationships?record_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&relationship_type=string&direction=both"

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Internal Create Relationship

Path Parameters

instance_idInstance Id

Formatuuid

Request Body

from_record_idFrom Record Id

Formatuuid

metadata?Metadata

relationship_typeRelationship Type

Length1 <= length <= 50

to_record_idTo Record Id

Formatuuid

Response Body

curl -X POST "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-relationships" \
  -H "Content-Type: application/json" \
  -d '{
    "from_record_id": "970e0aa8-b390-4ddc-afe1-fb4fc01a08b0",
    "relationship_type": "string",
    "to_record_id": "248de304-16b0-46af-b270-faee1be109a5"
  }'

curl -X POST "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-relationships" \  -H "Content-Type: application/json" \  -d '{    "from_record_id": "970e0aa8-b390-4ddc-afe1-fb4fc01a08b0",    "relationship_type": "string",    "to_record_id": "248de304-16b0-46af-b270-faee1be109a5"  }'

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Internal Delete Relationship

Path Parameters

instance_idInstance Id

Formatuuid

relationship_idRelationship Id

Formatuuid

Response Body

curl -X DELETE "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-relationships/497f6eca-6276-4993-bfeb-53cbbbba6f08"

curl -X DELETE "https://loading/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/entity-relationships/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Tenant List Definitions

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/entity-definitions" \
  -H "X-Api-Key: string"

curl -X GET "https://loading/v1/entity-definitions" \  -H "X-Api-Key: string"

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Tenant Create Definition

Authorization

AuthorizationBearer <token>

In: header

Header Parameters

X-Api-Key?X-Api-Key

Request Body

color?Color

description?Description

display_nameDisplay Name

Length1 <= length <= 200

field_sensitivity?Field Sensitivity

field_name → standard|sensitive|restricted

icon?Icon

schema?Schema

searchable_fields?Searchable Fields

slugSlug

Match^[a-z][a-z0-9_]*$

Length1 <= length <= 100

Response Body

curl -X POST "https://loading/v1/entity-definitions" \
  -H "X-Api-Key: string" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "string",
    "slug": "string"
  }'

curl -X POST "https://loading/v1/entity-definitions" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{    "display_name": "string",    "slug": "string"  }'

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Tenant Update Definition

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

definition_idDefinition Id

Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Request Body

color?Color

description?Description

display_name?Display Name

field_sensitivity?Field Sensitivity

field_name → standard|sensitive|restricted

icon?Icon

schema?Schema

searchable_fields?Searchable Fields

Response Body

curl -X PATCH "https://loading/v1/entity-definitions/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "X-Api-Key: string" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PATCH "https://loading/v1/entity-definitions/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string" \  -H "Content-Type: application/json" \  -d '{}'

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Tenant Delete Definition

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

definition_idDefinition Id

Formatuuid

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X DELETE "https://loading/v1/entity-definitions/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "X-Api-Key: string"

curl -X DELETE "https://loading/v1/entity-definitions/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Api-Key: string"

Empty

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Tenant List Kv

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

customer_idCustomer Id

Formatuuid

namespace?Namespace

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/entity-kv?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&namespace=string" \
  -H "X-Api-Key: string"

curl -X GET "https://loading/v1/entity-kv?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&namespace=string" \  -H "X-Api-Key: string"

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Tenant List Records

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

customer_id?Customer Id

definition_id?Definition Id

status?Status

limit?Limit

Default50

Range1 <= value <= 200

offset?Offset

Default0

Range0 <= value

Header Parameters

X-Api-Key?X-Api-Key

Response Body

curl -X GET "https://loading/v1/entity-records?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&definition_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&status=string&limit=50&offset=0" \
  -H "X-Api-Key: string"

curl -X GET "https://loading/v1/entity-records?customer_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&definition_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&status=string&limit=50&offset=0" \  -H "X-Api-Key: string"

null

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Entity store

200

422

200

422

200

422

204

422

200

422

200

422

200

422

200

422

201

422

200

422

200

422

204

422

200

422

201

422

204

422

200

422

201

422

200

422

204

422

200

422

200

422