Queries
itemsByFolder
Retrieves all items within a specified folder that meet the filter criteria specified by the filter argument.
Template for Query:
query GetItemsByFolder($hubId: ID!, $folderId: ID!, $filter: ItemFilterInput, $pagination: PaginationInput) {
itemsByFolder(hubId: $hubId, folderId: $folderId, filter: $filter, pagination: $pagination) {
# Items Fields
}
}
Arguments
| hubId* ID! non-null | The ID of the Hub that contains the item. |
| folderId* ID! non-null | The ID of the folder that contains the items. |
| filter | Specifies how to filter the content of a folder. You can filter by name. |
| pagination | Specifies how to split the response into multiple pages. |
* Required
Possible Returns
| Value Type | Description |
|---|---|
| Items | Contains a list of items returned in response to a query. An item refers to a file or sub-folder that exists within a folder. |
Examples
Example 1
Retrieves all items under a folder with filtering by item name.
Query:
query GetItemsByFolder($hubId: ID!, $folderId: ID!) {
itemsByFolder(hubId: $hubId, folderId: $folderId) {
results {
__typename
id
name
}
}
}
Show More
Query Variables:
{
"hubId": "urn:adsk.ace:beta.scope:02dd340f-3e84-4db8-b6a1-56a964a202c7",
"folderId": "urn:adsk.wipstg:fs.folder:co.quEik8frQn6SJBINysuqJw"
}
Response:
{
"data": {
"itemsByFolder": {
"results": [
{
"__typename": "DesignItem",
"id": "urn:adsk.wipstg:dm.lineage:CDZwg3U8QTmJxvqarNU71A",
"name": "Connector 70"
},
{
"__typename": "DesignItem",
"id": "urn:adsk.wipstg:dm.lineage:avHuvfAgRF-29KmOJq7CZQ",
"name": "Connector"
}
]
}
}
}
Show More