ConfiForms Server REST API version 1

POST

POST with  multipart/form-data

(from version 2.27)

Content-Type:application/json

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

SINCE 3.14.2

As the multipart/form-data requests are now get blocked in recent versions of ConfiForms and the suggested way is to send the file as a bas64 encoded contents

{
  "fields": {
    ...
    "myfile": {
      "fileName": "",
      "fileContentType" : "see https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types/Common_types",
      "fileContent" : "BASE64 encoded content here"
    }
  }
}

 Can also accept an array of files

{
  "fields": {
    ...
    "myfile": [
      {
      "fileName": "",
      "fileContentType" : "see https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types/Common_types",
      "fileContent" : "BASE64 encoded content here"
     }, 
     {
      "fileName": "",
      "fileContentType" : "see https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types/Common_types",
      "fileContent" : "BASE64 encoded content here"
    }
    ]
  }
}

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)
• SINCE 3.5.0 _debug - could give you statistics on IFTTTs being executed and the invocation log 

Same JSON structure shall be given as with a "create" method

SINCE 3.5.0

• lazy - true/false, let's you request form definition with or without values for external fields (smart fields, db fields, web-services backed fields). Default is false, meaning that the options (values) are NOT loaded
• _debug - true/false, allows you top get statistics on field initialization times to understand what are the slowest and problematic

• 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

• query - you can either use "{filter}" part of the url to specify the filtering expression or pass it via query request parameter (see an example on the top of the page)
• limit - to limit the number of records returned (number) 
• sort - to sort the results set Sorting in ConfiForms
• VERSION 3.5.5 ignoreCase - You can set the filtering to ignore case when matching (default) or not to ignore case when filtering entries, setting ignoreCase=false

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

VERSION 3.13.1

/rest/confiforms/1.0/deleteByFilter/{pageId}/{formName}?query={filter}

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

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

VERSION 3.7.6

/rest/confiforms/1.0/updateFieldValue/{pageId}/{formName}?query={filter}

• 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"
• VERSION 3.7.6 query - you can either use "{filter}" part of the url to specify the filtering expression or pass it via query request parameter (see an example on the top of the page)

Export RAW dataset

SINCE 2.18.7

ConfiForms installation info

SINCE 3.11.1

Example

{
  "licenseType": "Commercial license.  Max users: 5000....",
  "pluginVersion": "3.11.1",
  "pluginInstalled": "Sat Jun 08 11:19:58 EEST 2024",
  "memoryUsage": "1.4 GB",
  "confluenceLicenseType": "(users count: 5000), license type <DEVELOPER>",
  "pluginName": "ConfiForms, forms and workflows app for Confluence by Vertuna LLC",
  "memoryAvailable": "4 GB",
  "javaVersion": "17.0.8.1",
  "pluginDescription": "ConfiForms app helps you to create custom data entry forms for your business needs, in Confluence. The possibilities for creating powerfully effective data entry forms are endless! Voting, enrollment, inventory, surveys, bulletin boards, employee checklists, and other type of forms that are easy to create and manage",
  "debugLogEnabled": false
}

File upload

 SINCE 3.14.2

Content body

{
  "fileName": "",
  "fileContentType" : "see https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types/Common_types",
  "fileContent" : "BASE64 encoded content here"
}