Summary
Creates a Json Form
Description
Creates a new JSON form document with a unique name.
Route
POST /json-forms/forms
Roles
admin
other
readonly
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| name |
string |
yes |
Unique name of the JSON form |
| description |
string |
yes |
Short description of the JSON form |
| struct |
object |
yes |
Array structure of the form |
| schema |
object |
yes |
JSON schema of the form |
| uiSchema |
object |
yes |
UI schema of the form |
| bindingSchema |
object |
yes |
Binding schema of the form |
| validationSchema |
object |
yes |
Validation schema of the form |
Copied to Clipboard
{
"name": "Device Form",
"description": "This form describes the connection information for a device.",
"struct": {
"type": "deserunt",
"items": [
{
"nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
"type": "string",
"title": "File Upload",
"description": "Upload a file",
"helper": "Tooltip help message goes here",
"format": "data-url",
"customKey": true
},
{
"nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
"type": "string",
"title": "Device Name",
"description": "A unique name of the target device.",
"placeholder": "Enter the device's name",
"required": true,
"customKey": "mollit ullamco Duis",
"widget": "ex consectetur id",
"helper": "Tooltip help message goes here",
"pattern": "regex",
"validation": [],
"readOnly": true,
"format": "ad proident in",
"minLength": -37423997,
"maxLength": -68603781,
"default": "quis",
"disabled": false
},
{
"nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
"type": "boolean",
"title": "Allow timeout",
"description": "Is a timeout allowed to pass this step?",
"customKey": "officia ut aute do irure",
"helper": "Tooltip help message goes here",
"default": false,
"enum": [
{
"id": "labore velit minim",
"value": true
}
],
"readOnly": true,
"widget": "elit magna qui sed veniam"
}
],
"nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
"projectId": "dolore in ut eiusmod tempor"
},
"schema": {
"title": "schema"
},
"uiSchema": {
"title": "uiSchema"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"name": {
"title": "name",
"type": "string",
"examples": [
"Device Form"
]
},
"description": {
"title": "description",
"type": "string",
"examples": [
"This form describes the connection information for a device."
]
},
"struct": {
"title": "struct",
"$ref": "formStruct"
},
"schema": {
"title": "schema",
"$ref": "formSchema#/definitions/container"
},
"uiSchema": {
"title": "uiSchema",
"$ref": "formUISchema#/definitions/container"
},
"bindingSchema": {
"title": "bindingSchema",
"$ref": "formBindingSchema#/definitions/bindingSchema"
},
"validationSchema": {
"title": "validationSchema",
"$ref": "formValidationSchema#/definitions/validationSchema"
}
},
"required": [
"name",
"description",
"struct",
"schema",
"uiSchema",
"bindingSchema",
"validationSchema"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| document |
object |
document that was created from the request |
Copied to Clipboard
{
"document": true
}
