pp108 : GetCaseModels

GetCaseModels

The GetCaseModels is used to retrieve all the Case models from the Organization or ISV space. This Web service is a part of the CaseModelAdministration method set with the namespace 'http://schemas.cordys.com/casemanagement/modeladministration/1.0'.

Note: This method returns only the header information of the Case model but not its details.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <GetCaseModels xmlns="http://schemas.cordys.com/casemanagement/modeladministration/1.0">
            <query>
                <space>organization</space>
                <status>
                    <status>ACTIVE</status>
                    <status>DELETED</status>
                </status>
                <target>
                    <target>cn=sampleRole,cn=organizational roles,o=myorg,cn=cordys,cn=cordysInst,o=acme.com</target>
                    <target>001A6BFA-F5BF-11E0-EEDA-1CF0019DFBD3</target>
                </target>
            </query>
            <cursor id="0" maxRows="99999" numRows="5" pos="0"/>
        </GetCaseModels>
    </SOAP:Body>
</SOAP:Envelope>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

space

Refers to the space from which the Case models are to be retrieved.

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
  • organization
  • isv

status

Refers to the option to filter the Case models based on the status. You can define multiple status elements to filter the Case models.

Any Case model can be either in ACTIVE state or DEACTIVATED state or DELETED state.If multiple status are given , it then returns details of the Case models with one of the status specified.

Case model is in ACTIVE state when it is deployed,Case Model is in DELETED state when it is undeployed and Case Model which is not available for creating case instances is goes to DEACTIVATED state.

If status is not provided the details of the Case models irrespective of the status.

No
  • ACTIVE
  • DEACTIVATED
  • DELETED

target

Refers to the option to filter the Case models based on their target assignee. You can define multiple targets to filter the Case models

No

The XPath expression of the Case variable can be linked to the following:

  • User DN
  • Role DN
  • Team ID
  • Worklist ID

SOAP Response

<data>
    <GetCaseModelsResponse
        xmlns="http://schemas.cordys.com/casemanagement/modeladministration/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
        <model id="001A6BFA-F5BF-11E0-EE95-3B7B21743F96"
            latestrevision="001A6BFA-F5BF-11E0-EEDF-AF7F1B115BD3"
            name="Case/DemoCase" publishedDate="1304589190982"
            space="organization" status="ACTIVE">
            <description>DemoCase</description>
        </model>
        <model id="001A6BFA-F5BF-11E0-EEDF-4DC6E2CB9BD3"
            latestrevision="001A6BFA-F5BF-11E0-EEDF-4DC6E2CB7BD3"
            name="Case/MyCase" publishedDate="1304587879412"
            space="organization" status="DELETED">
            <description>MyCase</description>
        </model>
    </GetCaseModelsResponse>
</data>

Response Parameters

Parameter

Description

model

Contains the name, description, status, and other related information for each Case model