The Asset Service provides access to the assets stored in the database. More...

Classes
struct	TreeVersion
	Data for asset versioning. More...

struct	Tree
	Asset base data structure. More...

struct	TreeMetadataInternal
	Asset Metadata. More...

struct	DirMetadata
	Directory Metadata wrapper Used only for single viewType operations like getTreeOwnMetadata or getTreeMetadataList. More...

struct	CatMetadata
	Category Metadata wrapper Used only for single viewType operations like getCategoryOwnMetadata or getTreeMetadataList. More...

struct	TreeMetadata
	Asset Metadata wrapper This is used only for single ViewType operations like getTreeOwnMetadata or getTreeMetadataList. More...

struct	TreeDirMetadataSimple
	Directory Metadata wrapper For getTreeDirOwnMetadata, this returns per directory all the hierarchical directory metadata. More...

struct	CategoryMetadataSimple
	Category Metadata wrapper For getCategoryOwnMetadata, this returns per category all the hierarchical category metadata. More...

struct	Thumbnail
	Thumbnail image. More...

struct	ViewSetMetadata
	Viewset related metadata aggregations. More...

struct	TreeDirMetadata
	directory metadata More...

struct	CategoryMetadata
	category metadata More...

struct	TreeDir
	Directory data. More...

struct	TreeData
	Asset data wrapper structure. More...

struct	TreeTextInternal
	Asset text content. More...

struct	TreeText
	Asset text content wrapper. More...

struct	TreeRelationInternal
	Asset relations. More...

struct	TreeRelation
	Asset relation wrapper. More...

struct	FindResult
	Result of Search query. More...

struct	SearchResultAssets
	Search result part containing assets. More...

struct	SearchResultDirs
	Search result part containing directories. More...

struct	SearchResultCategories
	Search result part containing assets. More...

struct	SearchResult
	Search result (complete). More...

struct	Category
	Category definition. More...

struct	MediaShare
	Media Share definiton. More...

struct	Path
	Volume Path information. More...

struct	PreviewPage
	One page of an Asset preview. More...

struct	PreviewResult
	Result of Preview query. More...

struct	UserGroupUploadDir
	Upload directory information (per User Group). More...

struct	AssetLog
	Asset Log entry. More...

struct	AssetHistoryResult
	Asset history. More...

struct	CategoryPath
	Category "path". More...

struct	MetadataContent
	Metadata entry. More...

struct	Point
	Two dimensional point for defining locations in images. More...

struct	Note
	Note attached to a preview page. More...

struct	NoteShape
	Note attached to a preview page in form of a geometrical shape. More...

struct	NoteResult
	Result of note query. More...

struct	NoteShapeHistory
	History of NoteShapes. More...

struct	ActionData
	ActionID and DefaultOrder of Action. More...

struct	AssetActions
	Actions related to a certain asset. More...

struct	ActionResult
	Result of Action query. More...

struct	DirIDName
	Pair of Directory ID and Directory Name. More...

struct	DownloadLinkAsset
	Asset Data of DownloadLink data structure. More...

struct	DownloadLink
	DownloadLink data set. More...

struct	UploadMetadata
	UploadMetadata data set. More...

struct	UploadLink
	UploadLink data set. More...

struct	EmbedLink
	Embeddable Link data structure. More...

struct	DirectLink
	Direct Link data structure. More...

struct	UploadLinkOwner
	Upload Link Owner Information. More...

struct	MetadataSummaryItem
	SummaryItem struct for metadata value summary. More...

struct	OwnMetadataSummaryField
	Data structure representing statistical information on one metadata field. More...

struct	OwnMetadataSummary
	Data structure representing statistical information on metadata fields of a certain amount of assets. More...

struct	CategorySummaryField
	Data structure representing statistical information on one category. More...

struct	CategorySummary
	Data structure representing statistical information on categories of a certain amount of assets. More...

struct	LastChange
	Data structure containing the result of getLastChanges. More...

struct	TaskComment
	Comment for a task. More...

struct	Task
	Task data structure. More...

Enumerations
enum	TreeDataFlag { TDBASE = 0, TDICON = 1, TDMDSMALL = 2, TDMDMEDIUM = 4, TDMDLARGE = 8, TDMDLIST = 16, TDMDCOLL = 32, TDMDHYBRID = 64, TDMDALL = 126, TDWINPATH = 128, TDMACPATH = 256, TDACTIONS = 512, TDALL = 1023 }
	Flag for specifying which asset data to request in certain request functions. More...

enum	MasterChildFlag { MCALL, MCMASTERONLY, MCMASTERUNASSIGNED }
	Flag for specifying what type of assets should be delivered in asset related calls, specifically about the master-child relationship. More...

enum	ArchiveStyle { SHOWGROUPED, SHOWARCHIVED, SHOWNONARCHIVED }
	Archive style for asset listings. More...

enum	AssetLogType { UNKNOWN, OWNMETADATACHANGE }
	Asset Log entry type. More...

enum	NoteShapeAction { NSNONE, NSCREATE, NSCHANGE, NSDELETE }
	Action item of note history. More...

enum	ActionFlag { ACTIONASSETS, ACTIONDIRS, ACTIONCATS }
	Type of Action. More...

enum	DirectLinkType
	Direct Link Type.

enum	PathType { UNIX, MAC, WIN }
	Type of Path. More...

enum	PathFailReason { SUCCESS, NOACCESS, NOTFOUND, NOPATH, OTHER }
	Enumeration of reasons for failure to get the asset ID of a given path. More...

enum	FileAccessResult { FANOACCESS, FAEXISTS, FACREATE }
	Return value of checkFileAccess. More...

Functions
int	getNavigationLevel (xsd__string sessionID, xsd__string langID, xsd__string topDirID, xsd__boolean checkUploadDirs, std::vector< xsd__string > groupID 0:1, std::vector< struct TreeDir > &TreeDirs)
	Get one level of the directory navigation tree. More...

int	hasUploadDirs (xsd__string sessionID, xsd__boolean &hasThem)
	Has specific user upload dirs? More...

int	getTree (xsd__string sessionID, std::vector< xsd__string > treeIDs, xsd__string langID, enum TreeDataFlag dataFlag, enum MasterChildFlag masterChild, std::vector< struct TreeData > &Assets)
	Get Asset information. More...

int	getTreeMetaDataList (xsd__string sessionID, std::vector< xsd__string > treeIDs, enum ViewType viewType, xsd__string langID, std::vector< struct TreeMetadata > &TreeMetadata)
	Get metadata of an asset. More...

int	getTreeOwnMetadata (xsd__string sessionID, xsd__string langID, std::vector< xsd__string > treeIDs 0, std::vector< xsd__string > dirIDs 0, std::vector< xsd__string > catIDs 0, std::vector< struct TreeMetadata > &own_md)
	Get custom metadata of assets. More...

int	getTreeDirOwnMetadata (xsd__string sessionID, xsd__string langID, std::vector< xsd__string > dirIDs, std::vector< struct TreeDirMetadataSimple > &own_md)
	Get custom metadata of directories. More...

int	getCategoryOwnMetadata (xsd__string sessionID, xsd__string langID, std::vector< xsd__string > catIDs, std::vector< struct CategoryMetadataSimple > &own_md)
	Get custom metadata of categories. More...

int	getTreeOwnMetadataSummary (xsd__string sessionID, xsd__string langID, std::vector< xsd__string > treeIDs 0, std::vector< xsd__string > dirIDs 0, std::vector< xsd__string > catIDs 0, std::vector< struct OwnMetadataSummary > &mds)
	Get summary of custom metadata. More...

int	setTreeOwnMetadata (xsd__string sessionID, xsd__string langID, std::vector< xsd__string > treeIDs 0, std::vector< xsd__string > dirIDs 0, std::vector< xsd__string > catIDs 0, std::vector< struct MetadataContent > content, std::vector< struct noret > &)
	Set Metadata Values. More...

int	setTreeDirOwnMetadata (xsd__string sessionID, xsd__string langID, std::vector< xsd__string > treeDirIDs, std::vector< struct MetadataContent > content, std::vector< struct noret > &)
	Set Metadata Values of Directories. More...

int	setPathOwnMetadata (xsd__string sessionID, xsd__string langID, xsd__string unixPath, std::vector< struct MetadataContent > content, std::vector< struct noret > &)
	Set Metadata Values using Unix path of Asset. More...

int	getTreeTextList (xsd__string sessionID, std::vector< xsd__string > treeID, std::vector< struct TreeText > &TreeTexts)
	Get extracted Text content of Asset. More...

int	getTreeText (xsd__string sessionID, xsd__string treeID, xsd__string pageID, std::vector< struct TreeTextInternal > &text)
	Get extracted Text content of Asset (page by page). More...

int	getTreeRelationList (xsd__string sessionID, std::vector< xsd__string > treeIDs, enum ViewType viewType, xsd__string langID, xsd__string page, std::vector< struct TreeRelation > &TreeRelations)
	Get List of related Assets of an Asset. More...

int	getTreePreview (xsd__string sessionID, std::vector< xsd__string > treeIDs, xsd__string previewTypeID, xsd__string versionID, xsd__int startPage, xsd__int limit, std::vector< struct PreviewResult > &pages)
	Get Preview of Asset. More...

int	getTreeIcon (xsd__string sessionID, std::vector< xsd__string > treeID, std::vector< struct Thumbnail > &thumbnails)
	Get Asset Icon. More...

int	getTreeList (xsd__string sessionID, xsd__string topDirID, struct SortItem sortCode, enum ArchiveStyle archStyle, enum MasterChildFlag masterChild, xsd__string langID, xsd__string cacheID 0, xsd__boolean recursive 0, xsd__boolean excludeDirectories 0, std::vector< struct FindResult > &result)
	Get Assets within a directory. More...

int	getTreeVersions (xsd__string sessionID, xsd__string treeID, std::vector< struct TreeVersion > &versions)
	Get versions table for an asset. More...

int	Find (xsd__string sessionID, std::vector< struct SearchObject > searchParams, struct SortItem sortCode, enum ArchiveStyle archStyle, enum MasterChildFlag masterChild, xsd__string langID, xsd__boolean quick, xsd__string topDirID, std::vector< xsd__string > topCatIDs 0, xsd__boolean catIDsInclusive 0, xsd__boolean searchInCache 0, xsd__string cacheID 0, std::vector< struct FindResult > &result)
	Search for an Asset and/or a Directory. More...

int	FindBySearchChain (xsd__string sessionID, xsd__string searchChainID, struct SortItem sortCode, enum ArchiveStyle archStyle, enum MasterChildFlag masterChild, xsd__string langID, xsd__string topDirID, std::vector< xsd__string > topCatIDs 0, xsd__boolean catIDsInclusive 0, xsd__boolean searchInCache 0, xsd__string cacheID 0, std::vector< struct FindResult > &result)
	Search for an Asset and/or a Directory using a predefined search chain. More...

int	FindSimilar (xsd__string sessionID, xsd__string assetID, xsd__string similarity, xsd__string rankMode, xsd__boolean sameSize, xsd__boolean sameExtension, xsd__boolean duplicate, struct SortItem sortCode, enum ArchiveStyle archStyle, enum MasterChildFlag masterChild, xsd__string langID, xsd__string topDirID, std::vector< xsd__string > topCatIDs 0, xsd__boolean catIDsInclusive 0, xsd__boolean searchInCache 0, xsd__string cacheID 0, std::vector< struct FindResult > &result)
	Search for Assets similar to a given Asset. More...

int	SortSearchCache (xsd__string sessionID, struct SortItem sortCode, xsd__string langID, xsd__string cacheID 0, std::vector< struct FindResult > &result)
	Re-Sort search result cache. More...

int	getSearchResultAssets (xsd__string sessionID, xsd__unsignedInt start, xsd__unsignedInt limit, xsd__string langID, enum TreeDataFlag dataFlag, xsd__string cacheID 0, std::vector< struct SearchResultAssets > &assets)
	Retrieve cached Search Results (Assets). More...

