Package com.thingworx.security.groups

Class Group

    • Constructor Detail

      • Group

        public Group()

    • Method Detail

      • AssignMembers

        @ThingworxExtensionApiMethod(since={6,6})
public void AssignMembers​(InfoTable members)
                   throws java.lang.Exception
        Service Category:
        Members
        Service Description:
        Assign a list of users/groups to this group.
        Parameters:
        members - Members - INFOTABLE
        Throws:
        java.lang.Exception - If an error occurs

      • AddMember

        @ThingworxExtensionApiMethod(since={6,6})
public void AddMember​(java.lang.String member,
                      java.lang.String type)
               throws java.lang.Exception
        Service Category:
        Members
        Service Description:
        Add a user/group to this group.
        Parameters:
        member - Member - STRING
        type - Member type - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • DeleteMember

        @ThingworxExtensionApiMethod(since={6,6})
public void DeleteMember​(java.lang.String member,
                         java.lang.String type)
                  throws java.lang.Exception
        Service Category:
        Members
        Service Description:
        Remove a user/group from this group.
        Parameters:
        member - Member - STRING
        type - Member type - STRING
        Throws:
        java.lang.Exception - If an error occurs

      • deleteAllGroupMembers

        @ThingworxExtensionApiMethod(since={7,4})
public void deleteAllGroupMembers()
                           throws java.lang.Exception
        Throws:
        java.lang.Exception - If an error occurs

      • GetGroupMembers

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetGroupMembers()
                          throws java.lang.Exception
        Service Category:
        Members
        Service Description:
        Get a list of members in this group.
        Returns:
        result Group Members - INFOTABLE - Aspects {dataShape:GroupMember}
        Throws:
        java.lang.Exception - If an error occurs

      • GetGroupMember

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetGroupMember​(java.lang.String name)
                         throws java.lang.Exception
        Service Category:
        Service Description:
        Get members by name in this group.
        Parameters:
        name - Field name - STRING
        Returns:
        result Group Member - INFOTABLE - Aspects {dataShape:GroupMember}
        Throws:
        java.lang.Exception - If an error occurs

      • QueryGroupMembers

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable QueryGroupMembers​(org.json.JSONObject types,
                                   java.lang.String filter,
                                   java.lang.Double maxItems)
                            throws java.lang.Exception
        Service Category:
        Members
        Service Description:
        Query a list of members in this group.
        Parameters:
        types - Entity types - JSON
        filter - Term filter - STRING
        maxItems - Maximum number of items to return - NUMBER
        Returns:
        result Group Members - INFOTABLE - Aspects {dataShape:GroupMember}
        Throws:
        java.lang.Exception - If an error occurs

      • GetGroups

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetGroups()
                    throws java.lang.Exception
        Service Category:
        Members
        Service Description:
        Get list of groups that this group is a member of.
        Returns:
        result Result - INFOTABLE - Aspects {dataShape:EntityList}
        Throws:
        java.lang.Exception - If an error occurs

      • GetOrganizationalUnits

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetOrganizationalUnits()
                                 throws java.lang.Exception
        Service Category:
        Members
        Service Description:
        Get list of organizational units that this group is a member of.
        Returns:
        result Result - INFOTABLE - Aspects {dataShape:EntityList}
        Throws:
        java.lang.Exception - If an error occurs

      • GetOrganizations

        @ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetOrganizations()
                           throws java.lang.Exception
        Service Category:
        Members
        Service Description:
        Get list of organizations that this group is a member of.
        Returns:
        result Result - INFOTABLE - Aspects {dataShape:EntityList}
        Throws:
        java.lang.Exception - If an error occurs

      • SetHomeMashup

        @ThingworxExtensionApiMethod(since={6,6})
public void SetHomeMashup​(java.lang.String name)
                   throws java.lang.Exception
        Service Category:
        Mashups
        Service Description:
        Calling SetHomeMashup on Groups is not supported.
        Overrides:
        SetHomeMashup in class RootEntity
        Parameters:
        name - Home mashup name - MASHUPNAME
        Throws:
        java.lang.Exception - If an error occurs