updateCollection()

This API takes the current state of the model in the form of input JSON and updates the corresponding Teamcenter objects. It returns the updated state of the model in a JSON format.

This API also updates the model properties, model composition (GRM or BVR), and associated files.

ResponseData updateCollection( String applicationName, String inputData , String contextFolder )

Input Parameters

• applicationName — The name that identifies the integrating tool, for example, MATLAB, ECAD, or Amesim. This value is used to identify the mapping file of the tool.
• inputData — The delta input payload in the form of a JSON string. This is the JSON file that is created after the compareContainers() API is executed.
• contextDirectory — The context folder of the model data from the staging directory.

Returns

ResponseData containing the JSON document with the properties and Teamcenter UID of the model specified in the input along with the properties and Teamcenter UIDs of all the associated models and datasets.

Use case 1 — Update properties on a model

The following JSON input string is sent to updateCollection to modify the description of the model. In the example, the element tcContainerIdentifier with the value wJa5Z1Ghr8jZAC is the Teamcenter UID of the existing model object, Battery.

{
  "AllContainers": {
    "toolIdentifier": "MIG",
    "Containers": [
      {
        "containerIdentifier": "Battery_Identifier",
        "containerName": "Battery",
        "containerType": "Assembly",
        "tcContainerIdentifier": " wJa5Z1Ghr8jZAC ",
        "action": "update",
        "revAttributes": [
          {
            "attrName": "Revision_Description",
            "tcAttrName": "object_desc",
            "value": [ "This is a updated description" ]
          }
        ]
      }
    ]
  }
}

Use case 2 — Update model composition

The following JSON input string is sent to updateCollection to add a submodel MotorDrive to an existing model, GolfCart, in Teamcenter. In the example, the element tcContainerIdentifier with the value wJa5Z1Ghr8jZFD is the Teamcenter UID of the existing model object, GolfCart.

{"AllContainers":
 {
   "toolIdentifier": "MIG",
   "Containers": [
    {
       "containerIdentifier": "MotorDrive_Identifier",
       "containerName": "MotorDrive",
       "containerType": "Assembly",
       "tcContainerIdentifier": "",
       "tcContainerType": "",
       "tcContainerName": "",
       "isTopContainer": false,
       "action": "add",
       "tcFolderUid": "",
       "tcReservation": false,
       "tcLastModifiedDate": "",
       "attributes": [],
       "revAttributes": []
    },
    {
        "containerIdentifier": "GolfCart_Identifier",
        "containerName": "GolfCart",
        "containerType": "Project",
        "tcContainerIdentifier": " wJa5Z1Ghr8jZFD ",
        "tcContainerType": "Assembly",
        "tcContainerName": "GolfCart",
        "isTopContainer": true,
        "tcReservation": "false",
        "tcLastModifiedDate": "",
        "attributes": [],
        "revAttributes": [],
        "Components": [
         {
            "componentType": "jpg",
            "componentName": "MotorDrive_component",
            "componentIdentifier": "MotorDrive_component_Identifier",
            "containerIdentifier": "MotorDrive_Identifier",
            "tcContainerIdentifier": "",
            "tcComponentIdentifier": "",
            "tcComponentName": "",
            "tcComponentType": "",
            "tcComponentCopyStableID": "",
            "owningContainerIdentifier": "",
            "tcOwningContainerIdentifier": "",
            "action": "add",
            "attributes": [],
            "ComponentLinks": []
         }],
         "datasetFileInfos": [],
         "action": "update"
    }
   ]
 }
}

Use case 3 — Update associated files

The following JSON input string is sent to updateCollection to modify the file associated to the existing dataset. In the example, the element tcContainerIdentifier with the value wJa5Z1Ghr8jMAT is the Teamcenter UID of the GolfCart_Dataset in Teamcenter.

{
"AllContainers":{
"toolIdentifier": "MIG",
"Containers": [
 {
  "containerIdentifier": "GolfCart_Dataset_Identifier",
  "containerName": "GolfCart_Dataset",
  "containerType": "DesignData",
  "tcContainerIdentifier": "wJa5Z1Ghr8jMAT",
  "tcContainerType": "zip",
  "tcContainerName": "GolfCart_Dataset",
  "isTopContainer": false,
  "tcReservation": "false",
  "tcLastModifiedDate": "",
  "attributes": [],
  "revAttributes": [],
  "Components": [],
  "datasetFileInfos": [
   {
     "clientId": "",
     "fileName": "GolfCartModelFile",
     "filePath": "C:\\bhm\\staging\\GolfCart",
     "namedReferenceName": "ZIPFILE",
     "allowReplace": true,
     "isText": true,
     "writeTicket": "",
     "readTicket": "(FMS read ticket)",
     "fileExtension": "zip",
     "fileHash": "DA39A3EE5E6B4B0D3255BFEF95601890AFD80709",
     "action": "update"
   }]
 }]
}
}

You can use the MBSE Integration Services Toolkit to try out this API.