int	getSearchResultDirs (xsd__string sessionID, enum TreeDataFlag dataFlag, xsd__string langID, xsd__unsignedInt start, xsd__unsignedInt limit, xsd__string cacheID 0, std::vector< struct SearchResultDirs > &dirs)
	Retrieve cached Search Results (Directories) More...

int	getSearchResultCategories (xsd__string sessionID, xsd__unsignedInt start, xsd__unsignedInt limit, xsd__string langID, enum TreeDataFlag dataFlag, xsd__string cacheID 0, std::vector< struct SearchResultCategories > &categories)
	Retrieve cached Search Results (Categories). More...

int	getSearchResult (xsd__string sessionID, xsd__boolean useDirs, xsd__boolean useCats, xsd__unsignedInt start, xsd__unsignedInt limit, xsd__string langID, enum TreeDataFlag dataFlag, xsd__string cacheID 0, std::vector< struct SearchResult > &result)
	Retrieve cached Search Results (Assets, Directories and Categories) More...

int	getMacPath (xsd__string sessionID, xsd__string dirID, xsd__string &macPath)
	Get Mac Path of Directory. More...

int	getWinPath (xsd__string sessionID, xsd__string dirID, xsd__string &winPath)
	Get Windows Path of Directory. More...

int	getCategoryLevel (xsd__string sessionID, xsd__string topCatID, std::vector< xsd__string > groupID 0:1, xsd__string langID, std::vector< struct Category > &Categories)
	Get one level of the category navigation tree. More...

int	createCategory (xsd__string sessionID, xsd__string name, xsd__string parentID, xsd__string afterID, xsd__string langID 0, xsd__string &id)
	Create a new Category. More...

int	upCategory (xsd__string sessionID, xsd__string catID, std::vector< struct noret > &)
	Move Category up one step in Display Order. More...

int	downCategory (xsd__string sessionID, xsd__string catID, std::vector< struct noret > &)
	Move Category down one step in Display Order. More...

int	deleteCategory (xsd__string sessionID, xsd__string catID, std::vector< struct noret > &)
	Remove Category. More...

int	nameCategory (xsd__string sessionID, xsd__string catID, xsd__string langID, xsd__string name, std::vector< struct noret > &)
	Set a new Name for a Category. More...

int	assignCategory (xsd__string sessionID, xsd__string categoryID, xsd__string mediaShareID, std::vector< struct noret > &)
	Assign Category to a Media Share. More...

int	unassignCategory (xsd__string sessionID, xsd__string categoryID, xsd__string mediaShareID, std::vector< struct noret > &)
	Unassign Category from a Media Share. More...

int	getCategory (xsd__string sessionID, xsd__string categoryID, xsd__string langID, std::vector< struct Category > &category)
	Get Category data. More...

int	assignAssetsToCategories (xsd__string sessionID, xsd__string langID, std::vector< xsd__string > treeIDs 0, std::vector< xsd__string > dirIDs 0, std::vector< xsd__string > categoryIDs, std::vector< struct noret > &)
	Assign one or more Asset to one or multiple Categories. More...

int	findAssetsOfCategory (xsd__string sessionID, std::vector< xsd__string > categoryIDs, xsd__boolean catIDsInclusive, struct SortItem sort, enum ArchiveStyle archStyle, enum MasterChildFlag masterChild, xsd__string langID, xsd__string cacheID 0, xsd__boolean notRecursive 0, std::vector< struct FindResult > &result)
	Get all Assets contained in a certain Category. More...

int	unassignAssetsFromCategories (xsd__string sessionID, xsd__string langID, std::vector< xsd__string > treeIDs 0, std::vector< xsd__string > dirIDs 0, std::vector< xsd__string > categoryIDs, xsd__boolean recursive, std::vector< struct noret > &)
	Unassign Assets from Categories. More...

int	getCategoriesOfAsset (xsd__string sessionID, xsd__string treeID, xsd__string langID, std::vector< struct CategoryPath > &catPath)
	Get Category Data specific to an Asset. More...

int	moveCategory (xsd__string sessionID, xsd__string categoryID, xsd__string newParentID, xsd__int newPosition, std::vector< struct noret > &)
	Move Category to a new logical position. More...

int	setPathCategoryPath (xsd__string sessionID, xsd__string langID, xsd__string unixPath, std::vector< xsd__string > categories, std::vector< struct noret > &)
	Set Category membership by Unix Path. More...

int	getCategorySummary (xsd__string sessionID, xsd__string langID, std::vector< xsd__string > treeIDs 0, std::vector< xsd__string > dirIDs 0, std::vector< struct CategorySummary > &cs)
	Get Summary of Catgory membership. More...

int	getMediaShare (xsd__string sessionID, xsd__string mediaShareID, std::vector< struct MediaShare > &mediaShare)
	Get Media Share information. More...

int	getAllMediaShares (xsd__string sessionID, xsd__string groupID, std::vector< struct MediaShare > &mediaShares)
	Get informations on all Media Shares. More...

int	createMediaShare (xsd__string sessionID, xsd__string pathID, xsd__string pathExtension, xsd__string serverID, xsd__int &mediaShareID)
	Create a new Media Share. More...

int	deleteMediaShare (xsd__string sessionID, xsd__string mediaShareID, std::vector< struct noret > &)
	Delete Media Share. More...

int	setMediaShareName (xsd__string sessionID, xsd__string mediaShareID, xsd__string groupID, xsd__string newAlias, std::vector< struct noret > &)
	Set User Group specific Name for Media Share. More...

int	getMediaShareName (xsd__string sessionID, xsd__string mediaShareID, xsd__string groupID, std::vector< xsd__string > &name)
	Get User Group specific Name of Media Share. More...

int	getPath (xsd__string sessionID, xsd__string pathID, std::vector< struct Path > &path)
	Get Volume Information. More...

int	getAllPaths (xsd__string sessionID, std::vector< struct Path > &paths)
	Get Informations on all available Volumes. More...

int	changeMacWinPath (xsd__string sessionID, struct Path path, std::vector< struct noret > &)
	Change Windows and Mac Path data of given path. More...

int	addUserGroupUploadDir (xsd__string sessionID, xsd__string groupID, xsd__string dirID, xsd__boolean recurse, std::vector< struct noret > &)
	Add a Directory as Upload Directory. More...

int	deleteUserGroupUploadDir (xsd__string sessionID, xsd__string groupID, xsd__string dirID, xsd__boolean recurse, std::vector< struct noret > &)
	Remove a Directory from Upload Directories of User Group. More...

int	getAssetHistory (xsd__string sessionID, enum AssetLogObjectType logObjectType, xsd__string treeID, xsd__string langID, xsd__int start, xsd__int limit, std::vector< struct AssetHistoryResult > &result)
	Get Log entries for Asset data modifications. More...

int	getNotes (xsd__string sessionID, xsd__string treeID, xsd__string pageID 0, std::vector< xsd__string > userIDs 0, std::vector< struct NoteResult > &noteResult)
	Get Preview Notes for an Asset. More...

int	setNote (xsd__string sessionID, struct Note note, xsd__string &noteID)
	Set a preview Note for an Asset. More...

int	deleteNote (xsd__string sessionID, xsd__string noteID, std::vector< struct noret > &)
	Delete a preview Note. More...

int	setNoteShape (xsd__string sessionID, struct NoteShape noteShape, xsd__string &shapeID)
	Set a Note Shape. More...

int	deleteNoteShape (xsd__string sessionID, xsd__string shapeID, xsd__boolean realDelete, std::vector< struct noret > &)
	Delete a Note Shape. More...

int	getExternalCollections (xsd__string sessionID, xsd__string accesskey, struct SortItem sort, enum ArchiveStyle archStyle, enum MasterChildFlag masterChild, xsd__string langID, xsd__string cacheID 0, std::vector< struct FindResult > &result)
	Get Collection Content by Access Key (Guest Users). More...

int	findAssetsOfCollection (xsd__string sessionID, xsd__string collectionID, struct SortItem sort, enum ArchiveStyle archStyle, enum MasterChildFlag masterChild, xsd__string langID, xsd__string cacheID 0, xsd__int &assetCount)
	Get Content of a Collection. More...

int	getActionsForAssets (xsd__string sessionID, xsd__string langID, std::vector< xsd__string > treeIDs, std::vector< struct AssetActions > &assetActions)
	Get Actions allowed for certain Assets. More...

int	getCommonActionsForAssets (xsd__string sessionID, xsd__string langID, std::vector< xsd__string > objIDs, std::vector< xsd__string > systemIDs 0:, enum ActionFlag actionFlag, std::vector< struct ActionResult > &actionResult)
	Get Actions allowed for all of certain Assets. More...

int	getHotAssets (xsd__string sessionID, enum MasterChildFlag masterChild, struct SortItem sort, xsd__string langID, xsd__string cacheID 0, xsd__int &assetCount)
	Get N newest Assets accessible by a certain User Group. More...

int	getMediaShareEvents (xsd__string sessionID, xsd__string mediaShareID, xsd__unsignedInt limit, xsd__string langID, enum TreeDataFlag dataFlag, std::vector< struct SearchResult > &result)
	Get Media Share events. More...

int	getDirHierarchy (xsd__string sessionID, xsd__string dirID, std::vector< struct DirIDName > &result)
	Get DirectoryName/DirectoryID pairs for the whole path of directory. More...

int	getDownloadLinkByPath (xsd__string sessionID, std::vector< xsd__string > treePaths, enum PathType pathType, xsd__int timeout, xsd__int localTimeDiff, xsd__boolean emailToOwner, xsd__string displayName, xsd__boolean hidden, xsd__int maxDownloads, xsd__string password, xsd__string &downloadLink)
	Get Download Link for Asset file. More...

int	getOwnDownloadLinks (xsd__string sessionID, xsd__boolean nohidden, std::vector< struct DownloadLink > &links)
	Get Own DownloadLinks. More...

int	removeDownloadLink (xsd__string sessionID, xsd__string hash, std::vector< struct noret > &)
	Remove a DownloadLink. More...

int	changeDownloadLinkOption (xsd__string sessionID, xsd__string hash, xsd__int timeout, xsd__int localTimeDiff, xsd__boolean emailToOwner, xsd__string displayName, xsd__boolean hidden, xsd__int maxDownloads, xsd__string password, std::vector< struct noret > &)
	Change option of DownloadLink. More...

int	getUploadLink (xsd__string sessionID, xsd__string dirID, xsd__string uploadScript, xsd__int timeout, xsd__int localTimeDiff, xsd__boolean emailToOwner, xsd__base64Binary displayText, xsd__string displayName, std::vector< struct UploadMetadata > metaData, xsd__string &uploadLink)
	Get Upload Link for target directory. More...

int	getUploadLinkByPath (xsd__string sessionID, xsd__string treePaths, enum PathType pathType, xsd__string uploadScript, xsd__int timeout, xsd__int localTimeDiff, xsd__boolean emailToOwner, xsd__base64Binary displayText, xsd__string displayName, std::vector< struct UploadMetadata > metaData, xsd__string &uploadLink)
	Get Upload Link for target directory. More...

int	isUploadLinkValid (xsd__string accessKey, xsd__boolean &valid)
	Check if given upload key is valid. More...

int	getUploadLinkDisplayText (xsd__string accessKey, xsd__base64Binary &displayText)
	Get display text for a specific upload link. More...

int	getUploadLinkOwner (xsd__string accessKey, struct UploadLinkOwner &ownerInfo)
	Get owner information for a specific upload link. More...

int	getOwnUploadLinks (xsd__string sessionID, xsd__string langID, std::vector< struct UploadLink > &links)
	Get Own UploadLinks. More...

int	TransferCategoryAsset (xsd__string sessionID, xsd__string categoryID, xsd__string path, std::vector< struct noret > &)
	Transfer an uploaded asset into a category. More...

