Summary
Deletes a forms
Description
Deletes a previously created JSON form documents, based on a list of supplied document IDs.
Route
DELETE /json-forms/forms
Roles
admin
other
readonly
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| ids |
array |
yes |
An array of form IDs. |
Copied to Clipboard
{
"ids": [
"5cb5252a1bbc5a00def564c1",
"5cb5252a1bbc5a00def564c1",
"5cb5252a1bbc5a00def564c1",
"5cb5252a1bbc5a00def564c1",
"5cb5252a1bbc5a00def564c1"
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"ids": {
"title": "ids",
"type": "array",
"items": {
"type": "string",
"examples": [
"5cb5252a1bbc5a00def564c1"
]
}
}
},
"required": [
"ids"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| document |
object |
The status and number of delete forms. |
Copied to Clipboard
{
"status": "failure",
"n": 64646842
}
Copied to Clipboard
{
"title": "document",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"success",
"failure"
]
},
"n": {
"type": "integer"
}
}
}