Examples of the PTC ConfigurableLinks Domain

Windchill REST Services > Windchill REST Services Domain Capabilities > Examples for Basic REST Operations > Examples for the PTC ConfigurableLinks Domain > Examples of the PTC ConfigurableLinks Domain

Following are a few examples that demonstrate how to retrieve, create, update, and delete configurable link instances using the ConfigurableLinks domain.

Subtypes of ConfigurableDescribeLink

<constrained-type> is in "Role A":

• Template URI:

GET http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/DescribedBy<link-type>

GET http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/DescribedBy<link-type>('<link-id>')/DescribedBy

In addition to retrieval, this navigation supports create, update, and delete operations on configurable describe link instances.

Create a Configurable Describe Link (POST)

POST http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/DescribedBy<link-type>
{
"[email protected]": "<domain>/<roleB-entity-set>(<roleB-entity-id>)
}

Update a Configurable Describe Link (PATCH)

PATCH http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/DescribedBy<link-type>('<link-id>')
{
"<soft-attribute-name>": "<new-value>"
}

Delete a Configurable Describe Link (DELETE)

DELETE http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/DescribedBy<link-type>('<link-id>')

• Example URI

GET /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/DescribedByCustomDescribeLink

GET /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/DescribedByCustomDescribeLink('OR:wt.configurablelink.ConfigurableDescribeLink:298957')/DescribedBy

In addition to retrieval, this navigation supports create, update, and delete operations on configurable describe link instances.

Create (POST)

POST /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/DescribedByCustomDescribeLink
{
"[email protected]": "ProdMgmt/Documents('OR:wt.doc.WTDocument:XXXXX')"
}

Update (PATCH – soft attributes only)

PATCH /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/DescribedByCustomDescribeLink('OR:wt.configurablelink.ConfigurableDescribeLink:298957')
{
"<soft-attribute-name>": "<new-value>"
}

Delete (DELETE)

DELETE /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/DescribedByCustomDescribeLink('OR:wt.configurablelink.ConfigurableDescribeLink:298957')

<constrained-type> is in "Role B"

• Template URI:

http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<linked-entity-id>')/Describes<link-type>

http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<linked-entity-id>')/Describes<link-type>('<link-id>')/Describes

• Example URI

GET /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/DescribesCustomDescribeLink

GET /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/DescribesCustomDescribeLink('OR:wt.configurablelink.ConfigurableDescribeLink:298957')/Describes

The same create, update, and delete patterns apply when using the Role B navigation properties.

Subtypes of ConfigurableReferenceLink

<constrained-type> is in "Role A"

• Template URI

http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/References<link-type>

http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/References<link-type>('<link-id>')/References

• Example URI

http://<host>.ptcnet.ptc.com:2280/Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/ReferencesCustomReferenceLink

http://<host>.ptcnet.ptc.com:2280/Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/ReferencesCustomReferenceLink('OR:wt.configurablelink.ConfigurableReferenceLink:298957')/References

In addition to retrieval, this navigation supports create, update, and delete operations on configurable reference link instances.

Create a Configurable Revision Link (POST)

POST /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/ReferencesCustomReferenceLink
{
"[email protected]": "ProdMgmt/Documents('OR:wt.doc.WTDocument:XXXXX')"
}

Update a Configurable Revision Link (PATCH)

PATCH /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/ReferencesCustomReferenceLink('OR:wt.configurablelink.ConfigurableReferenceLink:298957')
{
"<soft-attribute-name>": "<new-value>"
}

Delete a Configurable Revision Link (DELETE)

DELETE /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/ReferencesCustomReferenceLink('OR:wt.configurablelink.ConfigurableReferenceLink:298957')

<constrained-type> is in "Role B"

• Template URI

http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/ReferencedBy<link-type>

http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/ReferencedBy<link-type>('<link-id>')/ReferencedBy

• Example URI

