CFolder

Contains information for a specific folder.

To retrieve a list of items in the folder, use getEntityListForFolderByRecordID.

To add or remove an item in a folder, use addEntityToFolderByRecordID or removeEntityFromFolderByRecordID.

To change a folder item’s rank, use editFolderItemRank.

Extends

CItemToTrack

Fields

Field Type Description
recordid long Unique folder record ID.
createdbyuser long Record ID of the user who created the folder.
ispublic boolean Indicates if the folder is public or private.
modifiedbyuser long Record ID of the user who last modified the folder.
locationaddedfrom string Method used to add the folder. Read only.
datetimecreated DateTime Date the folder was created.
datetimemodified DateTime Date the folder was last modified.
name string Folder name.
description string Folder description.
path string Full path to the folder. Does not include a trailing slash. (e.g., /Public/folder A/folder a)
order long Order of the folder relative to other folders in the same parent folder. Starts at 1.
parentid long Record ID of the parent folder.
foldertypename string Name of the folder type. Use getFolderTypeList to retrieve a list of folder types.
webview string Contents of the Web address field.
notes string Contents of the Notes field. See Working with multi-line text fields for formatting information.
notesInlineAttachList CFileAttachment[] Inline attachments associated with the Notes field.
noteseditable boolean Indicates if the folder Notes field can be edited by anyone.
scheduleinfo CScheduleInfo[] Contents of the Release Planning fields.

Returned by

Used in