pp108 : GetCaseVariables

GetCaseVariables

The Case variables of a Case model are used to configure the dynamic parameters of a Case model during the execution. The different types of available Case variables are Worklist, Team, Role, Users, Dispatch algorithm, and Due date.

This Web service operation is used to obtain the Case variables defined for a Case model. The response contains the details of the Case variables and can be used to update the Case variables in the runtime.

SOAP Request

<GetCaseVariables xmlns="http://schemas.cordys.com/casemanagement/execution/1.0">
    <caseinstanceid>001A6BFA-F5BF-11E0-EE95-46ACF010FF96</caseinstanceid>
</GetCaseVariables>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

caseinstanceid

The instance ID of the Case model for which the Case identifiers are to be retrieved

Yes

SOAP Response

<GetCaseVariablesResponse
    xmlns="http://schemas.cordys.com/casemanagement/execution/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <caseinstanceid>001A6BFA-F5BF-11E0-EE95-46ACF010FF96</caseinstanceid>
    <casedata lockID="001A6BFA-F5BF-11E0-EE95-4B237A3E5F96">
        <data name="case:casevariables" xmlns:case="http://schemas.cordys.com/casemanagement/1.0">
            <case:casevariables xmlns=""
                xmlns:case="http://schemas.cordys.com/casemanagement/1.0"
                xmlns:ns="http://orders.com/1.0"
                xmlns:ns1="http://orders.com/1.0" xmlns:sm="http://www.w3.org/2005/07/scxml">
                <case:RoleName type="role"/>
                <case:UserDN type="user">cn=John,cn=organizational users,o=myorg,cn=cordys,cn=myinstance,o=myorg.com</case:UserDN>
            </case:casevariables>
        </data>
    </casedata>
</GetCaseVariablesResponse>
Response Parameters

Parameter

Description

casedata

Contains the Case data associated with the Case model. The Case variables will be a part of the Case data.

data

Data is the placeholder of the content specified by its name attribute. In this case, data refers to the Case variables.

casevariables

The Case variables serve as the container for all the Case identifiers defined for a given Case model. Each child element of the casevariables element represents a Case variable. The name of the Case variable is the name of the element differentiated by its type.
In the above stated example, the Case variable UserDN stores a distinguished name of the user. When a Human task activity of a Case model is configured with the Target Assignee type as user and is mapped to this Case variable, the task will be delivered to this user.