Queries
project
Retrieves an object representing a project from a specified hub.
A project is a shared workspace for teams of people to store, organize, and manage all related design data.
Template for Query:
query GetProject($projectId: String!) {
project(projectId: $projectId) {
# Project Fields
}
}
Template for Query Variables:
{
"projectId" : "<SOME-STRING-TYPE-SCALAR-VALUE>"
}
Arguments
| projectId* String! non-null | The ID of the project to retrieve. |
* Required
Possible Returns
| Value Type | Description |
|---|---|
| Project | Represents a project. A project is a shared workspace for teams of people working together on a project, to store, organize, and manage all related design data. |
Example
Example 1
This example retrieves a specific project, and lists the content of the top-level folder of the project. The query does not split the content of the folder into multiple pages.
Query:
query GetProject($projectId: String) {
project(projectId: $projectId) {
name
rootFolder {
objectCount
items {
results {
__typename
name
id
}
}
}
}
}
Show More
Query Variables:
{
"projectId": "a.YnVzaW5lc3M6YXV0b2Rlc2syMDA2I0QyMDIxMTIwNzQ5ODU1NTY5"
}
Response:
{
"data": {
"project": {
"name": "Default Project",
"rootFolder": {
"objectCount": 36,
"items": {
"results": [
{
"__typename": "DesignFile",
"name": "M10 Hex Nut",
"id": "urn:adsk.wipstg:dm.lineage:hN8gB8BaQauWpREk58aiiw"
},
{
"__typename": "DesignFile",
"name": "Water Inlet / Outlet",
"id": "urn:adsk.wipstg:dm.lineage:DlhtZ8xwTC2X8X6myGsacw"
},
{
"__typename": "DesignFile",
"name": "Main Body",
"id": "urn:adsk.wipstg:dm.lineage:qlMis4VdT0CxKaEO1RcCig"
},
{
"__typename": "DesignFile",
"name": "M5 x 15mm BHS",
"id": "urn:adsk.wipstg:dm.lineage:FkcB2Oe9RrqCz8U5n2btZA"
},
{
"__typename": "DesignFile",
"name": "End Cap Pulley Side",
"id": "urn:adsk.wipstg:dm.lineage:roJzXyF0S1CZUFidbG4nmQ"
},
{
"__typename": "DesignFile",
"name": "John's Test",
"id": "urn:adsk.wipstg:dm.lineage:qH2H8mWaRoGlz2bY45dMRg"
},
{
"__typename": "DesignFile",
"name": "Parallel Key 5x5x15",
"id": "urn:adsk.wipstg:dm.lineage:1gKpy90tTkKFohK9HRyxdA"
},
{
"__typename": "DesignFile",
"name": "24mm Bearing",
"id": "urn:adsk.wipstg:dm.lineage:lQTl_DeSQpS2QBLwSIqnMw"
},
{
"__typename": "DesignFile",
"name": "Pump Assembly",
"id": "urn:adsk.wipstg:dm.lineage:rEHAX1n6RomGPpYx7EIRkQ"
},
{
"__typename": "DesignFile",
"name": "Drive Gear",
"id": "urn:adsk.wipstg:dm.lineage:wiA8gNWORF-UxLu4nVa4KQ"
},
{
"__typename": "DesignFile",
"name": "M6 x 22mm SHCS",
"id": "urn:adsk.wipstg:dm.lineage:BPhrhhOWRF2Y-zlN-t359g"
},
{
"__typename": "DesignFile",
"name": "Shilpa's Box",
"id": "urn:adsk.wipstg:dm.lineage:Tm41m5ClQEyBXw0VR9SYrw"
},
{
"__typename": "DesignFile",
"name": "Noemie's Box",
"id": "urn:adsk.wipstg:dm.lineage:EMnZbYklSPakau-Nt6633w"
},
{
"__typename": "DesignFile",
"name": "M6 Washer",
"id": "urn:adsk.wipstg:dm.lineage:u2LBSQToQRujgcVrOvhBrA"
},
{
"__typename": "DesignFile",
"name": "V-Belt Pulley",
"id": "urn:adsk.wipstg:dm.lineage:5TLpNyIBQUe9-E5krfw6yg"
},
{
"__typename": "DesignFile",
"name": "Water Outlet Gasket",
"id": "urn:adsk.wipstg:dm.lineage:tA23CZXVTLaNiiRP_CM3sw"
},
{
"__typename": "BasicFile",
"name": "House Design.rvt",
"id": "urn:adsk.wipstg:dm.lineage:WLu-TpA8QvCdLy_TuQMpqQ"
},
{
"__typename": "BasicFile",
"name": "Office Building.nwc",
"id": "urn:adsk.wipstg:dm.lineage:m8ziDAoKSv6NQHk5OzmFGw"
},
{
"__typename": "BasicFile",
"name": "Robot.iam",
"id": "urn:adsk.wipstg:dm.lineage:GQGIaxDATsO9IsfBiVFa3Q"
},
{
"__typename": "BasicFile",
"name": "Sports Car.dwfx",
"id": "urn:adsk.wipstg:dm.lineage:nMvafAgdRX-DjzBSG41ZLg"
},
{
"__typename": "BasicFile",
"name": "V8 Engine.iam",
"id": "urn:adsk.wipstg:dm.lineage:ZIFkUOrDRzK2FCpOVBplPw"
},
{
"__typename": "DesignFile",
"name": "Retaining Clip",
"id": "urn:adsk.wipstg:dm.lineage:MygM7EmCQf6W4kanOIiSCg"
},
{
"__typename": "DrawingFile",
"name": "Shilpa's Box Drawing",
"id": "urn:adsk.wipstg:dm.lineage:-7V1Sf1uSCChtwg24-Gd4A"
},
{
"__typename": "DesignFile",
"name": "Pump Gasket",
"id": "urn:adsk.wipstg:dm.lineage:sVD83IveTa2R-oJyxaVvmw"
},
{
"__typename": "DesignFile",
"name": "Parallel Key 4x4x15",
"id": "urn:adsk.wipstg:dm.lineage:0MvPgjpgSwKc3aA_jySOxw"
},
{
"__typename": "DesignFile",
"name": "External Retaining Ring",
"id": "urn:adsk.wipstg:dm.lineage:rSz_7yDxSqSIGgy7tqH6Iw"
},
{
"__typename": "DesignFile",
"name": "Driven Gear",
"id": "urn:adsk.wipstg:dm.lineage:SFYEghqTSlaRWXf8DOxH_A"
},
{
"__typename": "DrawingFile",
"name": "Noemie's Box Drawing 1",
"id": "urn:adsk.wipstg:dm.lineage:iFixNp1QS9iv1-X9f2xt1w"
},
{
"__typename": "DesignFile",
"name": "M10 Washer",
"id": "urn:adsk.wipstg:dm.lineage:KD57N1c4RWe4Za71JGh-Ug"
},
{
"__typename": "DesignFile",
"name": "Shaft Seal",
"id": "urn:adsk.wipstg:dm.lineage:CjDzOPBWT9m_-IXVVr6bjQ"
},
{
"__typename": "DrawingFile",
"name": "Noemie's Box Drawing 3",
"id": "urn:adsk.wipstg:dm.lineage:3WYF1TZzTqar-QnbrwWriA"
},
{
"__typename": "DesignFile",
"name": "Small End Cap",
"id": "urn:adsk.wipstg:dm.lineage:gq_spixyS_uoGMbiPT_Rqw"
},
{
"__typename": "DesignFile",
"name": "Drive Gear Shaft",
"id": "urn:adsk.wipstg:dm.lineage:_Aj-agXkRxO_2__hQtC7uQ"
},
{
"__typename": "DesignFile",
"name": "End Cap",
"id": "urn:adsk.wipstg:dm.lineage:iXZvqClST72tS2XGNtuLEg"
},
{
"__typename": "DesignFile",
"name": "Brass Bushing",
"id": "urn:adsk.wipstg:dm.lineage:ZNpPhdhUTRG2BSQJbrnsHg"
},
{
"__typename": "DrawingFile",
"name": "Noemie's Box Drawing 2",
"id": "urn:adsk.wipstg:dm.lineage:mhGnq_itTOm7uhlDLPNsjg"
}
]
}
}
}
}
}
Show More
Example 2
Get users belongs to project.
Query:
query project ($projectId: String!) {
project (projectId: $projectId) {
id
name
hub {
id
name
}
users(pagination:{cursor:"M34y"}){
results{
firstName
}
pagination{
cursor
}
}
}
}
Show More
Query Variables:
{
"projectId": "a.YnVzaW5lc3M6YXV0b2Rlc2syMDA2I0QyMDIxMTIwNzQ5ODU1NTY5"
}
Response:
{
"data": {
"project": {
"id": "a.YnVzaW5lc3M6YXV0b2Rlc2syMDA2I0QyMDIxMTIwNzQ5ODU1NTY5",
"name": "Default Project",
"hub": {
"id": "a.YnVzaW5lc3M6YXV0b2Rlc2syMDA2",
"name": "L2-Forge-Data-Team"
},
"users": {
"results": [
{
"firstName": "Michelangelo"
},
{
"firstName": "Farzad"
}
],
"pagination": {
"cursor": "NH4y"
}
}
}
}
}
Show More
