Request

Response

    Queries

    drawing

    query

    Retrieves a Drawing by its ID, optionally at a specific point in time.

    Template for Query:

    query GetDrawing($drawingId: ID!, $time: DateTime) {
      drawing(drawingId: $drawingId, time: $time) {
        # Drawing Fields
      }
    }
    

    Arguments

    drawingId*
    ID! non-null
    The ID of the drawing to retrieve.
    timeThe point in time at which to resolve the drawing.
    * Required

    Possible Returns

    Value TypeDescription
    Drawing Represents a drawing containing 2D projected views of a product design.


    Examples

    Example 1

    Retrieves a drawing along with its latest version and corresponding model.

    Query:

    query GetDrawing($drawingId: ID!) {
           drawing(drawingId: $drawingId) {
               id
               name
               itemNumber{
                   id
               }
               model{
                   id
                   name{
                       value
                   }
               }
    
           }
     }
    
    Show More

    Query Variables:

    {
     "drawingId": "ZHJhd345YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35xS1h5QlpqR1JmYUlzWTJjM3JqRFYzX2FnYQ"
    }
    

    Response:

    {
       "data": {
           "drawing": {
               "id": "ZHJhd345YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35xS1h5QlpqR1JmYUlzWTJjM3JqRFYzX2FnYQ",
               "name": "Controls Drawing",
               "itemNumber": {
                   "id": "DWG-000001"
               },
               "model": {
                   "id": "bW9kZWx-OWFiTWNGeEtnaFB5Y3d1TW9hR05pa19MMkN-ZHE0VHA4eE9rVjJOemtYbEY2RGdYbl9hZ2E",
                   "name": {
                       "value": "Controls"
                   }
               }
           }
       }
    }
    
    Show More

    Example 2

    Retrieves a drawing along with the lifecycle, revision, itemNumber, itemURN and itemURL.

    Query:

    query GetManageExtensionDetails($drawingId: ID!) {
           drawing(drawingId: $drawingId) {
               id
               name
               itemNumber{
                   id
                   schema{
                       name
                   }            }
               lifecycle{
                   itemUrl
                   itemUrn
               }
               revision{
                   createdBy{
                       email
                   }
                   createdOn
               }
           }
     }
    
    Show More

    Query Variables:

    {
     "drawingId": "ZHJhd345YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35xS1h5QlpqR1JmYUlzWTJjM3JqRFYzX2FnYQ"
    }
    

    Response:

    {
       "data": {
           "drawing": {
               "id": "ZHJhd345YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35xS1h5QlpqR1JmYUlzWTJjM3JqRFYzX2FnYQ",
               "name": "Controls Drawing",
               "itemNumber": {
                   "id": "DWG-000001",
                   "schema": {
                       "name": "Drawing (System)"
                   }
               },
               "lifecycle": {
                   "itemUrl": "https://YOPMAIL9163.autodeskplm.com/plm/extAccess?itemUrn=urn%3Aadsk.plm%3Atenant.workspace.item%3AYOPMAIL9163.76.15148&tab=details",
                   "itemUrn": "urn:adsk.plm:tenant.workspace.item:YOPMAIL9163.76.15148"
               },
               "revision": {
                   "createdBy": {
                       "email": "demo.docs@yopmail.com"
                   },
                   "createdOn": "2026-01-19T11:36:24.209Z"
               }
           }
       }
    }
    
    Show More

    Example 3

    Retrieves Properties associated with the drawing.

    Query:

    query GetDrawingProperties($drawingId: ID!) {
           drawing(drawingId: $drawingId) {
               id
               name
               customProperties {
                   results {
                       value
                       displayValue
                       definition {
                           id
                           name
                           specification
                           isHidden
                           isReadOnly
                           isArchived
                           description
                           propertyBehavior
                           units {
                               id
                               name
                           }
                       }
                   }
               }
           }
     }
    
    Show More

    Query Variables:

    {
     "drawingId": "ZHJhd345YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35xS1h5QlpqR1JmYUlzWTJjM3JqRFYzX2FnYQ"
    }
    

    Response:

    {
       "data": {
           "drawing": {
               "id": "ZHJhd345YWJNY0Z4S2doUHljd3VNb2FHTmlrX0wyQ35xS1h5QlpqR1JmYUlzWTJjM3JqRFYzX2FnYQ",
               "name": "Controls Drawing",
               "customProperties": {
                   "results": []
               }
           }
       }
    }
    
    Show More