int	getEmbedLinkInformation (xsd__string sessionID, xsd__string langID, std::vector< struct EmbedLink > &embedlink)
	Get embedded link information for this session. More...

int	getDirectLinkInformation (xsd__string sessionID, xsd__string langID, xsd__string directlinkkey, std::vector< struct DirectLink > &dlink)
	Get direct link information for this session. More...

int	getOwnEmbedLinks (xsd__string sessionID, xsd__string langID, xsd__boolean nohidden, std::vector< struct EmbedLink > &embedlinks)
	Get all embedded links of this user. More...

int	removeEmbedLink (xsd__string sessionID, xsd__string embedkey, std::vector< struct noret > &)
	Remove an embedded link for this user (For any user, if admin.) More...

int	changeEmbedLinkOption (xsd__string sessionID, xsd__string embedkey, xsd__int timeout, xsd__int localTimeDiff, xsd__string displayName, xsd__boolean hidden, xsd__string previewType, xsd__boolean direct, std::vector< struct noret > &)
	Change the timeout of an embedded link. More...

int	getAssetIDsForPaths (xsd__string sessionID, enum PathType pathType, std::vector< xsd__string > paths, std::vector< struct PathResult > &pathResult)
	Get Asset ID for (several) Mac/Unix/Windows paths. More...

int	getLastChanges (xsd__string sessionID, xsd__int limit, std::vector< struct LastChange > &lastChanges)
	Get treeID, filename and date of last change for latest changes in file system. More...

int	getPreviewTypes (xsd__string sessionID, xsd__string treeID, std::vector< xsd__string > &previewTypes)
	Get preview types of one asset. More...

int	addChildAssets (xsd__string sessionID, xsd__string masterID, std::vector< xsd__string > childIDs, std::vector< struct noret > &)
	Add child assets. More...

int	removeChildAssets (xsd__string sessionID, xsd__string masterID, std::vector< xsd__string > childIDs, std::vector< struct noret > &)
	Remove child assets. More...

int	checkFileAccess (xsd__string sessionID, xsd__string pathName, enum FileAccessResult &access)
	Check access to a file. More...

int	checkFileAccessCategory (xsd__string sessionID, xsd__string categoryID, xsd__string fileName, enum FileAccessResult &access)
	Check access to a file, which is to be uploaded to a category. More...

int	addTask (xsd__string sessionID, xsd__string treeID, xsd__string userID, xsd__string taskType, xsd__string status, std::vector< xsd__string > shapeIDs 0:, xsd__base64Binary comment, xsd__string &taskID)
	Create a task. More...

int	getTasks (xsd__string sessionID, xsd__string treeID, std::vector< struct Task > &tasks)
	Get all tasks associated with an asset. More...

int	deleteTask (xsd__string sessionID, xsd__string taskID, std::vector< struct noret > &)
	Remove a task. More...

int	assignTask (xsd__string sessionID, xsd__string taskID, xsd__string userID, xsd__string status, xsd__base64Binary comment 0:1, std::vector< struct noret > &)
	Assign a task to a user. More...

int	addTaskComment (xsd__string sessionID, xsd__string taskID, xsd__base64Binary comment, std::vector< struct noret > &)
	Add a comment to a task. More...

int	setTaskShapes (xsd__string sessionID, xsd__string taskID, std::vector< xsd__string > shapeIDs, std::vector< struct noret > &)
	Setting the NoteShapes associated with a task. More...

int	addTaskShapes (xsd__string sessionID, xsd__string taskID, std::vector< xsd__string > shapeIDs, std::vector< struct noret > &)
	Adding NoteShapes to a task. More...

int	removeTaskShapes (xsd__string sessionID, xsd__string taskID, std::vector< xsd__string > shapeIDs, std::vector< struct noret > &)
	Remove NoteShapes from a task. More...

Variables
enum PathFailReason	path
	Data structure containing the result of a getAssetIDsForPaths call. More...

Detailed Description

The Asset Service provides access to the assets stored in the database.

Enumeration Type Documentation

◆ ActionFlag

enum ActionFlag

Type of Action.

Enumerator
ACTIONASSETS	Action works on assets only.
ACTIONDIRS	Action works on directories only.
ACTIONCATS	Action works on categories only.

◆ ArchiveStyle

enum ArchiveStyle

Archive style for asset listings.

Enumerator
SHOWGROUPED	Show both archived and non archived assets.
SHOWARCHIVED	Show archived assets only.
SHOWNONARCHIVED	Show non archived assets only.

◆ AssetLogType

enum AssetLogType

Asset Log entry type.

Enumerator
UNKNOWN	Unknown entry type.
OWNMETADATACHANGE	Change of Metadata.

◆ FileAccessResult

enum FileAccessResult

Return value of checkFileAccess.

Enumerator
FANOACCESS	Access to file would not be possible.
FAEXISTS	File already exists in the filesystem.
FACREATE	File would be accessible and does not yet exist.

◆ MasterChildFlag

enum MasterChildFlag

Flag for specifying what type of assets should be delivered in asset related calls, specifically about the master-child relationship.

Enumerator
MCALL	All assets.
MCMASTERONLY	Only assets with associated child assets.
MCMASTERUNASSIGNED	Assets with associated child assets, and assets that have no assets assigned and are not assigned as child assets.

◆ NoteShapeAction

enum NoteShapeAction

Action item of note history.

Enumerator
NSNONE	No action.
NSCREATE	NoteShape created.
NSCHANGE	NoteShape changed.
NSDELETE	NoteShape deleted.

◆ PathFailReason

enum PathFailReason

Enumeration of reasons for failure to get the asset ID of a given path.

Enumerator
SUCCESS	No failure.
NOACCESS	No access to the specific asset for the calling group.
NOTFOUND	Path specified in call was not found in database.
NOPATH	given Mac/Win path cannot be translated to a unix path.
OTHER	Other failure, not further specified (consult log).

◆ PathType

enum PathType

Type of Path.

Enumerator
UNIX	Unix path.
MAC	Mac path.
WIN	Windows path.

◆ TreeDataFlag

enum TreeDataFlag

Flag for specifying which asset data to request in certain request functions.

Enumerator
TDBASE	Base information only.
TDICON	Icon.
TDMDSMALL	Metadata for the small view as defined in viewset.
TDMDMEDIUM	Metadata for the medium view as defined in viewset.
TDMDLARGE	Metadata for the large view as defined in viewset.
TDMDLIST	Metadata for the list view as defined in viewset.
TDMDCOLL	Metadata for the collection view as defined in viewset.
TDMDHYBRID	Metadata for the hybrid view as defined in viewset.
TDMDALL	Metadata for all views as defined in viewset.
TDWINPATH	Windows path.
TDMACPATH	Mac path.
TDACTIONS	Actions associated with the asset.
TDALL	All of the above.

Function Documentation

◆ addChildAssets()

int addChildAssets	(	xsd__string	sessionID,
		xsd__string	masterID,
		std::vector< xsd__string >	childIDs,
		std::vector< struct noret > &
	)

Add child assets.

Adds assets to a master asset.

Parameters

[in]	sessionID	Session ID
[in]	masterID	Asset ID of master asset
[in]	childIDs	Asset IDs of child assets
[out]	none

◆ addTask()

int addTask	(	xsd__string	sessionID,
		xsd__string	treeID,
		xsd__string	userID,
		xsd__string	taskType,
		xsd__string	status,
		std::vector< xsd__string > shapeIDs 0:	,
		xsd__base64Binary	comment,
		xsd__string &	taskID
	)

Create a task.

Parameters

[in]	sessionID	ID of Session
[in]	treeID	Asset ID associated with this task
[in]	userID	User associated with this task
[in]	taskType	Type of task
[in]	status	Status of task
[in]	shapeIDs	Array of NoteShape IDs associated with this task
[in]	comment	Comment associated with this task
[out]	taskID	Unique id of newly created task.

◆ addTaskComment()

int addTaskComment	(	xsd__string	sessionID,
		xsd__string	taskID,
		xsd__base64Binary	comment,
		std::vector< struct noret > &
	)

Add a comment to a task.

Parameters

[in]	sessionID	ID of Session
[in]	taskID	ID of task
[in]	comment	comment to add.

◆ addTaskShapes()

int addTaskShapes	(	xsd__string	sessionID,
		xsd__string	taskID,
		std::vector< xsd__string >	shapeIDs,
		std::vector< struct noret > &
	)

Adding NoteShapes to a task.

Parameters

[in]	sessionID	ID of Session
[in]	taskID	ID of task
[in]	shapeIDs	Array of NoteShape ids to add to the ids already associated with this task.

◆ addUserGroupUploadDir()

int addUserGroupUploadDir	(	xsd__string	sessionID,
		xsd__string	groupID,
		xsd__string	dirID,
		xsd__boolean	recurse,
		std::vector< struct noret > &
	)

Add a Directory as Upload Directory.

Parameters

[in]	sessionID	Session ID (admin session only)
[in]	groupID	ID of User Group for which directory shall be added.
[in]	dirID	ID of Directory which shall be added as upload directory
[in]	recurse	true, if all subdirectories shall be allowed as well.
[out]	none.

◆ assignAssetsToCategories()

int assignAssetsToCategories	(	xsd__string	sessionID,
		xsd__string	langID,
		std::vector< xsd__string > treeIDs	0,
		std::vector< xsd__string > dirIDs	0,
		std::vector< xsd__string >	categoryIDs,
		std::vector< struct noret > &
	)

Assign one or more Asset to one or multiple Categories.

Parameters

[in]	sessionID	Session ID
[in]	langID	Language ID
[in]	treeIDs	(optional) Array of asset IDs
[in]	dirIDs	(optional) Array of directory IDs – assets are taken from these directories and all of their subdirectories.
[in]	categoryIDs	Array of category IDs to assign assets to.
[out]	none.

◆ assignCategory()

int assignCategory	(	xsd__string	sessionID,
		xsd__string	categoryID,
		xsd__string	mediaShareID,
		std::vector< struct noret > &
	)

Assign Category to a Media Share.

Parameters

[in]	sessionID	Session ID
[in]	categoryID	ID of category.
[in]	mediaShareID	ID of media share to assign category to.
[out]	none.

◆ assignTask()

int assignTask	(	xsd__string	sessionID,
		xsd__string	taskID,
		xsd__string	userID,
		xsd__string	status,
		xsd__base64Binary comment 0:1	,
		std::vector< struct noret > &
	)

Assign a task to a user.

Parameters

[in]	sessionID	ID of Session
[in]	taskID	ID of task
[in]	userID	ID of user to assign the task to
[in]	status	new status of task
[in]	comment	Optional comment.

◆ changeDownloadLinkOption()

int changeDownloadLinkOption	(	xsd__string	sessionID,
		xsd__string	hash,
		xsd__int	timeout,
		xsd__int	localTimeDiff,
		xsd__boolean	emailToOwner,
		xsd__string	displayName,
		xsd__boolean	hidden,
		xsd__int	maxDownloads,
		xsd__string	password,
		std::vector< struct noret > &
	)

Change option of DownloadLink.

Parameters

[in]	sessionID	Session ID
[in]	hash	Unique hash of DownloadLink.
	timeout	Unix timestamp of intended expiry time of the link.
	localTimeDiff	Difference between local time and UTC at the client side (in minutes) (e.g. UTC+2 is +120, UTC-4 is -240).
[in]	emailToOwner	New setting for the mail emailToOwner option.
[in]	displayName	New setting for the display name of the link.
[in]	hidden	Link shall remain hidden.
[in]	maxDownloads	new value for maxDownloads parameter.
[in]	password	new password to use. (empty for no password)
[out]	none.

◆ changeEmbedLinkOption()

int changeEmbedLinkOption	(	xsd__string	sessionID,
		xsd__string	embedkey,
		xsd__int	timeout,
		xsd__int	localTimeDiff,
		xsd__string	displayName,
		xsd__boolean	hidden,
		xsd__string	previewType,
		xsd__boolean	direct,
		std::vector< struct noret > &
	)

