Request

Response

    Queries

    project

    query

    Get a project by its id

    See the asset query for a full description of possible errors.

    Template for Query:

    query GetProject($id: ID!) {
      project(id: $id) {
        # Project Fields
      }
    }
    

    Template for Query Variables:

    {
      "id" : "<SOME-ID-TYPE-SCALAR-VALUE>"
    }
    


    Arguments

    id*
    ID! non-null
    * Required

    Possible Returns

    Value TypeDescription
    GetProjectPayload Response from the _project_ query


    Examples

    Example 1

    Retrieves a project by ID along with the hub it belongs to and the items in that project by folder.

    Query:

    query GetProject($projectId: ID!) {
           project(projectId: $projectId) {
               id
               name
               hub {
                   id
                   name
               }
               folders {
                   results {
                       id
                       name
                       objectCount
                       items {
                           results {
                               id
                               name
                               __typename
                           }
                       }
                   }
               }
           }
     }
    
    Show More

    Query Variables:

    {
     "projectId": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4IzIwMjQwMTI1Njk4NjE1NTE"
    }
    

    Response:

    {
       "data": {
           "project": {
               "id": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4IzIwMjQwMTI1Njk4NjE1NTE",
               "name": "DOCS_STG",
               "hub": {
                   "id": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4",
                   "name": "stg-hds-test-hub"
               },
               "folders": {
                   "results": [
                       {
                           "id": "urn:adsk.wipstg:fs.folder:co.75-EpQPXQ_ynLYL0bOxSIg",
                           "name": "extensibility",
                           "objectCount": 5,
                           "items": {
                               "results": [
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:amvR65KFRouqbo47ye6bhw",
                                       "name": "Hydraulic_Bottle_Jack",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:dw4qLiUzT6So5K6B2OPhcQ",
                                       "name": "Gas Pedal",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:jYI275ltT0eiyF99nrQcyw",
                                       "name": "Connector Joint Drawing",
                                       "__typename": "DrawingItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:v99UgOsFT-OpfjHjs1ZtiA",
                                       "name": "Connecting Rod Assembly",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:zO8C8RUiTOOTITKo2pzG1Q",
                                       "name": "Connector Joint",
                                       "__typename": "DesignItem"
                                   }
                               ]
                           }
                       },
                       {
                           "id": "urn:adsk.wipstg:fs.folder:co.JqPba6NRT5-of8Eu7tpuXQ",
                           "name": "queries",
                           "objectCount": 7,
                           "items": {
                               "results": [
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:2T9wT3rFSZW0SJkfo139PQ",
                                       "name": "3D_Arm_Scan",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:S4bzROmAQfeAe4YQCPK_jw",
                                       "name": "Piston Linkage",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:hauI21OwSb2dO5Aq-CL-Ag",
                                       "name": "Bearing_Bracket",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:iqfetvZhS-SbytPyge6s-w",
                                       "name": "ALCOA Bracket",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:xg_7JjcHRvqHQuSuCBiykQ",
                                       "name": "3D_Arm_Scan Drawing",
                                       "__typename": "DrawingItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:zwJH00uUTcKHVXTox_uzBA",
                                       "name": "Drawings Utility Knife",
                                       "__typename": "DesignItem"
                                   }
                               ]
                           }
                       }
                   ]
               }
           }
       }
    }
    
    Show More

    Example 2

    Retrieves a project by ID along with its users.

    Query:

    query GetProject($projectId: ID!) {
           project(projectId: $projectId) {
               name
               id
               __typename
                   users {
                       results{
                           id
                           createdOn
                           lastModifiedOn
                       }
                   }
                   }
     }
    
    Show More

    Query Variables:

    {
     "projectId": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4IzIwMjQwMTI1Njk4NjE1NTE"
    }
    

    Response:

    {
       "data": {
           "project": {
               "id": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4IzIwMjQwMTI1Njk4NjE1NTE",
               "name": "DOCS_STG",
               "hub": {
                   "id": "a.YnVzaW5lc3M6YXV0b2Rlc2syMzk4",
                   "name": "stg-hds-test-hub"
               },
               "folders": {
                   "results": [
                       {
                           "id": "urn:adsk.wipstg:fs.folder:co.75-EpQPXQ_ynLYL0bOxSIg",
                           "name": "extensibility",
                           "objectCount": 5,
                           "items": {
                               "results": [
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:dw4qLiUzT6So5K6B2OPhcQ",
                                       "name": "Gas Pedal",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:amvR65KFRouqbo47ye6bhw",
                                       "name": "Hydraulic_Bottle_Jack",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:v99UgOsFT-OpfjHjs1ZtiA",
                                       "name": "Connecting Rod Assembly",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:zO8C8RUiTOOTITKo2pzG1Q",
                                       "name": "Connector Joint",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:jYI275ltT0eiyF99nrQcyw",
                                       "name": "Connector Joint Drawing",
                                       "__typename": "DrawingItem"
                                   }
                               ]
                           }
                       },
                       {
                           "id": "urn:adsk.wipstg:fs.folder:co.JqPba6NRT5-of8Eu7tpuXQ",
                           "name": "queries",
                           "objectCount": 6,
                           "items": {
                               "results": [
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:xg_7JjcHRvqHQuSuCBiykQ",
                                       "name": "3D_Arm_Scan Drawing",
                                       "__typename": "DrawingItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:hauI21OwSb2dO5Aq-CL-Ag",
                                       "name": "Bearing_Bracket",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:S4bzROmAQfeAe4YQCPK_jw",
                                       "name": "Piston Linkage",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:2T9wT3rFSZW0SJkfo139PQ",
                                       "name": "3D_Arm_Scan",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:iqfetvZhS-SbytPyge6s-w",
                                       "name": "ALCOA Bracket",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:zwJH00uUTcKHVXTox_uzBA",
                                       "name": "Drawings Utility Knife",
                                       "__typename": "DesignItem"
                                   }
                               ]
                           }
                       }
                   ]
               }
           }
       }
    }
    
    Show More