Windchill REST Services Domain Capabilities > PTC Domains > PTC BOM Transformation Domain > Actions Available in the BOM Transformation Domain for Creating or Updating Downstream BOMs > CreateEquivalenceLinks
CreateEquivalenceLinks
The CreateEquivalenceLinks action creates an equivalent link between the specified downstream part or assembly and the specified upstream part or assembly. You can create one or more equivalent links by specifying a single or multiple sets of downstream and upstream parts along with inline or specific upstream and downstream navigation criteria.
You can also create equivalent links in the context of change (change task or change notice).
See the Creating an Equivalent Link topic in the Windchill Help Center, for more information.
The attributes in the request payload of the CreateEquivalenceLinks action are described in the following table:
Request Attribute
Description
Required
UpstreamRoot
Attribute in the EquivalenceLinkAssociations entity type to specify the OID of the upstream root part.
* 
EquivalenceLinkAssociations is a collection of a single or multiple sets of downstream and upstream parts for which you want to create equivalent links.
Yes
UpstreamPath
Attribute in the EquivalenceLinkAssociations entity type to specify the path of an upstream part from its upstream root part.
The attribute value combines the part ID and the path ID of the upstream part.
* 
*UpstreamPath is a required attribute when you want to provide an upstream part from a structure for creating an equivalent link.
Yes*
DownstreamRoot
Attribute in the EquivalenceLinkAssociations entity type to specify the OID of the downstream root part.
Yes
DownstreamPath
Attribute in the EquivalenceLinkAssociations entity type to specify the path of a downstream part from its downstream root part.
The attribute value combines the part ID and the path ID of the downstream part.
* 
*DownstreamPath is a required attribute only when you want to specify a downstream part from a structure for creating an equivalent link.
Yes*
Description
Attribute in the EquivalenceLinkAssociations entity type to specify the description for the new equivalent link.
Optional
LinkType
Attribute in the EquivalenceLinkAssociations entity type to specify the type of the equivalent link that you want to create.
When the value is empty, an equivalent link is created.
When you specify AlternateEquivalent, an alternate equivalent link is created.
Optional
IsConsumable
Flag in the EquivalenceLinkAssociations entity type to specify whether you want to allow the equivalent link to be used as a context for creating occurrence links or not.
Yes
DoCopyOver
Flag in the EquivalenceLinkAssociations entity type to specify whether you want to allow the attributes from the upstream part to be used on the equivalent downstream part or not.
Yes
DownstreamNavigationCriteria
Inline or specific navigation criteria applied in the downstream.
* 
PTC recommends that you specify the navigation criteria when you perform this action.
If not specified, the System Default filter is applied.
Optional
UpstreamNavigationCriteria
Inline or specific navigation criteria applied in the upstream.
* 
PTC recommends that you specify the navigation criteria when you perform this action.
If not specified, the System Default filter is applied.
Optional
ChangeOid
Attribute to specify the OID of a change task or change notice.
Optional
The following URI with expand returns information for each equivalence link that is created:
POST Windchill/servlet/odata/BomTransformation/CreateEquivalenceLinks?$expand=EquivalenceLink
For example, the response is as follows:
{
"@odata.context": "$metadata#EquivalenceLinkAssociations",
"value": [
{
"ID": "wt.associativity.EquivalenceLink:561118",
"DownstreamPath": "39a15ac0-658b-4b4d-aa35-91b79015bdf1",
"UpstreamPath": "0152daed-0579-4698-91bb-a67e764b072d",
"Description": "EquivalentLink1",
"DoCopyOver": true,
"IsConsumable": false,
"LinkType": "",
"UpstreamId": "wt.part.WTPart:560915",
"DownstreamId": "wt.part.WTPart:561059",
"EquivalenceLink": {
"CreatedOn": "2022-08-23T10:30:46+02:00",
"ID": "OR:wt.associativity.EquivalenceLink:561220",
"LastModified": "2022-08-23T10:30:46+02:00",
"Annotations": "0",
"Consumable": false,
"Description": "EquivalentLink1",
"DownstreamContext": "Manufacturing",
"EquivalenceIdentifier": "1642",
"ObjectType": "Manufacturing Equivalence Link",
"UpstreamContext": "Design"
}
}
],
"@PTC.AppliedContainerContext.LocalTimeZone": "Europe/Warsaw"
}