importCollection()

This API imports the model data that is saved in Teamcenter. This API also downloads the files referenced by datasets to Teamcenter. Note that the files must be downloaded explicitly in case of the importCollection SOA.

It takes a JSON file payload as input containing the tcContainerIdentifier of the model to be imported. It returns all the associated models and datasets and their properties as configured in the integration definition file.

ResponseData importCollection( String applicationName, String userSpecifiedDownloadFolder, boolean shouldDownloadFiles, String inputData )

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.
• userSpecifiedSourceContextFolder — Not yet implemented.
• userSpecifiedTargetContextFolder — Not yet implemented.
• inputData — The input payload in the form of a JSON string. The JSON payload contains the tcContainerIdentifier of the model to be imported.

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 — Import the model from Teamcenter

In the following code example, the element tcContainerIdentifier with the value wJa5Z1Ghr8jZAC is the Teamcenter UID of the existing model object.

{
  "AllContainers": {
    "toolIdentifier": "MIG",
    "Containers": [
      {
        "tcContainerIdentifier": " wJa5Z1Ghr8jZAC ",
        "isTopContainer": true
      }
    ]
  }
}

Use case 2 — Apply filter on data that is extracted from Teamcenter using the importCollection API

Integrators can filter the output of the importCollection API. You can achieve this by specifying the filter expression for the type.

Note: The remainder of this example (the filter expression syntax and sample JSON) could not be captured cleanly from the source page during this extraction pass — the browser tooling's content filter redacted part of the code sample as it resembled cookie/query-string data. See the companion topic "Filter data from the importCollection API output" for the related filtering reference, and consult the live Support Center page directly for the full example if needed.