This eThis is a documentation for ConfiForms CLOUD REST API v1
...
Search | Searches and filters ConfiForms entries based QUERY given | GET | /search/{token}/{pageId}/{formName}?q=<QUERY> Supports optional parameters:
| Where QUERY is an expression in ConfiForms Filters format | ||||
---|---|---|---|---|---|---|---|---|
Delete | Deletes ConfiForms record from the form by id (UUID) | DELETE | /delete/{token}/{pageId}/{formName}/{entryId} | User must have permissions to edit/delete the record. This means ConfiForms cloud system user (com.vertuna.confluence.plugins.confiforms) must have enough permissions to do that. | ||||
Validate | Validates parameters against the rules and field types configured by the form | GET POST | /validate/{token}/{pageId}/{formName}?<FIELDS> | fields are given in a key=value format as any HTTP request parameters | ||||
Save | Saves the parameters given as new record in ConfiForms form. Alls the rules are applied before saving according to form configuration | GET POST | /save/{token}/{pageId}/{formName}?<FIELDS> Instead of <FIELDS> parameters added to the request url query string you can use POST method and send over the JSON payload with the structure as follows:
| fields are given in a key=value format as any HTTP request parameters
Partial updates are supported. Meaning that you can supply less parameters than the record has (missing fields will not be updated). To set the field value to empty, do supply it as a parameter myfield= (where "myfield" is the name of the field you want to set the empty value for) | ||||
Get | Loads ConfiForms record by id (UUID) | GET | /get/{token}/{pageId}/{formName}/{entryId} | 404 if not found | ||||
Update | Updates ConfiForms field by query (for each record matching the query) | GET POST | /update/{token}/{pageId}/{formName}?q=<QUERY>&fv=field:value | Where QUERY is an expression in ConfiForms Filters format and "fv" is given in a field:value format, where "field" is the name of the field in ConfiForms record you want to update with "value" | ||||
Definition | Returns form configuration | GET | /definition/{token}/{pageId}/{formName} | Returns form definition (configuration) 404 if not found |
Examples
Example result returned by "Search"
...