WorkflowInfoGraphNode¶
Example Json Object
1{
2 "state": {
3 "id": "string",
4 "name": "string",
5 "captionKey": "string",
6 "latestStateHistoryFailureMessage": "string",
7 "latestStateHistoryWarningMessage": "string",
8 "initial": true,
9 "transitionState": true,
10 "caption": "string",
11 "final": true
12 },
13 "objectType": "string",
14 "nodeInfo": "string",
15 "type": "INPUT",
16 "sourcePosition": "BOTTOM",
17 "targetPosition": "BOTTOM",
18 "customLayout": [
19 {
20 "position": "BOTTOM"
21 }
22 ],
23 "xcoordinate": 0,
24 "ycoordinate": 0,
25 "startStateNode": true,
26 "endStateNode": true,
27 "transitionStateNode": true,
28 "caption": "string"
29}
📄 Description: Data structure representing a node within a workflow graph, encapsulating essential information about the node’s role, connections, and status to facilitate effective process management and optimization.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
state |
false |
none |
Represents the current status of the workflow node, indicating its progress within the overall process. |
|
objectType |
string |
false |
none |
Type of the object |
nodeInfo |
string |
false |
none |
String representation of the node information within the workflow graph, facilitating the tracking and management of workflow processes. |
type |
string |
false |
none |
Type of the resource |
sourcePosition |
string |
false |
none |
Indicates the origin of the position within the workflow, providing context for its role in the overall process. |
targetPosition |
string |
false |
none |
Specifies the desired position within the workflow for effective task allocation and process management. |
customLayout |
false |
none |
An array of custom layout configurations that define the visual arrangement of workflow nodes within the application. |
|
xcoordinate |
integer(int32) |
false |
none |
Represents the horizontal position of a node within the workflow graph, facilitating the visualization and organization of process flows. |
ycoordinate |
integer(int32) |
false |
none |
Represents the vertical position of a node within the workflow graph, facilitating the visual organization and navigation of workflow processes. |
startStateNode |
boolean |
false |
none |
Indicates whether the node serves as the starting point in the workflow process, facilitating the identification of the initial step in the operational sequence. |
endStateNode |
boolean |
false |
none |
Indicates whether the current node in the workflow represents an end state, facilitating the identification of workflow completion points. |
transitionStateNode |
boolean |
false |
none |
Indicates whether the workflow node is in a transitional state, facilitating the management of process flows within the system. |
caption |
string |
false |
none |
Descriptive text associated with the workflow node, providing context and clarity for users navigating the workflow process. |
Enumerated Values
Attribute |
Value |
|---|---|
sourcePosition |
BOTTOM, LEFT, RIGHT, TOP |
targetPosition |
BOTTOM, LEFT, RIGHT, TOP |
type |
CUSTOM, DEFAULT, INPUT, OUTPUT |