Queries
folders
Retrieves all sub-folders within a specified folder that meet the filter criteria specified by the filter argument.
Template for Query:
query GetFolders($folderId: ID!, $filter: FolderFilterInput, $pagination: PaginationInput) {
folders(folderId: $folderId, filter: $filter, pagination: $pagination) {
# Folders Fields
}
}
Template for Query Variables:
{
"folderId" : "<SOME-ID-TYPE-SCALAR-VALUE>",
"filter" : "<SOME-FOLDERFILTER-INPUT-TYPE-VALUE>",
"pagination" : "<SOME-PAGINATION-INPUT-TYPE-VALUE>"
}
Arguments
| folderId* ID! non-null | The ID of the folder that contains the sub |
| filter | Specifies how to filter on folders. |
| pagination | Specifies how to split the response into multiple pages. |
* Required
Possible Returns
| Value Type | Description |
|---|---|
Folders! non-null |
Contains a list of folders returned in response to a query. |
Examples
Example 1
Retrieves sub folders under a folder by folder ID.
Query:
query GetFolders($folderId: ID!) {
folders (folderId: $folderId) {
id
name
objectCount
}
}
Query Variables:
{
"folderId": "Zm9sZH5iLmU0ZmJkMzE1LTJkYzUtNDAyNi04Y2EzLTgwZjA5ZDI0ZmY0Mn5iLjdhZGJmOWZkLWRlYmItNDI5Yy1iZmU1LTMyYTNjMjJjMDY5NX51cm46YWRzay53aXBzdGc6ZnMuZm9sZGVyOmNvLlhvSG9RY3pHUm9LczVZRm4yUDNpWlE"
}
Response:
{
"data": {
"folders": {
"results": [
{
"id": "Zm9sZH5iLmU0ZmJkMzE1LTJkYzUtNDAyNi04Y2EzLTgwZjA5ZDI0ZmY0Mn5iLjdhZGJmOWZkLWRlYmItNDI5Yy1iZmU1LTMyYTNjMjJjMDY5NX51cm46YWRzay53aXBzdGc6ZnMuZm9sZGVyOmNvLnBRYjdZcVNlUjlXNTdldmVkZVdvQlE",
"name": "Model",
"objectCount": 22
},
{
"id": "Zm9sZH5iLmU0ZmJkMzE1LTJkYzUtNDAyNi04Y2EzLTgwZjA5ZDI0ZmY0Mn5iLjdhZGJmOWZkLWRlYmItNDI5Yy1iZmU1LTMyYTNjMjJjMDY5NX51cm46YWRzay53aXBzdGc6ZnMuZm9sZGVyOmNvLkU1OENuck5pUTZDVW9PTG9Ja29QSUE",
"name": "Small House",
"objectCount": 1
}
]
}
}
}
Show More
