2.4.2 Manage Folder Metadata

2.4.2.1 Data Structures

2.4.2.1.1 FolderMetadataResult

Folder metadata in a form of name = value pairs

Data Type

Field Name

Description

int

FolderMetadataID

ID of a newly created metadata item for a folder

int

FolderID

ID of a folder for which metadata is created

string

Name

Metadata item name

int

DataType

Type of the data

string

Data

Value

2.4.2.2 Methods

2.4.2.2.1 CreateFolderMetadata

CreateFolderMetadata
Creates metadata for a specific folder in Thru file system.

FolderMetadataResult
CreateFolderMetadata(Guid sessionID, int folderID, string name, string data)

Parameter Name

Description

sessionID

User session returned by one of the Open functions

folderID

ID for the folder for which metadata is created

name

Name for a new metadata item

data

String with the data that will populate metadata item

2.4.2.2.2 GetFolderMetadata

GetFolderMetadata
Retrieves metadata for specific Thru folder

FolderMetadataResult[]
GetFolderMetadata (Guid sessionID, int folderID)

Parameter Name

Description

sessionID

User session returned by one of the Open functions

folderID

ID for the folder for which metadata is retrieved

2.4.2.2.3 SaveFolderMetadata

SaveFolderMetadata
Updates metadata for a specific folder in Thru file system. If metadata with the input name does not exist for the folder ID, exception will be thrown.
Note: metadata with the name Description will be displayed as a folder description in web UI and returned by the API

FolderMetadataResult
SaveFolderMetadata(Guid sessionID, int folderID, string name, string data)

Parameter Name

Description

sessionID

User session returned by one of the Open functions

folderID

ID for the folder for which metadata is created

name

Name for a new metadata item

data

String with the data that will populate metadata item