...
ConfiForms REST
...
Here is the list of REST endpoints and supported parameters for ConfiForms plugin
Both methods are supported:
- POST (for file uploads only POST)
- GET
pageId is a very important parameter and should be supplied always, as all the methods are executed when PAGE is known/defined, otherwise a NOT FOUND error is shown
...
Create entry
Code Block |
---|
http(s)://CONFLUENCE_SERVER/ajax/confiforms/rest/save.action?pageId=<PAGE_ID>&f=<FORM_NAME>&fields... |
...
Update entry
Code Block |
---|
http(s)://CONFLUENCE_SERVER/ajax/confiforms/rest/save.action?pageId=<PAGE_ID>&f=<FORM_NAME>&entryId=ID&fields... |
...
Delete entry
Code Block |
---|
http(s)://CONFLUENCE_SERVER/ajax/confiforms/delete.action?pageId=<PAGE_ID>®istrationFormName=<FORM_NAME>&entryId=<ID> |
...
Delete entries
Code Block |
---|
http(s)://CONFLUENCE_SERVER/ajax/confiforms/remove.action?pageId=<PAGE_ID>&f=<FORM_NAME>&q=<FILTER> |
...
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 |
...
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
...
Search entries
Code Block |
---|
http(s)://CONFLUENCE_SERVER/ajax/confiforms/rest/filter.action?pageId=<PAGE_ID>&f=<FORM_NAME>&q=<QUERY> |
...
Get form definition
Code Block |
---|
http(s)://CONFLUENCE_SERVER/ajax/confiforms/rest/definition.action?pageId=<PAGE_ID>&f=<FORM_NAME> |
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 |
---|
Upload file to ConfiForms field
Since ConfiForms version 1.20 you are now able to attach files to ConfiForms records via REST API
File should be encoded as BASE64 string
Code Block |
---|
http(s)://CONFLUENCE_SERVER/ajax/confiforms/rest/upload.action?pageId=<PAGE_ID>&f=<FORM_NAME>&q=<FILTER>&fv=<FIELD_NAME>:<BASE64ENCODED_STRING>&fileContentType=<CONTENT_TYPE>&fileName=<NAMEOFFILE> |
FIELD_NAME - name of the file followed by : and file contents encoded as BASE64 string
CONTENT_TYPE - file content type which you are trying to upload, expecting mime type, see https://www.sitepoint.com/web-foundations/mime-types-complete-list/
NAMEOFFILE - name of the file (will be visible as the name in attachments)
...