Change the timeout of an embedded link.

Parameters

[in]	sessionID	Session ID
[in]	embedkey	Embedded link access key.
[in]	timeout	Unix timestamp of planned expiry time of link.
[in]	localTimeDiff	Difference between local time and UTC at the client side (in minutes) (e.g. UTC+2 is +120, UTC-4 is -240).
[in]	displayName	display name of the embedded link.
[in]	hidden	Link shall remain hidden.
[in]	previewType	preview type of asset to return.
[in]	direct	preview shown direct or embedded.

◆ changeMacWinPath()

int changeMacWinPath	(	xsd__string	sessionID,
		struct Path	path,
		std::vector< struct noret > &
	)

Change Windows and Mac Path data of given path.

Parameters

[in]	sessionID	Session ID (must be admin session)
[in]	path	Path information (only pathid, macpath, winpath, macclientpath and winclientpath members are evaluated)
[out]	none.

◆ checkFileAccess()

int checkFileAccess	(	xsd__string	sessionID,
		xsd__string	pathName,
		enum FileAccessResult &	access
	)

Check access to a file.

Checks, if the session would have access to a file with the given unixpath.

Parameters

[in]	sessionID	Session ID
[in]	pathName	Unixpath of file.
[out]	access	return value according to definitiong of FileAccessResult.

◆ checkFileAccessCategory()

int checkFileAccessCategory	(	xsd__string	sessionID,
		xsd__string	categoryID,
		xsd__string	fileName,
		enum FileAccessResult &	access
	)

Check access to a file, which is to be uploaded to a category.

Checks, if the session would have access to a new file fileName, that would reside somewhere below the categoryUploadPath for the category given.

Parameters

[in]	sessionID	Session ID
[in]	pathName	Unixpath of file.
[out]	access	return value according to definitiong of FileAccessResult.

◆ createCategory()

int createCategory	(	xsd__string	sessionID,
		xsd__string	name,
		xsd__string	parentID,
		xsd__string	afterID,
		xsd__string langID	0,
		xsd__string &	id
	)

Create a new Category.

Parameters

[in]	sessionID	Session ID
[in]	name	Name of new category.
[in]	parentID	ID of parent category (0 if new category is at top level).
[in]	afterID	ID of category after which the new category shall be placed (if empty, 0, or the ID of a category which does not have the same parent category, the new category will be placed at the top within the parent category)
[in]	langID	(optional) Language ID for internationalization of name (if empty, default language is used).
[out]	id	ID of newly created category.

◆ createMediaShare()

int createMediaShare	(	xsd__string	sessionID,
		xsd__string	pathID,
		xsd__string	pathExtension,
		xsd__string	serverID,
		xsd__int &	mediaShareID
	)

Create a new Media Share.

After this function has finished, all Directories and Assets of the newly created Media Share are incorporated into the cavok database. This transaction might last for a while depending on the size of the new Media Share. However, the function returns immediately.

Parameters

[in]	session	ID Session ID (must be admin session)
[in]	pathID	Volume ID
[in]	pathExtension	Subdirectory within Volume (if empty, complete Volume is treated as new Media Share).
[in]	serverID	ID of file server
[out]	mediaShareID	ID of newly created Media Share.

◆ deleteCategory()

int deleteCategory	(	xsd__string	sessionID,
		xsd__string	catID,
		std::vector< struct noret > &
	)

Remove Category.

Parameters

[in]	sessionID	Session ID
[in]	catID	ID of category to remove.
[out]	none.

◆ deleteMediaShare()

int deleteMediaShare	(	xsd__string	sessionID,
		xsd__string	mediaShareID,
		std::vector< struct noret > &
	)

Delete Media Share.

When a Media Share is deleted, all Directories and Assets of this Media Share (including the Metadata stored for these Assets) will be deleted from the cavok database. They will be inaccessible immediately as soon as this function returns. (Even though, physically deleting the information might need more time.)

Parameters

[in]	sessionID	Session ID (must be admin session)
[in]	mediaShareID	ID of Media Share to delete
[out]	none.

◆ deleteNote()

int deleteNote	(	xsd__string	sessionID,
		xsd__string	noteID,
		std::vector< struct noret > &
	)

Delete a preview Note.

Parameters

[in]	sessionID	Session ID
[in]	noteID	ID of Note to delete.
[out]	none.

◆ deleteNoteShape()

int deleteNoteShape	(	xsd__string	sessionID,
		xsd__string	shapeID,
		xsd__boolean	realDelete,
		std::vector< struct noret > &
	)

Delete a Note Shape.

Parameters

[in]	sessionID	Session ID
[in]	shapeID	ID of Note Shape to delete.
[in]	realDelete	Delete all data of this shape from the database, if true; otherwise only create a "deleted" record in the shape history.
[out]	none.

◆ deleteTask()

int deleteTask	(	xsd__string	sessionID,
		xsd__string	taskID,
		std::vector< struct noret > &
	)

Remove a task.

Parameters

[in]	sessionID	ID of Session
[in]	taskID	ID of task to remove

◆ deleteUserGroupUploadDir()

int deleteUserGroupUploadDir	(	xsd__string	sessionID,
		xsd__string	groupID,
		xsd__string	dirID,
		xsd__boolean	recurse,
		std::vector< struct noret > &
	)

Remove a Directory from Upload Directories of User Group.

Parameters

[in]	sessionID	Session ID (admin session only)
[in]	groupID	ID of User Group
[in]	dirID	ID of Directory for which upload permission of the specified User Group shall be removed.
[in]	recurse	If true, all upload permissions in the directory hierarchy below dirID will be removed as well.
[out]	none.

◆ downCategory()

int downCategory	(	xsd__string	sessionID,
		xsd__string	catID,
		std::vector< struct noret > &
	)

Move Category down one step in Display Order.

Parameters

[in]	sessionID	Session ID
[in]	catID	ID of category
[out]	none.

◆ Find()

int Find	(	xsd__string	sessionID,
		std::vector< struct SearchObject >	searchParams,
		struct SortItem	sortCode,
		enum ArchiveStyle	archStyle,
		enum MasterChildFlag	masterChild,
		xsd__string	langID,
		xsd__boolean	quick,
		xsd__string	topDirID,
		std::vector< xsd__string > topCatIDs	0,
		xsd__boolean catIDsInclusive	0,
		xsd__boolean searchInCache	0,
		xsd__string cacheID	0,
		std::vector< struct FindResult > &	result
	)

Search for an Asset and/or a Directory.

This function does not return asset data directly. Asset data is stored in an internal cache which can be read afterwards by getSearchResultAssets or getSearchResult. The cache is invalidated when the session is closed or when another function is called which puts data into this cache. (However, with the parameter cacheID multiple caches may be used by successive calls.)

Parameters

[in]	sessionID	Session ID
[in]	searchParams	Search definition.
[in]	sortCode	Sorting definition.
[in]	archStyle	Archive style for asset retrieval.
[in]	masterChild	MasterChildFlag for selecting the type of Assets to return.
[in]	langID	Language ID
[in]	quick	if true, use view set type VTQSEARCH to determine which search items are allowed, otherwise VTASEARCH will be used.
[in]	topDirID	(optional) Starting directory for this search.
[in]	topCatIDs	(optional) Alternatively to the starting directories, starting categories for this search.
[in]	catIDsInclusive	If true, the category IDs in topCatIDs are treated as inclusive ... meaning that only assets are found that are members of ALL the categories given.
[in]	searchInCache	(optional) restrict the search to assets found in a previous search
[in]	cacheID	(optional) To make sure that multiple calls to Find do not use the same cache, a cacheID can be specified by the user. The same cacheID must then be used to retrieve the results of Find via the getSearchResult functions.
[out]	result	The amount of assets and directories found matching the search parameters.

◆ findAssetsOfCategory()

int findAssetsOfCategory	(	xsd__string	sessionID,
		std::vector< xsd__string >	categoryIDs,
		xsd__boolean	catIDsInclusive,
		struct SortItem	sort,
		enum ArchiveStyle	archStyle,
		enum MasterChildFlag	masterChild,
		xsd__string	langID,
		xsd__string cacheID	0,
		xsd__boolean notRecursive	0,
		std::vector< struct FindResult > &	result
	)

Get all Assets contained in a certain Category.

As with getTreeList and Find, no asset data are actually returned by this function; rather they are placed in an internal cache where they can be retrieved from using getSearchResultAssets. The cache is invalidated by session termination and use of another function filling the cache from the same session.

Parameters

[in]	sessionID	Session ID
[in]	categoryIDs	IDs of categories of which assets shall be found.
[in]	catIDsInclusive	If true, the category IDs are treated as inclusive ... meaning that only assets are found that are members of ALL the categories given.
[in]	sort	Sort type.
[in]	archStyle	Archive style for returning assets.
[in]	masterChild	MasterChildFlag deciding which types of assets to include.
[in]	langID	language ID (for internationalized items).
[in]	cacheID	(optional) This ID can be specified when successive uses of a search function shall not invalidate each others caches. Use the same cacheID with getSearchResults in order to obtain the correct result set.
[in]	notRecursive	(optional) Do not treat assets belonging to sub categories as valid results. (The default is to treat each asset belonging to a sub category as belonging to the higher category as well.)
[out]	result	Amount of assets and categories retrievable via search cache.

◆ findAssetsOfCollection()

int findAssetsOfCollection	(	xsd__string	sessionID,
		xsd__string	collectionID,
		struct SortItem	sort,
		enum ArchiveStyle	archStyle,
		enum MasterChildFlag	masterChild,
		xsd__string	langID,
		xsd__string cacheID	0,
		xsd__int &	assetCount
	)

Get Content of a Collection.

The assets contained in the collection are not returned directly, they are cached internally to the server. They can be retrieved using getSearchResultAssets. The cache will be invalidated upon session termination an upon call to other functions entering data into this cache.

Parameters

[in]	sessionID	Session ID
[in]	collectionID	ID of collection.
[in]	sort	Sort type.
[in]	archStyle	Archive style.
[in]	masterChild	MasterChildFlag deciding which types of assets to include.
[in]	langID	Language ID for internationalized content.
[in]	cacheID	Token ID to specify a cache line specific to this call. This is used in order to not invalidate caches used by other searches. Use this token as well with getSearchResult functions to obtain the correct result set.
[out]	assetCount	Amount of Assets retrievable via asset cache.

◆ FindBySearchChain()

int FindBySearchChain	(	xsd__string	sessionID,
		xsd__string	searchChainID,
		struct SortItem	sortCode,
		enum ArchiveStyle	archStyle,
		enum MasterChildFlag	masterChild,
		xsd__string	langID,
		xsd__string	topDirID,
		std::vector< xsd__string > topCatIDs	0,
		xsd__boolean catIDsInclusive	0,
		xsd__boolean searchInCache	0,
		xsd__string cacheID	0,
		std::vector< struct FindResult > &	result
	)

Search for an Asset and/or a Directory using a predefined search chain.

This function does not return asset data directly. Asset data is stored in an internal cache which can be read afterwards by getSearchResultAssets or getSearchResult. The cache is invalidated when the session is closed or when another function is called which puts data into this cache. (However, with the parameter cacheID multiple caches may be used by successive calls.)

Parameters

[in]	sessionID	Session ID
[in]	searchChainID	ID of predefined search chain
[in]	sortCode	Sorting definition.
[in]	archStyle	Archive style for asset retrieval.
[in]	masterChild	MasterChildFlag for deciding which types of assets to include.
[in]	langID	Language ID
[in]	topDirID	(optional) Starting directory for this search.
[in]	topCatIDs	(optional) Alternatively to the starting directory, starting categories for this search.
[in]	catIDsInclusive	If true, the category IDs in topCatIDs are treated as inclusive ... meaning that only assets are found that are members of ALL the categories given.
[in]	searchInCache	(optional) restrict the search to assets found in a previous search
[in]	cacheID	(optional) To make sure that multiple calls to Find do not use the same cache, a cacheID can be specified by the user. The same cacheID must then be used to retrieve the results of Find via the getSearchResult functions.
[out]	result	The amount of assets and directories found matching the search parameters.

