POST Cases/Cancel

Request Information

URI Parameters

None.

Body Parameters

CaseStatus
NameDescriptionTypeAdditional information
CaseId

Case Id (Either Case ID or Proccess ID must be provided)

integer

None.

ProcessId

Process Id (Either Case ID or Proccess ID must be provided)

integer

None.

Notes

Case Notes

string

Max length: 4000

ClassificationCode

Classification Code

string

None.

CustomProperties

Dictionary of string [key] and string [value]

None.

Status

Target Status (3=Waiting;4=Abandoned;8=Complete;15=Cancelled;17=NoShow;-1=no change) QFlow has very strict workflow rules which govern which statuses can go to which ones. This function will forcibly set the status regardless of the workflow rules.

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "CaseId": 1,
  "ProcessId": 2,
  "Notes": "sample string 3",
  "ClassificationCode": "sample string 4",
  "CustomProperties": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "Status": 5
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:
"sample string 1"