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": "consectetur",
"items": [
{
"nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
"type": "boolean",
"title": "Allow timeout",
"description": "Is a timeout allowed to pass this step?",
"customKey": "voluptate",
"helper": "Tooltip help message goes here",
"default": false,
"enum": [
{
"id": "officia",
"value": true
},
{
"id": "dolor Duis aliqua consequat",
"value": false
},
{
"id": "in et quis labore",
"value": false
},
{
"id": "et ad",
"value": false
},
{
"id": "ad",
"value": true
}
],
"readOnly": true,
"widget": "magna adipisicing id incididunt culpa"
},
{
"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": "dolor aute elit incididunt",
"widget": "et",
"helper": "Tooltip help message goes here",
"pattern": "regex",
"readOnly": false,
"format": "eiusmod do reprehenderit dolor aute",
"minLength": 24664516,
"maxLength": -68042169,
"default": "exercitation proident nulla dolor",
"disabled": 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": "qui consequat laborum sed pariatur",
"widget": "quis officia",
"helper": "Tooltip help message goes here",
"pattern": "regex",
"readOnly": false,
"format": "anim",
"minLength": 62117258,
"maxLength": -32511252,
"default": "consequat cupidatat",
"disabled": false
},
{
"nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
"type": "string",
"title": "Device Name",
"description": "A unique name of the target device.",
"placeholder": "Enter the device's name",
"required": false,
"customKey": "dolore",
"widget": "sint Duis consequat in",
"helper": "Tooltip help message goes here",
"pattern": "regex",
"readOnly": false,
"format": "deserunt cupidatat",
"minLength": 25772547,
"maxLength": -54700429,
"default": "commodo qui et",
"disabled": false
}
],
"nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
"projectId": "enim non proident ad reprehenderit"
},
"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
}