InformationBlock

Properties

Block Property	Definition	Example Input	Status
type	A block type which can display a notification or a progress bar.	InformationBlock (Can't be changed).
tag	Unique name for the logic block.	wait_for_approval.
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
stop Propagation	End processing here, don't pass control to the next block.	Checked or Unchecked.

RefreshEvents are used to refreshing the UI, instead of "dependencies" property.

UI Properties

UI Property	Definition
Type	Select the type of UI element for notifications. It can be either a LOADER (progress bar) or TEXT box
Title	Provides the Loader or Text box a title.
Description	Provides the Loader or Text box a description.

Events

Property Name	Name in JSON	Property Value	Value in JSON	Description
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.

API Parameters

GET /policies/{policyId}/blocks/{uuid}

Path Parameters

Name	Type	Description
policyId*	String	Policy ID
uuid*	String	Block UUID

200: OK Successful Operation

{
  "uiMetaData": {
    "description": "The page will refresh automatically once the application is approved.",
    "type": "text",
    "title": "Submitted for Approval"
  }
}