Functions

Description

ToDo

Events

Following events are transmitted via the websocket.

FUNCTION_CONFIG_ADD

FUNCTION_CONFIG_REMOVE

FUNCTION_CONFIG_UPDATE

FUNCTION_INSTANCE_ADD

FUNCTION_INSTANCE_REMOVE

FUNCTION_INSTANCE_NAME_UPDATE

Event that will be fired when a function config is created. This event requires read access to the resource functions.config.

Name	Description
type stringconstant	Constant value: FUNCTION_CONFIG_ADD
id string	UUIDv4 representing a function config
name string	The config human readable name Pattern: ^[0-9a-zA-Z\p{Letter}\p{Mark}\-._\s ]+$
nodes array
edges array
edges.[ ].from string
edges.[ ].to string
inputs dictionary

API

Endpoints

POST

Create Function Configuration

GET

Get Function Configuration

GET

List Function Configuration

DEL

Delete Function Configuration

PATCH

Patch Function Configuration

POST

Create Function Instance

DEL

Delete Function Instance

GET

List of Function Instances

GET

Get Function Instance State

GET

Get Function Instance Node State

GET

Get Function Instance Result State

Create Function Configuration

Calling this endpoint will create a function config

POST

/api/v1/functions/config

Access

This endpoint requires create permission for the resource functions.config.

Request Body

Name	Description
name string	The config human readable name Pattern: ^[0-9a-zA-Z\p{Letter}\p{Mark}\-._\s ]+$
nodes array
edges array
edges.[ ].from string
edges.[ ].to string

Response

Name	Description
id string	UUIDv4 representing a function config

Get Function Configuration

To get a given function configuration, call this endpoint

GET

/api/v1/functions/config/:configIdentifier

Access

This endpoint requires read permission for the resource functions.config.

URL Parameter

Name	Description
configIdentifier string	UUID v4 matching a given function

Response

Name	Description
id string	UUIDv4 representing a function config
name string	The config human readable name Pattern: ^[0-9a-zA-Z\p{Letter}\p{Mark}\-._\s ]+$
nodes array
edges array
edges.[ ].from string
edges.[ ].to string
inputs dictionary

List Function Configuration

This endpoint will return a list of all current function configurations

GET

/api/v1/functions/config

Access

This endpoint requires read permission for the resource functions.config.

Query Parameter

Name	Description
depth integeroptional	Due to the fact that some resources follow certain hierarchies, the depth query parameter can be used to include nested information in the response. This can be used to minimize roundtrips and is generally advised for.

Response

Name	Description

Delete Function Configuration

This endpoint will remove a given function configuration based on id.

DELETE

/api/v1/functions/config/:configIdentifier

Access

This endpoint requires delete permission for the resource functions.config.

URL Parameter

Name	Description
configIdentifier string	UUID v4 matching a given function

Response

This endpoint simply returns Status 204 to indicate a successful operation and to save bandwidth.

Patch Function Configuration

This endpoint will patch a given function configuration based on id. Be aware that this will reset all corresponding instances.

PATCH

/api/v1/functions/config/:configIdentifier

Access

This endpoint requires update permission for the resource functions.config.

URL Parameter

Name	Description
configIdentifier string	UUID v4 matching a given function

Request Body

Name	Description
name stringoptional	The config human readable name Pattern: ^[0-9a-zA-Z\p{Letter}\p{Mark}\-._\s ]+$
nodes arrayoptional
edges arrayoptional
edges.[ ].from string
edges.[ ].to string

Response

This endpoint simply returns Status 204 to indicate a successful operation and to save bandwidth.

Create Function Instance

Calling this endpoint will create a function instance

POST

/api/v1/functions/instances

Access

This endpoint requires create permission for the resource functions.instance.

Request Body

Name	Description
configIdentifier string	UUIDv4 representing a function config
parameter dictionaryoptional	Default: {}

Response

Name	Description
id string	UUIDv4 representing a function instance

Delete Function Instance

When calling this endpoint the function instance that matches the instance identifier will be deleted

DELETE

/api/v1/functions/instances/:instanceIdentifier

Access

This endpoint requires delete permission for the resource functions.instance.

URL Parameter

Name	Description
instanceIdentifier string	UUID v4 matching a given function instance

Response

This endpoint simply returns Status 204 to indicate a successful operation and to save bandwidth.

List of Function Instances

When calling this endpoint a list of all known instances of functions is returned

GET

/api/v1/functions/instances

Access

This endpoint requires read permission for the resource functions.instance.

Query Parameter

Name	Description
depth integeroptional	Due to the fact that some resources follow certain hierarchies, the depth query parameter can be used to include nested information in the response. This can be used to minimize roundtrips and is generally advised for.

Response

Name	Description

Get Function Instance State

Returns the current state of a given function instance

GET

/api/v1/functions/instances/:instanceIdentifier

Access

This endpoint requires read permission for the resource functions.instance.

URL Parameter

Name	Description
instanceIdentifier string	UUID v4 matching a given function instance

Response

Name	Description
nodes array
id string	UUIDv4 representing a function instance
configIdentifier string	UUIDv4 representing a function config
name string	The config human readable name Pattern: ^[0-9a-zA-Z\p{Letter}\p{Mark}\-._\s ]+$
edges array
edges.[ ].from string
edges.[ ].to string
parameter dictionaryoptional	Default: {}

Get Function Instance Node State

Returns the current state of a given function instance node

GET

/api/v1/functions/instances/:instanceIdentifier/nodes/:nodeReferenceIdentifier

Access

This endpoint requires read permission for the resource functions.instance.

URL Parameter

Name	Description
nodeReferenceIdentifier string	The reference given to the node
instanceIdentifier string	UUID v4 matching a given function instance

Response

Name	Description

Get Function Instance Result State

A direct way of inspecting the result of a function instance. Does the same as calling functions/instances/UUID/nodes/RES_REF/state

GET

/api/v1/functions/instances/:instanceIdentifier/res

Access

This endpoint requires read permission for the resource functions.instance.

URL Parameter

Name	Description
instanceIdentifier string	UUID v4 matching a given function instance

Response

Name	Description