pp108 : GetCaseIdentifiers

GetCaseIdentifiers

Case identifiers are used to search and identify a Case instance based on its business attributes. There are three types of identifiers, String, Numeric, and Date types, which can be configured for a Case model. The GetCaseIdentifiers retrieves the Case identifiers associated with the specified Case model and also provides information such as the identifier name, description, and its type. The GetCaseIdentifiers is a part of the CaseModelAdministration Web service interface with the namespace http://schemas.cordys.com/casemanagement/modeladministration/1.0.

SOAP Request

<GetCaseIdentifiers xmlns="http://schemas.cordys.com/casemanagement/modeladministration/1.0">
    <model name="Case/DemoCase" space="organization"/>
</GetCaseIdentifiers>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

name

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

Yes

space

Refers to the space in which 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

SOAP Response

<data>
    <GetCaseIdentifiersResponse
        xmlns="http://schemas.cordys.com/casemanagement/modeladministration/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
        <model name="Case/DemoCase" space="organization">
            <IDENTIFIER>
                <NAME>CurrentState</NAME>
                <TYPE>STRING</TYPE>
                <XPATH>sm:data[@name='case:caseinstanceproperties']/case:caseinstanceproperties/case:currentstate/text()</XPATH>
                <DESCRIPTION>Current Functional State</DESCRIPTION>
            </IDENTIFIER>
            <IDENTIFIER>
                <NAME>Order_ID</NAME>
                <TYPE>STRING</TYPE>
                <XPATH>sm:data[@name='ns:OrderDetails']/ns:OrderDetails/ns:OrderID/text()</XPATH>
                <DESCRIPTION>Order_ID</DESCRIPTION>
            </IDENTIFIER>
            <IDENTIFIER>
                <NAME>Customer_ID</NAME>
                <TYPE>STRING</TYPE>
                <XPATH>sm:data[@name='ns:OrderDetails']/ns:OrderDetails/ns:CustomerID/text()</XPATH>
                <DESCRIPTION>Customer_ID</DESCRIPTION>
            </IDENTIFIER>
            <IDENTIFIER>
                <NAME>OrderAmount</NAME>
                <TYPE>NUMERIC</TYPE>
                <XPATH>sm:data[@name='ns:OrderDetails']/ns:OrderDetails/ns:OrderAmount/text()</XPATH>
                <DESCRIPTION>OrderAmount</DESCRIPTION>
            </IDENTIFIER>
        </model>
    </GetCaseIdentifiersResponse>
</data>
Response Parameters

Parameter

Description

NAME

Contains the name of the Case identifier
TYPE Refers to the type of the Case identifier. String, Numeric, and Date types are supported.
XPATH Refers to the source of data for a Case identifier. The value 'XPath' indicates the mapping of Case data element with the Case identifier.

DESCRIPTION

Contains the description of the Case identifier