Summary
Import form documents
Description
Insert form documents into the forms collection from a user supplied JSON document.
Route
POST /json-forms/import/forms
Roles
admin
other
readonly
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| forms |
array |
yes |
Array of forms |
Copied to Clipboard
{
"forms": []
}
Copied to Clipboard
{
"type": "object",
"properties": {
"forms": {
"title": "forms",
"type": "array",
"items": {
"$ref": "formDocument#/definitions/form"
}
}
},
"required": [
"forms"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| status |
object |
Status of forms import operation |
Copied to Clipboard
{
"status": true
}
Copied to Clipboard
{
"title": "status",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"message": {
"type": "string",
"example": "2 forms imported successfully"
},
"imported": {
"type": "array",
"items": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
},
"original": {
"$ref": "formDocument#/definitions/importResultReport"
},
"created": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "formDocument#/definitions/importResultReport"
}
]
}
}
}
}
}
}
