Migrating from V2 to V3

Change 1: Time-Based Data Model

What’s New:

Version 3 introduces a time-based data model. Instead of accessing objects by version (for example, componentVersion or drawingVersion), you now retrieve objects as they existed at a specific point in time using a time parameter.

Migration Steps:

• Remove usage of componentVersion and drawingVersion.
• Use the time argument on component or drawing queries to retrieve the object’s state at a specific timestamp.

Before:

query GetComponentVersion($componentVersionId: ID!) {
  componentVersion(componentVersionId: $componentVersionId) {
    name
  }
}

After:

query GetComponentAtTime($componentId: ID!, $time: DateTime!) {
  component(componentId: $componentId, time: $time) {
    name
  }
}

Change 2: Removal of ComponentVersion and DrawingVersion Types

The ComponentVersion object has been removed from v3. Its fields have been moved to the Component and Model objects.

ComponentVersion fields now available in Component:

ComponentVersion fields now available in Model:

The DrawingVersion type has also been removed from v3. Its fields have been moved to the Drawing object.

Migration Steps:

• Remove any fields referencing ComponentVersion or DrawingVersion.
• Refactor queries to use component, model, or drawing.

Before:

query GetComponentVersion($componentVersionId: ID!) {
   componentVersion(componentVersionId: $componentVersionId) {
     materialName
   }
 }

After:

query GetModel($modelId: ID!) {
   model(modelId: $modelId) {
     materialName {
         value
     }
   }
 }

Change 3: Custom Property Type Updates

What’s New: The dynamic and dynamicAtVersion property types have been removed. All dynamic properties have been migrated to a unified property model.

Migration Steps:

• Remove references to dynamic and dynamicAtVersion property types.
• Update your queries and data handling to use the new property model.

Change 4: name Attribute is Now a Property Object

What’s New: The name attribute in several objects is no longer a string. It is now a Property object.

Migration Steps:

• Replace direct access to name with name.value.

Before:

model {
  name
}

After:

model {
  name {
    value
  }
}