pp108 : GetCaseModel

GetCaseModel

Given a Case model, this Web service returns the details using which the new instances will be instantiated. These details relate to what is published or deployed last. It 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>
        <GetCaseModel xmlns="http://schemas.cordys.com/casemanagement/modeladministration/1.0">
            <model name="HospitalManagement/case/HealthCheck" space="organization"/>
            <status>
                <status>ACTIVE</status>
                <status>DELETED</status>
            </status>
        </GetCaseModel>
    </SOAP:Body>
</SOAP:Envelope>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

name

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

Yes

space

(Deprecated)

A space in which the Case model is deployed.

Note: This parameter is currently deprecated. If it is not provided, the 'Organization space' is considered; if the expected model is not found in the organization space, then the 'Shared space' is considered automatically.

No
  • isv
  • organization

status

Option to filter Case models. You can define multiple statuses to filter the Case model.

Any Case model can be either in ACTIVE, DEACTIVATED, or DELETED status. If multiple statuses are provided, details of the Case model with one of the statuses specified are returned.

A Case model is in an ACTIVE status when it is deployed. It is in DELETED status when it is undeployed. A Case model, which is not available for creating Case instances is in DEACTIVATED status.

If the status is not provided, the details of the Case model are returned irrespective of its current status.

No
  • ACTIVE
  • DEACTIVATED
  • DELETED

SOAP Response

<data>
    <GetCaseModelResponse
        xmlns="http://schemas.cordys.com/casemanagement/modeladministration/1.0" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
        <model id="00215A63-1B7C-11E2-EE23-1EDF23D8DF4D"
            latestrevision="00215A63-1B7C-11E2-EE23-1EDF23D8BF4D"
            name="/HospitalManagement/case/HealthCheck"
            publishedDate="1360236282121" space="organization" status="ACTIVE">
            <description/>
            <runtimedefinition>....</runtimedefinition>
            <designtimedefinition/>
        </model>
    </GetCaseModelResponse>
</data>
Response Parameters
Parameter Description

model

 Details of the Case model such as name, space, status, ID, latestrevision, and publishedDate as its attributes.

description

 Description of the Case model as provided when the model was developed.

runtimedefinition

Complete SCXML of the Case model

The outcome of a CaseModel is an scxml file. Refer to Apache commons on SCXML for more information on the standard.

designtimedefinition

(Deprecated)

The value will always be empty.

Note: This parameter will be removed in subsequent versions of Process Platform.