JSON schema

JSON key	Description
AllContainers	Holds all the containers to be created, updated or imported from Teamcenter and information common to containers.
toolIdentifier	Application name to identify the integrating tool, for example MATLAB, ECAD, SAMPLE. This value is used by the framework to identify the integration definition file where integration specific configuration is done. This value and corresponding integration definition file are unique for different integrations. This is a required field.
Containers	This array holds containers to be created, updated or imported from Teamcenter. Each container is represented by a separate Teamcenter business object.
containerIdentifier	A unique identifier for the container assigned by the integrating modeling tool. This is required in all operations.
tcContainerIdentifier	A unique identifier of the Teamcenter business object corresponding to the container. This field is empty for exportCollection as no corresponding Teamcenter business object is created. It is a required field for updateCollection() and importCollection() SOAs.
containerName	Name of container in the tool.
tcContainerName	Name of the Teamcenter business object corresponding to the container. If this field is empty then containerName is given to the Teamcenter object.
containerType	The object type of a container in the tool. This is used to process the corresponding Teamcenter object mapped in the integration definition file.
tcContainerType	The type of object in Teamcenter such as Item, Dataset. This maps to the containerType in the tool. If this value is empty, then the mapped Teamcenter object type is picked from the integration definition file.
isTopContainer	If value is true and tcFolderUid value is empty then the container is copied under Newstuff folder in Teamcenter.
action	Action to be performed on this container. add creates new container object in Teamcenter. update updates the relationship or metadata of existing Teamcenter component.
tcFolderUid	The UID of Teamcenter folder where the new container can be pasted. It is optional. If value of isTopContainer is true and tcFolderUid value is empty then the container is copied under Newstuff folder in Teamcenter.
tcLastModifiedDate	The last modified date of the container saved to Teamcenter. This is populated in the output JSON.
attributes	An array of attributes of model object in tool mapped to the Teamcenter object properties and their values.
attrName	Name of attribute in the tool.
tcAttrName	Name of the Teamcenter object property mapped with the name of attribute in tool.
value	Array of attribute values. If the Teamcenter object property accepts single value, then the array will have only one value.
revAttributes	An array of attributes of model object in tool mapped to the Teamcenter revision object properties and their values.
datasetFileInfos	An array of attributes of tool files to be associated with a Teamcenter dataset.
fileName	Name of the file to be uploaded to Teamcenter without extension.
fileExtension	Extension of the file to be uploaded to Teamcenter without extension.
filePath	Absolute path of the folder where the file resides on the user desktop.
namedReferenceName	Name of the file reference in the dataset business object.
allowReplace	Allows overriding an existing named reference of a dataset. true overrides, false adds a new named reference to the dataset.
isText	The type of Named Reference file. true represents a text file, false represents a binary file.
writeTicket	This is an FMS write ticket to upload a file to Teamcenter dataset. This will be empty in case of saving a new dataset to Teamcenter. This is populated in the output JSON returned by the Common Integration Framework service operations exportCollection() and updateCollection().
readTicket	The FMS read ticket to download a file from Teamcenter dataset. This will be empty in case of saving data to Teamcenter. This is populated in the output JSON of importCollection().
Components	Array of components associated to the container. The association can be of the following types: a relation (GRM), the product structure (BVR) of the owning container, or a referenced container (REF).
componentName	This is the name of the occurrence if this is a BVR association.
componentIdentifier	Unique identifier of a component in the tool. This is required if component is added in the Container.
componentType	Type of component in the tool. For example a Model, Referenced Model, or a Referenced library in Matlab. This is a required field.
tcComponentType	Type of Teamcenter object. If this is empty then the default value is picked from the mapping file of the tool. This is the Teamcenter type of a relation object or the occurrence object. In case of referenced component it is empty.
ComponentLinks	This array in Component is to establish an association between two components of a container.
owningContainerIdentifier	This is the tool assigned unique identifier of container in which the component resides.
ContextualComponents	An array of contextual components, that is, associations or relations between two components in the context of a specific container, not necessarily the immediate parent container. For example, a tracelink relation between two occurrences of a wheel (Container) such as front wheel (component) and rear wheel (component) in the context of bicycle (container).
tcComponentIdentifier	This is a Teamcenter assigned unique identifier of the associated or related object. This is required when the action is UPDATE or REMOVE.
rootContainerIdentifier	This is containerIdentifier of a container in the context of which the association or relation is created.
tcRootContainerIdentifier	This is tcContainerIdentifier of a container in the context of which the association or relation is created.
owningComponentIdentifier	A :: (double colon) separated list of all parent componentIdentifiers, used to uniquely identify a nested component (e.g. Front Wheel component :: Rim component for a valve nested inside a bicycle's front wheel's rim). Required if the parent components are not saved into Teamcenter.
tcOwningComponentIdentifier	A :: separated list of all parent tcComponentIdentifiers, the Teamcenter-side equivalent of owningComponentIdentifier.
userSpecificInputs	User actions and operation specific input, with keys such as CHECKOUT, CHECKIN, REVISION_RULE, and VARIANT_RULE.
systemInputs	Special inputs, with keys such as RETURN_MAPPED_ATTRIBUTES and BOM_VIEW_TYPE_NAME.

Example systemInputs usage:

"systemInputs" : [ {
                    "values" : [ "true" ],
                    "inputKey" : "RETURN_MAPPED_ATTRIBUTES"
                } ],