pp108 : GetActivityInstances

GetActivityInstances

 

This Web service operation returns the details of all the activity instances triggered for a case instance. Each activity instance contains information such as the planned date, current status of the activity, and so on. GetActivityInstances is a part of the Method Set Case Instance Execution 4.2 Web service interface with the namespace http://schemas.cordys.com/casemanagement/execution.

SOAP Request

<soapenv:Envelope
    xmlns:ns="http://schemas.cordys.com/casemanagement/execution/1.0" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Header/>
    <soapenv:Body>
        <ns:GetActivityInstances>
            <ns:caseinstanceid>002481F0-8E9F-11E2-FA99-EB1BE5D6BD97</ns:caseinstanceid>
        </ns:GetActivityInstances>
    </soapenv:Body>
</soapenv:Envelope>
Request Parameters

Parameter

Description

Mandatory

caseinstanceid

Unique identifier of the case instance. The case instance ID can be obtained from any of the following:

Yes

SOAP Response

<GetActivityInstancesResponse xmlns="http://schemas.cordys.com/casemanagement/execution/1.0">
    <tuple>
        <old>
            <ACTIVITY_INSTANCE>
                <CASE_STATE>
                    <STATE_NAME>State</STATE_NAME>
                </CASE_STATE>
                <CASE_ACTIVITY>
                    <ACTIVITY_NAME>Auto1</ACTIVITY_NAME>
                    <ACTIVITY_TYPE>HUMANTASK</ACTIVITY_TYPE>
                    <ACTIVITY_MODEL_ID>002481F0-8E9F-11E2-F7D4-AB1054307435</ACTIVITY_MODEL_ID>
                </CASE_ACTIVITY>
                <ACTIVITY_INSTANCE_ID>002481F0-8E9F-11E2-FA99-EB1BE5D73D97</ACTIVITY_INSTANCE_ID>
                <CASE_INSTANCE>002481F0-8E9F-11E2-FA99-EB1BE5D6BD97</CASE_INSTANCE>
                <ACTIVITY>002481F0-8E9F-11E2-FA99-EB1BE5D5FD97</ACTIVITY>
                <PLANNED_ON>1371199780202</PLANNED_ON>
                <STARTED_ON>1371199780202</STARTED_ON>
                <LASTMODIFIED_ON>1371199780541</LASTMODIFIED_ON>
                <LASTMODIFIED_BY>cn=knagarjuna,cn=organizational users,o=system,cn=cordys,cn=build719,o=vanenburg.com</LASTMODIFIED_BY>
                <CORRELATION_ID>002481F0-8E9F-11E2-FA99-EB1BE5D73D97</CORRELATION_ID>
                <CURRENT_STATUS>SUSPENDED</CURRENT_STATUS>
            </ACTIVITY_INSTANCE>
        </old>
    </tuple>
    <tuple>
        <old>
            <ACTIVITY_INSTANCE>
                <CASE_STATE>
                    <STATE_NAME>State</STATE_NAME>
                </CASE_STATE>
                <CASE_ACTIVITY>
                    <ACTIVITY_NAME>Intermediate</ACTIVITY_NAME>
                    <ACTIVITY_TYPE>HUMANTASK</ACTIVITY_TYPE>
                    <ACTIVITY_MODEL_ID>002481F0-8E9F-11E2-F7D4-AB105444D435</ACTIVITY_MODEL_ID>
                </CASE_ACTIVITY>
                <ACTIVITY_INSTANCE_ID>002481F0-8E9F-11E2-FA99-EB1BE5D7DD97</ACTIVITY_INSTANCE_ID>
                <CASE_INSTANCE>002481F0-8E9F-11E2-FA99-EB1BE5D6BD97</CASE_INSTANCE>
                <ACTIVITY>002481F0-8E9F-11E2-FA99-EB1BE5D61D97</ACTIVITY>
                <PLANNED_ON>1371199780541</PLANNED_ON>
                <STARTED_ON>1371199780544</STARTED_ON>
                <LASTMODIFIED_ON>1371199780608</LASTMODIFIED_ON>
                <LASTMODIFIED_BY>cn=knagarjuna,cn=organizational users,o=system,cn=cordys,cn=build719,o=vanenburg.com</LASTMODIFIED_BY>
                <CORRELATION_ID>002481F0-8E9F-11E2-FA99-EB1BE5D7DD97</CORRELATION_ID>
                <CURRENT_STATUS>RELEASED</CURRENT_STATUS>
            </ACTIVITY_INSTANCE>
        </old>
    </tuple>
</GetActivityInstancesResponse>
Response Parameters

Parameter

Description

ACTIVITY_INSTANCE_ID

Unique identifier of the activity instance

CASE_INSTANCE

Unique identifier of the case instance

ACTIVITY

Unique identifier of the activity

PLANNED_ON

Time stamp when the activity was planned

STARTED_ON

Time stamp when the activity has started

LASTMODIFIED_ON

Time stamp when the activity was last modified

LASTMODIFIED_BY

Last user who modified the activity

CORRELATION_ID

CORRELATION_ID and ACTIVITY_INSTANCE_ID are the same, except when users set their own generated GUID as the instance_id, to instantiate a subprocess or subcase model.

CURRENT_STATUS

Current status of the activity. The possible values are:

  • COMPLETED
  • RELEASED
  • PLANNED
  • OBSOLETE
  • ABORTED

STATE_NAME

State to which the activity belongs

ACTIVITY_NAME

Name of the case activity

ACTIVITY_TYPE

Type of the case activity. The possible values are:

  • HUMANTASK - If the activity is a user interface
  • BPMTASK - If the activity is a BPM
  • CASETASK - If the activity is a case model