{ "$id": "formDocument", "$ref": "#/definitions/form", "definitions": { "form": { "type": "object", "properties": { "_id": { "$ref": "#/definitions/formId" }, "created": { "type": "string", "format": "date-time", "examples": [ "2019-04-16T00:43:22.038Z" ] }, "createdBy": { "type": "string", "examples": [ "5cb08d4f16640f00182c3890" ] }, "lastUpdated": { "type": "string", "format": "date-time", "examples": [ "2019-04-16T00:43:22.038Z" ] }, "lastUpdatedBy": { "type": "string", "examples": [ "5cb08d4f16640f00182c3890" ] }, "name": { "type": "string", "examples": [ "Device Form" ] }, "tags": { "type": "array", "items": { "anyOf": [ { "type": "string", "examples": [ "5cb5252a1bbc5a00def564c1" ] }, { "type": "object" } ] } }, "description": { "anyOf": [ { "type": "string", "examples": [ "This form describes the connection information for a device." ] }, { "type": "null" } ] }, "struct": { "$ref": "formStruct" }, "schema": { "$ref": "formSchema#/definitions/container" }, "uiSchema": { "$ref": "formUISchema#/definitions/container" }, "validationSchema": { "$ref": "formValidationSchema#/definitions/validationSchema" }, "bindingSchema": { "$ref": "formBindingSchema#/definitions/bindingSchema" }, "version": { "type": "string", "examples": [ "2020.1" ] }, "id": { "$ref": "#/definitions/formId" }, "namespace": { "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/projectNamespace" } ] } }, "required": [ "created", "createdBy", "lastUpdated", "lastUpdatedBy", "name", "description", "struct", "schema", "uiSchema", "bindingSchema", "validationSchema", "version" ], "additionalProperties": false }, "formId": { "type": "string", "examples": [ "5cb5252a1bbc5a00def564c1" ] }, "formData": { "type": "object", "patternProperties": { ".*": { "anyOf": [ { "type": "object" }, { "type": "null" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "validationResponse": { "type": "object", "properties": { "status": { "type": "integer", "enum": [ 200, 404 ] }, "validation": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } } }, "message": { "type": "string", "examples": [ "Form data is valid." ] } } }, "importResultReport": { "type": "object", "properties": { "_id": { "$ref": "#/definitions/formId" }, "created": { "type": "string", "format": "date-time", "examples": [ "2019-04-16T00:43:22.038Z" ] }, "createdBy": { "type": "string", "examples": [ "5cb08d4f16640f00182c3890" ] }, "lastUpdated": { "type": "string", "format": "date-time", "examples": [ "2019-04-16T00:43:22.038Z" ] }, "lastUpdatedBy": { "type": "string", "examples": [ "5cb08d4f16640f00182c3890" ] }, "name": { "type": "string", "examples": [ "Device Form" ] }, "description": { "type": "string", "examples": [ "This form describes the connection information for a device." ] } } }, "accessControl": { "type": "object", "properties": { "read": { "type": "array", "items": { "type": "string" } }, "execute": { "type": "array", "items": { "type": "string" } }, "write": { "type": "array", "items": { "type": "string" } }, "manage": { "type": "array", "items": { "type": "string" } } } }, "projectNamespace": { "type": "object", "required": [], "properties": { "type": { "const": "project" }, "_id": { "type": "string", "examples": [ "5cb5252a1bbc5a00def564c1" ] }, "name": { "type": "string" }, "accessControl": { "$ref": "#/definitions/accessControl" } } } } }
2023.2 (latest)