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": "adipisicing officia labore laborum occaecat",
    "items": [
      {
        "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": true,
        "helper": "Tooltip help message goes here",
        "pattern": "regex",
        "readOnly": false,
        "binding": false,
        "rel": "adipisicing deserunt in",
        "targetPointer": "in veniam eiusmod",
        "format": "anim aute nostrud dolor",
        "minLength": -12019452,
        "maxLength": 6545138,
        "default": "aliquip sit occaecat elit aute",
        "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": true,
        "customKey": "dolor do proident culpa quis",
        "helper": "Tooltip help message goes here",
        "pattern": "regex",
        "validation": [],
        "readOnly": false,
        "binding": true,
        "rel": "proident labore",
        "targetPointer": "reprehenderit deserunt",
        "format": "incididunt",
        "minLength": -78943535,
        "maxLength": 76348178,
        "default": "cupidatat magna officia ipsum",
        "disabled": true
      },
      {
        "nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
        "type": "boolean",
        "title": "Allow timeout",
        "description": "Is a timeout allowed to pass this step?",
        "customKey": false,
        "helper": "Tooltip help message goes here",
        "default": false,
        "enum": [
          {
            "id": "adipisicing amet elit in voluptate",
            "value": true
          }
        ],
        "readOnly": true,
        "widget": "occaecat consequat amet sit"
      },
      {
        "nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
        "type": "number",
        "title": "Retry attempts",
        "description": "The number of connection retries before timing out.",
        "placeholder": "Enter connection retry attempt count",
        "required": true,
        "customKey": "occaecat non ut ipsum adipisicing",
        "widget": "culpa amet fugiat laboris consequat",
        "helper": "Tooltip help message goes here",
        "readOnly": false,
        "minimum": null,
        "maximum": null,
        "default": -75771032.31683683,
        "disabled": true
      },
      {
        "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",
    "projectId": "dolore ut"
  },
  "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
}