Request

Response

    Queries

    projectByDataManagementAPIId

    query

    Retrieves an object representing a project by its external id.

    A project is a shared workspace for teams of people to store, organize, and manage all related design data.

    Template for Query:

    query GetProjectByDataManagementAPIId($dataManagementAPIProjectId: ID!) {
      projectByDataManagementAPIId(dataManagementAPIProjectId: $dataManagementAPIProjectId) {
        # Project Fields
      }
    }
    

    Arguments

    dataManagementAPIProjectId*
    ID! non-null
    The external ID of the project to retrieve.
    * Required

    Possible Returns

    Value TypeDescription
    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 entity data.


    Examples

    Example 1

    Retrieves a project by legacy dataManagement API Project ID

    Query:

    query GetProject($dataManagementAPIProjectId: ID!) {
     projectByDataManagementAPIId(
       dataManagementAPIProjectId: $dataManagementAPIProjectId
     ) {
       id
       name
       alternativeIdentifiers {
         dataManagementAPIProjectId
       }
     }
     }
    
    Show More

    Query Variables:

    {
     "dataManagementAPIProjectId": "a.YnVzaW5lc3M6eW9wbWFpbDkxNjMjMjAyNjAxMTYxMzMwOTc1MDE"
    }
    

    Response:

    {
       "data": {
           "projectByDataManagementAPIId": {
               "id": "urn:adsk.workspace:beta.project:99497e80-4c1f-4ca7-8132-4bf1735e4d68",
               "name": "Espresso Machine",
               "alternativeIdentifiers": {
                   "dataManagementAPIProjectId": "a.YnVzaW5lc3M6eW9wbWFpbDkxNjMjMjAyNjAxMTYxMzMwOTc1MDE"
               }
           }
       }
    }
    
    Show More