FLflowable
Case Instances

Start a case instance

Note that also a transientVariables property is accepted as part of this json, that follows the same structure as the variables property.

Only one of caseDefinitionId or caseDefinitionKey an be used in the request body.

Parameters businessKey, variables and tenantId are optional.

If tenantId is omitted, the default tenant will be used.

It is possible to send variables, transientVariables and startFormVariables in one request.

More information about the variable format can be found in the REST variables section.

Note that the variable-scope that is supplied is ignored, case-variables are always local.

post/cmmn-runtime/case-instances

Request

Request body

caseDefinitionIdstring
caseDefinitionKeystring
namestring
businessKeystring
outcomestring
tenantIdstring
overrideDefinitionTenantIdstring
returnVariablesboolean

Example request

{
  "caseDefinitionId": "oneTaskCase:1:158",
  "caseDefinitionKey": "oneTaskCase",
  "name": "My case name",
  "businessKey": "myBusinessKey",
  "variables": [
    {
      "name": "myVariable",
      "type": "string",
      "valueUrl": "http://...."
    }
  ],
  "transientVariables": [
    {
      "name": "myVariable",
      "type": "string",
      "valueUrl": "http://...."
    }
  ],
  "startFormVariables": [
    {
      "name": "myVariable",
      "type": "string",
      "valueUrl": "http://...."
    }
  ],
  "tenantId": "tenant1",
  "overrideDefinitionTenantId": "overrideTenant1"
}

Response

Indicates the case instance was created.

idstring
namestring
urlstring
businessKeystring
businessStatusstring
dueDatestring date-time
claimTimestring date-time
claimedBystring
startTimestring date-time
startUserIdstring
statestring
endedboolean
caseDefinitionIdstring
caseDefinitionUrlstring
caseDefinitionNamestring
caseDefinitionDescriptionstring
parentIdstring
callbackIdstring
callbackTypestring
referenceIdstring
referenceTypestring
tenantIdstring
completedboolean

Example response

{
  "id": "187",
  "name": "processName",
  "url": "http://localhost:8182/cmmn-repository/case-definitions/caseOne%3A1%3A4",
  "businessKey": "myBusinessKey",
  "businessStatus": "myBusinessStatus",
  "startTime": "2019-04-17T10:17:43.902+0000",
  "startUserId": "aUserId",
  "state": "active",
  "caseDefinitionId": "oneTaskCase:1:158",
  "caseDefinitionUrl": "http://localhost:8182/cmmn-repository/case-definitions/caseOne%3A1%3A4",
  "caseDefinitionName": "aCaseDefinitionName",
  "caseDefinitionDescription": "A case definition description",
  "parentId": "123",
  "callbackId": "123",
  "callbackType": "cmmn-1.1-to-cmmn-1.1-child-case",
  "referenceId": "123",
  "referenceType": "event-to-cmmn-1.1-case",
  "variables": [
    {
      "name": "myVariable",
      "type": "string",
      "valueUrl": "http://...."
    }
  ],
  "tenantId": "null"
}

Changes

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