Skip to main content
POST
/
process-definition
/
key
/
{key}
/
tenant-id
/
{tenant-id}
/
submit-form
Submit Start Form
curl --request POST \
  --url http://{host}:{port}/{contextPath}/process-definition/key/{key}/tenant-id/{tenant-id}/submit-form \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "variables": {
    "aVariable": {
      "value": "aStringValue",
      "type": "String"
    },
    "anotherVariable": {
      "value": true,
      "type": "Boolean"
    }
  },
  "businessKey": "myBusinessKey"
}'
{
  "links": [
    {
      "method": "GET",
      "href": "http://localhost:8080/rest-test/process-instance/anId",
      "rel": "self"
    }
  ],
  "id": "anId",
  "definitionId": "aProcessDefinitionId",
  "businessKey": "myBusinessKey",
  "caseInstanceId": null,
  "tenantId": null,
  "ended": false,
  "suspended": false
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
key
string
required

The key of the process definition to submit the form for.

​
tenant-id
string
required

The id of the tenant the process definition belongs to.

Body

application/json
​
variables
object | null
​
businessKey
string | null

The business key the process instance is to be initialized with. The business key uniquely identifies the process instance in the context of the given process definition.

Response

Request successful.

​
id
string | null

The id of the process instance.

​
definitionId
string | null

The id of the process definition that this process instance belongs to.

​
businessKey
string | null

The business key of the process instance.

​
caseInstanceId
string | null

The id of the case instance associated with the process instance.

​
ended
boolean | null
deprecated

A flag indicating whether the process instance has ended or not. Deprecated: will always be false!

​
suspended
boolean | null

A flag indicating whether the process instance is suspended or not.

​
tenantId
string | null

The tenant id of the process instance.

​
links
object[] | null

The links associated to this resource, with method, href and rel.