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"
| Name | URL | Http Method | Description | Extra parameters |
|---|---|---|---|---|
| Create ConfiForms Entry | /rest/confiforms/1.0/create/{pageId}/{formName} | POST | ||
| Update ConfiForms Entry | /rest/confiforms/1.0/update/{pageId}/{formName}/{id} | POST | ||
| Validate ConfiForms Entry | /rest/confiforms/1.0/validate/{pageId}/{formName} /rest/confiforms/1.0/validate/{pageId}/{formName}/{id} | POST | ||
| Get form definition | /rest/confiforms/1.0/definition/{pageId}/{formName} | GET | ||
| Get ConfiForms Entry by ID | /rest/confiforms/1.0/get/{pageId}/{formName}/{id} | GET | ||
| Search ConfiForms Entries by filter | /rest/confiforms/1.0/search/{pageId}/{formName} /rest/confiforms/1.0/search/{pageId}/{formName}/{filter} | GET | ||
Delete ConfiForms Entry by ID | /rest/confiforms/1.0/deleteById/{pageId}/{formName}/{id} | DELETE | ||
| Delete ConfiForms Entries by filter | /rest/confiforms/1.0/deleteByFilter/{pageId}/{formName}/{filter} | DELETE | ||
| Update ConfiForms Field value by filter | /rest/confiforms/1.0/updateFieldValue/{pageId}/{formName} /rest/confiforms/1.0/updateFieldValue/{pageId}/{formName}/{filter} | PUT |