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.
This API is available from ConfiForms version 2.18
- supports Confluence PAT tokens as authentication method (https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html)
- accessible through the https://developer.atlassian.com/server/framework/atlassian-sdk/using-the-rest-api-browser/) Search for confiforms in the APIs search box
ConfiForms API prefix is "/rest/confiforms/1.0"
Each API call expects you to provide at least the information about the page where the form is located (pageId - as number, pointing at Confluence page by ID - https://confluence.atlassian.com/confkb/how-to-get-confluence-page-id-648380445.html) and the form name (the name of the form you have given in ConfiForms Form Definition macro for the form).
See extra parameters that can be supplied as a request parameters (or as a POST/PUT parameters) to the call
| Name | URL | Http Method | Description | Extra parameters |
|---|---|---|---|---|
| Create ConfiForms Entry | /rest/confiforms/1.0/create/{pageId}/{formName} | POST | Creates ConfiForms entry in the form | |
| Update ConfiForms Entry | /rest/confiforms/1.0/update/{pageId}/{formName}/{id} | POST | Updates existing ConfiForms entry in the form (via {id} parameter) | |
| Validate ConfiForms Entry | /rest/confiforms/1.0/validate/{pageId}/{formName} /rest/confiforms/1.0/validate/{pageId}/{formName}/{id} | POST | Validates given data against the form's rules. Basically does the same as create/update, but does not do the actual "save" | |
| Get form definition | /rest/confiforms/1.0/definition/{pageId}/{formName} | GET | Returns form configuration (definition) | |
| Get ConfiForms Entry by ID | /rest/confiforms/1.0/get/{pageId}/{formName}/{id} | GET | Returns ConfiForms entry data in JSON format by given ID (UUID) in a given form | |
| Search ConfiForms Entries by filter | /rest/confiforms/1.0/search/{pageId}/{formName} /rest/confiforms/1.0/search/{pageId}/{formName}/{filter} | GET | Searches for ConfiForms entries in a form, based on the given filter/query (ConfiForms Filters). When filter is not specified all the entries are returned | |
Delete ConfiForms Entry by ID | /rest/confiforms/1.0/deleteById/{pageId}/{formName}/{id} | DELETE | Deletes ConfiForms entry by givenID (UUID) | |
| Delete ConfiForms Entries by filter | /rest/confiforms/1.0/deleteByFilter/{pageId}/{formName}/{filter} | DELETE | Deletes ConfiForms entry by given filter/query (ConfiForms Filters) | |
| Update ConfiForms Field value by filter | /rest/confiforms/1.0/updateFieldValue/{pageId}/{formName} /rest/confiforms/1.0/updateFieldValue/{pageId}/{formName}/{filter} | PUT | Updates specific field with a given value in the form, by filter (ConfiForms Filters). When filter is not specified the update is executed on all the entries |