◆ FindSimilar()

int FindSimilar	(	xsd__string	sessionID,
		xsd__string	assetID,
		xsd__string	similarity,
		xsd__string	rankMode,
		xsd__boolean	sameSize,
		xsd__boolean	sameExtension,
		xsd__boolean	duplicate,
		struct SortItem	sortCode,
		enum ArchiveStyle	archStyle,
		enum MasterChildFlag	masterChild,
		xsd__string	langID,
		xsd__string	topDirID,
		std::vector< xsd__string > topCatIDs	0,
		xsd__boolean catIDsInclusive	0,
		xsd__boolean searchInCache	0,
		xsd__string cacheID	0,
		std::vector< struct FindResult > &	result
	)

Search for Assets similar to a given Asset.

This function does not return asset data directly. Asset data is stored in an internal cache which can be read afterwards by getSearchResultAssets or getSearchResult. The cache is invalidated when the session is closed or when another function is called which puts data into this cache. (However, with the parameter cacheID multiple caches may be used by successive calls.)

Parameters

[in]	sessionID	Session ID
[in]	assetID	The asset to which similar assets shall be found.
[in]	similarity	A measure between 0 and 1 for the similarity of the assets. Only evaluated if duplicate is false.
[in]	rankMode	ranking mode for the similarity engine
[in]	sameSize	only look for assets with same file size
[in]	sameExtension	only look for assets with same extension
[in]	duplicate	If true, a special duplicate search function is used. similarity is not evaluated in this case.
[in]	sortCode	Sorting definition.
[in]	archStyle	Archive style for asset retrieval.
[in]	masterChild	MasterChildFlag deciding which assets to include.
[in]	langID	Language ID
[in]	topDirID	(optional) Starting directory for this search.
[in]	topCatIDs	(optional) Alternatively to the starting directory, starting categories for this search.
[in]	catIDsInclusive	If true, the category IDs in topCatIDs are treated as inclusive ... meaning that only assets are found that are members of ALL the categories given.
[in]	searchInCache	(optional) restrict the search to assets found in a previous search
[in]	cacheID	(optional) To make sure that multiple calls to Find do not use the same cache, a cacheID can be specified by the user. The same cacheID must then be used to retrieve the results of Find via the getSearchResult functions.
[out]	result	The amount of assets and directories found matching the search parameters.

◆ getActionsForAssets()

int getActionsForAssets	(	xsd__string	sessionID,
		xsd__string	langID,
		std::vector< xsd__string >	treeIDs,
		std::vector< struct AssetActions > &	assetActions
	)

Get Actions allowed for certain Assets.

Parameters

[in]	sessionID	Session ID
[in]	langID	Language ID (for internationalized content)
[in]	treeIDs	Array of Asset IDs.
[out]	assetActions	Array of Action Definitions which are allowed for each of the assets specified.

◆ getAllMediaShares()

int getAllMediaShares	(	xsd__string	sessionID,
		xsd__string	groupID,
		std::vector< struct MediaShare > &	mediaShares
	)

Get informations on all Media Shares.

Parameters

[in]	sessionID	Session ID
[in]	groupID	ID of user group. If empty, all media shares are returned which are permitted for the user group represented by the session; if not empty, admin permissions are needed to list only those media shares which are permitted to the specific user group.
[out]	mediaShares	Array of Media Share informations.

◆ getAllPaths()

int getAllPaths	(	xsd__string	sessionID,
		std::vector< struct Path > &	paths
	)

Get Informations on all available Volumes.

Parameters

[in]	sessionID	Session ID (must be admin session)
[out]	paths	Array of Volume Informations.

◆ getAssetHistory()

int getAssetHistory	(	xsd__string	sessionID,
		enum AssetLogObjectType	logObjectType,
		xsd__string	treeID,
		xsd__string	langID,
		xsd__int	start,
		xsd__int	limit,
		std::vector< struct AssetHistoryResult > &	result
	)

Get Log entries for Asset data modifications.

Parameters

[in]	sessionID	Session ID
[in]	logObjectType	type of asset for which the history shall be accessed
[in]	treeID	Asset ID (of the type specified in logObjectType)
[in]	langID	Language ID
[in]	start	Starting index (beginning with 0)
[in]	limit	Amount of entries to return.
[out]	result	Array of Asset Log data.

◆ getAssetIDsForPaths()

int getAssetIDsForPaths	(	xsd__string	sessionID,
		enum PathType	pathType,
		std::vector< xsd__string >	paths,
		std::vector< struct PathResult > &	pathResult
	)

Get Asset ID for (several) Mac/Unix/Windows paths.

Parameters

[in]	sessionID	Session ID
[in]	pathType	Type of paths given in paths parameter.
[in]	paths	Array of paths for which to find asset IDs.
[out]	pathResult	Array of data structures containing the result.

◆ getCategoriesOfAsset()

int getCategoriesOfAsset	(	xsd__string	sessionID,
		xsd__string	treeID,
		xsd__string	langID,
		std::vector< struct CategoryPath > &	catPath
	)

Get Category Data specific to an Asset.

Parameters

[in]	sessionID	Session ID
[in]	treeID	Asset ID
[in]	langID	language ID (for internationalized items)
[out]	catPath	Category path consisting of all categories the specified asset is contained in.

◆ getCategory()

int getCategory	(	xsd__string	sessionID,
		xsd__string	categoryID,
		xsd__string	langID,
		std::vector< struct Category > &	category
	)

Get Category data.

Parameters

[in]	sessionID	Session ID
[in]	categoryID	ID of category
[in]	langID	language ID
[out]	category	Category definition data structure.

◆ getCategoryLevel()

int getCategoryLevel	(	xsd__string	sessionID,
		xsd__string	topCatID,
		std::vector< xsd__string > groupID 0:1	,
		xsd__string	langID,
		std::vector< struct Category > &	Categories
	)

Get one level of the category navigation tree.

Parameters

[in]	sessionID	Session ID
[in]	topCatID	ID of top level category (whose subcategories are returned); may be 0 in which case the top level categories as permitted for the user group of the caller are returned.
[in]	groupID	Only meaningful for admin sessions: groupID to use for evaluation of display permissions.
[in]	langID	Language ID to use for category names. If empty, the default language is used.
[out]	Array	of Category structures.

◆ getCategoryOwnMetadata()

int getCategoryOwnMetadata	(	xsd__string	sessionID,
		xsd__string	langID,
		std::vector< xsd__string >	catIDs,
		std::vector< struct CategoryMetadataSimple > &	own_md
	)

Get custom metadata of categories.

For each of the categories specified by their category ID, metadata of custom metadata fields are returned; using the view set type VTDETAIL.

\param[in] sessionID Session ID
\param[in] langID Language ID
\param[in] dirIDs Array of directory IDs.
\param[out] own_md Array of metadata values for each of the directories given.

◆ getCategorySummary()

int getCategorySummary	(	xsd__string	sessionID,
		xsd__string	langID,
		std::vector< xsd__string > treeIDs	0,
		std::vector< xsd__string > dirIDs	0,
		std::vector< struct CategorySummary > &	cs
	)

Get Summary of Catgory membership.

Returns a summary information on category membership of assets selected by treeID and/or directory ID. Directory ID is used recursively, thus all assets in a subdirectory hierarchy below a given directory ID are included in the statistics.

Parameters

[in]	sessionID	Session ID
[in]	langID	Language ID used for returning category name
[in]	(optional)	treeIDs IDs of assets included in the summary
[in]	(optional)	dirIDs IDs of directories, of which assets are included in the summary. All assets in all subdirectory hierarchies below the given directory are included.
[out]	cs	Category Summary.

◆ getCommonActionsForAssets()

int getCommonActionsForAssets	(	xsd__string	sessionID,
		xsd__string	langID,
		std::vector< xsd__string >	objIDs,
		std::vector< xsd__string > systemIDs 0:	,
		enum ActionFlag	actionFlag,
		std::vector< struct ActionResult > &	actionResult
	)

Get Actions allowed for all of certain Assets.

Parameters

[in]	sessionID	Session ID
[in]	langID	Language ID (for internationalized content)
[in]	objIDs	Array of Directory IDs or Asset IDs depending on setting of actionFlag
[in]	systemIDs	optional Array of special system action IDs for which to check
[in]	actionFlag	Flag determining what type of Actions shall be found (only those working on assets or only those working on directories).
[out]	actionResult	Array of Action Definitions which are allowed for each of the assets specified.

◆ getDirectLinkInformation()

int getDirectLinkInformation	(	xsd__string	sessionID,
		xsd__string	langID,
		xsd__string	directlinkkey,
		std::vector< struct DirectLink > &	dlink
	)

Get direct link information for this session.

Parameters

[in]	sessionID	Session ID
[in]	langID	language ID for asset data returned.
[in]	directlinkkey	direct link key for which data is returned.
[out]	dlink	Data structure with informations on the direct link specified.

◆ getDirHierarchy()

int getDirHierarchy	(	xsd__string	sessionID,
		xsd__string	dirID,
		std::vector< struct DirIDName > &	result
	)

Get DirectoryName/DirectoryID pairs for the whole path of directory.

Parameters

[in]	sessionID	Session ID
[in]	dirID	ID of base directory
[out]	result	dirName/ID pairs hierarchically sorted from base directory towards filesystem root.

◆ getDownloadLinkByPath()

int getDownloadLinkByPath	(	xsd__string	sessionID,
		std::vector< xsd__string >	treePaths,
		enum PathType	pathType,
		xsd__int	timeout,
		xsd__int	localTimeDiff,
		xsd__boolean	emailToOwner,
		xsd__string	displayName,
		xsd__boolean	hidden,
		xsd__int	maxDownloads,
		xsd__string	password,
		xsd__string &	downloadLink
	)

Get Download Link for Asset file.

(By specifying asset file paths.)

Parameters

[in]	sessionID	Session ID
[in]	treePaths	Asset Paths
[in]	pathType	type of asset path given in treePaths
[in]	timeout	Unix timestamp of the planned expiring time of the link.
[in]	localTimeDiff	Difference between local time and UTC at the client side (in minutes) (e.g. UTC+2 is +120, UTC-4 is -240).
[in]	emailToOwner	should an email be sent to the owner each time the link is used?
[in]	displayName	Freetext name for easier identification of link.
[in]	hidden	Link shall remain hidden.
[in]	maxDownloads	new value for maxDownloads parameter.
[in]	password	new password to use. (empty for no password)
[out]	part	of URL with which the asset can be downloaded (the front part of the URL, which conicides with the URL the client uses to connect to the SOAP server, must be supplied by the client, since it is unknown to the server)

◆ getEmbedLinkInformation()

int getEmbedLinkInformation	(	xsd__string	sessionID,
		xsd__string	langID,
		std::vector< struct EmbedLink > &	embedlink
	)

Get embedded link information for this session.

Parameters

[in]	sessionID	Session ID
[in]	langID	language ID for asset data returned.
[out]	embedlink	Data structure with informations on the embedded link for which this session was opened.

◆ getExternalCollections()

int getExternalCollections	(	xsd__string	sessionID,
		xsd__string	accesskey,
		struct SortItem	sort,
		enum ArchiveStyle	archStyle,
		enum MasterChildFlag	masterChild,
		xsd__string	langID,
		xsd__string cacheID	0,
		std::vector< struct FindResult > &	result
	)

Get Collection Content by Access Key (Guest Users).

The assets contained in the collection are not returned directly, they are cached internally to the server. They can be retrieved using getSearchResultAssets. The cache will be invalidated upon session termination an upon call to other functions entering data into this cache.

Parameters

