PTC Sustainability Domain
 |
The API version 1 of the domain and its endpoints are deprecated and will be removed in a future release of Windchill REST Services.
|
The PTC Sustainability (Sustainability) domain provides access to the engineering material capabilities of Windchill to enable you to design for sustainability. Engineering materials are material specifications assigned by CAD/CAE users to verify that the design satisfies its physical and environmental requirements.
The domain contains the EngineeringMaterial OData entity that represents the engineering material objects in Windchill, and provides the EngineeringMaterials entity set that enables clients to create, read, update, and delete the engineering materials available in the Windchill system.
The following table lists the significant OData entities available in the Sustainability domain. To see all the OData entities available in the Sustainability domain, refer to the entity data model (EDM) of the domain. The domain EDM is available at the metadata URL, /Windchill/servlet/odata/Sustainability/$metadata
|
Items
|
OData Entities
|
Description
|
|---|---|---|
|
Engineering Materials
|
EngineeringMaterial
|
The EngineeringMaterial entity represents the engineering material object and has the entity-specific attributes such as Density and OrganizationName in addition to the common attributes.
|
|
Material Assignment Links
|
MaterialAssignmentLink
|
The MaterialAssignmentLink entity represents a material assignment link created between the given engineering material object and its related part.
|
|
References
|
EngineeringMaterialReferenceLink
|
The EngineeringMaterialReferenceLink entity represents an engineering material reference link created between the given engineering material object and a reference document.
|
|
DescribedBy
|
EngineeringMaterialDescribeLink
|
The EngineeringMaterialDescribeLink entity represents an engineering material describe link created between the given engineering material object and a document.
|
|
Engineering Material Catalogs
|
EngineeringMaterialCatalog
|
The EngineeringMaterialCatalog entity represents the catalog of engineering materials that are available for use in parts or part structures, depending on their approval status.
|
|
Engineering Material Approvals
|
MaterialApproval
|
The MaterialApproval entity represents an engineering material approval link that exists between an engineering material catalog and an engineering material with an approval status relative to that collection.
|
Navigation Properties Available for the EngineeringMaterial Entity
The following are some of the important navigation properties available for the EngineeringMaterial entity:
• MaterialAssignmentLinks—Retrieves the material assignment links for an engineering material.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterials('OR:wt.part.WTPart:565998')/MaterialAssignmentLinks
• Attachments—Retrieves the attachments for an engineering material.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterials('OR:wt.part.WTPart:536532')?$expand=Attachments
• Thumbnails—Retrieves the thumbnails configured for an engineering material.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterials('OR:wt.part.WTPart:536532')?$expand=Thumbnails
• SmallThumbnails—Retrieves the small thumbnails configured for an engineering material.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterials('OR:wt.part.WTPart:536532')?$expand=SmallThumbnails
• DescribedBy—Retrieves the association link between an engineering material object and a document.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterials('OR:wt.part.WTPart:546607')/DescribedBy
• References—Retrieves the association link between an engineering material object and a reference document.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterials('OR:wt.part.WTPart:546607')/References
Navigation Property Available for the MaterialAssignmentLink Entity
The following navigation property is available for the MaterialAssignmentLink entity:
RelatedPart—Retrieves the related parts for engineering material links.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterials('OR:wt.part.WTPart:565998')/MaterialAssignmentLinks?$expand=RelatedPart
Navigation Properties Available for the EngineeringMaterialReferenceLink Entity
The following are some of the important navigation properties available for the EngineeringMaterialReferenceLink entity:
• References—Retrieves the association link between an engineering material object and a reference document.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterials('OR:wt.part.WTPart:546607')/References
• ReferencedBy—Additionally, you can retrieve the related engineering material objects using the ReferencedBy navigation property.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterials('OR:wt.part.WTPart:546607')/References('OR:wt.part.WTPartReferenceLink:546620')/ReferencedBy
Navigation Properties Available for the EngineeringMaterialDescribeLink Entity
The following are some of the important navigation properties available for the EngineeringMaterialDescribeLink entity:
• DescribedBy—Retrieves the association link between an engineering material object and a document.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterials('OR:wt.part.WTPart:546607')/DescribedBy
• Describes—Additionally, you can retrieve the related engineering material objects using the Describes navigation property.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterials('OR:wt.part.WTPart:546607')/DescribedBy('OR:wt.part.WTPartDescribeLink:570092')/Describes
Navigation Properties Available for the EngineeringMaterialCatalog Entity
The following are the important navigation properties available for the EngineeringMaterialCatalog entity:
• MaterialApprovals—Retrieves the approval status for each engineering material object available in a given engineering material catalog.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterialCatalogs('OR:wt.engineeringmaterial.EngMatCatalog:410293')/MaterialApprovals
• DescribedByEngMatCatalogDescribeLink—Retrieves the DescribedBy link between an existing engineering material catalog and an existing document.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterialCatalogs('OR:wt.engineeringmaterial.EngMatCatalog:410293')/DescribedByEngMatCatalogDescribeLink
Additionally, you can retrieve the association link between a given DescribedByEngMatCatalogDescribeLink and a document.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterialCatalogs('OR:wt.engineeringmaterial.EngMatCatalog:410293')/DescribedByEngMatCatalogDescribeLink('OR:wt.configurablelink.ConfigurableDescribeLink:411102')/DescribedBy
• ReferencesEngMatCatalogReferenceLink—Retrieves the engineering material part reference link between an existing engineering material catalog and an existing reference document.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterialCatalogs('OR:wt.engineeringmaterial.EngMatCatalog:410293')/ReferencesEngMatCatalogReferenceLink
Additionally, you can retrieve the association link between a given ReferencesEngMatCatalogReferenceLink and a reference document.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterialCatalogs('OR:wt.engineeringmaterial.EngMatCatalog:410293')/ReferencesEngMatCatalogReferenceLink('OR:wt.configurablelink.ConfigurableReferenceLink:411101')/References
Navigation Properties Available for the MaterialApproval Entity
The following are the important navigation properties available for the MaterialApproval entity:
• RelatedMaterial—Retrieves the engineering material objects associated with a given engineering material catalog.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterialCatalogs('OR:wt.engineeringmaterial.EngMatCatalog:410293')/MaterialApprovals?$expand=RelatedMaterial
• RelatedCatalog—Retrieves the associated engineering material catalog for the engineering material objects available to a user.
Example URI:
GET /Windchill/servlet/odata/Sustainability/EngineeringMaterialCatalogs('OR:wt.engineeringmaterial.EngMatCatalog:410293')/MaterialApprovals?$expand=RelatedCatalog
Refer to the domain EDM for a complete list of navigation properties.