...
ConfiForms REST
...
Here is the list of REST endpoints for ConfiForms plugin
...
Create entry
| Code Block |
|---|
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
| Code Block |
|---|
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
| Code Block |
|---|
http(s)://CONFLUENCE_SERVER/ajax/confiforms/delete.action?storagePageId=PAGE_ID®istrationFormName=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 delete
...
Delete entries
| Code Block |
|---|
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
| Code Block |
|---|
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
| Code Block |
|---|
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
| Code Block |
|---|
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.
APIs for Server/Data Center version. If you are looking for integrations with ConfiForms for Confluence cloud then please refer to REST API for ConfiForms CLOUD
We maintain 2 versions of the API. Version 0 and Version 1 (available since ConfiForms 2.18 and supports Confluence PAT tokens as authentication method (https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html) and is also accessible through the REST API browser https://developer.atlassian.com/server/framework/atlassian-sdk/using-the-rest-api-browser/).
| Children Display |
|---|
Get form definition
| Code Block |
|---|
http(s)://CONFLUENCE_SERVER/ajax/confiforms/rest/definition.action?pageId=PAGE_ID&f=FORM_NAME |
PAGE_ID - where the ConfiForms form is configured
...