For Dashboard Designers Reference AppManagement
Friday, November 11, 2022 12:54 PMAppManagement
Label: :IA_Function
Property: type: AppManagement
Inherits from: Function
Bundles actions related to managing Graphileon Apps. Graphileon Apps are packages of Functions and Triggers that, together, provide some functionality. A range of apps is available from the Graphileon server, but they can also be distributed and imported as JSON.
Function parameters
Key | Description | Default value | Possible values |
---|---|---|---|
action |
The action to perform. | string; see below | |
params |
The parameters for the given action. See below for possible values. | object; see below |
Actions
Each action
requires specific parameters. Below are the possibilities.
action |
Description | params |
---|---|---|
create |
Create an app. | App to create. * |
delete |
Delete an app. | App to delete (only id , properties.uuid or properties.iaName are used). |
fetch-list |
Fetch the list of available apps from Graphileon server. | queryLanguage : filter by query Language. Defaults to application store query language. |
fetch-app |
Get application from Graphileon server. | uuid : get app by uuid proprety. |
patch |
Patch an app. Changes the given properties only. | App to patch. |
read |
Get app details. | App to read (only id , properties.uuid or properties.iaName are used). |
read-all |
Find a list of apps. | Array of apps (only id and meta.store are used). |
read-full |
Get app details, including its nodes and relations. | App to read (only id , properties.uuid or properties.iaName are used). |
update |
Update an app. Updates all properties as provided. | App to update |
* All nodes will be connected to the App node with a CONTAINS
relation.
The id
s of nodes are only used as reference for relations.
The final id
s depend on the target database. To update existing nodes and relations, they should have a uniquely
identifying propery. This property can then be specified as idProperty
(by default uuid
).
Outgoing triggers
Type: success
Occurrence: When the requested action was performed successfully.
Additional event properties (besides the inherited properties):
Key | Description | Possible values |
---|---|---|
response |
The response from the performed action. | See below |
For each action
, the response
can be different. Below are the possibilities:
action |
response |
---|---|
create |
Created App |
read |
Requested App |
update |
Updated App |
delete |
(empty) |
import |
nodes : (object) created nodes, relations : (object) created relations * |
* The nodes and relations in the response are both objects, where the keys are the original id
s, and the values the
corresponding entities in the database (note that the final id
s may be different than the id
s specified in the input).
App data structure
The App data structure inherits from the node data structure, with some additions:
Key | Description | Possible values |
---|---|---|
local |
Whether or not the App is fetched from Graphileon server. | false only when fetched from Graphileon server. Otherwise true . |
nodes |
The nodes in the App. | Array of nodes |
relations |
The relations in the App. | Array of relations |
remoteVersion |
If App was installed from Graphileon server, this indicates the available version on the server. | string (e.g. 1.0.0 ) |