Request

Response

    Retrieve Folders

    This topic provides instructions on how to retrieve folders within a project.

    You will use the following operation in this topic:

    TypeOperationDescription
    Query foldersByProject Retrieves folders within a specified project.

    Step 1 - Access Folders within a Project

    The following steps demonstrate how you can run the foldersByProject query to retrieve all the folders within a project.

    1. Enter the following query in the Query Pane of the Manufacturing Data Model Explorer.

      Query

      query GetFolders($projectId: ID!) {
         foldersByProject(projectId: $projectId) {
            pagination {
               cursor
               pageSize
            }
            results {
               id
               name
               objectCount
            }
         }
      }
      
      Show More
    2. In the Query Variables Pane, enter the value of projectId. To know how to obtain the projectId , refer to Retrieve Projects.

      Query Variables

      {
         "projectId": "urn:adsk.workspace:prod.project:1e5ae8b2-81c3-458c-861c-7f5e64856efd"
      }
      
    3. Click Play. A list of folders available within a project is displayed in the response.

      Response

      {
         "data": {
            "foldersByProject": {
               "pagination": {
                  "cursor": null,
                  "pageSize": 17
               },
               "results": [
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.4Dv21n56QJGm8tCdAMC8Xw",
                     "name": "Test - Folder queries",
                     "objectCount": 5
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.6T7nYV5WRSSm5ZpahNK8sg",
                     "name": "Custom Properties",
                     "objectCount": 3
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.9X1Xm1apSXinjsM91dcNzw",
                     "name": "CreateAndDeleteFolderTest-DoNotDelete",
                     "objectCount": 0
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.B_8z-DcxTLK184fPk_pVjQ",
                     "name": "arnab-test",
                     "objectCount": 6
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.HgAwAZT5QKOruZGR9suagw",
                     "name": "fileExportTest-DoNotDelete",
                     "objectCount": 3
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.Riyf20CFT3WjEJWcOnVSpQ",
                     "name": "JohnTest",
                     "objectCount": 1
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.SC8l0gh1RKa_MkpcNCYExw",
                     "name": "Test folder",
                     "objectCount": 3
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.TvPtIUpSSZaVQRdqs5Na-w",
                     "name": "AshutoshTest",
                     "objectCount": 14
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.X2d9p8cgQ9i6C3J9shdVLg",
                     "name": "Test - allModelOccurrences",
                     "objectCount": 4
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co._PESvgpuSQCYLjcGaLbsQg",
                     "name": "Noemie",
                     "objectCount": 1
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.aaWQ_Bm4QuuKAAyel8oGDA",
                     "name": "Kamal Test",
                     "objectCount": 1
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.g7bs8IUwQzeq529zdQxBmw",
                     "name": "Chetan-test",
                     "objectCount": 2
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.iDyppZWpS1aDoUD0twuApQ",
                     "name": "Artem's",
                     "objectCount": 6
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.lqarz3otRB6flM3kcLyirg",
                     "name": "Test - BOM permission handling",
                     "objectCount": 3
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.mebZ2ZiCTu6HIST52za7GQ",
                     "name": "ShivaaniTest",
                     "objectCount": 1
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.neOeWDZ2THyEog4s2vqFQg",
                     "name": "Config-Functional-Tests",
                     "objectCount": 9
                  },
                  {
                     "id": "urn:adsk.wipprod:fs.folder:co.w4LPxLFZR4SA1C7-rCzaPQ",
                     "name": "SubodhTest",
                     "objectCount": 1
                  }
               ]
            }
         }
      }
      
      Show More