OBJECT

Folder

GraphQL Schema definition

1 type Folder {
2 
3 #   The ID of this folder
4 id: ID! 
5 
6 treeObjectId: ID! @deprecated( reason: "obsolete"  )
7 
8 #   The name of this folder
9 name: String 
10 
11 #   An optional description
12 description: String 
13 
14 createdDateTime: DateTime 
15 
16 modifiedDateTime: DateTime 
17 
18 ownerId: String 
19 
20 #   The parent folder
21 parent: Folder 
22 
23 #   The subfolders of this folder
24 #   Deprecated: Use paginated childFolders instead.
25 subfolders: [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
31 #   entityTags: Provide a list of entity tags to filter by
32 childFolders(
33 offset: Int,
34 limit: Int,
35 names: [String],
36 nameMatch: StringMatch,
37 orderBy: [FolderOrderBy!],
38 entityTags: [EntityTagFilter!]
39 ): FolderList 
40 
41 #   The organization that owns this folder
42 organization: Organization 
43 
44 #   The ID of the organization that owns this folder
45 organizationId: ID 
46 
47 typeId: Int 
48 
49 rootFolderTypeId: Int 
50 
51 #   The maximum depth of child folders allowed
52 maxDepth: Int 
53 
54 orderIndex: Int 
55 
56 #   The folder status
57 status: FolderStatus 
58 
59 #   The ordered path of the folder hierarchy. The first element
60 #   is always a root folder, and the last is this folder's parent.
61 folderPath: [Folder!] 
62 
63 #   TemporalDataObjects that are filed in this folder
64 childTDOs(offset: Int, limit: Int): TDOList 
65 
66 #   Watchlists that are filed in this folder
67 # 
68 # Arguments
69 #   name: Provide a name to filter watchlists
70 #   names: Provide a list of names to filter folders
71 childWatchlists(
72 offset: Int,
73 limit: Int,
74 name: String,
75 names: [String],
76 nameMatch: StringMatch
77 ): WatchlistList 
78 
79 #   The read/write permissions for a shared folder
80 sharedAccess: [String] 
81 
82 sharedWith: SharedWith 
83 
84 contentTemplates: [FolderContentTemplate!]! 
85 
86 #   Collection that are filed in this folder
87 # 
88 # Arguments
89 #   name: Provide a name to filter collections
90 childCollections(offset: Int, limit: Int, name: String): CollectionList 
91 
92 #   Applications that are filed in this folder
93 childApplications(offset: Int, limit: Int): ApplicationList 
94 
95 #   The tags associated with the folder
96 entityTags: [EntityTag] 
97 
98 }

1	type Folder {
2
3	# The ID of this folder
4	id: ID!
5
6	treeObjectId: ID! @deprecated( reason: "obsolete" )
7
8	# The name of this folder
9	name: String
10
11	# An optional description
12	description: String
13
14	createdDateTime: DateTime
15
16	modifiedDateTime: DateTime
17
18	ownerId: String
19
20	# The parent folder
21	parent: Folder
22
23	# The subfolders of this folder
24	# Deprecated: Use paginated childFolders instead.
25	subfolders: [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
31	# entityTags: Provide a list of entity tags to filter by
32	childFolders(
33	offset: Int,
34	limit: Int,
35	names: [String],
36	nameMatch: StringMatch,
37	orderBy: [FolderOrderBy!],
38	entityTags: [EntityTagFilter!]
39	): FolderList
40
41	# The organization that owns this folder
42	organization: Organization
43
44	# The ID of the organization that owns this folder
45	organizationId: ID
46
47	typeId: Int
48
49	rootFolderTypeId: Int
50
51	# The maximum depth of child folders allowed
52	maxDepth: Int
53
54	orderIndex: Int
55
56	# The folder status
57	status: FolderStatus
58
59	# The ordered path of the folder hierarchy. The first element
60	# is always a root folder, and the last is this folder's parent.
61	folderPath: [Folder!]
62
63	# TemporalDataObjects that are filed in this folder
64	childTDOs(offset: Int, limit: Int): TDOList
65
66	# Watchlists that are filed in this folder
67	#
68	# Arguments
69	# name: Provide a name to filter watchlists
70	# names: Provide a list of names to filter folders
71	childWatchlists(
72	offset: Int,
73	limit: Int,
74	name: String,
75	names: [String],
76	nameMatch: StringMatch
77	): WatchlistList
78
79	# The read/write permissions for a shared folder
80	sharedAccess: [String]
81
82	sharedWith: SharedWith
83
84	contentTemplates: [FolderContentTemplate!]!
85
86	# Collection that are filed in this folder
87	#
88	# Arguments
89	# name: Provide a name to filter collections
90	childCollections(offset: Int, limit: Int, name: String): CollectionList
91
92	# Applications that are filed in this folder
93	childApplications(offset: Int, limit: Int): ApplicationList
94
95	# The tags associated with the folder
96	entityTags: [EntityTag]
97
98	}

Folder

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by