Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Searches and filters ConfiForms entries based QUERY givenGET/search/{token}/{pageId}/{formName}?q=<QUERY>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>

fields are given in a key=value format as any HTTP request parameters

Info

When you need to update the record the ID shall be given as "entryId" parameter

When no entryId parameter found or the record by given entryId could not be found then a new record will be created

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

myparam=

or

myparam=[empty]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:valueWhere 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"

...