Package com.thingworx.resources.collections

Class CollectionsServices

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.entities.ExtensibleRootEntity

com.thingworx.resources.Resource

com.thingworx.resources.collections.CollectionsServices

All Implemented Interfaces:

IConfigurableObject, INotScriptFriendly, ISupportsDeprecation, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, Serializable

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class CollectionsServices
extends Resource

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTY_DEFINITIONS, EXCLUDED_ENTITY_TYPES_IN_PROJECT

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
CollectionsServices()

Method Summary

Modifier and Type	Method	Description
void	AddCollectionDesignTimePermission(String collectionName, String type, String principal, String principalType, Boolean allow)	Service Category: Permissions Service Description: Add a design time permission.
void	AddCollectionRunTimePermission(String collectionName, String type, String resource, String principal, String principalType, Boolean allow)	Service Category: Permissions Service Description: Add a run time permission.
void	AddCollectionVisibilityPermission(String collectionName, String principal, String principalType)	Service Category: Permissions Service Description: Add a visibility permission.
void	DeleteCollectionDesignTimePermission(String collectionName, String type, String principal, String principalType)	Service Category: Permissions Service Description: Delete a design time permission.
void	DeleteCollectionRunTimePermission(String collectionName, String type, String resource, String principal, String principalType)	Service Category: Permissions Service Description: Delete a run time permission.
void	DeleteCollectionVisibilityPermission(String collectionName, String principal, String principalType)	Service Category: Permissions Service Description: Delete a visibility permission.
void	ExportUserPermissions(String repositoryName, String path, String fileName, Boolean includeCollectionPermissions, Boolean includeEntityPermissions, TagCollection tags, String projectName, Boolean includeDependents)	Service Category: Permissions Service Description: Export permissions for entities and collections.
InfoTable	GetCollectionDesignTimePermissions(String collectionName)	Service Category: Permissions Service Description: Get a list of assigned design time permissions.
InfoTable	GetCollectionRunTimePermissions(String collectionName)	Service Category: Permissions Service Description: Get a list of assigned runtime permissions.
InfoTable	GetCollectionVisibilityPermissions(String collectionName)	Service Category: Permissions Service Description: Get a list of assigned visibility permissions.
void	ImportUserPermissions(String repositoryName, String path, String fileName)	Service Category: Permissions Service Description: Import permissions for entities and collections.

Methods inherited from class com.thingworx.resources.Resource

getEntityType

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, initializeEntity, preInitializeEntity, processAPIServiceRequest, processServiceRequest

Methods inherited from class com.thingworx.entities.RootEntity

AddConfigurationTableDefinition, AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, DeleteConfigurationTableRows, deleteDesignTimePermission, DeleteDesignTimePermission, deleteRunTimePermission, DeleteRunTimePermission, deleteVisibilityPermission, DeleteVisibilityPermission, dispose, getAspects, GetAvatar, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, GetHomeMashup, GetIncomingDependencies, GetIncomingDependenciesAsNetwork, GetInstanceMetadataAsJSON, GetInstanceMetadataWithPermissionsAsJSON, GetLastModifiedDate, GetMetadata, GetMetadataAsJSON, GetMetadataWithPermissionsAsJSON, GetOutgoingDependencies, GetOutgoingDependenciesAsNetwork, getOwner, GetOwner, GetPermissionsForCurrentUser, GetPermissionsForGroup, GetPermissionsForUser, GetProjectName, GetPropertyDefinition, GetPropertyDefinitions, getRunTimePermissions, GetRunTimePermissions, GetRunTimePermissionsAsJSON, GetServiceDefinition, GetServiceDefinitions, getStringConfigurationSetting, getStringConfigurationSettingWithDefault, GetSummaryInformation, getTags, GetTags, GetTagsAsInfoTable, getVisibilityPermissions, GetVisibilityPermissions, GetVisibilityPermissionsAsJSON, HasIncomingDependencies, HasOutgoingDependencies, isEditable, isEditableExtensionObject, isEditableSystemObject, isExtensionObject, IsMultiRowTable, isOwner, isSystemObject, isThemeObject, isVisible, isVisible, ListDeprecatedUsage, persistDesignTimePermissions, persistRunTimePermissions, persistVisibilityPermissions, RemoveTags, SaveConfigurationTables, SetAvatar, setConfigurationSetting, SetConfigurationTable, SetConfigurationTableRows, SetDescription, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, SetHomeMashup, setLastModifiedDate, SetMultiRowConfigurationTable, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, SetTags, setVisibilityPermissions, SetVisibilityPermissionsAsJSON, toJSON, toJSONDefinition, UpdateProjectDependencies, validateConfiguration

Methods inherited from class com.thingworx.persistence.common.PersistableNamedObject

getID, hasID, isTransient

Methods inherited from class com.thingworx.types.NamedObject

getDescription, getName, setDescription, setName, toValueCollection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

Methods inherited from interface com.thingworx.entities.interfaces.IPersistable

getID, hasID

Methods inherited from interface com.thingworx.security.permissions.ISecurable

getID, getName

Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation

getDeprecated, isDeprecated, isDeprecatedBefore, since

Constructor Details

CollectionsServices

public CollectionsServices()

Method Details

AddCollectionRunTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void AddCollectionRunTimePermission(String collectionName,
 String type,
 String resource,
 String principal,
 String principalType,
 Boolean allow)
                                    throws Exception

Service Category:

Permissions

Service Description:

Add a run time permission.

Parameters:

collectionName - Collection name (Things, Users, ThingShapes, etc.) - STRING

type - Permission type (PropertyRead PropertyWrite ServiceInvoke EventInvoke EventSubscribe) - STRING

