SOAP API - getCaseModel

• the case model details. For example, appName, caseModelID and currentVersion.
• installedVersion. The version that is currently installed. This means all the database scripts have been run and process instances may exist.
• datetimeDeploymentUpdated. The last time a deployment or update operation, including initial deployment.
• createScript. Returns the CREATE database script.
• updateScript. If the application has been updated, this returns the UPDATE database script.
• dropScript. If the CREATE script has been run, this returns the DROP script.
• frozenDetails. This includes whether or not the case model is frozen and the operation details. For example, who performed the operation, when and why.
• state. States of the case model could be:
  • INITIAL. This describes the initial state of the application. The application is still in the process of deploying.
  • PENDING_DBA_TO_INSTALL. The CREATE/UPDATE scripts are ready for retrieval. You must retrieve the scripts and manually execute them on your database to generate the case model database schema. Once the scripts have been executed, use notifyDDLExecution to notify TIBCO ActiveMatrix BPM notify TIBCO ActiveMatrix BPM.
  • INSTALLED. The CREATE/UPDATE scripts have been executed and TIBCO ActiveMatrix BPM has been notified. Process instances can be run from this application.
  • PENDING_DBA_TO_UNINSTALL. The DROP script is ready for retrieval. You must retrieve the scripts and manually execute them on your database to generate the case model database schema. Once the scripts have been executed, use notifyDDLExecution to notify TIBCO ActiveMatrix BPM.
  • FAILED_TO_UNINSTALL. The scripts have not executed correctly on the database. You must clean-up your database and then use notifyDDLExecution to notify TIBCO ActiveMatrix BPM when the clean-up is complete.

<soapenv:Body>
      <api:GetCaseModelRequest>
         <appName>com.example.claimmodel-1</appName>
      </api:GetCaseModelRequest>
</soapenv:Body>

<SOAP-ENV:Body>
      <GetCaseModelResponse xmlns="http://api.bds.tibco.com">
         <caseModel xmlns="">
            <caseModelID>1</caseModelID>
            <appName>com.example.claimmodel-1</appName>
            <currentVersion>1.0.0</currentVersion>
            <datetimeDeploymentUpdated>2013-11-19T10:57:26.977Z</datetimeDeploymentUpdated>
            <createScript>---------------------------------------- TIBCO HEADER ----------------------------------------
-- BOM Name           : ClaimModel.bom
-- BOM Namespace      : com.example.claimbom
-- Namespace Tag      : CLAIMBOM
-- BOM Major Version  : 1
-- Table Mappings     : (BOM Class -> DB Table)
--    com.example.claimbom.Claim                         BDS_1_CLAIMBOM_CLAIM
--    com.example.claimbom.Person                        BDS_1_CLAIMBOM_PERSON
--    com.example.claimbom.Policy                        BDS_1_CLAIMBOM_POLICY
--    com.example.claimbom.Claimant                      BDS_1_CLAIMBOM_CLAIMANT
--    com.example.claimbom.IncidentDetails               BDS_1_CLAIMBOM_INCIDENTDETAILS
--    com.example.claimbom.CustomerNotes                 BDS_1_CLAIMBOM_CUSTOMERNOTES
----------------------------------------------------------------------------------------------
create table [BDS_1_CLAIMBOM_CLAIMANT] ([BDS_ID] numeric(19,0) not null, [DTYPE] nvarchar(255) not null, [BDS_VERSION] numeric(19,0) null, [PARTY] nvarchar(255) null, [BDS_OWNER_ID] numeric(19,0) null, [CLAIM_CLAIMANTS_BDSID] numeric(19,0) null, [CLAIM_CLAIMANTS_IDX] int null, primary key ([BDS_ID]));
.
.
.
</createScript>
            <frozenDetails isFrozen="false"/>
            <state>PENDING_DBA_ACTION_TO_INSTALL</state>
         </caseModel>
      </GetCaseModelResponse>
</SOAP-ENV:Body>