bhmReviseOperation API

Use the following API to revise models that are managed in Teamcenter.

List<BHMOperationOutput> bhmReviseOperation (List<String> dataReviseInputXML, String toolType)

Inputs

• dataReviseInputXML — Specifies a list of input strings that are based on the BHMOperationsSchema.xsd file. You can generate the xml string using the JAXB utility available with the BHMOperationData and BHMDesign classes in the com.teamcenter.behaviormodeling.common.xml package.
• toolType — Specifies the behavior modeling tool, for example, MATLAB.

In your Java code, you must specify the following:

• In the BHMOperations element, specify the values for rootModelName and rootModelIdentifier.
• In the Model element, specify the values for modelName, modelIdentifier, and tcuid.
• In the reviseOperationOptions element, specify the values of the following variables:
  • revisionID — Specifies the revision ID to be set when revising the behavior model. If this value is empty, the revision ID is automatically assigned. This value must contain alphanumeric characters and must not contain the _ (underscore) character or the . (period) character.
  • carryForwardAdditionalData — Specifies whether additional data must be revised and carried forward to the revised model. Boolean parameter. If true, additional data is carried forward. If not, the revised model will not have any additional data.

Output

The output is a list of BHMOperationOutput objects (com.teamcenter.behaviormodeling.common package). Each object corresponds to one of the input XML strings sent through dataReviseInputXML.

BHMOperationOutput variable	Description
OperationStatus	Returns one of: OPERATION_FAILED, OPERATION_WARNING, OPERATION_SUCCESSFUL, OPERATION_SUCCESSFUL_WITH_INFO
message	Specifies the cause of the API failure.
inputXML	Specifies the input XML string based on BHMOperationsSchema.xsd.
outputXML	Specifies an XML string based on BHMDesignSchema.xsd.
rootModelName	Specifies the root model to be saved.
rootModelIdentifier	Specifies the identifier of the root model.
rootModelFullFilePath	Specifies the full path of the root model.

Example

To revise a model, you can pass the following string through the dataReviseInputXML list of the bhmReviseOperation API.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<BHMOperations rootModelName="test" rootModelIdentifier="test"
   xmlns="http://www.plmxml.org/Schemas/bhm">
  <modelInfo>
    <Model modelName="test" modelIdentifier="test"
     tcuid="Q2TJlnST4BflXC" />
  </modelInfo>
  <options>
    <reviseOperationOptions revisionID="D"
    carryForwardAdditionalData="false" />
  </options>
</BHMOperations>