Retrieve Items by Project or Folder
This topic provides instructions on how to retrieve the following objects:
- Items within a project.
- Items within a folder.
You will use the following query in this topic:
Type | Operation | Description |
---|---|---|
Query | itemsByProject | Retrieves Items within a project. |
Query | itemsByFolder | Retrieves Items within a folder. |
Step 1 - Retrieve Items within a Project
The following steps demonstrate how you can run the itemsByProject query to retrieve all the Items within a project.
- Enter the following query in the Query Pane of the Manufacturing Data Model Explorer.
Query
query GetFolderItemsByProject($projectId: ID!) { itemsByProject(projectId: $projectId) { results { __typename id name ... on DesignItem { id name tipRootModel { id component{ id } } } } } }
Show More - In the Query Variables Pane, enter the value of the
projectId
. To know how to obtain theprojectId
, refer to Retrieve Projects.Query Variables
{ "projectId": "urn:adsk.workspace:beta.project:584a6b4e-3fa8-4896-8895-3e8409c83092" }
- Click Play. A list of Items within a project is displayed in the response.
Response
{ "data": { "itemsByProject": { "results": [ { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:15v-Ak2HQSm_TqEX-mRa3Q", "name": "AssyC", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-TzZhUEdkRzEyekhCYjZXWjd0YjVLNV9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ34ycmI2VmR3VGZYM3BORlhIU3FsMkEwX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:2hDdlKgMTW-C-CnI7yrfXQ", "name": "Test Box Component", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-ckJ3RHpxTlhnT0N0azQ5VEZWdGZTQl9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ35oMHVNRmgxbTRIaG43b3RBN3BLcWloX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:40Xab37ESMezjNh5zRE52w", "name": "Untitled", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-Rzh0RWU4eDlNdHpKZlRoVmxLUjBrcV9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ35UbWdHUjBobWJkT3pxbmNlZUJWb3lEX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:7SzhCrFkT7q2wjEHX65wKw", "name": "Untitled", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-THZTa2pGY0tIbWFiT2JkbWVSVzNYal9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ34zWkxiVmxsZEpmODlHZXFmSWFXY01UX2FnYQ" } } }, { "__typename": "DrawingItem", "id": "urn:adsk.wipstg:dm.lineage:8z0YKFZMS3mA_QQZ_79i9w", "name": "Test Drawing" }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:A-dzvS_UQ_mF8SxN9As4ZQ", "name": "Untitled3234213", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-aUh0c2ozeTNNQ3laYmNlM3B5ZWQ0d19hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ35JUWgzdHlsNG40Q0hSeXBDTEFQVHJqX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:BM_bLl4YT3WDXkb3Q9os9Q", "name": "Untitled3454354354q332", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-YzhoUTh2dHNHdGdycjdGNlJZU1g2UF9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ344UUhEUWQ2dzJ5c2FoZkhNZ2t1SmxJX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:HZx4hvNuSJmxlnexv_VhpQ", "name": "Untitled", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-ekhYUzBKU05NUGJZUnVOdkF5NElWR19hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ34xYmtNZzhKbkVGb1FGMkNWRUs2Wlc2X2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:KMrqk70WS2uBeLbLF1hy_A", "name": "AssyC", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-TllXSHV6NGZmTDJ3UDFoaHlVbXR0Ml9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ344RlNLTFhaRUp1N3pydVBkUmE3eVk3X2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:O4QH_er4RIi74Q8GPqR7SA", "name": "Untitled", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-b1dBOWhEUEtESmV0U25EdWZZUjNyWV9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ35nd1hWaG03bnpsdGIzRHlZZFNhWm43X2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:S68Gmk_vQoOn30skgWdWEA", "name": "UntitledBox123", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-bUFFZVhObUVpMVNzRUd3ZktCTG92MV9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ343RjFaZzU1MG1SZm5yNXA3d0xUVGY3X2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:STvA0_jTRFe8Dz-20AFDIg", "name": "Untitled14475", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-czBpVHI5MUJxNWlBdU11dEl5c21zd19hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ356UUNXOWZBamZEbXV2dVFYcFllUDFzX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:TMIwndZzSXuedUpORysmFw", "name": "Rectangle", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-Z2U0YWNSWGE1d2owNk9DWG9VeTlUdV9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ34xQmU1YVdZVVEzalV2WUZ2N0FxazJGX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:UNLDjdESQcmm1jCQ4Pxx4A", "name": "1", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-dFpiaWdhWmFVYnFKdlBwa3R6dDJQNl9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ35qbW1jeWhJR0ZBM0I5U0c1YlRCYk1UX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:_X30eOmyTWGPUQRvcsublQ", "name": "testData", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-czhFRVpFR2hqOEtrZjFRNmNTN2piOV9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ35JN1lVV1JwSGlva3ZsUHFEUHN3MXFNX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:aLOdpa7rQXux9B9mtnDYFQ", "name": "Untitled", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-dDFJZzhEb1J1QVFjWVZ3VlJlZWFyTF9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ34wcVpWZnk4RXJSb3NtaGl3MEtWQlVmX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:bbpT2HNVTEm2W5boBjh1Hw", "name": "FFF Bar support release", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-YnNWN295MDAzdk5zdGlPMmRVcGNYcl9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ35tTXQwajJGVnlSeURrTmFDZE5uZldTX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:f5-w0_VETq2nv6Nzvea01w", "name": "Untitled", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-dlA0YnVxNEExMHNCdFpuWnNaeklIaF9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ35vSGY2Mk81RGJtdmVvTWtjcUVLTlRQX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:fjXyAyI8QDmaPFvey0HtkQ", "name": "UntitledCylinder", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-dTNOdTZTOXVhZXROWk4xTXAwV2twal9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ35DZURJN3dneVcxdk9aaDdhQXI5MHdFX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:hBq90Lf1S0m_HqAmdk5JdQ", "name": "Untitled1", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-Y1g2eWEyVk5xZUFPWGFwc21hY3ZWRV9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ35vWU1VQm1hQW5Ed1pNTk1LNUZFd3lsX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:iRBDKIcVRn69_KTL9IQ9kQ", "name": "Untitled", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-ZExkMk5tYnlkM1BhVERUeWpVd09xYl9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ35mNlNjWGpnQXFMREI5Q2YzczQ2NGZlX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:lZgxjqurTyCwqdye8swQPg", "name": "Untitled", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-Rm96SGUzTExsT3EzZWpDNURwaWkxUF9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ35pY2M0aDd1WHlkdGpFWE4weXl2cHMyX2FnYQ" } } }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:vIVq-S-LTjixXhnFMz_FPA", "name": "SphereTest", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-YnR2SmZybm1WaWl5R1h4Rkw2WW10bl9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ354RUxNRjJ6QkNmOXVVaFl1bDJHWVZzX2FnYQ" } } }, { "__typename": "ConfiguredDesignItem", "id": "urn:adsk.wipstg:dm.lineage:x70DNgVLTK2zDb0yZwX2iA", "name": "Sphere" }, { "__typename": "DesignItem", "id": "urn:adsk.wipstg:dm.lineage:xidHQz_jR5arquNThQq-FA", "name": "WALKIE TALKIE v6", "tipRootModel": { "id": "bW9kZWx-d00wSVJmdmczT1VLTHZsYjJ4dDJMdF9MMkN-ald4c2F3Qmp5a1RRMmdMMmZkOUFKdl9hZ2E", "component": { "id": "cHJvZHVjdH53TTBJUmZ2ZzNPVUtMdmxiMnh0Mkx0X0wyQ340TmlrcXJQeEpITlZjRUFBcEdabmd1X2FnYQ" } } } ] } }, "extensions": { "pointValue": { "requestedQueryPointValue": 711 } } } }
Show More
Step 2 - Retrieve Items within a Folder
The following steps demonstrate how you can run the itemsByFolder query to retrieve all the Items within a folder.
- Enter the following query in the Query Pane of the Manufacturing Data Model Explorer.
Query
query GetFolderItemsByFolder($hubId: ID!, $folderId: ID!) { itemsByFolder(hubId: $hubId, folderId: $folderId) { results { __typename id name ... on DesignItem { id name rootComponent { id name } tipRootComponentVersion { id name } } } } }
Show More - In the Query Variables Pane, enter the value of the
hubId
andfolderId
. To know how to obtain thehubId
, refer to Retrieve Hubs.Query Variables
{ "hubId": "urn:adsk.ace:prod.scope:42db5214-7dfe-431a-8275-2ea47d5686d5", "folderId": "urn:adsk.wipprod:fs.folder:co.neOeWDZ2THyEog4s2vqFQg" }
- Click Play. A list of Items within a folder is displayed in the response.
Response
{ "data": { "itemsByFolder": { "results": [ { "__typename": "ConfiguredDesignItem", "id": "urn:adsk.wipprod:dm.lineage:3nKEsAAJRg2KuNLCl-UH5w", "name": "ConfigTest" }, { "__typename": "DesignItem", "id": "urn:adsk.wipprod:dm.lineage:AmkSu2iNRLiiELZQxAWhgQ", "name": "Normal-Design-New", "rootComponent": { "id": "Y29tcH5jby5uckdoR0ZIb1FXU3NQdFlhU0V2YThnflRaTUxQclZ0Q1hqNmJvQXdsOWppc3FfYWdh", "name": "Normal-Design-New" }, "tipRootComponentVersion": { "id": "Y29tcH5jby5uckdoR0ZIb1FXU3NQdFlhU0V2YThnflRaTUxQclZ0Q1hqNmJvQXdsOWppc3FfYWdhflRITEs5MzdJR3V5VXNUQkhuUVliTXA", "name": "Normal-Design-New" } }, { "__typename": "ConfiguredDesignItem", "id": "urn:adsk.wipprod:dm.lineage:B_mqmfHXQ8-luAzgisFI3w", "name": "design-for-model-occurence" }, { "__typename": "DesignItem", "id": "urn:adsk.wipprod:dm.lineage:FgnbBe-JSm6g5jzE6xo1UA", "name": "Normal-design-supergraph-test", "rootComponent": { "id": "Y29tcH5jby5uckdoR0ZIb1FXU3NQdFlhU0V2YThnfmRBNHdycUk4ellBUGhRMWN3UDFmczNfYWdh", "name": "Normal-design-supergraph-test" }, "tipRootComponentVersion": { "id": "Y29tcH5jby5uckdoR0ZIb1FXU3NQdFlhU0V2YThnfmRBNHdycUk4ellBUGhRMWN3UDFmczNfYWdhfjVIRXcxRzRyRWJIR0FlZENrVzN5bDY", "name": "Normal-design-supergraph-test" } }, { "__typename": "ConfiguredDesignItem", "id": "urn:adsk.wipprod:dm.lineage:SCdayUdRQZW7pkbfy9RpBQ", "name": "Configured-Design" }, { "__typename": "DesignItem", "id": "urn:adsk.wipprod:dm.lineage:Xbm07TlnTquPKdFrF756bg", "name": "Normal-Design", "rootComponent": { "id": "Y29tcH5jby5uckdoR0ZIb1FXU3NQdFlhU0V2YThnfkhxOThQSlYwMVVIVWZPUjdXaTA1elVfYWdh", "name": "Normal-Design" }, "tipRootComponentVersion": { "id": "Y29tcH5jby5uckdoR0ZIb1FXU3NQdFlhU0V2YThnfkhxOThQSlYwMVVIVWZPUjdXaTA1elVfYWdhflNZRHYyMUhPWmpzNmhZbWk1M0xQQlY", "name": "Normal-Design" } }, { "__typename": "DesignItem", "id": "urn:adsk.wipprod:dm.lineage:_K20F311R-K-LaJ4VxPCtQ", "name": "normalTEst", "rootComponent": { "id": "Y29tcH5jby5uckdoR0ZIb1FXU3NQdFlhU0V2YThnfnljVjJEcGtQMVdKM1d3UnVRTmhCM3VfYWdh", "name": "normalTEst" }, "tipRootComponentVersion": { "id": "Y29tcH5jby5uckdoR0ZIb1FXU3NQdFlhU0V2YThnfnljVjJEcGtQMVdKM1d3UnVRTmhCM3VfYWdhfmZQQW54MWtzT3BSMWVDTXhRc3k2NE0", "name": "normalTEst" } }, { "__typename": "DesignItem", "id": "urn:adsk.wipprod:dm.lineage:q_eTO0skS4yvFEJA6qSxpw", "name": "main-design-for-model-occurence", "rootComponent": { "id": "Y29tcH5jby5uckdoR0ZIb1FXU3NQdFlhU0V2YThnfko1RlJVYjBYbU1ieHdXVFBneG9PdXhfYWdh", "name": "main-design-for-model-occurence" }, "tipRootComponentVersion": { "id": "Y29tcH5jby5uckdoR0ZIb1FXU3NQdFlhU0V2YThnfko1RlJVYjBYbU1ieHdXVFBneG9PdXhfYWdhfndHdVVqdzNVbks2SGNXR2dTbWZKVjQ", "name": "main-design-for-model-occurence" } }, { "__typename": "ConfiguredDesignItem", "id": "urn:adsk.wipprod:dm.lineage:rjwmFUfBTmGzq12GgYO4ig", "name": "Configured-Design-New" } ] } } }
Show More