Functions Available in the PTC Common Domain

The function GetAllStates() returns a list of life cycle states, which are available and can be selected in Windchill. The life cycle states that cannot be selected in Windchill are not returned. The life cycle states are retrieved from the StateRb.rbinfo file.

The GetWindchillMetaInfo() function returns the localized display names of service metadata for OData entities, structural, navigation and complex type properties that are available in the domain from which the function is called. The function is available to all domains that import the PTC Common domain.

• For entity types that are not backed by a Windchill type, the function returns the internal names of the entity as null and the display names of the entity as defined in the rbInfoForDisplayName property, only when those are defined in the entity json configuration using the rbInfoForDisplayName property.

• For properties that are available on the OData entity, but are not available in Windchill, the function returns the value of display name as defined in the rbInfoForDisplayName property, only when it is defined in the entity json configuration using the rbInfoForDisplayName property.

◦ The “Real Numbers”, “Real Number with units”, and “Integer” attributes are for the Currency property (boolean flags for Currency and Percent). For attributes that are not “Real Numbers”, “Real Number with units” and “Integer”, Currency and Percent are null.

Here, Currency is not a Quantity of Measure. It is a Type Manager configuration option, which is not locale dependent To manage currencies, it is recommended to use Real Number with the Units attributes, as described in the About Windchill Units topic.

{
"@odata.context": "https://windchill.ptc.com/Windchill/servlet/odata/v3/PTC/$metadata#Collection(PTC.EntityMetaInfo)",
"value": [
...
{
"EntityType": "PTC.PrincipalMgmt.Group",
"BaseType": "PTC.PrincipalMgmt.Principal",
"HasWindchillType": true,
"DisplayName": "Group",
"InternalName": "wt.org.WTGroup",
"PropertyInfo": [
{
"PropertyName": "Description",
"DisplayName": "Description",
"InternalName": "description"
},
{
"PropertyName": "DomainName",
"DisplayName": "Name",
"InternalName": "administrativeDomainName"
}
],
"NavigationPropertyInfo": [
{
"PropertyName": "Users",
"DisplayName": "Members"
}
]
}
...
]
}

The function also returns the global names and data types including the complex data types such as PTC.EnumType, PTC.QuantityOfMeasureType, PTC.Hyperlink, and so on for the properties in the Part entity. For example, when you call the function,

{
"@odata.context": "https://windchill.ptc.com/Windchill/servlet/odata/v3/PTC/$metadata#PTC.EntityMetaInfo",
"@PTC.AppliedContainerContext.LocalTimeZone": "America/Chicago",
"EntityType": "PTC.ProdMgmt.Part",
"IsEntityTypeComplex": false,
"BaseType": "PTC.WindchillEntity",
"HaswindchillType": true,
"IsInstantiable": true,
"DisplayName": "Part",
"InternalName": "wt.part.WTPart",
"Propertylnfo": [
{
"PropertyName": "AlternateNumber",
"DisplayName": "Alternate Number",
"InternalName": "variation2",
"IsRichText": null,
"GlobalName": "IBA|reusableString"
},
{
"PropertyName": "LocalHyperlink",
"DisplayName": "Local Hyperlink",
"InternalName": "localHyperlink",
"IsRichText": null,
"DataType": "PTC.Hyperlink"
}
]
}

GET /Windchill/servlet/odata/ProdMgmt/GetWindchillMetaInfo(EntityName='PTC.ProdMgmt.SupplierPart',IncludeDescendants=true) will return the parent supplier part as well as its child properties. Setting the value of IncludeDescendants to false will return only the parent entity.

• The PropertyType field is used to flag persistent attributes like model-based attributes (MBA) and instance-based attributes (IBA), as well as non-persistent attributes (NPA) and server-calculated attributes (SCA). For example, you can use the following URI:

{
"EntityType": "PTC.ProdMgmt.Part",
"IsEntityTypeComplex": false,
"BaseType": "PTC.WindchillEntity",
"HasWindchillType": true,
"IsInstantiable": true,
"DisplayName": "Part",
"InternalName": "wt.part.WTPart",
"PropertyInfo": [
{
"PropertyName": "Identity",
"DisplayName": "Identity",
"InternalName": "displayIdentity",
"IsRichText": false,
"DataType": "Edm.String",
"ReadOnly": true,
"Common": false,
"Required": false,
"PropertyType": "ServerCalculated",
"GlobalName": null,
"Mapping": null,
"Formula": null
},
{
"PropertyName": "Number",
"DisplayName": "Number",
"InternalName": "number",
"IsRichText": false,
"DataType": "Edm.String",
"ReadOnly": false,
"Common": true,
"Required": false,
"PropertyType": "ModelBased",
"GlobalName": null,
"Mapping": null,
"Formula": null
},
{
"PropertyName": "OrganizationReference",
"DisplayName": "Organization Name",
"InternalName": "organizationReference",
"IsRichText": false,
"DataType": "Edm.String",
"ReadOnly": true,
"Common": false,
"Required": false,
"PropertyType": "NonPersisted",
"GlobalName": null,
"Mapping": "MBA|masterReference^WCTYPE|wt.part.WTPartMaster~MBA|organizationReference^WCTYPE|wt.org.WTOrganization",
"Formula": null
}
]
}

The GetWindchillVersion() function returns information similar to the windchill version command in the Windchill shell. For more information on the Windchill shell, see About the windchill Command in the Windchill Help Center. The function returns a list of installed modules along with the currently installed version of Windchill. Each installed module is represented as a Complex Type. For example: