Package com.ptc.wa.rest.services

Interface WAService

public interface WAService
Service contract for WAOperations REST call.

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    com.ptc.core.common.model.ItemList
    applySCN(String scn)
    Apply or save SCN.
    com.ptc.core.common.model.ItemList
    createPAATestFile()
    Creates a Test File in the predefined Windchill accessible location.
    com.ptc.core.common.model.ItemList
    deletePAATestFile()
    Deletes the created Test File by createPAATestFile() API
    Map<String,Object>
    generateHTMLLicenseReport(String timeStamp, String dtFrom, String dtTo)
    Gives html report (uses generateLicReport() API from License Management UI ).
    com.ptc.core.common.model.ItemList
    getEMSLocationPath()
    Gives the Location path saved by the user,
    com.ptc.core.common.model.ItemList
    getEMSStatus()
    Gives EMS Status True or False
    com.ptc.core.common.model.ItemList
    getOptInConfiguration()
    Reads OptIn value
    com.ptc.core.common.model.ItemList
    getSavedSCN()
    reads SCN from wt.properties
    com.ptc.core.common.model.ItemList
    getSendToPTC()
    Retrieve the value of the SendToPTC flag
    com.ptc.core.common.model.ItemList
    getWindchillInstanceID()
    Gives GUID (uses getWindchillInstanceID() from InstanceID ).
    com.ptc.core.common.model.ItemList
    saveEMSConfiguration(String location)
    Saves the EMS location and Status
    com.ptc.core.common.model.ItemList
    saveOptInConfiguration(com.ptc.wa.rest.WAOptInConfItem optInOptOut)
    Saves OptInOptOut value
    com.ptc.core.common.model.ItemList
    saveTelemetryDataForPreview(String payloadData)
    Save Telemetry data to a temporary location for preview .
    com.ptc.core.common.model.Item
    saveUserAcknowledgement()
    Save the admin user acknowledgement for sending data to PTC
    com.ptc.core.common.model.Item
    shouldDisplayModalMessage(boolean isAdmin)
    Whether a modal message should be displayed or not on first login
    com.ptc.core.common.model.ItemList
    validateSCN(String userID, String pwd, String scn)
    Validate scn.

  • Method Details

    • validateSCN

      com.ptc.core.common.model.ItemList validateSCN(String userID, String pwd, String scn) throws Exception
      Validate scn.
      Returns:
      Returns ItemList
      Throws:
      Exception - Supported API: true

    • getSavedSCN

      com.ptc.core.common.model.ItemList getSavedSCN() throws Exception
      reads SCN from wt.properties
      Returns:
      Returns ItemList
      Throws:
      Exception - Supported API: true

    • getOptInConfiguration

      com.ptc.core.common.model.ItemList getOptInConfiguration() throws Exception
      Reads OptIn value
      Returns:
      Returns ItemList
      Throws:
      Exception - Supported API: true

    • saveOptInConfiguration

      com.ptc.core.common.model.ItemList saveOptInConfiguration(com.ptc.wa.rest.WAOptInConfItem optInOptOut)
      Saves OptInOptOut value
      Returns:
      Returns ItemList
      Throws:
      Exception - Supported API: true

    • saveEMSConfiguration

      com.ptc.core.common.model.ItemList saveEMSConfiguration(String location)
      Saves the EMS location and Status
      Parameters:
      wAEmsItem -
      Returns:
      Supported API: true

    • applySCN

      com.ptc.core.common.model.ItemList applySCN(String scn) throws Exception
      Apply or save SCN. Supported API: true
      Throws:
      Exception

    • getEMSStatus

      com.ptc.core.common.model.ItemList getEMSStatus() throws Exception
      Gives EMS Status True or False
      Returns:
      Throws:
      Exception - Supported API: true

    • getEMSLocationPath

      com.ptc.core.common.model.ItemList getEMSLocationPath() throws Exception
      Gives the Location path saved by the user,
      Returns:
      Throws:
      Exception - Supported API: true

    • createPAATestFile

      com.ptc.core.common.model.ItemList createPAATestFile() throws Exception
      Creates a Test File in the predefined Windchill accessible location. This location can be set from the Windchill PA Agent configuration tab or remotely from the saveEMSConfiguration API.
      Returns:
      Throws:
      Exception - Supported API: true

    • deletePAATestFile

      com.ptc.core.common.model.ItemList deletePAATestFile() throws Exception
      Deletes the created Test File by createPAATestFile() API
      Returns:
      Throws:
      Exception - Supported API: true

    • getWindchillInstanceID

      com.ptc.core.common.model.ItemList getWindchillInstanceID() throws Exception
      Gives GUID (uses getWindchillInstanceID() from InstanceID ).
      Returns:
      Throws:
      Exception - Supported API: true

    • generateHTMLLicenseReport

      Map<String,Object> generateHTMLLicenseReport(String timeStamp, String dtFrom, String dtTo) throws Exception
      Gives html report (uses generateLicReport() API from License Management UI ).
      Returns:
      Throws:
      Exception - Supported API: true

    • saveTelemetryDataForPreview

      com.ptc.core.common.model.ItemList saveTelemetryDataForPreview(String payloadData) throws Exception
      Save Telemetry data to a temporary location for preview .
      Returns:
      Throws:
      Exception - Supported API: true

    • shouldDisplayModalMessage

      com.ptc.core.common.model.Item shouldDisplayModalMessage(boolean isAdmin) throws Exception
      Whether a modal message should be displayed or not on first login
      Returns:
      Throws:
      Exception - Supported API: true

    • saveUserAcknowledgement

      com.ptc.core.common.model.Item saveUserAcknowledgement() throws Exception
      Save the admin user acknowledgement for sending data to PTC
      Returns:
      Throws:
      Exception - Supported API: true

    • getSendToPTC

      com.ptc.core.common.model.ItemList getSendToPTC() throws Exception
      Retrieve the value of the SendToPTC flag
      Returns:
      Throws:
      Exception - Supported API: true