# Functions

# GET Retrieve Function Definitions

# /definitions/functions

# Description

Retrieves the list of function definitions with an optional filter.

# Parameters

Name	Located in	Description	Required	Schema
limit	query	Limit the number of returned values. Defaults to 100 if not specified	No	LimitClause
includeDeleted	query	Whether to return a definition that has been marked as deleted	No	-
filter	query	A boolean expression used to filter the results	No	WhereClause

# Responses

Code	Description	Schema
200	Success	FunctionDefinitions
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
404	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
5XX	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# POST Add a New Function Definition

# /definitions/functions

# Description

Adds a new function definition.

# Responses

Code	Description	Schema
201	Definition was added to database	FunctionDefinition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
409	Conflict - definition with this id already exists
5XX	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Retrieve a Function Definition

# /definitions/functions/{functionDefinitionId}

# Description

Retrieves latest version of specific function definition.

# Parameters

Name	Located in	Description	Required	Schema
functionDefinitionId	path	Definition id	Yes	string
includeDeleted	query	Whether to return a definition that has been marked as deleted	No	-

# Responses

Code	Description	Schema
200	Success. Retrieve object models by filter criteria.	FunctionDefinition
404	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
5XX	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# DELETE Delete a Function Definition

# /definitions/functions/{functionDefinitionId}

# Description

Deletes specific function definition through a soft-delete approach, which implies mark the function definition as deleted. Users cannot create any new instances, and no new versions added. The function definition will stay in the database, as this is a soft delete. To delete the entity completely (hard delete), please contact the Operations Team.

# Parameters

Name	Located in	Description	Required	Schema
functionDefinitionId	path	Definition id	Yes	string

# Responses

Code	Description	Schema
204	FunctionDefinition successfully marked as deleted.
404	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
5XX	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Get Function Definition Versions

# /definitions/functions/{functionDefinitionId}/versions

# Description

Retrieves all specific function definition versions.

# Parameters

Name	Located in	Description	Required	Schema
functionDefinitionId	path	Definition id	Yes	string
includeDeleted	query	Whether to return a definition that has been marked as deleted	No	-

# Responses

Code	Description	Schema
200	Success	FunctionVersions
404	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
5XX	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Get Function Definition by Version Number

# /definitions/functions/{functionDefinitionId}/versions/{version}

# Description

Retrieves a specific function definition identified by function definition id and version.

# Parameters

Name	Located in	Description	Required	Schema
functionDefinitionId	path	Definition id	Yes	string
version	path	(Partial) version number	Yes	string
includeDeleted	query	Whether to return a definition that has been marked as deleted	No	-

# Responses

Code	Description	Schema
200	Success. Retrieve object models by filter criteria.	FunctionDefinition
404	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
5XX	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

← Events Variables →