InterfaceActionBlock

Properties

Block Property	Definition	Example Input	Status
type	A block to create custom actions.	InterfaceActionBlock (Can't be changed).
tag	Unique name for the logic block.	download_config_btn.
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.
stop Propagation	End processing here, don't pass control to the next block.	Checked or unchecked.
type	Specific the type of action workflow action block.	Current options are: SELECTOR (select an action) and DOWNLOAD (download files)

UI Properties

UI Property	Definition	Status
Title	Provides the title.
Field	Provides the field name. Action workflow type needs to be SELECTOR.
Option Name	Provides the name of the option. Action workflow type needs to be SELECTOR.
Option Value	Provides the value of the option. Action workflow type needs to be SELECTOR.
UI Class	Button style. Action workflow type needs to be SELECTOR.
Button Content	Provide the content for the button. Action workflow type needs to be DOWNLOAD.
Schema	Pre-configured schemas relevant for download to be selected from the drop down of available schemas in your Guardian instance. Only needed in the reference implementation of the Guardian because of the IoT Simulator that is generating MRV data. Action workflow type needs to be DOWNLOAD.
Target URL	Set the target URL where the file should be stored. Only needed in the reference implementation of the Guardian because of the IoT Simulator that is generating MRV data. Action workflow type needs to be DOWNLOAD.
User	Action workflow type needs to be SELECTOR. It determines who will get update actions (Dependencies property in other blocks) and which user will be used in next Blocks. It can be "Current" or "Owner". "Current" - user under which the action is performed. "Owner" - document owner.
Option Tag	Name of the dynamic events

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

{
  "id": "448ff538-1c3b-45eb-a310-9414ae223b81",
  "blockType": "interfaceActionBlock",
  "type": "dropdown",
  "uiMetaData": {
    "options": [],
    "content": "VVB"
  },
  "name": "document.credentialSubject.0.field0",
  "value": "group",
  "field": "assignedToGroup",
  "options": [
    {
      "name": "1",
      "value": "6b3efd88-037c-4335-a4d1-02776e23973c"
    }
  ]
}

POST /policies/{policyId}/blocks/{uuid}

Path Parameters

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

Request Body

Name	Type	Description
document*	VC	VC Document