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,
36orderBy: [FolderOrderBy!]
37): FolderList
38
39# The organization that owns this folder
40organization: Organization
41
42# The ID of the organization that owns this folder
43organizationId: ID
44
45typeId: Int
46
47rootFolderTypeId: Int
48
49# The maximum depth of child folders allowed
50maxDepth: Int
51
52orderIndex: Int
53
54# The folder status
55status: FolderStatus
56
57# The ordered path of the folder hierarchy. The first element
58# is always a root folder, and the last is this folder's parent.
59folderPath: [Folder!]
60
61# TemporalDataObjects that are filed in this folder
62childTDOs(offset: Int, limit: Int): TDOList
63
64# Watchlists that are filed in this folder
65#
66# Arguments
67# name: Provide a name to filter watchlists
68# names: Provide a list of names to filter folders
69childWatchlists(
70offset: Int,
71limit: Int,
72name: String,
73names: [String],
74nameMatch: StringMatch
75): WatchlistList
76
77# The read/write permissions for a shared folder
78sharedAccess: [String]
79
80sharedWith: SharedWith
81
82contentTemplates: [FolderContentTemplate!]!
83
84# Collection that are filed in this folder
85#
86# Arguments
87# name: Provide a name to filter collections
88childCollections(offset: Int, limit: Int, name: String): CollectionList
89
90# Applications that are filed in this folder
91childApplications(offset: Int, limit: Int): ApplicationList
92
93}