InterfaceContainerBlock
InterfaceContainerBlock
Properties
type
A block which contains and organizes other blocks.
InterfaceContainerBlock (Can't be changed).
tag
Unique name for the logic block.
installer_header.
permissions
Which entity has rights to interact at this part of the workflow.
Installer.
defaultActive
Shows whether this block is active at this time and whether it needs to be shown.
Checked or unchecked.
dependencies
Establish workflow dependancies that need to be completed prior.
Select the appropriate block from the dropdown.
Deprecated
RefreshEvents are used to refreshing the UI, instead of "dependencies" property.
UI Properties
Title
Provides a title for the UI element.
Type BLANK
Does not contain any frame, will render all child elements one after the other.
Type TABS
A container which has a tab for each of the child element. It will render the first child element as type "blank".
Events
Event Type
-
Input Event
Output Event
-
Type of the event - determines whether this is ingress or egress event for the current block.
Source
"source"
Block tag(string)
"block_tag"
The block which initiates the event.
Target
"target"
Block tag(string)
"block_tag"
The block which receives the event.
Output Event
"output"
Event name(string)
"event_name"
Action or issue that caused the event.
Input Event
"input"
Event name(string)
"event_name"
Action which will be triggered by the event.
Event Actor
"actor"
Event Initiator
Document Owner
Document Issuer
""
"owner"
"issuer"
Allows to transfer control of the block (execution context) to another user. Empty field leaves control at the Event Initiator.
Disabled
"disabled"
True/False
true/false
Allows to disable the event without deleting it.
To know more information about events, please look at events.md.
API Parameters
GET
blocktype :
Path Parameters
id*
String
Block ID
blockType*
String
Block Type
blocks*
array
Contained blocks
uiMetadata*
String
{}
Last updated