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": "irure qui tempor occaecat",
"items": [
{
"nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
"type": "string",
"title": "File Upload",
"description": "Upload a file",
"helper": "Tooltip help message goes here",
"format": "data-url",
"customKey": false
},
{
"nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
"type": "nisi commodo elit velit",
"title": "Device Name",
"description": "A unique name of the target device.",
"required": false,
"customKey": "consectetur Duis pariatur dolore",
"helper": "Tooltip help message goes here",
"enum": [],
"enumNames": [],
"binding": false,
"pattern": "regex",
"rel": "mollit",
"targetPointer": "id aute adipisicing ut sit",
"method": "GET",
"sourcePointer": "/",
"sourceKeyPointer": "/name",
"labelKeyPointer": "/name",
"base": "http://www.google.com/",
"href": "api/v1/devices",
"validation": [],
"readOnly": true,
"transformation": null,
"disabled": true,
"default": "in aliqua",
"widget": "eu Ut dolore elit",
"radio": false,
"inline": false
},
{
"nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
"type": "string",
"title": "File Upload",
"description": "Upload a file",
"helper": "Tooltip help message goes here",
"format": "data-url",
"customKey": false
},
{
"nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
"type": "est consequat Excepteur id sed",
"title": "Device Name",
"description": "A unique name of the target device.",
"required": false,
"customKey": "cupidatat occaecat in ad",
"helper": "Tooltip help message goes here",
"enum": [],
"enumNames": [],
"binding": false,
"pattern": "regex",
"rel": "Duis fugiat nisi proident et",
"targetPointer": "amet eu non",
"method": "GET",
"sourcePointer": "/",
"sourceKeyPointer": "/name",
"labelKeyPointer": "/name",
"base": "http://www.google.com/",
"href": "api/v1/devices",
"readOnly": false,
"transformation": "anim Ut",
"disabled": false,
"default": [
"ad",
"magna sint",
"consectetur nostrud mollit",
"dolor adipisicing aliquip irure proident",
"nostrud"
],
"widget": "ipsum reprehenderit anim",
"radio": false,
"inline": false
}
],
"nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
"projectId": "pariatur"
},
"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
}