Skip to content

Entry

Entry is the foundational base class for most response objects in the API. It provides common metadata such as identifiers, document references, timestamps, and geometric contexts that keep extracted items traceable back to their origin in the drawing. By inheriting from Entry, specialized models can focus on their domain-specific fields while still exposing consistent attributes for auditing, filtering, and display. Use this class when you need to treat diverse objects—dimensions, notes, manufacturing steps—as a unified stream of information. Its normalized structure supports list rendering, change tracking, and search operations across the dataset generated from a technical document, while also providing hooks for enrichment pipelines to attach analytics results in a predictable fashion.

Bases: Reference

Represents an entry in a list or table.

PARAMETER DESCRIPTION
reference_id

Reference ID to identify the object.

TYPE: int

language

The language of the identifier, if known.

TYPE: Language | None DEFAULT: None

value

The value of the identifier. Must be a non-empty string.

TYPE: str

Source code in werk24/models/v2/models.py
class Entry(Reference):
    """
    Represents an entry in a list or table.
    """

    language: Optional[Language] = Field(
        None,
        description="The language of the identifier, if known.",
        examples=[Language.ENG, Language.DEU],
    )

    value: str = Field(
        ...,
        description="The value of the identifier. Must be a non-empty string.",
        examples=["12345-ABC"],
    )