[in]	sessionID	Session ID
[in]	accesskey	Access Key
[in]	sort	Sort type.
[in]	archStyle	Archive style.
[in]	masterChild	MasterChildFlag deciding which types of assets to include.
[in]	langID	Language ID for internationalized content.
[in]	cacheID	(optional) This ID can be used to specify a certain cache if succeeding calls shall not invalidate the same cache. Use the same cacheID in getSearchResult functions to obtain the correct result set.
[out]	result	Amount of Assets retrievable via asset cache.

◆ getHotAssets()

int getHotAssets	(	xsd__string	sessionID,
		enum MasterChildFlag	masterChild,
		struct SortItem	sort,
		xsd__string	langID,
		xsd__string cacheID	0,
		xsd__int &	assetCount
	)

Get N newest Assets accessible by a certain User Group.

This call now also uses the search result cache. It just delivers a count of assets matching the specification and stores their IDs in the asset cache. The asset data can be retrieved afterwards using getSearchResultAssets. Use matching cacheIDs (or none thereof) to be sure to obtain matching results.

Parameters

[in]	sessionID	Session ID (determines the User Group)
[in]	masterChild	MasterChildFlag deciding which types of assets to include.
[in]	sort	Sort type.
[in]	langID	Language ID (for internationalized content)
[in]	cacheID	Token ID to specify a cache line specific to this call. This is used in order to not invalidate caches used by other searches. Use this token as well with getSearchResult functions to obtain the correct result set.
[out]	assetCount	Amount of Assets retrievable via asset cache.

◆ getLastChanges()

int getLastChanges	(	xsd__string	sessionID,
		xsd__int	limit,
		std::vector< struct LastChange > &	lastChanges
	)

Get treeID, filename and date of last change for latest changes in file system.

Parameters

[in]	sessionID	Session ID (must be admin session)
[in]	limit	Amount of changes to deliver.
[out]	lastChanges	Array of data structures containing the result.

◆ getMacPath()

int getMacPath	(	xsd__string	sessionID,
		xsd__string	dirID,
		xsd__string &	macPath
	)

Get Mac Path of Directory.

Parameters

[in]	sessionID	Session ID
[in]	dirID	Directory ID
[out]	macPath	Mac Path of Directory.

◆ getMediaShare()

int getMediaShare	(	xsd__string	sessionID,
		xsd__string	mediaShareID,
		std::vector< struct MediaShare > &	mediaShare
	)

Get Media Share information.

Parameters

[in]	sessionID	Session ID
[in]	mediaShareID	Media Share ID
[out]	mediaShare	Media Share information.

◆ getMediaShareEvents()

int getMediaShareEvents	(	xsd__string	sessionID,
		xsd__string	mediaShareID,
		xsd__unsignedInt	limit,
		xsd__string	langID,
		enum TreeDataFlag	dataFlag,
		std::vector< struct SearchResult > &	result
	)

Get Media Share events.

Parameters

[in]	sessionID	Session ID
[in]	mediaShareID	ID of media share
[in]	limit	Maximum amount of Assets returned.
[in]	langID	Language ID (for internationalized content)
[in]	dataFlag	Definition of which asset data to return.
[out]	result	Assets, which were recently added to the media share.

◆ getMediaShareName()

int getMediaShareName	(	xsd__string	sessionID,
		xsd__string	mediaShareID,
		xsd__string	groupID,
		std::vector< xsd__string > &	name
	)

Get User Group specific Name of Media Share.

Parameters

[in]	sessionID	Session ID
[in]	mediaShareID	ID of Media Share
[in]	groupID	ID of User Group (meaningful only in case of an admin session, where it is used to determine which name shall be returned; otherwise, the User Group is deduced from the Session).
[out]	name	User Group specific Name of the Media Share.

◆ getNavigationLevel()

int getNavigationLevel	(	xsd__string	sessionID,
		xsd__string	langID,
		xsd__string	topDirID,
		xsd__boolean	checkUploadDirs,
		std::vector< xsd__string > groupID 0:1	,
		std::vector< struct TreeDir > &	TreeDirs
	)

Get one level of the directory navigation tree.

Navigation in cavok can be done by browsing directories, which are delivered by this function. There are permissions which may hinder members of certain user groups to see certain directories. These permissions are observed here.

Parameters

[in]	sessionID	Session ID
[in]	langID	Display language of metadata content.
[in]	topDirID	ID of top level directory (whose subdirectories are returned); may be 0 in which case the top level directories as permitted for the user group of the caller are returned.
[in]	checkUploadDirs	check for upload dirs (which will be returned in uploadDirsBelow of the ns:TreeDir structure). May degrade performance a bit, depending on ratio of upload:no-upload directories.
[in]	groupID	Only meaningful for admin sessions: groupID to use for evaluation of display permissions.
[out]	Array	of TreeDir structures.

◆ getNotes()

int getNotes	(	xsd__string	sessionID,
		xsd__string	treeID,
		xsd__string pageID	0,
		std::vector< xsd__string > userIDs	0,
		std::vector< struct NoteResult > &	noteResult
	)

Get Preview Notes for an Asset.

Parameters

[in]	sessionID	Session ID
[in]	treeID	Asset ID
[in]	pageID	(optional) ID of Preview page (if omitted, notes for all pages are returned in sequence)
[in]	userIDs	(optional) IDs of Users who authored a note.
[out]	noteResult	Array of Preview Notes.

◆ getOwnDownloadLinks()

int getOwnDownloadLinks	(	xsd__string	sessionID,
		xsd__boolean	nohidden,
		std::vector< struct DownloadLink > &	links
	)

Get Own DownloadLinks.

Retrieve all available download links created by specific user.

Parameters

[in]	sessionID	Session ID
[in]	nohidden	if true, "hidden" links are excluded from result.
[out]	links	Array of DownloadLink structures for all links created by the session owner.

◆ getOwnEmbedLinks()

int getOwnEmbedLinks	(	xsd__string	sessionID,
		xsd__string	langID,
		xsd__boolean	nohidden,
		std::vector< struct EmbedLink > &	embedlinks
	)

Get all embedded links of this user.

(For all users, if admin.)

Parameters

[in]	sessionID	Session ID
[in]	langID	language ID of asset data returned.
[in]	nohidden	if true, "hidden" links are excluded from the result.
[out]	embedlinks	Array of embedded link data structures.

◆ getOwnUploadLinks()

int getOwnUploadLinks	(	xsd__string	sessionID,
		xsd__string	langID,
		std::vector< struct UploadLink > &	links
	)

Get Own UploadLinks.

Retrieve all available upload links created by specific user.

Parameters

[in]	sessionID	Session ID
[in]	langID	language ID to be used for metadata names
[out]	links	Array of UploadLink structures for all links created by the session owner.

◆ getPath()

int getPath	(	xsd__string	sessionID,
		xsd__string	pathID,
		std::vector< struct Path > &	path
	)

Get Volume Information.

Parameters

[in]	sessionID	Session ID (must be admin session)
[in]	pathID	Volume ID
[out]	path	Volume Information.

◆ getPreviewTypes()

int getPreviewTypes	(	xsd__string	sessionID,
		xsd__string	treeID,
		std::vector< xsd__string > &	previewTypes
	)

Get preview types of one asset.

Preview types are freetext strings entered when inserting previews.

Parameters

[in]	sessionID	Session ID
[in]	treeID	Asset ID
[out]	previewTypes	Array of preview type strings

◆ getSearchResult()

int getSearchResult	(	xsd__string	sessionID,
		xsd__boolean	useDirs,
		xsd__boolean	useCats,
		xsd__unsignedInt	start,
		xsd__unsignedInt	limit,
		xsd__string	langID,
		enum TreeDataFlag	dataFlag,
		xsd__string cacheID	0,
		std::vector< struct SearchResult > &	result
	)

Retrieve cached Search Results (Assets, Directories and Categories)

Parameters

[in]	sessionID	Session ID
[in]	useDirs	if true, return directories as well.
[in]	useCats	if true, return categories as well.
[in]	start	Starting index (begins with 0).
[in]	limit	Maximum combined amount of Asset, Category and Directory informations returned. Directory informations are always returned first, Category information second.
[in]	langID	Language ID to be used for internationalized items.
[in]	dataFlag	Flag for specifying which Asset informations shall be returned. (Meaningless for directories.)
[in]	cacheID	(optional) identical cacheID as used in the call to Find.
[out]	result	Combined result set containing Asset, Category and Directory informations.

◆ getSearchResultAssets()

int getSearchResultAssets	(	xsd__string	sessionID,
		xsd__unsignedInt	start,
		xsd__unsignedInt	limit,
		xsd__string	langID,
		enum TreeDataFlag	dataFlag,
		xsd__string cacheID	0,
		std::vector< struct SearchResultAssets > &	assets
	)

Retrieve cached Search Results (Assets).

Parameters

[in]	sessionID	Session ID
[in]	start	Starting index (starting with 0).
[in]	limit	Maximum amount of Asset data to be returned.
[in]	langID	Language ID for internationalized data fields.
[in]	dataFlag	Flag for specifying which Asset data shall be returned.
[in]	cacheID	(optional) identical cacheID as used in the call to Find.
[out]	assets	Array with Asset data.

◆ getSearchResultCategories()

int getSearchResultCategories	(	xsd__string	sessionID,
		xsd__unsignedInt	start,
		xsd__unsignedInt	limit,
		xsd__string	langID,
		enum TreeDataFlag	dataFlag,
		xsd__string cacheID	0,
		std::vector< struct SearchResultCategories > &	categories
	)

Retrieve cached Search Results (Categories).

Parameters

[in]	sessionID	Session ID
[in]	start	Starting index (starting with 0).
[in]	limit	Maximum amount of Category data to be returned.
[in]	langID	Language ID for internationalized data fields.
[in]	dataFlag	Flag for specifying which Category data shall be returned.
[in]	cacheID	(optional) identical cacheID as used in the call to Find.
[out]	categories	Array with Category data.

◆ getSearchResultDirs()

int getSearchResultDirs	(	xsd__string	sessionID,
		enum TreeDataFlag	dataFlag,
		xsd__string	langID,
		xsd__unsignedInt	start,
		xsd__unsignedInt	limit,
		xsd__string cacheID	0,
		std::vector< struct SearchResultDirs > &	dirs
	)

Retrieve cached Search Results (Directories)

Parameters

[in]	sessionID	Session ID
[in]	dataFlag	Selection of ViewSetTypes for directory metadata.
[in]	langID	Display language for metadata content.
[in]	start	Starting index (begins with 0).
[in]	limit	Maximum amount of directories to be returned.
[in]	cacheID	(optional) identical cacheID as used in the call to Find.
[out]	dirs	Array of directory information.

◆ getTasks()

int getTasks	(	xsd__string	sessionID,
		xsd__string	treeID,
		std::vector< struct Task > &	tasks
	)

Get all tasks associated with an asset.

Parameters

[in]	sessionID	ID of Session
[in]	treeID	Asset ID
[out]	tasks	Array of Task data structures containing the information

◆ getTree()

int getTree	(	xsd__string	sessionID,
		std::vector< xsd__string >	treeIDs,
		xsd__string	langID,
		enum TreeDataFlag	dataFlag,
		enum MasterChildFlag	masterChild,
		std::vector< struct TreeData > &	Assets
	)

Get Asset information.

There's a wealth of information on each asset stored in cavok. All of this can be retrieved using getTree. The dataFlag determines, which members of the returned TreeData data structures are meaningful. Base asset data (the Tree data structure embedded in TreeData) is always returned.

Parameters

[in]	sessionID	Session ID
[in]	treeIDs	Array of asset IDs.
[in]	langID	ID of language which shall be used for returned values.
[in]	dataFlag	TreeDataFlag describing which data shall be returned.
[in]	masterChild	MasterChildFlag deciding what types of assets shall be returned.
[out]	Assets	Array of TreeData data structures (one for each asset ID given), only the members are filled out, which are requested by dataFlag.

