Queries
foldersByFolder
Retrieves all subfolders within a specified folder that meet the filter criteria specified by the filter argument.
Template for Query:
query GetFoldersByFolder($projectId: ID!, $folderId: ID!, $filter: FolderFilterInput, $pagination: PaginationInput) {
foldersByFolder(projectId: $projectId, folderId: $folderId, filter: $filter, pagination: $pagination) {
# Folders Fields
}
}
Arguments
| projectId* ID! non-null | The ID of the project that contains the items. |
| folderId* ID! non-null | The ID of the folder that contains the subfolders. |
| filter | Specifies how to filter on folders. You can filter by name. |
| pagination | Specifies how to split the response into multiple pages. |
* Required
Possible Returns
| Value Type | Description |
|---|---|
| Folders | A list of Folders returned in response to a query. A folder contains items, such as designs and sub-folders. |
Examples
Example 1
Retrieves all subfolders within a specified folder that meet the filter criteria specified by the filter argument in a project.
Query:
query FoldersByFolder($projectId: ID!, $folderId: ID!) {
foldersByFolder(projectId: $projectId, folderId: $folderId) {
results {
id
name
path
}
}
}
Show More
Query Variables:
{
"projectId": "urn:adsk.workspace:beta.project:99497e80-4c1f-4ca7-8132-4bf1735e4d68",
"folderId": "urn:adsk.wipstg:fs.folder:co.quEik8frQn6SJBINysuqJw"
}
Response:
{
"data": {
"foldersByFolder": {
"results": [
{
"id": "urn:adsk.wipstg:fs.folder:co.e1RDpnm3TjaqIr_ZOy9RFA",
"name": "Folder 01",
"path": "/Espresso Machine/Connectors"
}
]
}
}
}
Show More