FLflowable
Form Definitions

List of form definitions

get/form-repository/form-definitions

Request

Query parameters

categorystring

Only return form definitions with the given category.

categoryLikestring

Only return form definitions with a category like the given value.

categoryNotEqualsstring

Only return form definitions not with the given category.

keystring

Only return form definitions with the given key.

keyLikestring

Only return form definitions with a key like the given value.

namestring

Only return form definitions with the given name.

nameLikestring

Only return form definitions with a name like the given value.

resourceNamestring

Only return form definitions with the given resource name.

resourceNameLikestring

Only return form definitions a resource name like the given value.

versionstring

Only return form definitions with the given version.

versionGreaterThanstring

Only return form definitions with a version greater than the given value.

versionGreaterThanOrEqualsstring

Only return form definitions with a version greater than or equal to the given value.

versionLowerThanstring

Only return form definitions with a version lower than the given value.

versionLowerThanOrEqualsstring

Only return form definitions with a version lower than or equal to the given value.

deploymentIdstring

Only return form definitions with the given deployment id.

parentDeploymentIdstring

Only return form definitions with the given parent deployment id.

tenantIdstring

Only return form definitions with the given tenant id.

tenantIdLikestring

Only return form definitions with a tenant id like the given value.

withoutTenantIdstring

Only return form definitions without a tenant id.

latestboolean

If true; only the latest versions will be returned.

sort'key' | 'category' | 'id' | 'version' | 'name' | 'deploymentId' | 'tenantId'

Property to sort on, to be used together with the order.

Response

Indicates request was successful and the form definitions are returned

totalinteger
startinteger
sortstring
orderstring
sizeinteger

Example response

{
  "data": [
    {
      "id": "10",
      "url": "http://localhost:8182/form-repository/form-definitions/simpleForm",
      "category": "Examples",
      "name": "The Simple Form",
      "key": "simpleForm",
      "description": "This is a form for testing purposes",
      "version": 1,
      "resourceName": "SimpleSourceName",
      "deploymentId": "818e4703-f1d2-11e6-8549-acde48001121",
      "tenantId": "null"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.