#EntityTypes

---

#GET /{o}/{p}/entity-types

List entity types

List all entity types defined in this project.

Auth: Bearer token required · Permission: catalog:read

Path parameters

Name	Type	Description
o	string
p	string

Responses

Status	Description	Schema
200	Entity types	EntityTypeList

---

#POST /{o}/{p}/entity-types

Create an entity type

Auth: Bearer token required · Permission: catalog:write

Path parameters

Name	Type	Description
o	string
p	string

Request body (application/json)

Field	Type	Description
kind	EntityType	(required)
name	string	(required)
displayName	string
states	string[]	(required)
initialState	string	(required)
properties	object[]
metrics	object[]
constraints	object[]
syncTracked	boolean
syncFreshness	object
applier	string

Responses

Status	Description	Schema
201	Created entity type	EntityType
409	Entity type already exists	Error

---

#GET /{o}/{p}/entity-types/{name}

Get an entity type by name

Auth: Bearer token required · Permission: catalog:read

Path parameters

Name	Type	Description
o	string
p	string
name	string

Responses

Status	Description	Schema
200	The entity type	EntityType
404	Entity type not found	Error

---

#PUT /{o}/{p}/entity-types/{name}

Update an entity type

Auth: Bearer token required · Permission: catalog:write

Path parameters

Name	Type	Description
o	string
p	string
name	string

Request body (application/json)

Field	Type	Description
kind	EntityType	(required)
name	string	(required)
displayName	string
states	string[]	(required)
initialState	string	(required)
properties	object[]
metrics	object[]
constraints	object[]
syncTracked	boolean
syncFreshness	object
applier	string

Responses

Status	Description	Schema
200	Updated entity type	EntityType
404	Entity type not found	Error

---

#DELETE /{o}/{p}/entity-types/{name}

Delete an entity type

Auth: Bearer token required · Permission: catalog:write

Path parameters

Name	Type	Description
o	string
p	string
name	string

Responses

Status	Description	Schema
200	Deletion result	Deleted
404	Entity type not found	Error
409	Still referenced by entities	Error

#Schemas

#Deleted

Field	Type	Description
deleted	true	(required)
name	string	(required)

#EntityType

Field	Type	Description
name	string	(required)
displayName	string
states	string[]	(required)
initialState	string	(required)
properties	object[]	(required)
metrics	object[]	(required)
constraints	object[]	(required)
syncTracked	boolean	(required)
syncFreshness	object
applier	string
orgId	string	(required)
projectId	string	(required)
createdAt	string | string	(required)
updatedAt	string | string	(required)

#EntityTypeList

Type: EntityType[]

#Error

Field	Type	Description
error	string	(required)
code	string