◆ getTreeDirOwnMetadata()

int getTreeDirOwnMetadata	(	xsd__string	sessionID,
		xsd__string	langID,
		std::vector< xsd__string >	dirIDs,
		std::vector< struct TreeDirMetadataSimple > &	own_md
	)

Get custom metadata of directories.

For each of the directories specified by their directory ID, metadata of custom metadata fields are returned; using the view set type VTDETAIL.

\param[in] sessionID Session ID
\param[in] langID Language ID
\param[in] dirIDs Array of directory IDs.
\param[out] own_md Array of metadata values for each of the directories given.

◆ getTreeIcon()

int getTreeIcon	(	xsd__string	sessionID,
		std::vector< xsd__string >	treeID,
		std::vector< struct Thumbnail > &	thumbnails
	)

Get Asset Icon.

Parameters

[in]	sessionID	Session ID
[in]	treeID	Array of asset IDs
[out]	thumbnails	Array of Thumbnail data structures containing thumbnail information.

◆ getTreeList()

int getTreeList	(	xsd__string	sessionID,
		xsd__string	topDirID,
		struct SortItem	sortCode,
		enum ArchiveStyle	archStyle,
		enum MasterChildFlag	masterChild,
		xsd__string	langID,
		xsd__string cacheID	0,
		xsd__boolean recursive	0,
		xsd__boolean excludeDirectories	0,
		std::vector< struct FindResult > &	result
	)

Get Assets within a directory.

Actually, this function does not deliver asset data, it rather caches asset data internally and returns how many assets were found. The data itself can be retrieved using getSearchResultAssets or getSearchResult afterwards. The cache is invalidated when the Session is closed, or when another function is called which caches asset or directory data.

Parameters

[in]	sessionID	Session ID
[in]	dataFlag	Selection of ViewSetType for directory metadata.
[in]	topDirID	ID of directory from which assets are to be returned.
[in]	sortCode	Type of sorting to be used for assets.
[in]	archStyle	Archive style for finding assets.
[in]	masterChild	MasterChildFlag deciding what type of assets to include.
[in]	langID	Language ID
[in]	cacheID	(optional) Token used to identify a certain cache line for this search action. Use the same token for the getSearchResult function in order to obtain the correct result set.
[in]	recursive	(optional) If true, all asset belonging to sub-hierarchies of this directory will be included in the result. Default is false.
[in]	excludeDirectories	(optional) If true, directories will not be included in the result set. Default is false.
[out]	result	Result data (amount of assets found).

◆ getTreeMetaDataList()

int getTreeMetaDataList	(	xsd__string	sessionID,
		std::vector< xsd__string >	treeIDs,
		enum ViewType	viewType,
		xsd__string	langID,
		std::vector< struct TreeMetadata > &	TreeMetadata
	)

Get metadata of an asset.

All metadata configured for viewing in the specified viewType is returned for the assets given in treeIDs.

Parameters

[in]	sessionID	Session ID
[in]	treeIDs	Array of asset IDs for which metadata shall be returned.
[in]	viewType	ViewSet type for which metadata shall be returned.
[in]	langID	Language ID
[out]	TreeMetadata	Array of Metadata for each of the assets specified.

◆ getTreeOwnMetadata()

int getTreeOwnMetadata	(	xsd__string	sessionID,
		xsd__string	langID,
		std::vector< xsd__string > treeIDs	0,
		std::vector< xsd__string > dirIDs	0,
		std::vector< xsd__string > catIDs	0,
		std::vector< struct TreeMetadata > &	own_md
	)

Get custom metadata of assets.

For each of the assets specified either by their asset ID, the ID of a directory below which they reside recursively, or the ID of a category to which the assets belong, or a combination thereof, metadata of custom metadata fields are returned.

Parameters

[in]	sessionID	Session ID
[in]	langID	Language ID
[in]	treeIDs	Array of asset IDs. (optional)
[in]	dirIDs	Array of directory IDs. (optional)
[in]	catIDs	Array of category IDs. (optional)
[out]	own_md	Array of metadata values for each of the assets given.

◆ getTreeOwnMetadataSummary()

int getTreeOwnMetadataSummary	(	xsd__string	sessionID,
		xsd__string	langID,
		std::vector< xsd__string > treeIDs	0,
		std::vector< xsd__string > dirIDs	0,
		std::vector< xsd__string > catIDs	0,
		std::vector< struct OwnMetadataSummary > &	mds
	)

Get summary of custom metadata.

For each of the assets specified either by their asset ID, the ID of a directory below which they reside recursively, or the ID of a category to which the assets belong, or a combination thereof, a summary of metadata values of custom metadata fields are returned.

Parameters

[in]	sessionID	Session ID
[in]	langID	Language ID
[in]	treeIDs	Array of asset IDs. (optional)
[in]	dirIDs	Array of directory IDs. (optional)
[in]	catIDs	Array of category IDs. (optional)
[out]	mds	Metadata Summary.

◆ getTreePreview()

int getTreePreview	(	xsd__string	sessionID,
		std::vector< xsd__string >	treeIDs,
		xsd__string	previewTypeID,
		xsd__string	versionID,
		xsd__int	startPage,
		xsd__int	limit,
		std::vector< struct PreviewResult > &	pages
	)

Get Preview of Asset.

Parameters

