PTC Product Platform Management Domain
 |
Starting with Windchill REST Services 2.6, the API versions 1, 2, and 3 of the domain are deprecated and will be removed in a future release of Windchill REST Services.
|
The PTC Product Platform Management domain provides access to the Options and Variants capabilities of Windchill. The Options and Variants capabilities define fixed options and choices that are used to specify discrete configurations for a product. The domain provides OData entities that represent business objects such as options, choices, option sets, variant specifications, and so on.
The PTC Product Platform Management domain is available only when Windchill PDMLink is installed.
|
|
From Windchill REST Services 2.4 onwards, this domain is available irrespective of the preference value for Configurable Module Support at any context level.
The POST and PATCH actions in this domain will be tracked against the required licenses for this capability.
|
The following table lists the significant OData entities available in the PTC Product Platform Management domain. To see all the OData entities available in the PTC Product Platform Management domain, refer to the EDM of the domain. The domain EDM is available at the metadata URL.
|
Items
|
OData Entities
|
Description
|
|---|---|---|
|
Options
|
Option
|
The Option entity represents a capability or feature of a product that can be designed with variations. An option may have several choices.
The entity provides navigation to Choice or OptionGroup entities.
|
|
Choices in an option
|
Choice
|
The Choice entity represents the values that are associated with an option.
This entity provides a navigation property that lists the options associated with the choice. You can also expand the navigation property to list the details of the option.
|
|
Collection of options
|
OptionSet
|
An OptionSet is a collection of options and choices. These options and choices are referenced from the option pool.
This entity provides navigation property that lists all the options available in the option set. You can also expand the navigation property to list the choices available in each option.
|
|
Variant specification
|
VariantSpecification
|
Variant specification is a collection of inputs and selections specified for a configurable structure when you create a variant.
See the section Navigation Properties Available for VariantSpecification Entity, for information on some of the navigation properties available with VariantSpecification entity.
|
Information About Other Entities
The following entities are not a part of the service document.
• OptionGroup—Collection of options that enables you to organize the options available for a product.
• OptionPoolItem—Option groups and top-level options created for a Windchill product or library context. Every Windchill product or library context can have a pool of options that are used in option sets.
• DesignOption—Options created for product design.
For example, the following URL retrieves design options:
/ProdPlatformMgmt/Options/PTC.ProdPlatformMgmt.DesignOption
• DesignChoice—Choices created for product design.
For example, the following URL retrieves design choices:
/ProdPlatformMgmt/Choices/PTC.ProdPlatformMgmt.DesignChoice
• SalesOption—Options created for sales.
For example, the following URL retrieves sales options:
/ProdPlatformMgmt/Options/PTC.ProdPlatformMgmt.SalesOption
• SalesChoice—Choices created for sales.
For example, the following URL retrieves sales choices:
/ProdPlatformMgmt/Choices/PTC.ProdPlatformMgmt.SalesChoice
• IndependentAssignedExpression—Independent expressions that are assigned to objects. The entity contains the following navigation properties:
◦ AssignedExpression—Retrieves the details for independent expressions. Information about the expression aliases is also returned.
◦ Effectivities—Retrieves the effectivities associated with the independent expressions.
Navigation Properties Available for VariantSpecification Entity
The following navigation properties are available for the VariantSpecification entity:
• NavigationCriteria—Retrieves the navigation criteria, which is saved with the variant specification.
• ConfigurableModule—Retrieves the configurable module, which is associated with the variant specification.
• OptionSet—Retrieves the option set assigned to the variant specification.