pp108 : RestartCaseInstance

RestartCaseInstance

This Web service operation is used to restart the aborted Case instance. The RestartCaseInstance 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>
      <RestartCaseInstance xmlns="http://schemas.cordys.com/casemanagement/instanceadministration/1.0">
           <caseinstanceid>005056C0-0008-11E0-EEF9-05AE4B8713C8</caseinstanceid>
      </RestartCaseInstance>
   </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>
      <RestartCaseInstanceResponse
        xmlns="http://schemas.cordys.com/casemanagement/instanceadministration/1.0"
            xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
         <status
            activitytype="CASETASK"
            instanceid="005056C0-0008-11E0-EEF9-05AE4B8713C8"
                success="true">
              <status
                activitytype="BPMTASK"
                instanceid="005056C0-0008-11E0-EEF9-05AE4B8773C8" success="true"/>
         </status>
      </RestartCaseInstanceResponse>
</data>
Response Parameters

Parameters

Description

success

Refers to status of the Case. Returns

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