[in]	sessionID	Session ID
[in]	treeIDs	Array of asset IDs
[in]	previewTypeID	ID of preview type (usually 0 if no different types of previews are created in this installation)
[in]	versionID	ID of version (usually 0 if there's no versioning or if you want the preview of the main asset)
[in]	startPage	(only in case of a query for a single asset) page ID of first preview page to return
[in]	limit	(only in case of a query for a single asset) maximum amount of pages to return
[out]	pages	result array containing at most limit pages (in case of single asset query)

◆ getTreeRelationList()

int getTreeRelationList	(	xsd__string	sessionID,
		std::vector< xsd__string >	treeIDs,
		enum ViewType	viewType,
		xsd__string	langID,
		xsd__string	page,
		std::vector< struct TreeRelation > &	TreeRelations
	)

Get List of related Assets of an Asset.

Parameters

[in]	sessionID	Session ID.
[in]	treeIDs	Array of Asset IDs.
[in]	viewType	Part of ViewSet for which data shall be returned.
[in]	langID	ID of language for which data shall be returned.
[in]	page	Page number, for which relations should be returned; this is only valid for assets contained in the documents given in treeIDs; assets containing the documents given in treeIDs are returned irrespective of this setting. Leave empty if relations of all pages are desired.
[out]	TreeRelations	Array of related Assets (including the information for each specified in the ViewSet part specified in parameter viewType).

◆ getTreeText()

int getTreeText	(	xsd__string	sessionID,
		xsd__string	treeID,
		xsd__string	pageID,
		std::vector< struct TreeTextInternal > &	text
	)

Get extracted Text content of Asset (page by page).

Parameters

[in]	sessionID	Session ID.
[in]	treeID	Asset ID.
[in]	pageID	ID of page from which text was extracted.
[out]	text	Text of this page.

◆ getTreeTextList()

int getTreeTextList	(	xsd__string	sessionID,
		std::vector< xsd__string >	treeID,
		std::vector< struct TreeText > &	TreeTexts
	)

Get extracted Text content of Asset.

Parameters

[in]	sessionID	Session ID
[in]	treeID	Array of Asset IDs.
[out]	TreeTexts	Array of TreeText data structures containing extracted text for each Asset seperately.

◆ getTreeVersions()

int getTreeVersions	(	xsd__string	sessionID,
		xsd__string	treeID,
		std::vector< struct TreeVersion > &	versions
	)

Get versions table for an asset.

Delivers the content of the versions table of the asset.

Parameters

[in]	sessionID	Session ID
[in]	treeID	Asset ID
[out]	versions	Array of TreeVersion structures.

◆ getUploadLink()

int getUploadLink	(	xsd__string	sessionID,
		xsd__string	dirID,
		xsd__string	uploadScript,
		xsd__int	timeout,
		xsd__int	localTimeDiff,
		xsd__boolean	emailToOwner,
		xsd__base64Binary	displayText,
		xsd__string	displayName,
		std::vector< struct UploadMetadata >	metaData,
		xsd__string &	uploadLink
	)

Get Upload Link for target directory.

(by directory ID)

Parameters

[in]	sessionID	Session ID
[in]	dirID	Directory ID
	timeout	Unix timestamp of planned expiry time of link.
	localTimeDiff	Difference between local time and UTC at the client side (in minutes) (e.g. UTC+2 is +120, UTC-4 is -240).
[in]	emailToOwner	should an email be sent to the owner each time the link is used?
[in]	displayText	Text to be displayed in the client when an upload dialog for this upload link is opened (base64 encoded).
[in]	displayName	Custom name of link.
[in]	metaData	metaData elements to be associated with this UploadLink. Only config.metaID and mandatory will be evaluated. The selected metadata must be contained in the VTWRITE view type of the view set of the owner group of this link.
[out]	part	of URL with which an upload into the selected directory can be initiated (the front part of the URL, which conicides with the URL the client uses to connect to the SOAP server, must be supplied by the client, since it is unknown to the server)

◆ getUploadLinkByPath()

int getUploadLinkByPath	(	xsd__string	sessionID,
		xsd__string	treePaths,
		enum PathType	pathType,
		xsd__string	uploadScript,
		xsd__int	timeout,
		xsd__int	localTimeDiff,
		xsd__boolean	emailToOwner,
		xsd__base64Binary	displayText,
		xsd__string	displayName,
		std::vector< struct UploadMetadata >	metaData,
		xsd__string &	uploadLink
	)

Get Upload Link for target directory.

(by path)

Parameters

[in]	sessionID	Session ID
[in]	treePath	Asset Path
[in]	pathType	type of asset path given in treePath
	timeout	Unix timestamp of planned expiry time of link.
	localTimeDiff	Difference between local time and UTC at the client side (in minutes) (e.g. UTC+2 is +120, UTC-4 is -240).
[in]	emailToOwner	should an email be sent to the owner each time the link is used?
[in]	displayName	Custom name of link.
[in]	metaData	metaData elements to be associated with this UploadLink. Only config.metaID and mandatory will be evaluated. The selected metadata must be contained in the VTWRITE view type of the view set of the owner group of this link.
[out]	part	of URL with which an upload into the selected directory can be initiated (the front part of the URL, which conicides with the URL the client uses to connect to the SOAP server, must be supplied by the client, since it is unknown to the server)

◆ getUploadLinkDisplayText()

int getUploadLinkDisplayText	(	xsd__string	accessKey,
		xsd__base64Binary &	displayText
	)

Get display text for a specific upload link.

Parameters

[in]	accessKey	Access key of upload link.
[out]	displayText	display text specified for this link.

◆ getUploadLinkOwner()

int getUploadLinkOwner	(	xsd__string	accessKey,
		struct UploadLinkOwner &	ownerInfo
	)

Get owner information for a specific upload link.

Parameters

[in]	accessKey	Access key of upload link.
[out]	ownerInfo	owner information for this link.

◆ getWinPath()

int getWinPath	(	xsd__string	sessionID,
		xsd__string	dirID,
		xsd__string &	winPath
	)

Get Windows Path of Directory.

Parameters

[in]	sessionID	Session ID
[in]	dirID	Directory ID
[out]	winPath	Windows Path of Directory.

◆ hasUploadDirs()

int hasUploadDirs	(	xsd__string	sessionID,
		xsd__boolean &	hasThem
	)

Has specific user upload dirs?

Parameters

[in]	sessionID	Session ID
[out]	hasThem	the answer to the question.

◆ isUploadLinkValid()

int isUploadLinkValid	(	xsd__string	accessKey,
		xsd__boolean &	valid
	)

Check if given upload key is valid.

Parameters

[in]	accessKey	Access key of upload link.
[out]	valid	true, if access key is valid.

◆ moveCategory()

int moveCategory	(	xsd__string	sessionID,
		xsd__string	categoryID,
		xsd__string	newParentID,
		xsd__int	newPosition,
		std::vector< struct noret > &
	)

Move Category to a new logical position.

Parameters

[in]	sessionID	Session ID
[in]	categoryID	ID of category to move
[in]	newParentID	ID of new parent category.
[in]	newPosition	Insert position within new parent category.
[out]	none.

◆ nameCategory()

int nameCategory	(	xsd__string	sessionID,
		xsd__string	catID,
		xsd__string	langID,
		xsd__string	name,
		std::vector< struct noret > &
	)

Set a new Name for a Category.

Parameters

[in]	sessionID	Session ID
[in]	catID	ID of category
[in]	langID	ID of language for which the name shall be set.
[in]	name	Name of the category.
[out]	none.

◆ removeChildAssets()

int removeChildAssets	(	xsd__string	sessionID,
		xsd__string	masterID,
		std::vector< xsd__string >	childIDs,
		std::vector< struct noret > &
	)

Remove child assets.

Removes child assets from a master asset.

Parameters

[in]	sessionID	Session ID
[in]	masterID	Asset ID of master asset
[in]	childIDs	Asset IDs of child assets. If none specified, remove all children of this master asset.

◆ removeDownloadLink()

int removeDownloadLink	(	xsd__string	sessionID,
		xsd__string	hash,
		std::vector< struct noret > &
	)

Remove a DownloadLink.

Remove a DownloadLink from the database. User may only remove DownloadLinks created by himself; admin may remove any DownloadLink.

Parameters

[in]	sessionID	Session ID
[in]	hash	Unique hash of DownloadLink to remove from DB.
[out]	none.

◆ removeEmbedLink()

int removeEmbedLink	(	xsd__string	sessionID,
		xsd__string	embedkey,
		std::vector< struct noret > &
	)

Remove an embedded link for this user (For any user, if admin.)

Parameters

[in]	sessionID	Session ID
[in]	embedkey	Embedded link access key.

◆ removeTaskShapes()

int removeTaskShapes	(	xsd__string	sessionID,
		xsd__string	taskID,
		std::vector< xsd__string >	shapeIDs,
		std::vector< struct noret > &
	)

Remove NoteShapes from a task.

Parameters

[in]	sessionID	ID of Session
[in]	taskID	ID of task
[in]	shapeIDs	Array of NoteShape ids to unassign from the task.

◆ setMediaShareName()

int setMediaShareName	(	xsd__string	sessionID,
		xsd__string	mediaShareID,
		xsd__string	groupID,
		xsd__string	newAlias,
		std::vector< struct noret > &
	)

Set User Group specific Name for Media Share.

Parameters

[in]	sessionID	Session ID (must be admin session)
[in]	mediaShareID	ID of Media Share.
[in]	groupID	ID of User Group.
[in]	newAlias	User Group specific alias name for the Media Share.
[out]	none.

◆ setNote()

int setNote	(	xsd__string	sessionID,
		struct Note	note,
		xsd__string &	noteID
	)

Set a preview Note for an Asset.

Parameters

[in]	sessionID	Session ID
[in]	note	Note content and position information.
[out]	noteID	ID of newly created Note.

◆ setNoteShape()

int setNoteShape	(	xsd__string	sessionID,
		struct NoteShape	noteShape,
		xsd__string &	shapeID
	)

Set a Note Shape.

Parameters

[in]	sessionID	Session ID
[in]	noteShape	Note Shape data structure.
[out]	shapeID	ID of newly created note shape.

◆ setPathCategoryPath()

int setPathCategoryPath	(	xsd__string	sessionID,
		xsd__string	langID,
		xsd__string	unixPath,
		std::vector< xsd__string >	categories,
		std::vector< struct noret > &
	)

Set Category membership by Unix Path.

Categories are accessed by name here. If a category with the specified name does not exist, it is created as a child category of the category previous to it in the path. The path always has to start with a top level category (which also may not exist, in which case it is created as top level category.) The categories are assumed to be hierarchical (categories[0] –> categories[1] –> categories[2] –> ...).

Parameters

[in]	sessionID	Session ID
[in]	langID	language ID (for name internationalization)
[in]	unixPath	Unix Path of asset.
[in]	categories	Array of category names in hierarchical form.
[out]	none.

◆ setPathOwnMetadata()

int setPathOwnMetadata	(	xsd__string	sessionID,
		xsd__string	langID,
		xsd__string	unixPath,
		std::vector< struct MetadataContent >	content,
		std::vector< struct noret > &
	)

Set Metadata Values using Unix path of Asset.

Only metadata of meta class OWN can be set!

Parameters

[in]	sessionID	Session ID
[in]	langID	ID of language for which value(s) shall be set.
[in]	unixPath	Unix path of asset.
[in]	content	Metadata values to be set (multiple metadata can be set with one call).
[out]	none.

◆ setTaskShapes()

int setTaskShapes	(	xsd__string	sessionID,
		xsd__string	taskID,
		std::vector< xsd__string >	shapeIDs,
		std::vector< struct noret > &
	)

Setting the NoteShapes associated with a task.

Parameters

[in]	sessionID	ID of Session
[in]	taskID	ID of task
[in]	shapeIDs	Array of NoteShape ids to be associated with the task. (All previous shape associations are removed.)

◆ setTreeDirOwnMetadata()

int setTreeDirOwnMetadata	(	xsd__string	sessionID,
		xsd__string	langID,
		std::vector< xsd__string >	treeDirIDs,
		std::vector< struct MetadataContent >	content,
		std::vector< struct noret > &
	)

Set Metadata Values of Directories.

Only metadata of meta class OWN can be set!

Parameters

[in]	sessionID	Session ID.
[in]	langID	ID of language for which value shall be set.
[in]	treeDirIDs	Array of Directory IDs.
[in]	content	Set of new metadata values to be set. (Multiple metadata can be set with one call.)
[out]	none.

◆ setTreeOwnMetadata()

int setTreeOwnMetadata	(	xsd__string	sessionID,
		xsd__string	langID,
		std::vector< xsd__string > treeIDs	0,
		std::vector< xsd__string > dirIDs	0,
		std::vector< xsd__string > catIDs	0,
		std::vector< struct MetadataContent >	content,
		std::vector< struct noret > &
	)

Set Metadata Values.

Only metadata of meta class OWN can be set!

Parameters

[in]	sessionID	Session ID.
[in]	langID	ID of language for which value shall be set.
[in]	treeIDs	(optional) Array of Asset IDs. Only content with metaClass OWN is set, all other content is ignored.
[in]	dirIDs	(optional) Array of directory IDs. Content with metaClass OWN: The values specified are set for each of the assets contained in these directories. Content with metaClass OWNDIR: the values specified are set for all directories with dirIDs specified here. Content with metaClass OWNCAT is ignored.
[in]	catIDs	(optional) Array of category IDs. Content with metaClass OWN: The values specified are set for each of the assets contained in these categories. Content with metaClass OWNCAT: the values specified are set for all categories with catIDs specified here. Content with metaClass OWNDIR is ignored.
[in]	content	Set of new metadata values to be set. (Multiple metadata can be set with one call.)
[out]	none.

◆ SortSearchCache()

int SortSearchCache	(	xsd__string	sessionID,
		struct SortItem	sortCode,
		xsd__string	langID,
		xsd__string cacheID	0,
		std::vector< struct FindResult > &	result
	)

Re-Sort search result cache.

Only sort an existing search result cache by a new search criterion.

Parameters

[in]	sessionID	Session ID
[in]	sortCode	sort criterion
[in]	langID	Language ID
[in]	cacheID	Cache ID (optional)

◆ TransferCategoryAsset()

int TransferCategoryAsset	(	xsd__string	sessionID,
		xsd__string	categoryID,
		xsd__string	path,
		std::vector< struct noret > &
	)

Transfer an uploaded asset into a category.

Parameters

sessionID	Session ID (admin only)
categoryID	ID of Category
path	Unix path of Asset

◆ unassignAssetsFromCategories()

int unassignAssetsFromCategories	(	xsd__string	sessionID,
		xsd__string	langID,
		std::vector< xsd__string > treeIDs	0,
		std::vector< xsd__string > dirIDs	0,
		std::vector< xsd__string >	categoryIDs,
		xsd__boolean	recursive,
		std::vector< struct noret > &
	)

Unassign Assets from Categories.

Parameters

[in]	sessionID	Session ID
[in]	langID	Language ID
[in]	treeIDs	(optional) Array of Asset IDs.
[in]	dirIDs	(optional) Array of directory IDs where assets are taken from; these are used recursively, thus, assets are also taken from all subdirectories (and their subdirectories).
[in]	categoryIDs	Categories from which assets shall be unassigned.
[in]	recursive	Transaction shall be recursive for sub categories of the given category IDs.
[out]	none.

◆ unassignCategory()

int unassignCategory	(	xsd__string	sessionID,
		xsd__string	categoryID,
		xsd__string	mediaShareID,
		std::vector< struct noret > &
	)

Unassign Category from a Media Share.

Parameters

[in]	sessionID	Session ID
[in]	categoryID	ID of category to unassign.
[in]	mediaShareID	ID of media share to unassign from.
[out]	none.

◆ upCategory()

int upCategory	(	xsd__string	sessionID,
		xsd__string	catID,
		std::vector< struct noret > &
	)

Move Category up one step in Display Order.

Parameters

[in]	sessionID	Session ID
[in]	catID	ID of category
[out]	none.

Variable Documentation

◆ path

enum PathFailReason path

Data structure containing the result of a getAssetIDsForPaths call.

the path as given as parameter to the call.

Classes

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ ActionFlag

◆ ArchiveStyle

◆ AssetLogType

◆ FileAccessResult

◆ MasterChildFlag

◆ NoteShapeAction

◆ PathFailReason

◆ PathType

◆ TreeDataFlag

Function Documentation

◆ addChildAssets()

◆ addTask()

◆ addTaskComment()

◆ addTaskShapes()

◆ addUserGroupUploadDir()

◆ assignAssetsToCategories()

◆ assignCategory()

◆ assignTask()

◆ changeDownloadLinkOption()

◆ changeEmbedLinkOption()

◆ changeMacWinPath()

◆ checkFileAccess()

◆ checkFileAccessCategory()

◆ createCategory()

◆ createMediaShare()

◆ deleteCategory()

◆ deleteMediaShare()

◆ deleteNote()

◆ deleteNoteShape()

◆ deleteTask()

◆ deleteUserGroupUploadDir()

◆ downCategory()

◆ Find()

◆ findAssetsOfCategory()

◆ findAssetsOfCollection()

◆ FindBySearchChain()

◆ FindSimilar()

◆ getActionsForAssets()

◆ getAllMediaShares()

◆ getAllPaths()

◆ getAssetHistory()

◆ getAssetIDsForPaths()

◆ getCategoriesOfAsset()

◆ getCategory()

◆ getCategoryLevel()

◆ getCategoryOwnMetadata()

◆ getCategorySummary()

◆ getCommonActionsForAssets()

◆ getDirectLinkInformation()

◆ getDirHierarchy()

◆ getDownloadLinkByPath()

◆ getEmbedLinkInformation()

◆ getExternalCollections()

◆ getHotAssets()

◆ getLastChanges()

◆ getMacPath()

◆ getMediaShare()

◆ getMediaShareEvents()

◆ getMediaShareName()

◆ getNavigationLevel()

◆ getNotes()

◆ getOwnDownloadLinks()

◆ getOwnEmbedLinks()

◆ getOwnUploadLinks()

◆ getPath()

◆ getPreviewTypes()

◆ getSearchResult()

◆ getSearchResultAssets()

◆ getSearchResultCategories()

◆ getSearchResultDirs()

◆ getTasks()

◆ getTree()

◆ getTreeDirOwnMetadata()

◆ getTreeIcon()