Queries
folder
Retrieves an object representing a folder.
A folder is a container of sub-folders and other resources.
Template for Query:
query GetFolder($folderId: ID!) {
folder(folderId: $folderId) {
# Folder Fields
}
}
Template for Query Variables:
{
"folderId" : "<SOME-ID-TYPE-SCALAR-VALUE>"
}
Arguments
folderId* ID! non-null | The ID of the folder to retrieve. |
* Required
Possible Returns
Value Type | Description |
---|---|
Folder | Represents a folder. A folder is a location for storing files, data, and other folders (sub-folders). |
Examples
Example 1
Retrieves a folder by ID along with its Exchanges.
Query:
query GetFolder($folderId: ID!) {
folder(folderId: $folderId) {
id
name
exchanges {
results {
id
name
alternativeRepresentations {
fileUrn
}
}
}
items {
... on Items {
results {
id
name
extensionType
}
}
}
}
}
}
Show More
Query Variables:
{
"folderId": "Zm9sZH5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZn51cm46YWRzay53aXBwcm9kOmZzLmZvbGRlcjpjby5ON21kU05TSFR3Nk81dWNualhsSjJR"
}
Response:
{
"data": {
"folder": {
"id": "Zm9sZH5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZn51cm46YWRzay53aXBwcm9kOmZzLmZvbGRlcjpjby5ON21kU05TSFR3Nk81dWNualhsSjJR",
"name": "Large-models",
"exchanges": {
"results": [
{
"id": "ZXhjfnlwdWFzY1NicWlIT0R1R0s4OUkwTHdfTDJDfjgwNDg4OWIzLTk0YjAtMzFkOC1hZTBiLWUxNmM5ODJmMTM2NQ",
"name": "SHARE - First Floor",
"alternativeRepresentations": {
"fileUrn": "urn:adsk.wipprod:dm.lineage:s3z-uvBzSlSP1fqEGC4xoA"
}
},
{
"id": "ZXhjfnlwdWFzY1NicWlIT0R1R0s4OUkwTHdfTDJDfjI0ZjQ0MmZkLTcxYmQtMzNmNi1hMDg2LTk4NTZjZDUxYmEyMQ",
"name": "SHARE - Overall",
"alternativeRepresentations": {
"fileUrn": "urn:adsk.wipprod:dm.lineage:PJUJS8ybSrWRnM21lXkoqg"
}
},
{
"id": "ZXhjfnlwdWFzY1NicWlIT0R1R0s4OUkwTHdfTDJDfjkwMGM5ODY1LWI2ZmMtMzI0Ny04NWUxLTgxMmZhOGY1ZTJkNA",
"name": "SHARE -Multi-Fam Apt-Wing 2",
"alternativeRepresentations": {
"fileUrn": "urn:adsk.wipprod:dm.lineage:wfjaO3PZSwC2gWg2A1AvbQ"
}
}
]
},
"items": {
"results": [
{
"id": "aXRlbX5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZn51cm46YWRzay53aXBwcm9kOmZzLmZvbGRlcjpjby5ON21kU05TSFR3Nk81dWNualhsSjJRfnVybjphZHNrLndpcHByb2Q6ZG0ubGluZWFnZTpaSnh1M1Q3T1R6dW1QeUVaU1RCQ2p3",
"name": "FourWalls.ifc",
"extensionType": "items:autodesk.bim360:File"
},
{
"id": "aXRlbX5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZn51cm46YWRzay53aXBwcm9kOmZzLmZvbGRlcjpjby5ON21kU05TSFR3Nk81dWNualhsSjJRfnVybjphZHNrLndpcHByb2Q6ZG0ubGluZWFnZTpCVGJ3enVuSlFRU0wwTVBsbFhNVDZB",
"name": "FourWalls_2024.rvt",
"extensionType": "items:autodesk.bim360:File"
},
{
"id": "aXRlbX5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZn51cm46YWRzay53aXBwcm9kOmZzLmZvbGRlcjpjby5ON21kU05TSFR3Nk81dWNualhsSjJRfnVybjphZHNrLndpcHByb2Q6ZG0ubGluZWFnZTo1MjlsOVduTVRzMmhYcnMzNmFlalNn",
"name": "Multi-Fam Apt-2023.rvt",
"extensionType": "items:autodesk.bim360:File"
}
]
}
}
}
}
Show More