Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateFolderDetails

Properties used in folder update operations.

Properties

Optional businessName

businessName: undefined | string

Optional user friendly business name of the folder. If set, this supplements the harvested display name of the object.

Optional customPropertyMembers

customPropertyMembers: Array<CustomPropertySetUsage>

The list of customized properties along with the values for this object

Optional description

description: undefined | string

Detailed description of a folder.

Optional displayName

displayName: undefined | string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional harvestStatus

harvestStatus: model.HarvestStatus

Harvest status of the folder.

Optional lastJobKey

lastJobKey: undefined | string

The key of the last harvest process to update the metadata of this object.

Optional parentFolderKey

parentFolderKey: undefined | string

The key of the containing folder.

Optional properties

properties: undefined | object

A map of maps that contains the properties which are specific to the folder type. Each folder type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most folders have required properties within the "default" category. To determine the set of optional and required properties for a folder type, a query can be done on '/types?type=folder' that returns a collection of all folder types. The appropriate folder type, which includes definitions of all of it's properties, can be identified from this collection. Example: {@code {"properties": { "default": { "key1": "value1"}}}}

Optional timeExternal

timeExternal: Date

Last modified timestamp of this object in the external system.

Functions

getDeserializedJsonObj

getJsonObj