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 the content of a folder. |
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 all the sub-folders in a folder by ID.
Query:
query GetFolders($folderId: ID!) {
folders(folderId: $folderId) {
results {
id
name
objectCount
}
}
}
Show More
Query Variables:
{
"folderId": "Zm9sZH5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZn51cm46YWRzay53aXBwcm9kOmZzLmZvbGRlcjpjby40U0F5Z29SSFNjZUllVUlySVMtSUxB"
}
Response:
{
"data": {
"folders": {
"results": [
{
"id": "Zm9sZH5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZn51cm46YWRzay53aXBwcm9kOmZzLmZvbGRlcjpjby5ON21kU05TSFR3Nk81dWNualhsSjJR",
"name": "Large-models",
"objectCount": 8
},
{
"id": "Zm9sZH5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZn51cm46YWRzay53aXBwcm9kOmZzLmZvbGRlcjpjby5TWW9LbnlJNVJOU3pmNVBVeWlqNXB3",
"name": "Small-models",
"objectCount": 4
}
]
}
}
}
Show More