Skip navigation links
Thingworx Platform API
9.0.0
com.thingworx.metadata.annotations

Annotation Type ThingworxServiceDefinition

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element and Description
      java.lang.String name


      Required parameter: the name of the service.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element and Description
      java.lang.String[] aspects


      Optional parameter: an array of key-value pairs associated with colons (e.g., "aspect1:value1", "aspect2:value2", …) describing aspects applicable to the field definition.
      java.lang.String category


      Optional parameter: a category that conceptually groups together related services.
      java.lang.String description


      Optional parameter: : a short description for the service.
      boolean isAllowOverride


      Optional parameter: specifies if the service should be overridable by other thing templates or things.
      boolean isDefinitionOnly


      Optional parameter: specifies that the service definition is only intended to describe the service and should fail if invoked.
      boolean isLocalOnly


      Optional parameter: specifies whether the service should be reflected in metadata when external-only metadata is requested.
      boolean isOpen
      Deprecated. 
      boolean isPrivate


      Optional parameter: indicates whether the service is intended for use by end users and other extensions, or if it is only intended for use within this extension.
    • Element Detail

      • name

        public abstract java.lang.String name


        Required parameter: the name of the service. It is standard convention for service names to start with a capital letter. The name of the service must be identical to the name of the method.
      • description

        public abstract java.lang.String description


        Optional parameter: : a short description for the service. The description should provide information on functionality of the service and any other pertinent information for users.
        Default:
        ""
      • category

        public abstract java.lang.String category


        Optional parameter: a category that conceptually groups together related services.
        Default:
        ""
      • isPrivate

        public abstract boolean isPrivate


        Optional parameter: indicates whether the service is intended for use by end users and other extensions, or if it is only intended for use within this extension. This is not currently enforced by the Platform.
        Default:
        false
      • isLocalOnly

        public abstract boolean isLocalOnly


        Optional parameter: specifies whether the service should be reflected in metadata when external-only metadata is requested. Typically this should be set to true if the service should not be exposed across federated servers.
        Default:
        false
      • isDefinitionOnly

        public abstract boolean isDefinitionOnly


        Optional parameter: specifies that the service definition is only intended to describe the service and should fail if invoked. Set this to true if you are applying it to an abstract method that other thing templates should override.
        Default:
        false
      • isAllowOverride

        public abstract boolean isAllowOverride


        Optional parameter: specifies if the service should be overridable by other thing templates or things. When set to true, ThingWorx will check to see if a service definition has been specified on the effective thing that overrides this service. Note that if this is set to true and isDefinitionOnly is set to false, then the service cannot be assigned any behavior.
        Default:
        false
      • isOpen

        @Deprecated
        public abstract boolean isOpen
        Deprecated. 


        Annotation has been deprecated since 8.4. Beware that the use of isOpen could expose your extensions to security holes and should be used with extreme prejudice. Optional parameter: indicates that this service should always execute regardless of whether the user has permission to invoke it. The service will still fail to execute if the user does not have permission to access the thing or subsystem itself.
        Default:
        false
      • aspects

        public abstract java.lang.String[] aspects


        Optional parameter: an array of key-value pairs associated with colons (e.g., "aspect1:value1", "aspect2:value2", …) describing aspects applicable to the field definition.
        See Also:
        Aspects
        Default:
        {}