Skip to content

Reference

Reference is a lightweight linking object that points to another extracted element on the drawing. It carries a single reference_id, the identifier of the target element, so related objects can be connected without duplicating their content. For example, a Bore uses a Reference to link to the thread cut into it. By resolving these identifiers against the other extracted objects you can navigate between related features, join data across the payload, and keep downstream systems consistent with a single source of truth for each element.

Bases: BaseModel

Base model that allows refering to a specific object by its reference_id.

PARAMETER DESCRIPTION
reference_id

Reference ID to identify the object.

TYPE: int

Source code in werk24/models/v2/models.py
class Reference(BaseModel):
    """
    Base model that allows refering to a specific object by its reference_id.
    """

    reference_id: int = Field(
        ...,
        description="Reference ID to identify the object.",
        examples=[12345],
    )