resource - Resource name (* = all or enter a specific resource to override) - STRING

principal - Principal name (name of user or group) - STRING

principalType - Principal type (User or Group) - STRING

allow - Permission (true = allow, false = deny) - BOOLEAN

Throws:

Exception - If an error occurs

DeleteCollectionRunTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteCollectionRunTimePermission(String collectionName,
 String type,
 String resource,
 String principal,
 String principalType)
                                       throws Exception

Service Category:

Permissions

Service Description:

Delete a run time permission.

Parameters:

collectionName - Collection name (Things, Users, ThingShapes, etc.) - STRING

type - Permission type - STRING

resource - Resource name - STRING

principal - Principal name (name of user or group) - STRING

principalType - Principal type (User or Group) - STRING

Throws:

Exception - If an error occurs

GetCollectionRunTimePermissions

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetCollectionRunTimePermissions(String collectionName)
                                          throws Exception

Service Category:

Permissions

Service Description:

Get a list of assigned runtime permissions.

Parameters:

collectionName - Collection name (Things, Users, ThingShapes, etc.) - STRING

Returns:

result Permission list - INFOTABLE - Aspects {dataShape:Permissions}

Throws:

Exception - If an error occurs

AddCollectionDesignTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void AddCollectionDesignTimePermission(String collectionName,
 String type,
 String principal,
 String principalType,
 Boolean allow)
                                       throws Exception

Service Category:

Permissions

Service Description:

Add a design time permission.

Parameters:

collectionName - Collection name (Things, Users, ThingShapes, etc.) - STRING

type - Permission type (Create, Read, Update and Delete) - STRING

principal - Principal name (name of user or group) - STRING

principalType - Principal type (User or Group) - STRING

allow - Permission (true = allow, false = deny) - BOOLEAN

Throws:

Exception - If an error occurs

DeleteCollectionDesignTimePermission

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteCollectionDesignTimePermission(String collectionName,
 String type,
 String principal,
 String principalType)
                                          throws Exception

Service Category:

Permissions

Service Description:

Delete a design time permission.

Parameters:

collectionName - Collection name (Things, Users, ThingShapes, etc.) - STRING

type - Permission type - STRING

principal - Principal name (name of user or group) - STRING

principalType - Principal type (User or Group) - STRING

Throws:

Exception - If an error occurs

GetCollectionDesignTimePermissions

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetCollectionDesignTimePermissions(String collectionName)
                                             throws Exception

Service Category:

Permissions

Service Description:

Get a list of assigned design time permissions.

Parameters:

collectionName - Collection name (Things, Users, ThingShapes, etc.) - STRING

Returns:

result Permission list - INFOTABLE - Aspects {dataShape:Permissions}

Throws:

Exception - If an error occurs

AddCollectionVisibilityPermission

@ThingworxExtensionApiMethod(since={6,6})
public void AddCollectionVisibilityPermission(String collectionName,
 String principal,
 String principalType)
                                       throws Exception

Service Category:

Permissions

Service Description:

Add a visibility permission.

Parameters:

collectionName - Collection name (Things, Users, ThingShapes, etc.) - STRING

principal - Principal name (name of organization or organization unit) - STRING

principalType - Principal type (Organization or Organization Unit) - STRING

Throws:

Exception - If an error occurs

DeleteCollectionVisibilityPermission

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteCollectionVisibilityPermission(String collectionName,
 String principal,
 String principalType)
                                          throws Exception

Service Category:

Permissions

Service Description:

Delete a visibility permission.

Parameters:

collectionName - Collection name (Things, Users, ThingShapes, etc.) - STRING

principal - Principal name (name of organization or organization unit) - STRING

principalType - Principal type (Organization or Organization Unit) - STRING

Throws:

Exception - If an error occurs

GetCollectionVisibilityPermissions

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetCollectionVisibilityPermissions(String collectionName)
                                             throws Exception

Service Category:

Permissions

Service Description:

Get a list of assigned visibility permissions.

Parameters:

collectionName - Collection name (Things, Users, ThingShapes, etc.) - STRING

Returns:

result Permission list - INFOTABLE - Aspects {dataShape:Permissions}

Throws:

Exception - If an error occurs

ExportUserPermissions

@ThingworxExtensionApiMethod(since={7,1})
public void ExportUserPermissions(String repositoryName,
 String path,
 String fileName,
 Boolean includeCollectionPermissions,
 Boolean includeEntityPermissions,
 TagCollection tags,
 String projectName,
 Boolean includeDependents)
                           throws Exception

Service Category:

Permissions

Service Description:

Export permissions for entities and collections.

Parameters:

repositoryName - File repository to which to export the permissions - THINGNAME

path - Path to which to write the permissions - STRING

fileName - Name of the file in which to write the permissions - STRING

includeCollectionPermissions - Export the collection permissions - BOOLEAN

includeEntityPermissions - Export the entity permissions - BOOLEAN

tags - Tags (optional) - TAGS

projectName - Project Name (optional) - PROJECTNAME

includeDependents - Include dependent projects - BOOLEAN

Throws:

Exception - If an error occurs

ImportUserPermissions

@ThingworxExtensionApiMethod(since={7,1})
public void ImportUserPermissions(String repositoryName,
 String path,
 String fileName)
                           throws Exception

Service Category:

Permissions

Service Description:

Import permissions for entities and collections.

Parameters:

repositoryName - File repository from which to import the permissions - THINGNAME

path - Path from which to read the permissions - STRING

fileName - Name of the file from which to read the permissions - STRING

Throws:

Exception - If an error occurs