pp108 : SuspendCaseInstance

SuspendCaseInstance

This Web service operation is used to suspend the Case instance.When a Case instance is suspended, all the human tasks associated to the Case instance will also be suspended. The SuspendCaseInstance is a part of the CaseInstanceAdministration Web service interface with the namespace 'http://schemas.cordys.com/casemanagement/instanceadministration/1.0'.

SOAP Request

<SOAP:Envelope xmlns:SOAP=http://schemas.xmlsoap.org/soap/envelope/>
	<SOAP:Body>
		<SuspendCaseInstance xmlns="http://schemas.cordys.com/casemanagement/instanceadministration/1.0">
			<caseinstanceid>005056C0-0008-11E0-EEE0-8C31D000F3C8</caseinstanceid>
		</SuspendCaseInstance>
	</SOAP:Body>
</SOAP:Envelope>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

caseinstanceid

Refers to the unique identifier of the Case instance. The Case instance ID can be obtained from:

  • The ID returned in the response of CreateCase invocation
  • The Workflow.getCaseInstanceId Web API when invoked from a human task of the Case instance

Yes

GUID

SOAP Response

<data>
    <SuspendCaseInstanceResponse
        xmlns="http://schemas.cordys.com/casemanagement/instanceadministration/1.0|" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
        <status activitytype="CASETASK"
            instanceid="005056C0-0008-11E0-EEE0-8C31D000F3C8" success="true">
            <status activitytype="state"
                instanceid="005056C0-0008-11E0-EEE0-8C31D00133C8" success="true"/>
            <status activitytype="HUMANTASK"
                instanceid="005056C0-0008-11E0-EEE0-8C31D00153C8" success="true"/>
        </status>
    </SuspendCaseInstanceResponse>
</data>
Response Parameters

Parameters

Description

success

Refers to the status of the Case. Returns

  • true, if the Case is suspended
  • false, if the Case is not suspended