http://<host>.ptcnet.ptc.com:2280/Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/ReferencedByCustomReferenceLink

http://<host>.ptcnet.ptc.com:2280/Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/ReferencedByCustomReferenceLink('OR:wt.configurablelink.ConfigurableReferenceLink:298957')/ReferencedBy

The same create, update, and delete patterns apply when using the Role B navigation properties.

Subtypes of ConfigurableMastersLink

<constrained-type> is in "Role A"

• Template URI

http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/Traces<link-type>

http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/Traces<link-type>('<link-id>')/Traces

• Example URI

http://<host>.ptcnet.ptc.com:2280/Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/TracesCustomMastersLink

http://<host>.ptcnet.ptc.com:2280/Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/TracesCustomMastersLink('OR:wt.configurablelink.ConfigurableMastersLink:298957')/Traces

In addition to retrieval, this navigation supports create, update, and delete operations on configurable master link instances.

Create a Configurable Master Link (POST)

POST /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/LinkedToCustomRevisionLink
{
"[email protected]": "ProdMgmt/Parts('OR:wt.part.WTPart:YYYYY')"
}

Update a Configurable Master Link (PATCH)

PATCH /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/TracesCustomMastersLink('OR:wt.configurablelink.ConfigurableMastersLink:298957')
{
"<soft-attribute-name>": "<new-value>"
}

Delete a Configurable Master Link (DELETE)

DELETE /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/TracesCustomMastersLink('OR:wt.configurablelink.Config

<constrained-type> is in "Role B"

• Template URI

http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/TracedBy<link-type>

http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/TracedBy<link-type>('<link-id>')/TracedBy

• Example URI

http://<host>.ptcnet.ptc.com:2280/Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/TracedByCustomMastersLink

http://<host>.ptcnet.ptc.com:2280/Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/TracedByCustomMastersLink('OR:wt.configurablelink.ConfigurableMastersLink:298957')/TracedBy

Subtypes of ConfigurableRevisionLink

<constrained-type> is in "Role A"

• Template URI

http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/LinkedTo<link-type>

http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/LinkedTo<link-type>('<link-id>')/LinkedTo

• Example URI

http://<host>.ptcnet.ptc.com:2280/Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/LinkedToCustomRevisionLink

http://<host>.ptcnet.ptc.com:2280/Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/LinkedToCustomRevisionLink('OR:wt.configurablelink.ConfigurableRevisionLink:298957')/LinkedTo

In addition to retrieval, this navigation supports create, update, and delete operations on configurable revision link instances.

Create a Configurable Revision Link (POST)

POST /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/LinkedToCustomRevisionLink
{
"[email protected]": "ProdMgmt/Parts('OR:wt.part.WTPart:YYYYY')"
}

Update a Configurable Revision Link (PATCH)

PATCH /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/LinkedToCustomRevisionLink('OR:wt.configurablelink.ConfigurableRevisionLink:298957')
{
"<soft-attribute-name>": "<new-value>"
}

Delete a Configurable Revision Link (DELETE)

DELETE /Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/LinkedToCustomRevisionLink('OR:wt.configurablelink.ConfigurableRevisionLink:298957')

<constrained-type> is in "Role B"

• Template URI

http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/LinkedFrom<link-type>

http://<host>/Windchill/servlet/odata/<domain>/<constrained-type>('<constrained-entity-id>')/LinkedFrom<link-type>('<link-id>')/LinkedFrom

• Example URI

http://<host>.ptcnet.ptc.com:2280/Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/LinkedFromCustomRevisionLink

http://<host>.ptcnet.ptc.com:2280/Windchill/servlet/odata/ProdMgmt/Parts('OR:wt.part.WTPart:298950')/LinkedFromCustomRevisionLink('OR:wt.configurablelink.ConfigurableRevisionLink:298957')/LinkedFrom

The same create, update, and delete patterns apply when using the Role B navigation properties.

Refer to the domain EDM for a complete list of navigation properties.

Was this helpful?