#Actions

---

#GET /{o}/{p}/actions

List actions

List the action definitions in this project.

Auth: Bearer token required · Permission: catalog:read

Path parameters

Name	Type	Description
o	string
p	string

Responses

Status	Description	Schema
200	Actions	ActionList

---

#POST /{o}/{p}/actions

Create an action

Auth: Bearer token required · Permission: catalog:write

Path parameters

Name	Type	Description
o	string
p	string

Request body (application/json)

Field	Type	Description
kind	Action	(required)
name	string	(required)
displayName	string
description	string
associatedWith	object	(required)
conditions	object[]
parameters	object[]
recommendations	object[]
operation	object | object | object | object | object | object | object | object	(required)
trigger	object | object | object | object | object | object	(required)
envOverrides	object
dependsOn	object[]
timeout	integer
mutatesProperty	string

Responses

Status	Description	Schema
201	Created action	Action
400	Invalid mutatesProperty reference	Error
409	Action already exists	Error

---

#GET /{o}/{p}/actions/{name}

Get an action 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 action	Action
404	Action not found	Error

---

#PUT /{o}/{p}/actions/{name}

Update an action

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	Action	(required)
name	string	(required)
displayName	string
description	string
associatedWith	object	(required)
conditions	object[]
parameters	object[]
recommendations	object[]
operation	object | object | object | object | object | object | object | object	(required)
trigger	object | object | object | object | object | object	(required)
envOverrides	object
dependsOn	object[]
timeout	integer
mutatesProperty	string

Responses

Status	Description	Schema
200	Updated action	Action
400	Invalid mutatesProperty reference	Error
404	Action not found	Error

---

#DELETE /{o}/{p}/actions/{name}

Delete an action

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	Action not found	Error

---

#POST /{o}/{p}/envs/{envName}/actions/{name}/run

Trigger a collection-scoped action

Run a collection-scoped action in this environment. Instance-scoped actions are triggered via the entity actions route.

Auth: Bearer token required · Permission: data:write

Path parameters

Name	Type	Description
o	string
p	string
envName	string
name	string

Request body (application/json)

Field	Type	Description
parameters	object
recommendations	object

Responses

Status	Description	Schema
202	Action run accepted	ActionRun
400	Action is instance-scoped	Error
404	Action not found	Error

#Schemas

#Action

Field	Type	Description
name	string	(required)
displayName	string
description	string
associatedWith	object	(required)
conditions	object[]	(required)
parameters	object[]	(required)
recommendations	object[]	(required)
operation	object | object | object | object | object | object | object | object	(required)
trigger	object | object | object | object | object | object	(required)
envOverrides	object
dependsOn	object[]
timeout	integer
mutatesProperty	string
orgId	string	(required)
projectId	string	(required)
createdAt	string | string	(required)
updatedAt	string | string	(required)

#ActionList

Type: Action[]

#ActionRun

Field	Type	Description
id	string(uuid)	(required)
actionName	string	(required)
entityId	string,null(uuid)	(required)
status	pending | running | succeeded | failed | cancelled	(required)
parameters	object	(required)
recommendations	object	(required)
triggeredBy	string	(required)
createdAt	string(date-time)	(required)
startedAt	string,null(date-time)	(required)
completedAt	string,null(date-time)	(required)
error	string,null	(required)
output	object,null	(required)

#Deleted

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

#Error

Field	Type	Description
error	string	(required)
code	string