Allow the user to select a single option from a list of options displayed as buttons and also optionally enter notes and add attachments.
Property | Required | Type | Default | Description |
---|---|---|---|---|
type | Yes | string | 'compliance' | The type of Form Element. |
name | Yes | string | The key that will be assigned a value in the submission data when the form is submitted. | |
label | Yes | string | Display text presented to the user above the input by default. | |
hint | No | string | A hint triggered by an icon tooltip to be displayed when hovering beside the element label. | |
defaultValue | Yes | string | The identifier of an option to be selected when the form is opened. | |
required | Yes | boolean | false | Determine if this element requires an option to be selected (true ) or not (false ). |
readOnly | Yes | boolean | false | Determine if this selected option be changed by the user (false ) or not (true ). |
storageType | no | string | How the media uploaded by a user will be stored: private , public , legacy |
Compliance element also inherits the properties of the following:
Example Element
{
"id": "b1311ae0-6bb7-11e9-a923-1681be663d3e",
"type": "compliance",
"name": "result",
"label": "How did it go?",
"storageType": "private",
"defaultValue": "954af543-f500-4476-9403-f2ebc6c2260e",
"required": true,
"readOnly": false,
"options": [
{
"id": "954af543-f500-4476-9403-f2ebc6c2260e",
"value": "pass",
"label": "Pass",
"colour": "#43a047"
},
{
"id": "51a282e8-4134-4d69-a18a-10440d5f4e12",
"value": "fail",
"label": "Fail",
"colour": "#f44336"
},
{
"id": "cf61d95f-658c-409f-b57e-d9c74d0fb9d1",
"value": "n/a",
"label": "N/A",
"colour": "#212121"
}
]
}
Example Submission Data
Private/Public Storage
{
"submission": {
"[element.name]": {
"value": "pass",
"notes": "This is why it passed",
"files": [
{
"s3": {
"region": "ap-southeast-2",
"bucket": "customer.forms.oneblink.io",
"key": "submissions/1/attachments/44cdee6f-edbd-4620-aaf5-df25ce976e43"
},
"url": "https://auth-api.blinkm.io/submissions/1/attachments/44cdee6f-edbd-4620-aaf5-df25ce976e43",
"contentType": "image/png",
"fileName": "dot.png",
"id": "44cdee6f-edbd-4620-aaf5-df25ce976e43",
"isPrivate": true
}
]
}
}
}
Legacy Storage (Deprecated)
{
"submission": {
"[element.name]": {
"value": "pass",
"notes": "This is why it passed",
"files": [
{
"fileName": "dot.png",
"data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAMAAAADCAYAAABWKLW/AAAAIElEQVQYV2NkYGBoYGBgqGdgYGhkZGBg+M8ABSAOXAYATFcEA8STCz8AAAAASUVORK5CYII="
}
]
}
}
}