Folder

GraphQL Schema definition

type Folder {
#   Folder ID
id: ID! 
#   Date created
created: DateTime 
#   Date modified
modified: DateTime 
#   Folder name
name: String! 
#   Number of folders from root folder to the current folder
depth: Int! 
#   Folder creator account information.
creator: UserSummary 
#   Organization which owns this folder
organization: OrganizationSummary 
#   Parent folder of the given folder. For root folder, parent will be null.
parent: Folder 
#   Fetches paged list of direct subfolders for this folder (not recursive)
# 
# Arguments
#   pageSize: The maximum number of results to return in a single 
#   page.  If the requested pageSize exceeds
#   the maximum of 1000, the value 1000 will be used.
#   Default: 10
#   offset: An offset id for the next page to retrieve.  The value 
#   from `nextOffset` in the previous result should
#   be used to grab the next page.
subfolders(pageSize: Int, offset: String): PagedFolderList 
#   Fetches paged list of models in this folder (does not include subfolders)
# 
# Arguments
#   pageSize: The maximum number of results to return in a single 
#   page.  If the requested pageSize exceeds
#   the maximum of 100 a `request.invalid` will be thrown.
#   Default: 10
#   offset: An offset id for the next page to retrieve.  The value 
#   from `nextOffset` in the previous result should
#   be used to grab the next page.
models(pageSize: Int, offset: String): PagedModelList 
#   Fetches an ordered paged list of parents. One can get head or tail of parent 
#   list using offset and sortOrder
# 
# Arguments
#   sortOrder: The sort order which can be used to get the head end 
#   or tail end of parent list, defaults to descending (desc)
#   pageSize: The maximum number of results to return in a single 
#   page.  If the requested pageSize exceeds
#   the maximum of 1000, the value 1000 will be used.
#   Default: 10
#   offset: An offset id for the next page to retrieve.  The value 
#   from `nextOffset` in the previous result should
#   be used to grab the next page.
parents(sortOrder: SortOrder, pageSize: Int, offset: String): PagedFolderList 
#   Get all the users with their role that can access given folder
#   @beta
#   @deprecated v2023.06.28 use objectAccess instead
# 
# Arguments
#   filters: Filter results based on the parameter provided. If not 
#   specified, all access information is returned. If more than
#   one value is given, result will be a union between these values.
#   orderBy: Choose a field to order by. If not specified, 
#   AccessInfoOrder.USER_EMAIL is default.
#   sortOrder: Choose a sort order. If not specified, ascending 
#   order is default.
#   pageSize: Desired number of entries in a page of results. If 
#   not specified, default will be 10
#   offset: The offset value to apply, if omitted will start with 
#   the first matching result. The result list's
#   'nextOffset' property provides the offset value for the next page of results.
access(
filters: [FolderAccessFilter!],
orderBy: AccessInfoOrder,
sortOrder: SortOrder,
pageSize: Int,
offset: String
): AccessInfoList 
#   Get a count of all the active and archived models in a given folder.
# 
# Arguments
#   status: Specify status of model. If left unspecified, it will 
#   count all the models in the given folder.
#   includeModelsInSubfolders: If true, count will include all the 
#   models in the given folder and all the subfolders. If false, only models in
#   the given folder are counted.
#   @default false.
modelCountSummary(
status: [ModelFlag!],
includeModelsInSubfolders: Boolean
): Int 
}
Folder

GraphQL Schema definition

Require by
