Form Instances

List of form instances

get/form/form-instances

Request

Query parameters

idstring

Only return form instances with the given id.

formDefinitionIdstring

Only return form instances with the given form definition id.

formDefinitionIdLikestring

Only return form instances with a form definition id like the given value.

taskIdstring

Only return form instances with the given task id.

taskIdLikestring

Only return form instances with a task id like the given value.

processInstanceIdstring

Only return form instances with the given process instance id.

processInstanceIdLikestring

Only return form instances with a process instance id like the given value.

processDefinitionIdstring

Only return form instances with the given process definition id.

processDefinitionIdLikestring

Only return form instances with a process definition id like the given value.

scopeIdstring

Only return form instances with the given scope id.

scopeTypestring

Only return form instances with a scope type like the given value.

scopeDefinitionIdstring

Only return form instances with the given scope definition id.

submittedBystring

Only return form instances submitted by the given value.

submittedByLikestring

Only return form instances submitted by like the given value.

tenantIdstring

Only return form instances with the given tenantId.

tenantIdLikestring

Only return form instances with a tenantId like the given value.

withoutTenantIdboolean

If true, only returns form instances without a tenantId set. If false, the withoutTenantId parameter is ignored.

sort'submittedDate' | 'tenantId'

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

Response

Indicates request was successful and the form instances are returned

totalinteger
startinteger
sortstring
orderstring
sizeinteger

Example response

{
  "data": [
    {
      "id": "48b9ac82-f1d3-11e6-8549-acde48001122",
      "formDefinitionId": "818e4703-f1d2-11e6-8549-acde48001122",
      "taskId": "88",
      "processInstanceId": "66",
      "processDefinitionId": "oneTaskProcess:1:158",
      "submittedDate": "2013-04-17T10:17:43.902+0000",
      "submittedBy": "testUser",
      "formValuesId": "818e4703-f1d2-11e6-8549-acde48001110",
      "tenantId": "null",
      "url": "http://localhost:8182/form/form-instances/48b9ac82-f1d3-11e6-8549-acde48001122",
      "scopeId": "66",
      "scopeType": "CAS-d6d53baa-2618-11e9-895e-aee50c200f02",
      "scopeDefinitionId": "CAS-d6d53baa-2618-11e9-895e-aee50c200f02"
    }
  ]
}

Changes

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