Class DeviceFunctions

    • Constructor Detail

      • DeviceFunctions

        public DeviceFunctions()
    • Method Detail

      • SearchDevices

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable SearchDevices​(org.json.JSONObject query,
                                       java.lang.String nameMask,
                                       java.lang.String thingShape,
                                       java.lang.String thingTemplate,
                                       java.lang.Double maxItems)
                                throws java.lang.Exception
        Service Category:
        Queries
        Service Description:
        Retrieve a list of Devices that match the options specified.
        Parameters:
        query - Query definition - QUERY
        nameMask - Name pattern - STRING
        thingShape - Filter only for devices that implement this shape - THINGSHAPENAME
        thingTemplate - Filter only for devices that are derived from this template - THINGTEMPLATENAME
        maxItems - Maximum number of items to return - NUMBER
        Returns:
        result Matching Devices - INFOTABLE - Aspects {dataShape:DeviceStatus}
        Throws:
        java.lang.Exception - If an error occurs
      • GetUnboundRemoteThings

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable GetUnboundRemoteThings​(java.lang.Double maxItems)
                                         throws java.lang.Exception
        Service Category:
        Bindings
        Service Description:
        Get unbound remote things.
        Parameters:
        maxItems - Maximum number of items to return - NUMBER
        Returns:
        result Unbound remote things - INFOTABLE - Aspects {dataShape:BoundName}
        Throws:
        java.lang.Exception - If an error occurs
      • GetUnboundIdentifiers

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable GetUnboundIdentifiers​(java.lang.Double maxItems)
                                        throws java.lang.Exception
        Service Category:
        Bindings
        Service Description:
        Get unbound identifiers.
        Parameters:
        maxItems - Maximum number of items to return - NUMBER
        Returns:
        result Unbound remote things with identifiers - INFOTABLE - Aspects {dataShape:EntityList}
        Throws:
        java.lang.Exception - If an error occurs
      • GetBoundRemoteThings

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable GetBoundRemoteThings​(java.lang.Double maxItems)
                                       throws java.lang.Exception
        Service Category:
        Bindings
        Service Description:
        Get bound remote things.
        Parameters:
        maxItems - Maximum number of items to return - NUMBER
        Returns:
        result Bound remote things - INFOTABLE - Aspects {dataShape:DeviceStatus}
        Throws:
        java.lang.Exception - If an error occurs
      • GetUnboundThingsForFederatedServer

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable GetUnboundThingsForFederatedServer​(java.lang.String name,
                                                            java.lang.Double maxItems)
                                                     throws java.lang.Exception
        Service Category:
        Federation
        Service Description:
        Get unbound federated things.
        Parameters:
        name - Federated server name - THINGNAME
        maxItems - Maximum number of items to return - NUMBER
        Returns:
        result Unbound federated things - INFOTABLE - Aspects {dataShape:EntityList}
        Throws:
        java.lang.Exception - If an error occurs
      • GetBoundThingsForFederatedServer

        @ThingworxExtensionApiMethod(since={6,6})
        public InfoTable GetBoundThingsForFederatedServer​(java.lang.String name,
                                                          java.lang.Double maxItems)
                                                   throws java.lang.Exception
        Service Category:
        Federation
        Service Description:
        Get bound federated things.
        Parameters:
        name - Federated server name - THINGNAME
        maxItems - Maximum number of items to return - NUMBER
        Returns:
        result Bound federated things - INFOTABLE - Aspects {dataShape:DeviceStatus}
        Throws:
        java.lang.Exception - If an error occurs