Here is the list of REST endpoints for ConfiForms plugin
Method / URL | |
---|---|
Create entry
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
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
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
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
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
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
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
PAGE_ID - where the ConfiForms form is configured FORM_NAME - name of ConfiForms form |