CreateEquivalenceUsageLinks

Windchill REST Services Domain Capabilities > PTC Domains > PTC BOM Transformation Domain > Actions Available in the BOM Transformation Domain for Creating or Updating Downstream BOMs > CreateEquivalenceUsageLinks

The CreateEquivalenceUsageLinks action creates equivalent usage links between upstream part usages and their respective equivalent downstream part usages. You can create a single or multiple equivalent usage links using inline or specific upstream and downstream navigation criteria.

See the Equivalent Usages and Creating an Equivalent Usage Link topics in the Windchill Help Center, for more information.

The attributes in the request payload of the CreateEquivalenceUsageLinks action are described in the following table:

Request Attribute

Description

Required

UpstreamRoot

Attribute in the EquivalenceUsageAssociation entity type to specify the OID of the upstream root part.

EquivalenceUsageAssociation is a collection of a single or multiple sets of upstream part usages and their equivalent downstream part usages for which you want to create the equivalent usage links.

Yes

UpstreamPath

Attribute in the EquivalenceUsageAssociation entity type to specify the usage path between an upstream part and its upstream root part.

The attribute value combines the part ID and the path ID of the upstream part.

Yes

DownstreamRoot

Attribute in the EquivalenceUsageAssociation entity type to specify the OID of the equivalent downstream root part.

Yes

DownstreamPath

Attribute in the EquivalenceUsageAssociation entity type to specify the usage path between an equivalent downstream part and its downstream root part.

The attribute value combines the part ID and the path ID of the downstream part.

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

The following URI with expand returns information for each equivalence usage link that is created:

POST Windchill/servlet/odata/BomTransformation/CreateEquivalenceUsageLinks?$expand=EquivalenceUsageLink

For example, the response is as follows:

{
"@odata.context": "$metadata#EquivalenceUsageAssociations",
"value": [
{
"DownstreamPath": "33b682f1-085c-4c3d-a535-63287e4dd993",
"UpstreamPath": "23d3aab1-1932-4e0c-9980-af0121c09f10",
"EquivalenceUsageLink": {
"ID": "wt.associativity.PartUsagePath:195739",
"DownstreamPath": "33b682f1-085c-4c3d-a535-63287e4dd993",
"UpstreamPath": "23d3aab1-1932-4e0c-9980-af0121c09f10"
}
},
{
"DownstreamPath": "741a8cc1-3792-4388-b31a-f50a7b0777fe",
"UpstreamPath": "23d3aab1-1932-4e0c-9980-af0121c09f10",
"EquivalenceUsageLink": {
"ID": "wt.associativity.PartUsagePath:195739",
"DownstreamPath": "741a8cc1-3792-4388-b31a-f50a7b0777fe",
"UpstreamPath": "23d3aab1-1932-4e0c-9980-af0121c09f10"
}
}
],
"@PTC.AppliedContainerContext.LocalTimeZone": "Europe/Warsaw"
}