OBJECT

Folder

link GraphQL Schema definition

1type Folder {
2
3# The ID of this folder
4id: ID!
5
6treeObjectId: ID!
7
8# The name of this folder
9name: String
10
11# An optional description
12description: String
13
14createdDateTime: DateTime
15
16modifiedDateTime: DateTime
17
18ownerId: String
19
20# The parent folder
21parent: Folder
22
23# The subfolders of this folder
24# Deprecated: Use paginated childFolders instead.
25subfolders: [Folder!]
26
27# A paginated list of child folders of this folders
28#
29# Arguments
30# names: Provide a list of names to filter folders
31childFolders(
32offset: Int,
33limit: Int,
34names: [String],
35nameMatch: StringMatch
36): FolderList
37
38# The organization that owns this folder
39organization: Organization
40
41# The ID of the organization that owns this folder
42organizationId: ID
43
44typeId: Int
45
46rootFolderTypeId: Int
47
48# The maximum depth of child folders allowed
49maxDepth: Int
50
51orderIndex: Int
52
53# The folder status
54status: FolderStatus
55
56# The ordered path of the folder hierarchy. The first element
57# is always a root folder, and the last is this folder's parent.
58folderPath: [Folder!]
59
60# TemporalDataObjects that are filed in this folder
61childTDOs(offset: Int, limit: Int): TDOList
62
63# Watchlists that are filed in this folder
64#
65# Arguments
66# name: Provide a name to filter watchlists
67childWatchlists(offset: Int, limit: Int, name: String): WatchlistList
68
69# The read/write permissions for a shared folder
70sharedAccess: [String]
71
72sharedWith: SharedWith
73
74contentTemplates: [FolderContentTemplate!]!
75
76# Collection that are filed in this folder
77#
78# Arguments
79# name: Provide a name to filter collections
80childCollections(offset: Int, limit: Int, name: String): CollectionList
81
82}