pp108 : GetCaseActivity

GetCaseActivity

This method can be used to obtain the details of a particular activity associated with a Case model that is currently available for creating new instances. The GetCaseActivity is a part of the CaseModelAdministration Web service interface with the namespace http://schemas.cordys.com/casemanagement/modeladministration/1.0.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <GetCaseActivity xmlns="http://schemas.cordys.com/casemanagement/modeladministration/1.0">
            <model name="emp case model" space="organization"/>
            <activitymodelid>00215A63-1B7C-11E2-F05F-4676F87BBF04</activitymodelid>
        </GetCaseActivity>
    </SOAP:Body>
</SOAP:Envelope>
Request Parameters

Parameter

 Description

Mandatory

Accepted Input Values

name

 Refers to the Fully Qualified Name (FQN) of the Case model for which the details are to be retrieved

Yes

space

Refers to the space where the Case model is deployed.

If space is not given,it first checks for the case model in the organization space from where request is fired,if case model is not found it falls back to isv space.

 No
  • isv
  • organization

activitymodelid

 Refers to the unique identifier of the activity in the Case model

Yes

You can obtain it from the SCXML of the Case model.

The outcome of a CaseModel is an scxml file. For more info on the standard see:Apache commons on SCXML

SOAP Response

<data>
    <GetCaseActivityResponse
        xmlns="http://schemas.cordys.com/casemanagement/modeladministration/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
        <tuple>
            <old>
                <CASE_ACTIVITY>
                    <ACTIVITY_ID>00215A63-1B7C-11E2-F05F-5C0FC3883F04</ACTIVITY_ID>
                    <ACTIVITY_MODEL_ID>00215A63-1B7C-11E2-F05F-4676F87BBF04</ACTIVITY_MODEL_ID>
                    <ACTIVITY_NAME>UI1</ACTIVITY_NAME>
                    <ACTIVITY_TYPE>HUMANTASK</ACTIVITY_TYPE>
                    <DEFINITION>
                        <case:activity
                            id="005056C0-0008-11E0-EEF4-E8953B6513C8"
                            name="emp data" type="HUMANTASK" xmlns:case="http://schemas.cordys.com/casemanagement/1.0">
                            <HumanInteraction xmlns="http://schemas.cordys.com/notification/workflow/1.0">
                                <HumanTaskModelId>005056C0-0008-11E0-EE44-EAABB31613C8</HumanTaskModelId>
                                <Subject>emp data</Subject>
                                <SendTo>
                                    <Target type="team">
                                    <Assignee dynamic="true">sm:data[@name='case:casevariables']/case:casevariables/case:caseVariable</Assignee>
                                    </Target>
                                </SendTo>
                                <DueDate dynamic="false">P0Y0M2DT0H0M0S</DueDate>
                            </HumanInteraction>
                            <case:messages>
                                <case:input>
                                    <case:message
                                    name="empdata_empdataDefaultDeliveryModel_IP" ns="http://schemas.cordys.com/1.0/xforms/processapi"/>
                                </case:input>
                                <case:output>
                                    <case:message
                                    name="empdata_empdataDefaultDeliveryModel_OP" ns="http://schemas.cordys.com/1.0/xforms/processapi"/>
                                </case:output>
                            </case:messages>
                            <case:associatedevents/>
                            <case:duedate dynamic="false" type="duration">P0Y0M2DT0H0M0S</case:duedate>
                            <case:escalation/>
                        </case:activity>
                    </DEFINITION>
                </CASE_ACTIVITY>
            </old>
        </tuple>
    </GetCaseActivityResponse>
</data>
Response Parameters

Parameter

Description
ACTIVITY_ID Contains the unique identifier of the retrieved activity

ACTIVITY_MODEL_ID

Contains the unique identifier of the retrieved activity during design-time

ACTIVITY_NAME

Contains the name of the retrieved activity

ACTIVITY_TYPE

Contains the type of the retrieved activity. It will have one of the following values:

  • HUMANTASK (When the activity is an user interface)
  • BPMTASK (When the activity is a sub-bpm )
  • CASETASK (When the activity is a sub-case)

DEFINITION

Contains the other information related to the activity.