ConfiForms

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

This is the documentation for ConfiForms Server/Data Center app

However, this might also work for ConfiForms cloud and in most cases it does. But please see this page to understand the differences between server and cloud versions of the ConfiForms app.


Using ConfiForms REST API

Here is the list of REST endpoints for ConfiForms plugin

 

Method / URL

Create entry

 

http(s)://CONFLUENCE_SERVER/ajax/confiforms/rest/save.action?pageId=PAGE_ID&f=FORM_NAME&fields...
PAGE_ID - where the ConfiForms form is configured
FORM_NAME - name of ConfiForms form
fields... - fields here is a set of key-value pairs for ConfiForms form's fields you want to set (separated with '&' as HTTP parameters). For example if the form has a field with a name 'bookTitle' defined then you will need to write bookTitle=Book Title

Update entry

 

 

http(s)://CONFLUENCE_SERVER/ajax/confiforms/rest/save.action?pageId=PAGE_ID&f=FORM_NAME&entryId=ID&fields...

 

PAGE_ID - where the ConfiForms form is configured
FORM_NAME - name of ConfiForms form
ID - entity id you would like to update, if not given then a new entity is created
fields... - fields here is a set of key-value pairs for ConfiForms form's fields you want to set (separated with '&' as HTTP parameters). For example if the form has a field with a name 'bookTitle' defined then you will need to write bookTitle=Book Title

 

Delete entry

 

http(s)://CONFLUENCE_SERVER/ajax/confiforms/delete.action?storagePageId=PAGE_ID&registrationFormName=FORM_NAME&entryId=ID

 

PAGE_ID - where the ConfiForms form is configured
FORM_NAME - name of ConfiForms form
ID - entity id you would like to update, if not given then a new entity is created

Delete entries

 

http(s)://CONFLUENCE_SERVER/ajax/confiforms/remove.action?pageId=PAGE_ID&f=FORM_NAME&q=FILTER
PAGE_ID - where the ConfiForms form is configured
FORM_NAME - name of ConfiForms form
FILTER - filter to match records you want to delete. Same syntax as the filter itself uses. See Using filters section in documentation

Update specific field

 

http(s)://CONFLUENCE_SERVER/ajax/confiforms/rest/update.action?pageId=PAGE_ID&f=FORM_NAME&q=FILTER&fv=field:value
PAGE_ID - where the ConfiForms form is configured
FORM_NAME - name of ConfiForms form
FILTER - filter to match records you want to update. Same syntax as the filter itself uses. See Using filters section in documentation
fv=field:value - parameter fv shows which form's field to update and it's new value

 

Validate entry

 

http(s)://CONFLUENCE_SERVER/ajax/confiforms/rest/validate.action?pageId=PAGE_ID&f=FORM_NAME&fields...

 

This method only validates if the data could be saved

PAGE_ID - where the ConfiForms form is configured
FORM_NAME - name of ConfiForms form
fields... - fields here is a set of key-value pairs for ConfiForms form's fields you want to set (separated with '&' as HTTP parameters). For example if the form has a field with a name 'bookTitle' defined then you will need to write bookTitle=Book Title

Search entries

 

http(s)://CONFLUENCE_SERVER/ajax/confiforms/rest/filter.action?pageId=PAGE_ID&f=FORM_NAME&q=QUERY

 

PAGE_ID - where the ConfiForms form is configured
FORM_NAME - name of ConfiForms form
QUERY - search query in Lucene format, For example to search for books which have a title ('bookTitle' field on the form) set to 'Catching fire' you would need to write the following expression: &q=bookTitle:Catching fire.
Take a look at Using filters tutorial to learn more by example

Get form definition

 

http(s)://CONFLUENCE_SERVER/ajax/confiforms/rest/definition.action?pageId=PAGE_ID&f=FORM_NAME

 

PAGE_ID - where the ConfiForms form is configured
FORM_NAME - name of ConfiForms form
  • No labels