PTC Reporting Domain

Windchill REST Services > Windchill REST Services Domain Capabilities > PTC Domains > PTC Reporting Domain

The PTC Reporting (Reporting) domain provides access to the reporting and query capabilities of Windchill. The domain includes entity types that represent report templates. This domain provides functionality to view and execute report templates.

The following table lists the significant OData entities available in the PTC Reporting domain. To see all the OData entities available in the PTC Reporting domain, refer to the EDM of the domain. The domain EDM is available at the metadata URL— /Windchill/servlet/odata/Reporting/$metadata.

Items	OData Entities	Description
Report Template	ReportTemplate	Represents the report template Windchill object that is a saved query, that can be used to generate and run a query. The ReportTemplate entity represents persistable information about report templates.
Report Result	ReportResult	ReportResult is used as a base type for all report templates listed as entities. ReportResult is a non-persistable entity.
Every Report Template is an EntityType	ReportTemplate Name	Every Report template object is represented as an entity type in metadata with QML attributes as its Properties. Report templates are non-persistable entities. Report templates are auto generated based on the number of report templates that exist.

Annotations

The following annotations are used to represent additional attributes for properties of entity types for reporting:

• PTC.Type : To identify alias of the table of a property

• PTC.Table : To identify the table name of a property

• PTC.Column : To identify the column mapped to a property.

• PTC.UserCanSelect : To check whether a user can select an object.

• PTC.UserCanConstrain : To check whether a user can constrain the attributes for a property.

Actions

The following is the key action available for this domain:

• ExecuteReportTemplate—Executes an existing report template, and returns a JSON output.

ExecuteReportTemplate can be invoked as either an unbound or a bound action:

◦ As an unbound action: POST /Windchill/servlet/odata/Reporting/ExecuteReportTemplate

◦ As a bound action: /Windchill/servlet/odata/Reporting/ReportTemplates('OR:wt.query.template.ReportTemplate:334133')/PTC.Reporting.ExecuteReportTemplate