Create a JSON form

curl -X POST http://localhost:3000/json-forms/forms \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{}'

{
  "created": "2019-04-16T00:43:22.038Z",
  "createdBy": "5cb08d4f16640f00182c3890",
  "lastUpdated": "2019-04-16T00:43:22.038Z",
  "lastUpdatedBy": "5cb08d4f16640f00182c3890",
  "name": "Device Form",
  "description": "This form describes the connection information for a device.",
  "struct": {
    "type": "string",
    "items": [
      {
        "nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
        "type": "string",
        "title": "Connection Information",
        "required": true,
        "options": {},
        "description": "This section describes the connection information for a device.",
        "helper": "Tooltip help message goes here",
        "items": [
          null
        ],
        "collapsed": true,
        "readOnly": true,
        "schemaOption": true,
        "combinationType": "string",
        "widget": "string",
        "uniqueItems": true,
        "minItems": 1.1,
        "maxItems": 1.1,
        "customKey": "string"
      }
    ],
    "nodeId": "kdWO-g4oS3GkzrbqDqCZUw",
    "projectId": "string"
  },
  "schema": {
    "type": "string",
    "title": "Connection Information",
    "_id": "string",
    "uniqueItems": true,
    "minItems": 1.1,
    "maxItems": 1.1,
    "description": "This form describes the connection information for a device.",
    "required": [
      "kdWO-g4oS3GkzrbqDqCZUw"
    ],
    "readOnly": true,
    "options": {},
    "properties": {},
    "items": {
      "_id": "string",
      "type": "string",
      "required": [
        "string"
      ],
      "readOnly": true,
      "properties": {}
    },
    "anyOf": [
      {}
    ],
    "oneOf": [
      {}
    ],
    "allOf": [
      {}
    ]
  },
  "uiSchema": {},
  "validationSchema": {},
  "bindingSchema": {},
  "version": "2020.1",
  "_id": "5cb5252a1bbc5a00def564c1",
  "tags": [
    "5cb5252a1bbc5a00def564c1"
  ],
  "id": "5cb5252a1bbc5a00def564c1"
}

Creates a new JSON form document with a unique name.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

request body

namestringOptional

descriptionstringOptional

structobjectOptional

schemaobjectOptional

uiSchemaobjectOptional

bindingSchemaobjectOptional

validationSchemaobjectOptional

Response

document that was created from the request

createdstringformat: "date-time"

createdBystring

lastUpdatedstringformat: "date-time"

lastUpdatedBystring

namestring

descriptionstring or null

structobject

schemaobject

uiSchemaobject

validationSchemaobject

bindingSchemaobject

versionstring

_idstring

tagslist of strings or maps from strings to any

idstring

namespaceobject or null

Errors

500

Internal Server Error