OBJECT

Folder

GraphQL Schema definition

1 type Folder {
2 
3 #   The ID of this folder
4 id: ID! 
5 
6 treeObjectId: ID! 
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 childFolders(
32 offset: Int,
33 limit: Int,
34 names: [String],
35 nameMatch: StringMatch
36 ): FolderList 
37 
38 #   The organization that owns this folder
39 organization: Organization 
40 
41 #   The ID of the organization that owns this folder
42 organizationId: ID 
43 
44 typeId: Int 
45 
46 rootFolderTypeId: Int 
47 
48 #   The maximum depth of child folders allowed
49 maxDepth: Int 
50 
51 orderIndex: Int 
52 
53 #   The folder status
54 status: 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.
58 folderPath: [Folder!] 
59 
60 #   TemporalDataObjects that are filed in this folder
61 childTDOs(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
67 childWatchlists(offset: Int, limit: Int, name: String): WatchlistList 
68 
69 #   The read/write permissions for a shared folder
70 sharedAccess: [String] 
71 
72 sharedWith: SharedWith 
73 
74 contentTemplates: [FolderContentTemplate!]! 
75 
76 #   Collection that are filed in this folder
77 # 
78 # Arguments
79 #   name: Provide a name to filter collections
80 childCollections(offset: Int, limit: Int, name: String): CollectionList 
81 
82 }

1	type Folder {
2
3	# The ID of this folder
4	id: ID!
5
6	treeObjectId: ID!
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	childFolders(
32	offset: Int,
33	limit: Int,
34	names: [String],
35	nameMatch: StringMatch
36	): FolderList
37
38	# The organization that owns this folder
39	organization: Organization
40
41	# The ID of the organization that owns this folder
42	organizationId: ID
43
44	typeId: Int
45
46	rootFolderTypeId: Int
47
48	# The maximum depth of child folders allowed
49	maxDepth: Int
50
51	orderIndex: Int
52
53	# The folder status
54	status: 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.
58	folderPath: [Folder!]
59
60	# TemporalDataObjects that are filed in this folder
61	childTDOs(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
67	childWatchlists(offset: Int, limit: Int, name: String): WatchlistList
68
69	# The read/write permissions for a shared folder
70	sharedAccess: [String]
71
72	sharedWith: SharedWith
73
74	contentTemplates: [FolderContentTemplate!]!
75
76	# Collection that are filed in this folder
77	#
78	# Arguments
79	# name: Provide a name to filter collections
80	childCollections(offset: Int, limit: Int, name: String): CollectionList
81
82	}

Folder

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by