Page tree
Skip to end of metadata
Go to start of metadata

This is the documentation for ConfiForms Server/Data Center app


This API is available from ConfiForms version 2.18


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

For example:

/rest/confiforms/1.0/deleteById/123456/myform/deae188e-a6a2-409c-b197-b46332df331f?skipIFTTTExecute=true

Multiple parameters should be given by using & as a parameters separator, for example

/rest/confiforms/1.0/search/123456/myform/mytext:hello?sort=created ASC&limit=5


When you get "XSRF check failed" as a response from the API

see this https://confluence.atlassian.com/kb/cross-site-request-forgery-csrf-protection-changes-in-atlassian-rest-779294918.html on how to get it properly resolved or add the X-Atlassian-Token into your request headers (https://confluence.atlassian.com/cloudkb/xsrf-check-failed-when-calling-cloud-apis-826874382.html)

X-Atlassian-Token: no-check


For uploading the files with ConfiForms API please see this ConfiForms Server REST API version 0#UploadfiletoConfiFormsfield, as version 1 does not have this API endpoint yet

List of APIs


NameURLHttp MethodDescriptionExtra parameters

Create ConfiForms Entry

/rest/confiforms/1.0/create/{pageId}/{formName}POSTCreates ConfiForms entry in the form

You will need to POST the following JSON structure to this REST API endpoint

{
  "fields": {
    "mytextfield":"field value",
    "datefield1": "2020-04-25",
    "ready": true,
    "mydropdown": 2
  }
}

Where each property name in the "fields" JSON object matches the field name in your ConfiForms Form, 

Values are expected to be in the internal format

Values for Date/DateTime could be given in the same format as your Confluence uses or as timestamp

  • skipIFTTTExecute - true/false, to skip IFTTT executions (if there are any that should be executed onCreated event, you can switch them off)

Update ConfiForms Entry

/rest/confiforms/1.0/update/{pageId}/{formName}/{id}POSTUpdates existing ConfiForms entry in the form (via {id} parameter)

Same as for create method, but with given UUID for the entry to perform an update

  • skipIFTTTExecute - true/false, to skip IFTTT executions (if there are any that should be executed onModified event, you can switch them off)
  • _skipIfParamIsEmpty - true/false (false by default). Setting this parameter with value "true" to your request helps to bypass setting all the fields - useful when you have field definitions with validations and you dont want to set / reset those with your REST API call (and want ConfiForms to lookup existing values)

Validate ConfiForms Entry

/rest/confiforms/1.0/validate/{pageId}/{formName}

/rest/confiforms/1.0/validate/{pageId}/{formName}/{id}

POSTValidates given data against the form's rules. Basically does the same as create/update, but does not do the actual "save"Same JSON structure shall be given as "create" method

Get form definition

/rest/confiforms/1.0/definition/{pageId}/{formName}GETReturns form configuration (definition)

Get ConfiForms Entry by ID

/rest/confiforms/1.0/get/{pageId}/{formName}/{id}GETReturns ConfiForms entry data in JSON format by given ID (UUID) in a given form
  • flatten - true/false - you can flatten multi-value fields (This will result in MULTIPLE rows returned!)
  • fields - used to decorate the returned values with Virtual functions. Use "," to separate field decoration instructions.
  • limitFields - comma separated list of field names to return in the response (helps to reduce the amount of data travelling between your service and ConfiForms). Please be aware that "metadata" fields are always returned - see Documentation
  • append - you can set this as "true", in your query parameters which instructs the parameter "fields" to add the transformed (decorated) fields into the record. This allows you to have multiple representations of the field in the output

Search ConfiForms Entries by filter

/rest/confiforms/1.0/search/{pageId}/{formName}

/rest/confiforms/1.0/search/{pageId}/{formName}/{filter}

GETSearches for ConfiForms entries in a form, based on the given filter/query (ConfiForms Filters). When filter is not specified all the entries are returned

Same additional parameters as in "Get ConfiForms Entry by ID" method

Additionally you can pass the following parameters:

  • limit - to limit the number of records returned (number) 
  • sortto sort the results set Sorting in ConfiForms

Delete ConfiForms Entry by ID

/rest/confiforms/1.0/deleteById/{pageId}/{formName}/{id}DELETEDeletes ConfiForms entry by givenID (UUID)
  • skipIFTTTExecute - true/false, to skip IFTTT executions (if there are any that should be executed onDeleted event, you can switch them off)

Delete ConfiForms Entries by filter

/rest/confiforms/1.0/deleteByFilter/{pageId}/{formName}/{filter}DELETEDeletes ConfiForms entry by given filter/query (ConfiForms Filters)
  • skipIFTTTExecute - true/false, to skip IFTTT executions (if there are any that should be executed onDeleted event, you can switch them off)

Update ConfiForms Field value by filter

/rest/confiforms/1.0/updateFieldValue/{pageId}/{formName}

/rest/confiforms/1.0/updateFieldValue/{pageId}/{formName}/{filter}

PUTUpdates 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
  • skipIFTTTExecute - true/false, to skip IFTTT executions (if there are any that should be executed onModified event, you can switch them off)
  • fv  - abbreviation for "field-value" and is expected to have the following structure:  fv=myfield:somevalue. Which will be translated to - update ConfiForms records, and the "myfield" in particular with "somevalue"

Export RAW dataset

SINCE 2.18.7

/rest/confiforms/1.0/raw/{pageId}/{formName}GETExports ConfiForms RAW dataset (which can be used with Migration and Recovery API)
  • No labels