Download OpenAPI specification:Download
The flow service implements the user defined GroupAlarm flow logic
Creates a flow with the passed parameters
description | string |
object (FlowFunction) | |
id | integer <int64> |
Array of objects (InheritParameterConfiguration) [ items ] | |
isActive | boolean |
isInheritable | boolean |
isValid | boolean |
name | string |
organizationID | integer <int64> |
Array of objects (InheritParameterConfiguration) [ items ] | |
parentID | integer <int64> |
validationError | string |
{- "description": "string",
- "graph": {
- "children": [
- { }
], - "functionID": "string",
- "id": 0,
- "name": "string",
- "parameters": {
- "dynamicArrayFields": {
- "property1": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}, - "property2": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}
}, - "dynamicFields": {
- "property1": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}, - "property2": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}
}, - "staticFields": {
- "property1": { },
- "property2": { }
}
}, - "registryFunction": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "followerAmount": 0,
- "icon": "string",
- "id": "string",
- "inputEntity": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "fields": [
- {
- "id": "string",
- "isArray": true,
- "name": "string",
- "path": "string",
- "required": true
}
], - "id": "string",
- "name": "string"
}, - "inputEntityID": "string",
- "name": "string",
- "outputEntity": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "fields": [
- {
- "id": "string",
- "isArray": true,
- "name": "string",
- "path": "string",
- "required": true
}
], - "id": "string",
- "name": "string"
}, - "outputEntityID": "string",
- "type": "string"
}
}, - "id": 0,
- "inheritConfiguration": [
- {
- "flowFunctionID": 0,
- "parameterName": "string",
- "value": { }
}
], - "isActive": true,
- "isInheritable": true,
- "isValid": true,
- "name": "string",
- "organizationID": 0,
- "parentConfiguration": [
- {
- "flowFunctionID": 0,
- "parameterName": "string",
- "value": { }
}
], - "parentID": 0,
- "validationError": "string"
}
{- "description": "string",
- "graph": {
- "children": [
- { }
], - "functionID": "string",
- "id": 0,
- "name": "string",
- "parameters": {
- "dynamicArrayFields": {
- "property1": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}, - "property2": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}
}, - "dynamicFields": {
- "property1": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}, - "property2": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}
}, - "staticFields": {
- "property1": { },
- "property2": { }
}
}, - "registryFunction": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "followerAmount": 0,
- "icon": "string",
- "id": "string",
- "inputEntity": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "fields": [
- {
- "id": "string",
- "isArray": true,
- "name": "string",
- "path": "string",
- "required": true
}
], - "id": "string",
- "name": "string"
}, - "inputEntityID": "string",
- "name": "string",
- "outputEntity": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "fields": [
- {
- "id": "string",
- "isArray": true,
- "name": "string",
- "path": "string",
- "required": true
}
], - "id": "string",
- "name": "string"
}, - "outputEntityID": "string",
- "type": "string"
}
}, - "id": 0,
- "inheritConfiguration": [
- {
- "flowFunctionID": 0,
- "parameterName": "string",
- "value": { }
}
], - "isActive": true,
- "isInheritable": true,
- "isValid": true,
- "name": "string",
- "organizationID": 0,
- "parentConfiguration": [
- {
- "flowFunctionID": 0,
- "parameterName": "string",
- "value": { }
}
], - "parentID": 0,
- "validationError": "string"
}
{- "description": "string",
- "graph": {
- "children": [
- { }
], - "functionID": "string",
- "id": 0,
- "name": "string",
- "parameters": {
- "dynamicArrayFields": {
- "property1": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}, - "property2": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}
}, - "dynamicFields": {
- "property1": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}, - "property2": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}
}, - "staticFields": {
- "property1": { },
- "property2": { }
}
}, - "registryFunction": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "followerAmount": 0,
- "icon": "string",
- "id": "string",
- "inputEntity": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "fields": [
- {
- "id": "string",
- "isArray": true,
- "name": "string",
- "path": "string",
- "required": true
}
], - "id": "string",
- "name": "string"
}, - "inputEntityID": "string",
- "name": "string",
- "outputEntity": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "fields": [
- {
- "id": "string",
- "isArray": true,
- "name": "string",
- "path": "string",
- "required": true
}
], - "id": "string",
- "name": "string"
}, - "outputEntityID": "string",
- "type": "string"
}
}, - "id": 0,
- "inheritConfiguration": [
- {
- "flowFunctionID": 0,
- "parameterName": "string",
- "value": { }
}
], - "isActive": true,
- "isInheritable": true,
- "isValid": true,
- "name": "string",
- "organizationID": 0,
- "parentConfiguration": [
- {
- "flowFunctionID": 0,
- "parameterName": "string",
- "value": { }
}
], - "parentID": 0,
- "validationError": "string"
}
Updates a flow with the passed parameters
flowID required | integer |
description | string |
object (FlowFunction) | |
id | integer <int64> |
Array of objects (InheritParameterConfiguration) [ items ] | |
isActive | boolean |
isInheritable | boolean |
isValid | boolean |
name | string |
organizationID | integer <int64> |
Array of objects (InheritParameterConfiguration) [ items ] | |
parentID | integer <int64> |
validationError | string |
{- "description": "string",
- "graph": {
- "children": [
- { }
], - "functionID": "string",
- "id": 0,
- "name": "string",
- "parameters": {
- "dynamicArrayFields": {
- "property1": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}, - "property2": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}
}, - "dynamicFields": {
- "property1": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}, - "property2": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}
}, - "staticFields": {
- "property1": { },
- "property2": { }
}
}, - "registryFunction": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "followerAmount": 0,
- "icon": "string",
- "id": "string",
- "inputEntity": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "fields": [
- {
- "id": "string",
- "isArray": true,
- "name": "string",
- "path": "string",
- "required": true
}
], - "id": "string",
- "name": "string"
}, - "inputEntityID": "string",
- "name": "string",
- "outputEntity": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "fields": [
- {
- "id": "string",
- "isArray": true,
- "name": "string",
- "path": "string",
- "required": true
}
], - "id": "string",
- "name": "string"
}, - "outputEntityID": "string",
- "type": "string"
}
}, - "id": 0,
- "inheritConfiguration": [
- {
- "flowFunctionID": 0,
- "parameterName": "string",
- "value": { }
}
], - "isActive": true,
- "isInheritable": true,
- "isValid": true,
- "name": "string",
- "organizationID": 0,
- "parentConfiguration": [
- {
- "flowFunctionID": 0,
- "parameterName": "string",
- "value": { }
}
], - "parentID": 0,
- "validationError": "string"
}
Returns the inherit flows as paginated list
flowID required | integer |
{- "flows": [
- {
- "description": "string",
- "graph": {
- "children": [
- { }
], - "functionID": "string",
- "id": 0,
- "name": "string",
- "parameters": {
- "dynamicArrayFields": {
- "property1": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}, - "property2": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}
}, - "dynamicFields": {
- "property1": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}, - "property2": {
- "inputFunctionID": 0,
- "inputPath": "string",
- "useFileContent": true
}
}, - "staticFields": {
- "property1": { },
- "property2": { }
}
}, - "registryFunction": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "followerAmount": 0,
- "icon": "string",
- "id": "string",
- "inputEntity": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "fields": [
- {
- "id": "string",
- "isArray": true,
- "name": "string",
- "path": "string",
- "required": true
}
], - "id": "string",
- "name": "string"
}, - "inputEntityID": "string",
- "name": "string",
- "outputEntity": {
- "categoryID": "string",
- "categoryName": "string",
- "description": "string",
- "fields": [
- {
- "id": "string",
- "isArray": true,
- "name": "string",
- "path": "string",
- "required": true
}
], - "id": "string",
- "name": "string"
}, - "outputEntityID": "string",
- "type": "string"
}
}, - "id": 0,
- "inheritConfiguration": [
- {
- "flowFunctionID": 0,
- "parameterName": "string",
- "value": { }
}
], - "isActive": true,