POST
/
organisations
/
{organisationId}
/
board-instances
/
{boardId}
/
trigger-execution

Authorizations

Authorization
string
headerrequired

Path Parameters

organisationId
string
required
boardId
string
required

Body

application/json
nodeIds
string[]
required

NodeIDs is a list of Node IDs which should be manually triggered. At least one ID must be provided.

Response

202 - application/json

BoardTriggered is used to indicate if the trigger request has been accepted. The actual scheduling is done in the background and does not indicate the board has finished execution yet.

ok
boolean
required

OK denotes whether the request was handled successfully. If this field is true, then all nodeIds from the request were successfully triggered, otherwise at least one nodeId failed to trigger.

nodes
object[]
required

Nodes provides info on which nodes were triggered and if any failed.

nodes.ok
boolean
required

OK denotes whether the request was handled successfully. If this field is true, then the node was triggered, otherwise the node failed to trigger.

nodes.message
string
required

Message contains a human-friendly message to display to the user in response to their trigger request.