W24Asks

W24AskCanvasThumbnail¶

Requests a thumbnail of each canvas in each sheet. The canvas describes the "drawing area" of the sheet.

Attributes:

remove_canvas_notes__dangerous (bool): Remove the canvas
    notes from the canvas thumbnail.

    !!! DANGEROUS: chances are that you are removing
    !!! important information. Run a risk analysis
    !!! before using this attribute

Properties¶

• is_training (boolean): Default: False.

• file_format: Default: JPEG.

• remove_canvas_notes__dangerous (boolean): Default: False.

Definitions¶

• W24FileFormatThumbnail (string): List of supported File Formats in which the Thumbnail can be supplied.
  !!! note At this stage, the API only supports JPEG. This prepares the support for additional format (e.g. TIFF). Must be one of: ['JPEG'].

W24AskInternalScreening¶

Internal Ask to trigger the file screening.

NOTE: not available on the public API.

Properties¶

• is_training (boolean): Default: False.

Definitions¶

W24AskNotes¶

Ask all the notes on the Canvas and the sectionals

Properties¶

• is_training (boolean): Default: False.

Definitions¶

W24AskNotesResponse¶

Response to the W24AskNotes

Attributes:

notes(List[W24Ask]): List of the notes that were
    identified.

Properties¶

• notes (array)

• Items: Refer to #/definitions/W24Note.

Definitions¶

• W24BaseFeatureCoordinate (object): Coordinate point
  Attributes: x: x position normalized by the thumbnail's width
  y: y position normalized by the thumbnail's height.

• x (number)

• y (number)

• W24BaseFeaturePosition (object): Position of the Feature on the individual thumbnails normalized by the width and height of each thumbnail.
  Each features position is indicated as a list of coordinates. If the list only has two elements, you are dealing with a line. If it has four or more, you are looking at a polygon
  Attributes: page: Position of the Feature on the Page thumbnail
  sheet: Position of the Feature on the Sheet thumbnail
  sectional: Position of the Feature on the Sectional thumbnail.

• sheet (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• canvas (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• sectional (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• W24NoteType (string): Differentiation between Canvas and Sectional Notes.
  Canvas Notes are sometimes referred to as "General Notes", they are associated with the canvas in general.
  Sectional Notes are associated with a specific sectional, but not as part of a leader or call-out. (e.g., "VIEW A")
  Sectional Call Outs are linked to the sectional through a leader symbol (e.g., "MARK HERE")
  NOTE: please note that we are only returning the information that is not understood by the system through another way. Over time, number of sectional call outs will thus gradually reduce. Must be one of: ['CANVAS NOTE', 'SECTIONAL NOTE', 'SECTIONAL_CALLOUT'].

• W24Note (object): Notes object for Sectional and Canvas Notes.
  Attributes: type (W24NoteType): Type of the note to differentiate between notes that are associated with the complete sectional and the canvas
  text (str): Raw text that was read.

• position: Refer to #/definitions/W24BaseFeaturePosition.

• type: Refer to #/definitions/W24NoteType.

• text (string)

W24AskPageThumbnail¶

Requests a thumbnail for each page in the document; rotated, and with the surrounding white-space removed.

Properties¶

• is_training (boolean): Default: False.

• file_format: Default: JPEG.

Definitions¶

• W24FileFormatThumbnail (string): List of supported File Formats in which the Thumbnail can be supplied.
  !!! note At this stage, the API only supports JPEG. This prepares the support for additional format (e.g. TIFF). Must be one of: ['JPEG'].

W24AskPartFamilyCharacterization¶

Triggers a post-processor that turns the raw data into a dictionary of attributes characteristic for the part family.

E.g. a Screw could have the following attributes: * Drive Type * Head diameter * Head length * Thread * Thread length

The definition of a part family can be done in a Part Family Template and is implemented by Werk24 on the backend - where it has access to more granular data.

Attributes:

part_family_id (UUID4): Unique part family identifier
    that we will provide to you after the part family
    post processor is implemented.

Properties¶

• is_training (boolean): Default: False.

• part_family_id (string)

Definitions¶

W24AskPartFamilyCharacterizationResponse¶

Response object corresponding to a PartFamilyCharacterization request.

Attributes:

page_id (UUID4): Id of the page that specified the part_family

sheet_id (UUID4):Id of the sheet

Properties¶

• page_id (string)

• sheet_id (string)

• part_family_characterizations (array)

• Items: Refer to #/definitions/W24PartFamilyCharacterization.

Definitions¶

• W24PartFamilyCharacterization (object): Instance of a part family described by the File.
  Part families can be defined by the Werk24 partner. This allows us the flexibility to consider the exact situation of the customer.
  Take two companies that both deal with screws, but use different characteristic values to describe the part family. With this flexibility, we can simply specify a postprocessor for each customer and are able to consider their very special situation.
  Attributes: part_family_id (UUID4): Unique Identifier of the part family. You need this ID to trigger the correct postprocessor. Note that this is account-specific, so a post-processors need to be activated for your account, but are available to all of your tenants. If you want to show them selectively to your users, you are responsible for checking that the postprocessor can only be used by authorized tenants / users.
  part_family_name (str): A more human way of referring to the part family. This identifier is chosen by Werk24 according to an internal naming convention.
  variant_id (UUID4): Unique identifier of the variant. Note that a single drawing can specify multiple part family instances.
  characteristic_values (Dict[str, Any]): Characteristic values that define the part family. When exported to CSV, the keys correspond the column names, and the values to the cell values.

• part_family_id (string)

• part_family_name (string)

• variant_id (string)

• characteristic_values (object)

W24AskProductPMIExtract¶

Ask object to request the PMIExtract Product.

Properties¶

• is_training (boolean): Default: False.

Definitions¶

W24AskProductPMIExtractResponse¶

Response object corresponding to the W24AskProduct PMIExtract

Attributes:

variant_id (UUID4): Unique ID of the variant detected on the
    Technical Drawing. Refer to the documentation on Variants
    for details.

material (Optional[W24Material]): Material that was detected on
    the technical drawing. If no material was detected,
    this is set to None.

general_tolerances (Optional[W24GeneralTolerances]): General tolerances
    detected on the drawing. This will automatically translate the
    general tolerances detected on the canvas notes to an ISO-2768
    class. None if no general tolerances are detected.

measures (List[W24Measure]): List of the available measures on
    the drawing. Note: in the PMIExtract, the position will not be
    returned.

gdts (List[W24GDT]): List of the detected GD&Ts. Note: in the
    PMIExtract, the position will not be returned.

radii (List[W24Radius]): List of the detected Radii. Note: in the
    PMIExtract, the position will not be returned.

roughnesses (List[W24Roughness]): List of the detected
    roughnesses. Note: in the PMIExtract, the position will not
    be returned.

Properties¶

• variant_id (string)

• material: Refer to #/definitions/W24Material.

• general_tolerances: Refer to #/definitions/W24GeneralTolerances.

• measures (array)

• Items: Refer to #/definitions/W24Measure.

• gdts (array)

• Items: Refer to #/definitions/W24GDT.

• radii (array)

• Items: Refer to #/definitions/W24Radius.

• roughnesses (array)

• Items: Refer to #/definitions/W24Roughness.

Definitions¶

• W24BaseFeatureCoordinate (object): Coordinate point
  Attributes: x: x position normalized by the thumbnail's width
  y: y position normalized by the thumbnail's height.

• x (number)

• y (number)

• W24BaseFeaturePosition (object): Position of the Feature on the individual thumbnails normalized by the width and height of each thumbnail.
  Each features position is indicated as a list of coordinates. If the list only has two elements, you are dealing with a line. If it has four or more, you are looking at a polygon
  Attributes: page: Position of the Feature on the Page thumbnail
  sheet: Position of the Feature on the Sheet thumbnail
  sectional: Position of the Feature on the Sectional thumbnail.

• sheet (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• canvas (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• sectional (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• W24MaterialCategory1 (string): An enumeration. Must be one of: ['FERROUS_ALLOY', 'NONFERROUS_ALLOY', 'POLYMER', 'CERAMIC', 'COMPOSITE', 'ORGANIC'].

• W24MaterialCategory2 (string): An enumeration. Must be one of: ['STEEL', 'IRON', 'MAGNETIC_OR_ELECTRICAL_MATERIAL', 'SINTERED_POWDEDERD_METAL', 'WELDING_FILLER_MATERIAL', 'ALUMINUM', 'ANTIMONY', 'BERYLLIUM', 'BISMUTH', 'CADMIUM', 'CHROMIUM', 'COBALT', 'COPPER', 'GALLIUM', 'LEAD', 'MAGNESIUM', 'MANGANESE', 'MERCURY', 'MOLYBDENUM', 'NICKEL', 'NIOBIUM', 'PLATINUM', 'REAR_EARTHS', 'SELENIUM', 'SILICON', 'THALLIUM', 'TIN', 'TITANIUM', 'TUNGSTEN', 'VANADIUM', 'ZINC', 'ZIRCONIUM', 'THERMOPLAST', 'THERMOSET', 'THERMOPLASTIC_ELASTOMER', 'THERMOSET_ELASTOMER', 'POLYMER_FOAM', 'REFRACTORY', 'TECHNICAL_CERAMIC', 'CERAMIC_FOAM', 'MATRIX', 'REINFORCEMENT', 'WOOD'].

• W24MaterialCategory3 (string): An enumeration. Must be one of: ['STRUCTURAL_OR_CONSTRUCTIONAL_STEEL', 'STAINLESS_STEEL', 'TOOL_STEEL', 'CAST_STEEL', 'CAST_IRON', 'FERROALLOY', 'ABS', 'ABS_PC', 'ABS_PLUS_PA', 'ABS_PLUS_PA6', 'ABS_PLUS_PA66', 'ABS_PLUS_PBT', 'ABS_PLUS_PC', 'ABS_PLUS_PET', 'ABS_PLUS_PMMA', 'ABS_PLUS_PVC', 'ABS_PLUS_PVC_C', 'ABS_PLUS_SAN', 'ABS_PLUS_TPE', 'ABS_PLUS_TPES', 'ABS_PLUS_TPU', 'ABS_PP', 'ACPES', 'AES', 'AES_PLUS_PC', 'ASA', 'ASA_PC', 'ASA_PLUS_ABS', 'ASA_PLUS_AES', 'ASA_PLUS_MSAN', 'ASA_PLUS_PA', 'ASA_PLUS_PC', 'ASA_PLUS_PMMA', 'ASA_PLUS_SAN', 'ASA_PLUS_TPE', 'BMI', 'BVOH', 'CAB', 'CAP', 'CE', 'COC', 'CP', 'CPE', 'CPT', 'E_P', 'EA', 'EAA', 'EBA', 'EBACO', 'EC', 'ECTFE', 'EEA', 'EFEP', 'EMAA', 'EMAAA', 'ENBAGMA', 'ETFE', 'EVA', 'EVACO', 'EVOH', 'FEP', 'HDPE', 'HIPP', 'HIPS', 'IONOMER_RESIN', 'LCP', 'LCP_PLUS_PPS', 'LDPE', 'LDPE_EVA', 'LDPE_LLDPE', 'LLDPE', 'LMDPE', 'MABS', 'MBS', 'MDPE', 'MFA', 'PA', 'PA_MACM10_1010', 'PA_MACM12', 'PA_MACM12_PLUS_PA_12', 'PA_MXD6', 'PA_MXD6_MXDI', 'PA_PACM12', 'PA_PLUS_HDPE', 'PA_PLUS_PA66_6', 'PA_PLUS_PE', 'PA_PLUS_PP', 'PA_PLUS_PPA', 'PA_PLUS_SPS', 'PA_PLUS_TPE', 'PA_TPE', 'PA1010', 'PA1012', 'PA10T_X', 'PA11', 'PA12', 'PA12_MACMI', 'PA12_MACMI_PLUS_PA12', 'PA410', 'PA46', 'PA46_PLUS_PA6', 'PA4T', 'PA510', 'PA6', 'PA6_12', 'PA6_3T', 'PA6_66_12', 'PA6_66_136', 'PA6_66_610', 'PA6_69', 'PA6_6I', 'PA6_6T', 'PA6_IPDI', 'PA6_PA12', 'PA6_PLUS_ASA', 'PA_6_PLUS_PA_6I_6T', 'PA6_PLUS_PA12', 'PA6_PLUS_PA12_X', 'PA6_PLUS_PA66', 'PA6_PLUS_PA66_6', 'PA6_PLUS_PE', 'PA6_PLUS_PP', 'PA610', 'PA612', 'PA66', 'PA66_6', 'PA66_610', 'PA66_PLUS_PA610', 'PA66_PLUS_PA612', 'PA66_PLUS_PA6I', 'PA66_PLUS_PA6I_6T', 'PA66_PLUS_PA6I_X', 'PA66_PLUS_PE', 'PA66_PLUS_PP', 'PA66_PLUS_PPA', 'PA69', 'PA6I', 'PA6I_6T', 'PA6I_X', 'PA6T', 'PA6T_66', 'PA6T_XT_PLUS_PA6T_66', 'PA6T_6I', 'PA6T_6I_66', 'PA6T_MPMDT', 'PA6T_XT', 'PA9T', 'PAEK', 'PAI', 'PAMXD6_PA66', 'PAO', 'PAR', 'PARA', 'PB', 'PBAT', 'PBAT_PLUS_PLA', 'PBI', 'PBS', 'PBT', 'PBT_ASA', 'PBT_PC', 'PBT_PLUS_ASA', 'PBT_PLUS_PE', 'PBT_PLUS_PET', 'PBT_PLUS_PET_PLUS_ASA', 'PBT_PLUS_PETG', 'PBT_PLUS_PPE', 'PBT_PLUS_PS', 'PBT_PLUS_SAN', 'PC', 'PC_PET', 'PC_PLUS_HIPS', 'PC_PLUS_MBS', 'PC_PLUS_PBT', 'PC_PLUS_PCT', 'PC_PLUS_PET', 'PC_PLUS_PET_PLUS_PBT', 'PC_PLUS_PLA', 'PC_PLUS_PMMA', 'PC_PLUS_PPC', 'PC_PLUS_PS', 'PC_PLUS_PTFE', 'PC_PLUS_SAN', 'PC_PLUS_TPES', 'PC_PLUS_TPU', 'PC_PPC', 'PCL', 'PCT', 'PCTA', 'PCTFE', 'PCTG', 'PCTG_PLUS_PC', 'PE', 'PE_HMW', 'PE_HMWHD', 'PE_PLUS_HIPS', 'PE_UHMW', 'PEEK', 'PEI', 'PEI_PLUS_PCE', 'PEK', 'PEKEKK', 'PEKK', 'PEN', 'PESU', 'PET', 'PET_G', 'PET_PLUS_PA6', 'PET_PLUS_PA66', 'PEX_B', 'PFA', 'PFSA_PTFE', 'PGA', 'PHA', 'PHB', 'PHBV', 'PI', 'PIB', 'PK', 'PLA', 'PLA_PCL', 'PLA_PEG', 'PLA_PHA', 'PLA_PLUS_ABS', 'PLA_PLUS_HDPE', 'PLA_PLUS_PHB', 'PLA_PLUS_PMMA', 'PLGA', 'PMMA', 'PMMI', 'PMP', 'PMS', 'POM', 'POM_PLUS_MBS', 'POM_PLUS_PE', 'POM_PLUS_PTFE', 'POM_PLUS_PUR', 'PP', 'PP_PE', 'PP_PLUS_EPDM', 'PP_PLUS_EPR', 'PP_PLUS_EVA', 'PP_PLUS_PE', 'PP_PLUS_PPE_PLUS_PS', 'PPA', 'PPC', 'PPE', 'PPE_PLUS_HIPS', 'PPE_PLUS_PA', 'PPE_PLUS_PA6', 'PPE_PLUS_PA66', 'PPE_PLUS_PP', 'PPE_PLUS_PS', 'PPE_PLUS_PS_PLUS_PA', 'PPE_PLUS_TPE', 'PPE_PLUS_TPS_SEBS', 'PPOX', 'PPS', 'PPS_PLUS_PA', 'PPS_PLUS_PPE', 'PPS_PLUS_PTFE', 'PPSU', 'PPSU_PLUS_PSU', 'PS', 'PS_I', 'PS_PLUS_PE', 'PS_PLUS_PMMA', 'PS_PLUS_SPS', 'PSU', 'PSU_PLUS_ABS', 'PSU_PLUS_PC', 'PTFE', 'PTT', 'PVAL', 'PVB', 'PVC', 'PVC_C', 'PVC_C_PLUS_PVC', 'PVC_PLUS_NBR', 'PVC_PLUS_PMMA', 'PVC_PLUS_PUR', 'PVC_U', 'PVCA', 'PVDC', 'PVDF', 'PVP', 'RPS', 'SAN', 'SB', 'SMA', 'SMA_PLUS_HIPS', 'SMI', 'SMMA', 'SPS', 'SRP', 'TPC_EE_PLUS_PBT', 'TPC_ET_PLUS_EMA', 'TPC_ET_PLUS_PBT', 'TPES', 'TPU_PLUS_TPS_PLUS_TPA', 'VDF_CTFE', 'VDF_HFP', 'VINYL_CHLORIDE_BLEND', 'VLDPE', 'XLPE', 'XLPO', 'CA', 'EP', 'MA', 'MF', 'MP', 'PDAIP', 'PDAP', 'PUR', 'UF', 'UP', 'VE', 'MPR', 'PCU', 'PEBA', 'SPU', 'TPA', 'TPC', 'TPC_EE', 'TPC_ES', 'TPC_ET', 'TPE', 'TPO', 'TPO_EB', 'TPO_EO', 'TPO_EPDM_PLUS_PP', 'TPS', 'TPS_SBS', 'TPS_SEBS', 'TPS_SIS', 'TPU', 'TPU_ALES', 'TPU_ALET', 'TPU_ARES', 'TPU_ARET', 'TPU_ES', 'TPU_ET', 'TPV', 'TPV_EPDM', 'TPV_EPDM_PLUS_PP', 'TPV_IIR_HIIR', 'TPV_NBR', 'TSPCU', 'TSPU', 'ACM', 'ACSM', 'AEM', 'AU', 'BIIR', 'BR', 'CIIR', 'CM', 'CR', 'CR_NBR', 'CR_SBR', 'CSM', 'ECO', 'EPDM', 'EPDM_SBR', 'EPM', 'EPM_EPDM', 'EPT', 'EU', 'FFKM', 'FKM', 'FMQ', 'FVMQ', 'HNBR', 'IIR', 'IR', 'IR_BR', 'NBR', 'NBR_PVC', 'NBR_SBR', 'NR', 'PDMS', 'PUMA', 'PVMQ', 'RET', 'SBR', 'SBR_ACM', 'SBR_BR', 'SBR_IR', 'SBR_NR', 'SI', 'VMQ', 'VMQ_PVMQ', 'XNBR', 'XNBR_PVC', 'CARBON_FIBER_COMPOSITE', 'GLASS_FIBER_COMPOSITE', 'FIBER_REINFORCEMENT', 'STRUCTURAL_COMPOSITE', 'POLYPHENYLENE_OR_POLYSTYRENE', 'POLYPHENYLENE_OR_POLYSTYRENE_HIPS', 'POLYCARBONATE'].

• W24Material (object): W24 Object for Materials.
  Parsed Material object that can either be associated to the TitleBlock or derived from all the available information (including the text on the canvas.
  Attributes: blurb: Material Name for human consumption. This will typically include the designation and the standard.
  standard: Material Standard indicated on the technical drawing. This used to be an enum - but we now have over 100 supported material standards and the number is increasing weekly. So a string seems to be more appropriate.
  designation: Name of the material in accordance with the material standard. An alternative name would be material_designation.
  material_category: Categorization of the material following W24MaterialCategoryX Tree.

• position: Refer to #/definitions/W24BaseFeaturePosition.

• blurb (string)

• standard (string)

• designation (string)

• material_category (array)

  • Items_0: Refer to #/definitions/W24MaterialCategory1.

  • Items_1: Refer to #/definitions/W24MaterialCategory2.

  • Items_2: Refer to #/definitions/W24MaterialCategory3.

• material_family

• material_class

• material_type

• material_group

• material_standard

• material_code (string)

• W24GeneralTolerancesStandard (string): Enum of all supported General Tolerance Standards. Must be one of: ['DIN 7168', 'ISO 2768', 'ISO 4759-1', 'DEFINED_ON_SHEET'].

• W24GeneralTolerancesPrinciple (string): Enum of the supported General Tolerance Principles. Must be one of: ['INDEPENDENCE', 'ENVELOPE'].

• W24ToleranceProperty (string): Enum of all attributes that can be described by general tolerances. Must be one of: ['ANGULAR', 'FLATNESS', 'LINEAR', 'PERPENDICULARITY', 'RADIUS', 'RUNOUT', 'STRAIGHTNESS', 'SYMMETRY'].

• W24ToleranceTableItem (object)

• nominal_min (number)

• nominal_max (number)

• deviation_min (number)

• deviation_max (number)

• W24ToleranceClass (object): Tolerance Class which matches an individual attribute of the General Tolerances to a tolerance property and tolerance table
  Attributes: blurb: Tolerance class label for human consumption
  property: Property that is being tolerated
  table: Rows of the tolerance table that correspond to the selected tolerance class.

• blurb (string)

• property: Refer to #/definitions/W24ToleranceProperty.

• table (array)

  • Items: Refer to #/definitions/W24ToleranceTableItem.

• W24GeneralTolerances (object): Object representing the General Tolerances indicated on the Title Block of the Technical Drawing.

• position: Refer to #/definitions/W24BaseFeaturePosition.

• blurb (string)

• tolerance_standard: Refer to #/definitions/W24GeneralTolerancesStandard.

• principle: Refer to #/definitions/W24GeneralTolerancesPrinciple.

• angular_class: Refer to #/definitions/W24ToleranceClass.

• flatness_class: Refer to #/definitions/W24ToleranceClass.

• straightness_class: Refer to #/definitions/W24ToleranceClass.

• linear_class: Refer to #/definitions/W24ToleranceClass.

• radius_class: Refer to #/definitions/W24ToleranceClass.

• runout_class: Refer to #/definitions/W24ToleranceClass.

• symmetry_class: Refer to #/definitions/W24ToleranceClass.

• perpendicularity_class: Refer to #/definitions/W24ToleranceClass.

- W24SizeType (string): Enumeration class for W24 size types.
Attributes:¶

NOMINAL (str): Nominal size type. DIAMETER (str): Diameter size type. WIDTH_ACROSS_FLATS (str): Width across flats size type. Must be one of: ['NOMINAL', 'DIAMETER', 'SPHERICAL_DIAMETER', 'WIDTHS_ACROSS_FLATS', 'SQUARE'].

• W24UnitLength (string): Enum of the supported length units . Must be one of: ['METER', 'DECIMETER', 'CENTIMETER', 'MILLIMETER', 'FOOT', 'INCH', 'MICRO_INCH'].

- W24Size (object): Abstract Base Class for the Sizes.
Attributes:¶

blurb: A blurb for human consumption.
size_type: The type of size for deserialization.
nominal_size: The unit-less nominal size. The unit is attached to the parent object, which also defines the toleration.
unit: Unit of the measure if known. This should typically be inch or millimeter. In some cases it might be possible that the units are unknown.

• blurb (string)

• size_type: Refer to #/definitions/W24SizeType.

• nominal_size (number)

• unit: Refer to #/definitions/W24UnitLength.

• W24Tolerance (object): Abstract Base Class to cover the Tolerances.
  Attributes: blurb (str): String representation for human consumption
  toleration_type (W24SizeToleranceType): Toleration Type for deserialization.

• blurb (string)

• toleration_type (string)

• W24ThreadType (string): Enum for the individual thread types
  NOTE: UTS_COARSE, UTS_FINE, UTS_EXTRAFINE and UTS_SPECIAL as individual types will be deprecated. Their information individual threads_per_inch information will be stored in the corresponding variable. Must be one of: ['ISO_METRIC', 'WHITWORTH', 'UTS', 'UTS_COARSE', 'UTS_FINE', 'UTS_EXTRAFINE', 'UTS_SPECIAL'].

• W24ThreadHandedness (string): Enum describing the direction of the thread. Must be one of: ['LEFT', 'RIGHT'].

• W24ThreadMultiStart (object): Multi-Start Thread Information
  A common example of multi-start threads are the cap on a plastic water bottle. The cap will screw on quickly because a multi-start thread.
  Attributes:
  thread_lead (Decimal, optional): Thread lead for multiple starts
  number_of_starts (int): Number of intertwined threads running in parallel to one another.

• thread_lead (number)

• number_of_starts (integer): Default: 1.

• W24Thread (object): Abstract Base Class for all Threads
  Attributes: blurb (str): String representation of the thread for human consumption
  diameter (Decimal): Diameter of the thread
  diameter_preference: Not all Threads are made equal. The standardization bodies assign different preferences to the different thread diameters.
  unit (W24UnitLength): Length unit of the diameter. This allows you to differentiate between inch and millimeter (UTS or ISO METRIC). NOTE: Whitworth inch are not 2.54mm long! (for historic reasons). Use the whitworth_size if you need to have the Whitworth inches.
  thread_type: thread type to facilitate deserialization
  pitch: Pitch of the thread in mm. Normed range: 0.25 - 9mm The value will always be set - even if the pitch is give implicitly (e.g. M10c) or when the pitch is given in threads per inch. When the Pitch is ambiguous, this value be the median pitch
  threads_per_inch: Pitch and Threads per inch are interchangeable concepts. Depending on your geographic focus, the one or the other concept is more suitable. We convert ISO pitches to UTS threads per inch and vice versa, so that you do not have to handle the conversion.
  handedness: Left of right-handedness of the thread. This will be RIGHT unless explicitly described as LEFT in the drawing.
  length (Decimal, optional): Length of the Thread if specified on the label (e.g., M15x1x20). None otherwise. NOTE: If the thread length is not specified in the label, you can still obtain the information from the W24ThreadElement NOTE: If the thread label specifies both a thread length and a bore length, only the thread length will be included here. The bore length can be found in the W24MeasureElement.depth attribute.

• blurb (string)

• diameter (number)

• unit: Default: MILLIMETER.

• thread_type: Refer to #/definitions/W24ThreadType.

• pitch (number)

• threads_per_inch (number)

• handedness: Default: RIGHT.

• multi_start: Refer to #/definitions/W24ThreadMultiStart.

• length (number)

• W24UnitAngle (string): Enum of all the supported angle units
  NOTE: currently we are only supporting degrees. If you come across a drawing that uses GON, let us know, we love the concept! Must be one of: ['DEGREE'].

• W24Chamfer (object): Chamfer in degree.
  Attributes: blurb: String representation for human consumption
  angle: Chamfer angle in degrees
  unit: Angle Unit. Currently only degrees are supported.
  !!! note The chamfers can be tolerated. Future implementations will take this into account.

• blurb (string)

• angle (number)

• unit: Default: DEGREE.

• W24DepthThroughType (string): Through Type specified on ASME drawings. . Must be one of: ['THRU', 'THRU_ALL'].

• W24Depth (object): Depth object that describes the details of the depth of a drilling or thread
  Attributes: blurb: String for human consumption
  depth: Depth of the drilling or thread in the units of the parent object.

• blurb (string)

• depth (number)

• through_type: Refer to #/definitions/W24DepthThroughType.

• W24TestCriticality (string): An enumeration. Must be one of: ['CTD', 'CTF', 'CTP', 'CTQ', 'CTS'].

• W24TestDimension (object): Test Dimension attributes that can either be attached to a MeasureLabel or a GDTLabel
  Attributes: blurb: Blurb of the complete label for human consumption
  criticality: Some measures can be critical to Function, others critical to price. The TestDimensions sometimes highlight this with a shorthand (e.g., CTF)
  rate: Test rate as percentage. If a 100% inspection rate has been defined, rate will be Decimal('100'). If not defined, the rate will be None.

• blurb (string)

• criticality: Refer to #/definitions/W24TestCriticality.

• rate (number)

• W24MeasureLabel (object): Measure Label
  Attributes:
  blurb: String representation of the item for human consumption
  quantity: Quantity for spacings, e.g., (2x). Currently only the indicated measure will be detected and returned. Future implementation could detect the spacings and return individual measures for the respective spacings. When we implement this feature, we will add an attribute to the ASK, which allows you to control the behavior.
  size: Size of measure as referred to in the drawing. Sizes are always associated with units! This becomes important to remember when you are dealing with mixed-unit drawings (e.g., an adapter bolt that has an ISO thread and an UTC tapped hole). To avoid any loss of precision, we return the size in the unit that was indicated on the drawing.
  size_tolerance: Tolerance details. Default: General tolerances. By default we are referring to the general tolerances of the drawing. When you are also requesting the TitleBlock, we are attaching the applicable General Tolerances (assuming they were understood) to the measure. This will consider the nominal size of the measure. If the W24MeasureLabel describes a "Theoretically Exact Measure", i.e, the label is surrounded by a box, like: "[15]", the size_tolerance refers to a W24ToleranceTheoreticallyExact object (and is NOT None)
  unit: Length unit of the size. This information is only available when you request the TitleBlock as well; as only the title block will allow us to determine the geographic origin of the drawing.
  thread: Optional thread details. The thread details describe the complete thread description and follow the respective standards. In consequence, the thread diameter of an ISO-thread will be indicated in millimeter, while the thread diameter of an UTS thread will be in inch.
  chamfer: Optional Chamfer
  depth: Depth of the drilling or thread. Uses the same dimensions.

• blurb (string)

• quantity (integer): Default: 1.

• size: Refer to #/definitions/W24Size.

• size_tolerance: Default: {'blurb': '', 'toleration_type': 'GENERAL_TOLERANCES', 'standard': None, 'standard_class': None, 'deviation_lower': None, 'deviation_upper': None, 'tolerance_grade': None}.

• unit: Refer to #/definitions/W24UnitLength.

• thread: Refer to #/definitions/W24Thread.

• chamfer: Refer to #/definitions/W24Chamfer.

• depth: Refer to #/definitions/W24Depth.

• test_dimension: Refer to #/definitions/W24TestDimension.

• W24MeasureWarningType (string): List of all warnings that can be associated with the returned measures. Must be one of: ['UNCONVENTIONAL_TOLERANCE_ORDER', 'UNPROPORTIONAL'].

• W24MeasureWarning (object): Warnings are issued when something about the label or measure is not conforming with convention.

• warning_type: Refer to #/definitions/W24MeasureWarningType.

• W24Measure (object): Measure object
  Attributes:
  measure_id: Unique UUID4 identifier
  label: Measure Label
  warnings: List of Warnings that are associated with the measure. See W24MeasureWarning for details.
  confidence: Werk24 calculates an internal confidence score for each measure. Depending on your use-case, you might want to consider or discard low-confidence measures. This value allows you to do so. The value ranges from 0.0 to 1.0.

• position: Refer to #/definitions/W24BaseFeaturePosition.

• measure_id (string)

• label: Refer to #/definitions/W24MeasureLabel.

• warnings (array): Default: [].

  • Items: Refer to #/definitions/W24MeasureWarning.

• confidence (number): Default: 0.0.

• W24GDTCharacteristic (string): Enum of all possible Characteristics following ISO 1101.
  !!! note When the GDT frame only describes the location of a reference datum, the value DATUM_INDICATOR is used. Must be one of: ['⏤', '⏥', '○', '⌭', '⌓', '⌒', '⟂', '∠', '∥', '⌖', '◎', '⌯', '↗', '⌰', '[DATUM]'].

• W24GDTZoneShape (string): Enum of all zone shapes . Must be one of: ['Ø', 'S⌀'].

• W24GDTZoneValue (object): Preliminary defintion of the GDT Zone Value Future implementation will give access to the width and extend seperately
  Attributes:
  blurb: String representation for human consumption e.g., 0.05/12x10°
  width_min: Minimal width. Also used when no maximal width is defined.
  width_max: Optional maximal width.
  extend_quantity: Optional quantity of the spacing
  extend_shape: Optional shape of the extend
  extend_value: Optional extend value
  extend_angle: Optional angle of the extend.

• blurb (string)

• width_min (number)

• width_max (number)

• extend_quantity (integer)

• extend_shape: Refer to #/definitions/W24GDTZoneShape.

• extend_value (number)

• extend_angle (number)

• W24GDTZoneCombination (string): Enum of all tolerance zone combinations . Must be one of: ['CZ', 'SZ'].

• W24GDTZoneOffset (object): Specified offset indicated by leading UZ...
  Attributes: blurb: blurb of the specified offset for human consumption. e.g., UZ+0.15, UZ-0.2, UZ+0.1:0.2.

• blurb (string)

• W24GDTZoneConstraint (string): Enum of the Zone Constraints . Must be one of: ['OZ', 'VA', '><'].

• W24GDTFilterType (string): Preliminary list of feature filters
  Filters remaining: RG, S, OH, SW, AB, CW. Must be one of: ['G', 'S', 'SW', 'CW', 'RG', 'RS', 'OB', 'OH', 'OC', 'CB', 'CH', 'CD', 'AB', 'AH', 'AD', 'F', 'H'].

• W24GDTFilter (object): Abstract base class to describe feature filters
  Attributes: blurb: String representation of the file for human consumption
  filter_type: Filter Type to facilitate deserialization.

• blurb (string)

• filter_type: Refer to #/definitions/W24GDTFilterType.

• W24GDTFeatureAssociated (string): Enum of all associated tolerated features . Must be one of: ['Ⓒ', 'Ⓖ', 'Ⓝ', 'Ⓧ', 'Ⓣ'].

• W24GDTFeatureDerived (string): Enum of all derived features . Must be one of: ['Ⓟ', 'Ⓐ'].

• W24GDTReferenceAssociation (string): Association of the Reference Element . Must be one of: ['C', 'CE', 'CI', 'G', 'GE', 'GI', 'N', 'X'].

• W24GDTReferenceParameter (string): Parameter of the reference element . Must be one of: ['P', 'V', 'T', 'Q'].

• W24GDTMaterialCondition (string): Enum for Material Conditions . Must be one of: ['Ⓜ', 'Ⓛ', 'Ⓡ'].

• W24GDTState (string): Enum for the State . Must be one of: ['Ⓕ'].

• W24GDTDatum (object): Preliminary implementation of the GD&T Datum
  Attributes: blurb: Reference name. Typically: A,B,C ... Can also contain more complex names, e.g., (A-B-C-D)[CM]
  !!! note Future implementations might allow fine-grained access to the attributes of complex names: e.g., (A-B-C-D)[CM].

• blurb (string)

• W24GDTFrame (object): Representation of the Geometric Dimensioning and Toleration frame
  Attributes: gdt_id: Unique id of the GDT
  blurb: String representation of the label for human consumption e.g., [⌖|⌀0.3Ⓜ|A|B|C]
  characteristic: Section for geometric characteristic e.g.: ⌓
  zone_shape: Tolerance zone shape, e.g, S⌀
  zone_value: GDT value: e.g., 0.03 Is optional to support Datum Feature Indicators
  zone_combinations: Ordered list of zone combinations, e.g., CZ, SZ
  zone_offset: Optional specified offset, e.g., UZ-0.2
  zone_constraint: Optional zone constraint: e.g., OZ, VA
  feature_filter: Optional feature filter
  feature_associated: Associated toleraced feature
  feature_derived: Derived Feature
  reference_association: Reference element association
  reference_parameter: Reference element parameter
  material_condition: Material condition
  state: FREE or None
  data: Ordered list of data.

• gdt_id (string)

• blurb (string)

• characteristic: Refer to #/definitions/W24GDTCharacteristic.

• zone_shape: Refer to #/definitions/W24GDTZoneShape.

• zone_value: Refer to #/definitions/W24GDTZoneValue.

• zone_combinations (array): Default: [].

  • Items: Refer to #/definitions/W24GDTZoneCombination.

• zone_offset: Refer to #/definitions/W24GDTZoneOffset.

• zone_constraint: Refer to #/definitions/W24GDTZoneConstraint.

• feature_filter: Refer to #/definitions/W24GDTFilter.

• feature_associated: Refer to #/definitions/W24GDTFeatureAssociated.

• feature_derived: Refer to #/definitions/W24GDTFeatureDerived.

• reference_association: Refer to #/definitions/W24GDTReferenceAssociation.

• reference_parameter: Refer to #/definitions/W24GDTReferenceParameter.

• material_condition: Refer to #/definitions/W24GDTMaterialCondition.

• state: Refer to #/definitions/W24GDTState.

• data (array): Default: [].

  • Items: Refer to #/definitions/W24GDTDatum.

• W24GDT (object): Parent object for Geometric Dimensionsing and Toleration Frames, attaching them to the physical location on the drawing.
  Attributes: frame: Representation of the GDT frame.

• position: Refer to #/definitions/W24BaseFeaturePosition.

• bounding_polygon (array)

  • Items (array)

  • Items_0 (number)

  • Items_1 (number)

• frame: Refer to #/definitions/W24GDTFrame.

• W24RadiusLabel (object): Radius Label
  Attributes: blurb: String representation of the Radius for human consumption
  quantity: Quantity of the annotated radius, e.g., 2 x R4 returns quantity=2
  size: Size of the Radius as referred in the drawing.
  size_tolerance: Tolerance details of the Radius. Please keep in mind that Radii can carry special tolerances. If none are mentioned on the drawing, the general tolerances apply.
  unit: Length units of the size and size_tolerance. In most cases this will be be millimeter (METRIC) or inch (IMPERIAL) and be consistent for the complete drawing. Exceptions are very rare, but exist.

• blurb (string)

• quality (integer): Default: 1.

• size: Refer to #/definitions/W24Size.

• size_tolerance: Default: {'blurb': '', 'toleration_type': 'GENERAL_TOLERANCES', 'standard': None, 'standard_class': None, 'deviation_lower': None, 'deviation_upper': None, 'tolerance_grade': None}.

• unit: Refer to #/definitions/W24UnitLength.

• W24Radius (object): Radius Feature
  Attributes: radius_id: Unique UUID4 identifier. This can be used to provide automated feedback about customer changes.
  label: Label of the radius.
  confidence: Werk24 calcualtes an internal confidence score for reach radius. Depending on your use-case, you might want to consider or discard low-confidence radii. This value allows you to do so. The value ranges from 0.0 to 1.0.

• position: Refer to #/definitions/W24BaseFeaturePosition.

• radius_id (string)

• label: Refer to #/definitions/W24RadiusLabel.

• confidence (number)

• W24RoughnessStandard (string): Most standards that define the surface roughness use very similar symbols. However, the position of the fields varies.
  The standards listed here are understood and supported by the API.
  NOTE: the ISO 1302 standard exists in four different versions, these releases substantially modified the position and structure of the roughness symbols.
  NOTE: this list is not exhaustive, many countries have specified their own standards over the years. Do not hesitate to reach out if you wish us to implement another standard. Must be one of: ['ISO 1302:1978', 'ISO 1302:1992', 'ISO 1302:2002', 'ISO 21920-1:2021', 'ASME Y14.36-1978', 'ASME Y14.36M-1996', 'ASME Y14.36-2018'].

• W24RoughnessMaterialRemovalType (string): Most standard allow the designer to specify whether material removal is required or prohibited.
  By default both options are allowed. Must be one of: ['UNSPECIFIED', 'PROHIBITED', 'REQUIRED'].

• W24RoughnessDirectionOfLay (string): The lay of the roughness limits the manufacturing process and is sometimes required for the application. Must be one of: ['=', '⟂', 'X', 'M', 'C', 'R', 'P'].

• W24ManufacturingMethod (object): Manufacturing method specified on the drawing. Currently only the blurb is available.
  Attributes: blurb: Manufacturing method as specified on the drawing.

• blurb (string)

• W24RoughnessConditionType (string): Roughnesses can specify, the upper limit, the lower limit and the average. Must be one of: ['U', 'L', 'A'].

• W24RoughnessFilterType (string): When measuring the roughness, different filter types will result in different results. To reduce this source of ambiguity, the designer can specify the filter to be used.
  NOTE: this list is not exhaustive. If you need us to support another filter method, please reach out. Must be one of: ['G', 'RG', 'S', '"2RC"'].

• W24RoughnessParameter (string): Roughness Parameter that is specified.
  NOTE: this list is not exhaustive, but covers the most frequently used parameters. Must be one of: ['AA', 'CLA', 'PVA', 'RMS', 'Pa', 'PC', 'Pku', 'Pp', 'Pq', 'Psk', 'Pt', 'Pv', 'Py', 'Pz', 'Ra(DIN)', 'Ra(ISO)', 'Rc', 'Rku', 'Rp', 'Rq', 'Rsk', 'Rt', 'Rv', 'Ry', 'Rz', 'Wa', 'Wc', 'Wku', 'Wp', 'Wq', 'Wsk', 'Wt', 'Wv', 'Wy', 'Wz', 'N'].

• W24RoughnessEvaluationLengthType (string): An enumeration. Must be one of: ['LENGTH', 'LAMBDA_C_MULTIPLE'].

• W24RoughnessEvaluationLength (object): For sophisticated application, the sample needs to be taken over a longer distances. This is specified the either the sampling length in millimeter (ISO 3012:1974, ISO 3012:1978, ISO 3012:1992) or as multiple of the main lambda (ISO 3012:2002 and ISO 3012:2021).
  
  Attributes: evaluation_length_type: Sampling length type that is specified by the applicable standard
  length: evaluation length in the specified units.
  length_unit: Millimeter for both the ISO and ASME standards
  lambda_c_multiple: multiple of the main cutoff lambda_c.

• evaluation_length_type: Refer to #/definitions/W24RoughnessEvaluationLengthType.

• length (number)

• length_unit: Refer to #/definitions/W24UnitLength.

• lambda_c_multiple (number)

• W24RoughnessAcceptanceCriterion (string): The designer can specify whether to apply the 16%-rule, the maximum- or medium- rule when deciding whether a surface complies with the specifications. Must be one of: ['16%', 'max', 'mean'].

• W24RoughnessGrade (object): ISO Roughness Grade
  Attributes: blurb: String representation for human consumption
  grade: Roughness Grade in the range N01 to N12. Valid values are N01, N0, N1, N2, N3, N4, N5, N6, N7, N8, N9, N10, N11, N12, N13, N14.

• blurb (string)

• grade (string)

• W24RoughnessCondition (object): Roughness Label
  Attributes: blurb: String representation of the Roughness for human consumption.
  condition_type: Roughness Side that is specified (upper or lower). We automatically determine this value depending on the standard and the position of the parameter
  filter_type: Filter Type to use when measuring the surface. When not specified on the drawing, we set the default value according to the applicable standard.
  lambda_s: Filter bandwidth microroughness cutoff lambda_s. When not specified, we determine the default value based on the standard and the value_limit.
  lambda_c: Filter bandwidth main cutoff lambda_c. When not specified, we determine the default value based on the standard and the value_limit.
  parameter: Parameter to be measured
  
  characteristic: Method of converting the 2D-measurement into a single number
  evaluation_length: For sophisticated application, the roughness needs to be evaluated over a longer distances. This is specified the either the sampling length in millimeter (ISO 3012:1974, ISO 3012:1978, ISO 3012:1992) or as multiple of the main lambda (ISO 3012:2002 and ISO 3012:2021).
  acceptance_criterion: Designers can specify what rule to apply when deciding whether a measured tolerance complies with the requirements
  value_limit: Specification limit
  roughness_grade: ISO roughness grade that the roughness specifications correspond to. IMPORTANT: this allows you to deal with all the standards in a simple way.

• blurb (string)

• condition_type: Refer to #/definitions/W24RoughnessConditionType.

• filter_type: Refer to #/definitions/W24RoughnessFilterType.

• lambda_s (number)

• lambda_c (number)

• parameter: Refer to #/definitions/W24RoughnessParameter.

• evaluation_length: Refer to #/definitions/W24RoughnessEvaluationLength.

• acceptance_criterion: Refer to #/definitions/W24RoughnessAcceptanceCriterion.

• value (number)

• roughness_grade: Refer to #/definitions/W24RoughnessGrade.

• W24UnitSystem (string): Unit System that is used for a certain feature . Must be one of: ['METRIC', 'IMPERIAL'].

• W24RoughnessWaviness (object): Roughness Waviness as defined in the ASME-Y14-36
  Attributes: waviness_height: Waviness height in inch waviness_width: Waviness width in inch.

• waviness_height (number)

• waviness_width (number)

• W24RoughnessLabel (object): Roughness Label
  Attributes: blurb: String for human consumption
  blurb_html: HTML for human consumption. The complex structure of the symbol makes this necessary.
  standard : Standard in which the Roughness Symbol is written NOTE: there are multiple standards that are in use
  machining_allowance: Machining Allowance in millimeter of micro-inch. See the unit attribute.
  material_removal_type: The MaterialRemovalType specifies whether material must / must not be removed.
  applies_all_around: Boolean value that specifies whether the roughness applies to all surfaces around
  direction_of_lay: The lay of the roughness limits the manufacturing process and is sometimes required for the application.
  manufacturing_method: Method by which to achieve the roughness
  conditions: Roughness conditions
  unit_system: Unit system that is used for the roughness. We are not using the explicit units as the different attributes have different units (e.g, micro and nano meters)
  waviness: Waviness defined in ASME standards.

• blurb (string)

• blurb_html (string)

• standard: Refer to #/definitions/W24RoughnessStandard.

• machining_allowance (number)

• material_removal_type: Refer to #/definitions/W24RoughnessMaterialRemovalType.

• applies_all_around (boolean)

• direction_of_lay: Refer to #/definitions/W24RoughnessDirectionOfLay.

• manufacturing_method: Refer to #/definitions/W24ManufacturingMethod.

• conditions (array)

  • Items: Refer to #/definitions/W24RoughnessCondition.

• unit_system: Refer to #/definitions/W24UnitSystem.

• waviness: Refer to #/definitions/W24RoughnessWaviness.

• W24Roughness (object): Roughness object
  Attributes: roughness_id: Unique UUID4 identifier
  label: RoughnessLabel.

• position: Refer to #/definitions/W24BaseFeaturePosition.

• roughness_id (string)

• label: Refer to #/definitions/W24RoughnessLabel.

W24AskRevisionTable¶

With this Ask you are requesting the list of all revision tables in the document

Properties¶

• is_training (boolean): Default: False.

Definitions¶

W24AskRevisionTableResponse¶

Response object corresponding toi the W24AskRevisionTable

Attributes:

revision_table: RevisionTable object with all
    the content that was extracted from the
    drawing

Properties¶

• revision_table: Refer to #/definitions/W24RevisionTable.

Definitions¶

• W24Date (object): Date object
  Attributes: blurb: Date in ISO 8601 format
  date: Python date object; this will automatically be interpreted when the object is loaded.

• blurb (string)

• date (string)

• W24GridSquare (object): Grid Square
  Attributes: column (str): Column of the Grid Square
  row (str): Row of the Grid Square.

• column (string)

• row (string)

• W24RevisionTableRow (object): Row of a revision table
  Attributes: serial (Optional[str]): Serial number, also referred to as Index or Position of the row in the revision table. The serial number is typicall used to identify the revision on each individual sheet (e.g., A, B, C or 01, 02, 03)
  ecn_number (Optional[str]): Identifier of the Engineering Change Note to uniquely identify the change across multiple documents. This is typically a long number and sometimes identifies a revision process that affect multiple parts.
  description (str): Description of the change
  revision_date (Optional[date]): Date of the revision
  grid_squares: (List[W24GridSquare]): List of the grid squares that are affected by the revision.

• serial (string)

• ecn_number (string)

• description (string)

• revision_date: Refer to #/definitions/W24Date.

• grid_squares (array)

  • Items: Refer to #/definitions/W24GridSquare.

• W24RevisionTable (object): Revision Table object that contains all the rows
  Attributes: rows (List[W24RevisionTableRow]): List of all rows in the revision table.

• rows (array)

  • Items: Refer to #/definitions/W24RevisionTableRow.

  W24AskSectionalThumbnail¶

The W24AskPlaneThumbnail requests a thumbnail of each sectional on each sheet in the document.

Properties¶

• is_training (boolean): Default: False.

• file_format: Default: JPEG.

Definitions¶

• W24FileFormatThumbnail (string): List of supported File Formats in which the Thumbnail can be supplied.
  !!! note At this stage, the API only supports JPEG. This prepares the support for additional format (e.g. TIFF). Must be one of: ['JPEG'].

W24AskSheetAnonymization¶

Requests an ANONYMIZED thumbnail of each sheet on each page in the document. The sheet will only contain the pixels within the main frame that surrounds the canvas and header fields.

Attributes:

replacement_logo (bytes): SVG version of the logo that
    shall be used to replace the logo on the drawing.

identification_snippets (List[str]): List of string values
    that might identify the authoring company. The software
    will actively look for such text segments in the data
    and replace them with white pixels.

redact_employee_names (bool): Redact the employee names
    when they are indicated by a caption such as
    "Drawn by"

redact_cage_code (bool): Redact the CAGE Code (
    Commercial and Government Entity Code) typically
    used for US-government suppliers

fill_color (Tuple[int,int,int]): Color that shall be used
    to fill the pixels that are to be redacted. Currently
    only grayscale is supported.

Properties¶

• is_training (boolean): Default: False.

• file_format: Default: JPEG.

• replacement_logo_url (string)

• identification_snippets (array): Default: [].

• Items (string)

• redact_employee_names (boolean): Default: False.

• redact_cage_code (boolean): Default: False.

• fill_color (array): Default: [255, 255, 255].

• Items_0 (integer)

• Items_1 (integer)

• Items_2 (integer)

Definitions¶

• W24FileFormatThumbnail (string): List of supported File Formats in which the Thumbnail can be supplied.
  !!! note At this stage, the API only supports JPEG. This prepares the support for additional format (e.g. TIFF). Must be one of: ['JPEG'].

W24AskSheetThumbnail¶

Requests a thumbnail of each sheet on each page in the document. The sheet will only contain the pixels within the main frame that surrounds the canvas and header fields.

Properties¶

• is_training (boolean): Default: False.

• file_format: Default: JPEG.

Definitions¶

• W24FileFormatThumbnail (string): List of supported File Formats in which the Thumbnail can be supplied.
  !!! note At this stage, the API only supports JPEG. This prepares the support for additional format (e.g. TIFF). Must be one of: ['JPEG'].

W24AskThumbnail¶

Base model for features that request a thumbnail.

Attributes:

file_format: File format in which you wish to obtain
    the result. Currently only JPEG is supported.

Properties¶

• is_training (boolean): Default: False.

• file_format: Default: JPEG.

Definitions¶

• W24FileFormatThumbnail (string): List of supported File Formats in which the Thumbnail can be supplied.
  !!! note At this stage, the API only supports JPEG. This prepares the support for additional format (e.g. TIFF). Must be one of: ['JPEG'].

W24AskTitleBlock¶

This ask requests all information that we can obtain from the title block

Properties¶

• is_training (boolean): Default: False.

Definitions¶

W24AskTrain¶

If you submit this Ask, we will use your request to train and improve our models. It does not trigger a response.

Properties¶

• is_training (boolean): Default: False.

Definitions¶

W24AskVariantAngles¶

With this Ask you are requesting the list of all measures that were detected on all sectionals of a variant.

Properties¶

• is_training (boolean): Default: False.

Definitions¶

W24AskVariantAnglesResponse¶

ResponseType associated with the W24AskVariantAngles.

Attributes:

variant_id: Unique ID of the variant detected on
    the Technical Drawing. Refer to the documentation
    on Variants for details.

sectional_id: Unique ID of the sectional on which the
    Angle was detected. This allows you to associate
    the Angle to the SectionalThumbnail (should you
    have requested it).

angles: List of Angles that were found for the Variant
    on the Sectional.

Properties¶

• variant_id (string)

• sectional_id (string)

• angles (array)

• Items: Refer to #/definitions/W24Angle.

Definitions¶

• W24BaseFeatureCoordinate (object): Coordinate point
  Attributes: x: x position normalized by the thumbnail's width
  y: y position normalized by the thumbnail's height.

• x (number)

• y (number)

• W24BaseFeaturePosition (object): Position of the Feature on the individual thumbnails normalized by the width and height of each thumbnail.
  Each features position is indicated as a list of coordinates. If the list only has two elements, you are dealing with a line. If it has four or more, you are looking at a polygon
  Attributes: page: Position of the Feature on the Page thumbnail
  sheet: Position of the Feature on the Sheet thumbnail
  sectional: Position of the Feature on the Sectional thumbnail.

• sheet (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• canvas (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• sectional (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• W24UnitAngle (string): Enum of all the supported angle units
  NOTE: currently we are only supporting degrees. If you come across a drawing that uses GON, let us know, we love the concept! Must be one of: ['DEGREE'].

• W24AngleSize (object): Size of an Angle including its tolerance
  Attributes:
  blurb: Blurb for human consumption
  angle: Nominal angle size in [units]
  unit: Angle Unit. Currently only degrees are supported.

• blurb (string)

• angle (number)

• unit: Default: DEGREE.

• W24Tolerance (object): Abstract Base Class to cover the Tolerances.
  Attributes: blurb (str): String representation for human consumption
  toleration_type (W24SizeToleranceType): Toleration Type for deserialization.

• blurb (string)

• toleration_type (string)

• W24AngleLabel (object): Label associated with an Angle indicated on the Technical Drawing
  Attributes:
  blurb: Blurb for human consumption quantity: Number of annotated angles angle: Nominal angle size angle_tolerance: Tolerated deviations.

• blurb (string)

• quantity (integer)

• angle: Refer to #/definitions/W24AngleSize.

• angle_tolerance: Refer to #/definitions/W24Tolerance.

• W24Angle (object): Tolerated Angle detected on a sectional of the Technical Drawing
  Attributes:
  angle_id: Unique identifier of the Angle. This allows the reference of the angle from another object (e.g., a leader)
  vertex: X and y coordinates of the angle's vertex normalized by the sectional's width and height.
  ray1: Unit-vector attached to the vertex that indicates the angle's start ray
  ray2: Unit-vector attached to the vertex that indicates the angle's end ray
  label: AngleLabel associated with the Angle
  confidence: Werk24 calculates an internal confidence score for each angle. The score ranges from 0.0 to 1.0 and can be used to accept the reading as-is or queuing it for a manual verification.

• position: Refer to #/definitions/W24BaseFeaturePosition.

• vertex (array)

  • Items_0 (number)

  • Items_1 (number)

• ray1 (array)

  • Items_0 (number)

  • Items_1 (number)

• ray2 (array)

  • Items_0 (number)

  • Items_1 (number)

• angle_id (string)

• label: Refer to #/definitions/W24AngleLabel.

• confidence (number)

W24AskVariantCAD¶

By sending this Ask, you are requesting an associated CAD model

Attributes:

output_format: Output format in which to generate
    the CAD file.

Properties¶

• is_training (boolean): Default: False.

• output_format: Default: DXF.

Definitions¶

• W24FileFormatVariantCAD (string): List of the supported CAD file formats
  !!! note At this stage, the API only supports DXF as output format. Additional formats are available upon request. Must be one of: ['DXF'].

W24AskVariantCADResponse¶

Response object corresponding to the W24AskVariantCad.

Attributes:

variant_id: Unique ID of the variant detected on
    the Technical Drawing. Refer to the documentation
    on Variants for details.

num_sectionals: Number of sectionals that were detected
    on the Variant. This allows you to better classify
    the type of file you are dealing with.

num_angles: Number of  angles that were detected on the Variant.
    This allows you to better classify the type of file you are
    dealing with.

!!!! note Be aware that requesting the measures will yield one response for each variant. Refer to the Variant documentation for details

Properties¶

• variant_id (string)

• num_sectionals (integer): Default: 0.

• num_angles (integer): Default: 0.

W24AskVariantExternalDimensions¶

Ask object to request the external dimensions of each variant on the Document.

Properties¶

• is_training (boolean): Default: False.

Definitions¶

W24AskVariantExternalDimensionsResponse¶

Response object corresponding to the W24AskVariantExternalDimensions

Attributes:

variant_id (UUID4): Unique ID of the variant detected on the
    Technical Drawing. Refer to the documentation on Variants
    for details.

enclosing_cuboid (W24GeometricShapeCuboid): Cuboid that encloses
    the complete geometric shape of the part

enclosing_cylinder (W24GeometricShapeCuboid): Cylinder that encloses
    the complete geometric shape of the part

confidence (float): Confidence that the reading is correct.

!!! the cuboid and cylinder are not necessarily aligned. So might
!!! receive different depths of the cuboid and the cylinder.

Properties¶

• variant_id (string)

• enclosing_cuboid: Refer to #/definitions/W24GeometricShapeCuboid.

• enclosing_cylinder: Refer to #/definitions/W24GeometricShapeCylinder.

• confidence (number)

Definitions¶

• W24GeometricShapeCuboid (object): Geometric Shape of a cuboid
  Attributes: width (Decimal): Width of the cuboid
  height (Decimal): Height of the cuboid
  depth (Decimal): Depth of the cuboid.

• width (number)

• height (number)

• depth (number)

• W24GeometricShapeCylinder (object): Geometric Shape of a cylinder
  Attributes: diameter (Decimal): Diameter of the cylinder
  depths (Decimal): Depth of the cylinder.

• diameter (number)

• depth (number)

W24AskVariantGDTs¶

This Ask requests the list of all Geometric Dimensions and Tolerances that were detected for the Variant.

Properties¶

• is_training (boolean): Default: False.

Definitions¶

W24AskVariantGDTsResponse¶

Response object corresponding to the W24AskVariantGDTs.

Attributes:

variant_id: Unique ID of the variant detected on
    the Technical Drawing. Refer to the documentation
    on Variants for details.

sectional_id: Unique ID of the sectional on which the
    GD&T was detected. This allows you to associate
    the Leader to the SectionalThumbnail (should you
    have requested it).

gdts: List of GD&Ts that were found for the
    Variant on the Sectional.

Properties¶

• variant_id (string)

• sectional_id (string)

• gdts (array)

• Items: Refer to #/definitions/W24GDT.

Definitions¶

• W24BaseFeatureCoordinate (object): Coordinate point
  Attributes: x: x position normalized by the thumbnail's width
  y: y position normalized by the thumbnail's height.

• x (number)

• y (number)

• W24BaseFeaturePosition (object): Position of the Feature on the individual thumbnails normalized by the width and height of each thumbnail.
  Each features position is indicated as a list of coordinates. If the list only has two elements, you are dealing with a line. If it has four or more, you are looking at a polygon
  Attributes: page: Position of the Feature on the Page thumbnail
  sheet: Position of the Feature on the Sheet thumbnail
  sectional: Position of the Feature on the Sectional thumbnail.

• sheet (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• canvas (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• sectional (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• W24GDTCharacteristic (string): Enum of all possible Characteristics following ISO 1101.
  !!! note When the GDT frame only describes the location of a reference datum, the value DATUM_INDICATOR is used. Must be one of: ['⏤', '⏥', '○', '⌭', '⌓', '⌒', '⟂', '∠', '∥', '⌖', '◎', '⌯', '↗', '⌰', '[DATUM]'].

• W24GDTZoneShape (string): Enum of all zone shapes . Must be one of: ['Ø', 'S⌀'].

• W24GDTZoneValue (object): Preliminary defintion of the GDT Zone Value Future implementation will give access to the width and extend seperately
  Attributes:
  blurb: String representation for human consumption e.g., 0.05/12x10°
  width_min: Minimal width. Also used when no maximal width is defined.
  width_max: Optional maximal width.
  extend_quantity: Optional quantity of the spacing
  extend_shape: Optional shape of the extend
  extend_value: Optional extend value
  extend_angle: Optional angle of the extend.

• blurb (string)

• width_min (number)

• width_max (number)

• extend_quantity (integer)

• extend_shape: Refer to #/definitions/W24GDTZoneShape.

• extend_value (number)

• extend_angle (number)

• W24GDTZoneCombination (string): Enum of all tolerance zone combinations . Must be one of: ['CZ', 'SZ'].

• W24GDTZoneOffset (object): Specified offset indicated by leading UZ...
  Attributes: blurb: blurb of the specified offset for human consumption. e.g., UZ+0.15, UZ-0.2, UZ+0.1:0.2.

• blurb (string)

• W24GDTZoneConstraint (string): Enum of the Zone Constraints . Must be one of: ['OZ', 'VA', '><'].

• W24GDTFilterType (string): Preliminary list of feature filters
  Filters remaining: RG, S, OH, SW, AB, CW. Must be one of: ['G', 'S', 'SW', 'CW', 'RG', 'RS', 'OB', 'OH', 'OC', 'CB', 'CH', 'CD', 'AB', 'AH', 'AD', 'F', 'H'].

• W24GDTFilter (object): Abstract base class to describe feature filters
  Attributes: blurb: String representation of the file for human consumption
  filter_type: Filter Type to facilitate deserialization.

• blurb (string)

• filter_type: Refer to #/definitions/W24GDTFilterType.

• W24GDTFeatureAssociated (string): Enum of all associated tolerated features . Must be one of: ['Ⓒ', 'Ⓖ', 'Ⓝ', 'Ⓧ', 'Ⓣ'].

• W24GDTFeatureDerived (string): Enum of all derived features . Must be one of: ['Ⓟ', 'Ⓐ'].

• W24GDTReferenceAssociation (string): Association of the Reference Element . Must be one of: ['C', 'CE', 'CI', 'G', 'GE', 'GI', 'N', 'X'].

• W24GDTReferenceParameter (string): Parameter of the reference element . Must be one of: ['P', 'V', 'T', 'Q'].

• W24GDTMaterialCondition (string): Enum for Material Conditions . Must be one of: ['Ⓜ', 'Ⓛ', 'Ⓡ'].

• W24GDTState (string): Enum for the State . Must be one of: ['Ⓕ'].

• W24GDTDatum (object): Preliminary implementation of the GD&T Datum
  Attributes: blurb: Reference name. Typically: A,B,C ... Can also contain more complex names, e.g., (A-B-C-D)[CM]
  !!! note Future implementations might allow fine-grained access to the attributes of complex names: e.g., (A-B-C-D)[CM].

• blurb (string)

• W24GDTFrame (object): Representation of the Geometric Dimensioning and Toleration frame
  Attributes: gdt_id: Unique id of the GDT
  blurb: String representation of the label for human consumption e.g., [⌖|⌀0.3Ⓜ|A|B|C]
  characteristic: Section for geometric characteristic e.g.: ⌓
  zone_shape: Tolerance zone shape, e.g, S⌀
  zone_value: GDT value: e.g., 0.03 Is optional to support Datum Feature Indicators
  zone_combinations: Ordered list of zone combinations, e.g., CZ, SZ
  zone_offset: Optional specified offset, e.g., UZ-0.2
  zone_constraint: Optional zone constraint: e.g., OZ, VA
  feature_filter: Optional feature filter
  feature_associated: Associated toleraced feature
  feature_derived: Derived Feature
  reference_association: Reference element association
  reference_parameter: Reference element parameter
  material_condition: Material condition
  state: FREE or None
  data: Ordered list of data.

• gdt_id (string)

• blurb (string)

• characteristic: Refer to #/definitions/W24GDTCharacteristic.

• zone_shape: Refer to #/definitions/W24GDTZoneShape.

• zone_value: Refer to #/definitions/W24GDTZoneValue.

• zone_combinations (array): Default: [].

  • Items: Refer to #/definitions/W24GDTZoneCombination.

• zone_offset: Refer to #/definitions/W24GDTZoneOffset.

• zone_constraint: Refer to #/definitions/W24GDTZoneConstraint.

• feature_filter: Refer to #/definitions/W24GDTFilter.

• feature_associated: Refer to #/definitions/W24GDTFeatureAssociated.

• feature_derived: Refer to #/definitions/W24GDTFeatureDerived.

• reference_association: Refer to #/definitions/W24GDTReferenceAssociation.

• reference_parameter: Refer to #/definitions/W24GDTReferenceParameter.

• material_condition: Refer to #/definitions/W24GDTMaterialCondition.

• state: Refer to #/definitions/W24GDTState.

• data (array): Default: [].

  • Items: Refer to #/definitions/W24GDTDatum.

• W24GDT (object): Parent object for Geometric Dimensionsing and Toleration Frames, attaching them to the physical location on the drawing.
  Attributes: frame: Representation of the GDT frame.

• position: Refer to #/definitions/W24BaseFeaturePosition.

• bounding_polygon (array)

  • Items (array)

  • Items_0 (number)

  • Items_1 (number)

• frame: Refer to #/definitions/W24GDTFrame.

W24AskVariantLeaders¶

With this Ask you are requesting the complete list of all leaders that were detected on the variant

Properties¶

• is_training (boolean): Default: False.

Definitions¶

W24AskVariantLeadersResponse¶

Response object corresponding to the W24AskVariantLeaders.

Attributes:

variant_id: Unique ID of the variant detected on
    the Technical Drawing. Refer to the documentation
    on Variants for details.

sectional_id: Unique ID of the sectional on which the
    Leader was detected. This allows you to associate
    the Leader to the SectionalThumbnail (should you
    have requested it).

leaders: List of Leaders that were found for the
    Variant on the Sectional.

Properties¶

• variant_id (string)

• sectional_id (string)

• leaders (array)

• Items: Refer to #/definitions/W24Leader.

Definitions¶

• W24LeaderLabel (object)

• blurb (string)

• W24Leader (object): Leaders indicate which location .

• leader_id (string)

• anchor_coordinates (array)

  • Items (array)

  • Items_0 (number)

  • Items_1 (number)

• text_coordinate (array)

  • Items_0 (number)

  • Items_1 (number)

• label: Refer to #/definitions/W24LeaderLabel.

• associated_measure_ids (array): Default: [].

  • Items (string)

  W24AskVariantMaterial¶

This ask requests the material of the individual variant. It will now only consider the material that is listed on the TitleBlock, but also consider material information that is found as text on the Canvas.

Attributes:

material_hint: If already know the material that "should"
    be indicated on the drawing, you are welcome to submit
    it here as hint. This will allow us to improve the
    accuracy of our algorithms. Feel free to use any material
    designation that is convenient.

Properties¶

• is_training (boolean): Default: False.

• material_hint (string)

Definitions¶

W24AskVariantMeasures¶

With this Ask you are requesting the complete list of all measures that were detected for the variant.

Attributes:

confidence_min: Werk24 calculates internal
    confidence scores for each measure. Depending
    on your use-case you might want to consider or
    discard low-confidence results. This parameter
    allows you to filter the results. The resulting
    W24Measure objects also contain a confidence score
    that allows you to filter even further.

Properties¶

• is_training (boolean): Default: False.

• confidence_min (number): Default: 0.2.

Definitions¶

W24AskVariantMeasuresResponse¶

Response object corresponding to the W24AskVariantMeasures ask.

Attributes:

variant_id: Unique ID of the variant detected on
    the Technical Drawing. Refer to the documentation
    on Variants for details.

sectional_id: Unique ID of the sectional on which the
    Measure was detected. This allows you to associate
    the Measure to the SectionalThumbnail (should you
    have requested it).

measures: List of Measures that were found for the
    Variant on the Sectional.

Properties¶

• variant_id (string)

• sectional_id (string)

• measures (array)

• Items: Refer to #/definitions/W24Measure.

Definitions¶

• W24BaseFeatureCoordinate (object): Coordinate point
  Attributes: x: x position normalized by the thumbnail's width
  y: y position normalized by the thumbnail's height.

• x (number)

• y (number)

• W24BaseFeaturePosition (object): Position of the Feature on the individual thumbnails normalized by the width and height of each thumbnail.
  Each features position is indicated as a list of coordinates. If the list only has two elements, you are dealing with a line. If it has four or more, you are looking at a polygon
  Attributes: page: Position of the Feature on the Page thumbnail
  sheet: Position of the Feature on the Sheet thumbnail
  sectional: Position of the Feature on the Sectional thumbnail.

• sheet (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• canvas (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• sectional (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

- W24SizeType (string): Enumeration class for W24 size types.
Attributes:¶

NOMINAL (str): Nominal size type. DIAMETER (str): Diameter size type. WIDTH_ACROSS_FLATS (str): Width across flats size type. Must be one of: ['NOMINAL', 'DIAMETER', 'SPHERICAL_DIAMETER', 'WIDTHS_ACROSS_FLATS', 'SQUARE'].

• W24UnitLength (string): Enum of the supported length units . Must be one of: ['METER', 'DECIMETER', 'CENTIMETER', 'MILLIMETER', 'FOOT', 'INCH', 'MICRO_INCH'].

- W24Size (object): Abstract Base Class for the Sizes.
Attributes:¶

blurb: A blurb for human consumption.
size_type: The type of size for deserialization.
nominal_size: The unit-less nominal size. The unit is attached to the parent object, which also defines the toleration.
unit: Unit of the measure if known. This should typically be inch or millimeter. In some cases it might be possible that the units are unknown.

• blurb (string)

• size_type: Refer to #/definitions/W24SizeType.

• nominal_size (number)

• unit: Refer to #/definitions/W24UnitLength.

• W24Tolerance (object): Abstract Base Class to cover the Tolerances.
  Attributes: blurb (str): String representation for human consumption
  toleration_type (W24SizeToleranceType): Toleration Type for deserialization.

• blurb (string)

• toleration_type (string)

• W24ThreadType (string): Enum for the individual thread types
  NOTE: UTS_COARSE, UTS_FINE, UTS_EXTRAFINE and UTS_SPECIAL as individual types will be deprecated. Their information individual threads_per_inch information will be stored in the corresponding variable. Must be one of: ['ISO_METRIC', 'WHITWORTH', 'UTS', 'UTS_COARSE', 'UTS_FINE', 'UTS_EXTRAFINE', 'UTS_SPECIAL'].

• W24ThreadHandedness (string): Enum describing the direction of the thread. Must be one of: ['LEFT', 'RIGHT'].

• W24ThreadMultiStart (object): Multi-Start Thread Information
  A common example of multi-start threads are the cap on a plastic water bottle. The cap will screw on quickly because a multi-start thread.
  Attributes:
  thread_lead (Decimal, optional): Thread lead for multiple starts
  number_of_starts (int): Number of intertwined threads running in parallel to one another.

• thread_lead (number)

• number_of_starts (integer): Default: 1.

• W24Thread (object): Abstract Base Class for all Threads
  Attributes: blurb (str): String representation of the thread for human consumption
  diameter (Decimal): Diameter of the thread
  diameter_preference: Not all Threads are made equal. The standardization bodies assign different preferences to the different thread diameters.
  unit (W24UnitLength): Length unit of the diameter. This allows you to differentiate between inch and millimeter (UTS or ISO METRIC). NOTE: Whitworth inch are not 2.54mm long! (for historic reasons). Use the whitworth_size if you need to have the Whitworth inches.
  thread_type: thread type to facilitate deserialization
  pitch: Pitch of the thread in mm. Normed range: 0.25 - 9mm The value will always be set - even if the pitch is give implicitly (e.g. M10c) or when the pitch is given in threads per inch. When the Pitch is ambiguous, this value be the median pitch
  threads_per_inch: Pitch and Threads per inch are interchangeable concepts. Depending on your geographic focus, the one or the other concept is more suitable. We convert ISO pitches to UTS threads per inch and vice versa, so that you do not have to handle the conversion.
  handedness: Left of right-handedness of the thread. This will be RIGHT unless explicitly described as LEFT in the drawing.
  length (Decimal, optional): Length of the Thread if specified on the label (e.g., M15x1x20). None otherwise. NOTE: If the thread length is not specified in the label, you can still obtain the information from the W24ThreadElement NOTE: If the thread label specifies both a thread length and a bore length, only the thread length will be included here. The bore length can be found in the W24MeasureElement.depth attribute.

• blurb (string)

• diameter (number)

• unit: Default: MILLIMETER.

• thread_type: Refer to #/definitions/W24ThreadType.

• pitch (number)

• threads_per_inch (number)

• handedness: Default: RIGHT.

• multi_start: Refer to #/definitions/W24ThreadMultiStart.

• length (number)

• W24UnitAngle (string): Enum of all the supported angle units
  NOTE: currently we are only supporting degrees. If you come across a drawing that uses GON, let us know, we love the concept! Must be one of: ['DEGREE'].

• W24Chamfer (object): Chamfer in degree.
  Attributes: blurb: String representation for human consumption
  angle: Chamfer angle in degrees
  unit: Angle Unit. Currently only degrees are supported.
  !!! note The chamfers can be tolerated. Future implementations will take this into account.

• blurb (string)

• angle (number)

• unit: Default: DEGREE.

• W24DepthThroughType (string): Through Type specified on ASME drawings. . Must be one of: ['THRU', 'THRU_ALL'].

• W24Depth (object): Depth object that describes the details of the depth of a drilling or thread
  Attributes: blurb: String for human consumption
  depth: Depth of the drilling or thread in the units of the parent object.

• blurb (string)

• depth (number)

• through_type: Refer to #/definitions/W24DepthThroughType.

• W24TestCriticality (string): An enumeration. Must be one of: ['CTD', 'CTF', 'CTP', 'CTQ', 'CTS'].

• W24TestDimension (object): Test Dimension attributes that can either be attached to a MeasureLabel or a GDTLabel
  Attributes: blurb: Blurb of the complete label for human consumption
  criticality: Some measures can be critical to Function, others critical to price. The TestDimensions sometimes highlight this with a shorthand (e.g., CTF)
  rate: Test rate as percentage. If a 100% inspection rate has been defined, rate will be Decimal('100'). If not defined, the rate will be None.

• blurb (string)

• criticality: Refer to #/definitions/W24TestCriticality.

• rate (number)

• W24MeasureLabel (object): Measure Label
  Attributes:
  blurb: String representation of the item for human consumption
  quantity: Quantity for spacings, e.g., (2x). Currently only the indicated measure will be detected and returned. Future implementation could detect the spacings and return individual measures for the respective spacings. When we implement this feature, we will add an attribute to the ASK, which allows you to control the behavior.
  size: Size of measure as referred to in the drawing. Sizes are always associated with units! This becomes important to remember when you are dealing with mixed-unit drawings (e.g., an adapter bolt that has an ISO thread and an UTC tapped hole). To avoid any loss of precision, we return the size in the unit that was indicated on the drawing.
  size_tolerance: Tolerance details. Default: General tolerances. By default we are referring to the general tolerances of the drawing. When you are also requesting the TitleBlock, we are attaching the applicable General Tolerances (assuming they were understood) to the measure. This will consider the nominal size of the measure. If the W24MeasureLabel describes a "Theoretically Exact Measure", i.e, the label is surrounded by a box, like: "[15]", the size_tolerance refers to a W24ToleranceTheoreticallyExact object (and is NOT None)
  unit: Length unit of the size. This information is only available when you request the TitleBlock as well; as only the title block will allow us to determine the geographic origin of the drawing.
  thread: Optional thread details. The thread details describe the complete thread description and follow the respective standards. In consequence, the thread diameter of an ISO-thread will be indicated in millimeter, while the thread diameter of an UTS thread will be in inch.
  chamfer: Optional Chamfer
  depth: Depth of the drilling or thread. Uses the same dimensions.

• blurb (string)

• quantity (integer): Default: 1.

• size: Refer to #/definitions/W24Size.

• size_tolerance: Default: {'blurb': '', 'toleration_type': 'GENERAL_TOLERANCES', 'standard': None, 'standard_class': None, 'deviation_lower': None, 'deviation_upper': None, 'tolerance_grade': None}.

• unit: Refer to #/definitions/W24UnitLength.

• thread: Refer to #/definitions/W24Thread.

• chamfer: Refer to #/definitions/W24Chamfer.

• depth: Refer to #/definitions/W24Depth.

• test_dimension: Refer to #/definitions/W24TestDimension.

• W24MeasureWarningType (string): List of all warnings that can be associated with the returned measures. Must be one of: ['UNCONVENTIONAL_TOLERANCE_ORDER', 'UNPROPORTIONAL'].

• W24MeasureWarning (object): Warnings are issued when something about the label or measure is not conforming with convention.

• warning_type: Refer to #/definitions/W24MeasureWarningType.

• W24Measure (object): Measure object
  Attributes:
  measure_id: Unique UUID4 identifier
  label: Measure Label
  warnings: List of Warnings that are associated with the measure. See W24MeasureWarning for details.
  confidence: Werk24 calculates an internal confidence score for each measure. Depending on your use-case, you might want to consider or discard low-confidence measures. This value allows you to do so. The value ranges from 0.0 to 1.0.

• position: Refer to #/definitions/W24BaseFeaturePosition.

• measure_id (string)

• label: Refer to #/definitions/W24MeasureLabel.

• warnings (array): Default: [].

  • Items: Refer to #/definitions/W24MeasureWarning.

• confidence (number): Default: 0.0.

W24AskVariantProcesses¶

Ask to receive the processes associated with the Variant.

Properties¶

• is_training (boolean): Default: False.

Definitions¶

W24AskVariantProcessesResponse¶

Response Model for the processes.

Attributes: processes (List[W24Process]): List of all the processes that were identified on the drawing.

Properties¶

• processes (array)

• Items: Refer to #/definitions/W24Process.

Definitions¶

• W24Process (object): Base Model for Processes.
  Attributes: blurb (str): Name of the process.
  process_type (str): Programmatic name of the process.
  process_category (List[str]): Categorization of the process. See DIN 8580 for details.

• blurb (string)

• process_type (string)

• process_category (array)

  • Items (string)

  W24AskVariantRadii¶

With this Ask you are requesting the list of all radii that were detected for the variant.

Properties¶

• is_training (boolean): Default: False.

Definitions¶

W24AskVariantRadiiResponse¶

Response object corresponding to the W24AskVariantRadii ask.

Attributes:

variant_id: Unique ID of the variant detected on
    the Technical Drawing. Refer to the documentation
    on Variants for details.

sectional_id: Unique ID of the sectional on which the
    Measure was detected. This allows you to associate
    the Measure to the SectionalThumbnail (should you
    have requested it).

radii: List of Radii that were found for the
    Variant on the Sectional.

Properties¶

• variant_id (string)

• sectional_id (string)

• radii (array)

• Items: Refer to #/definitions/W24Radius.

Definitions¶

• W24BaseFeatureCoordinate (object): Coordinate point
  Attributes: x: x position normalized by the thumbnail's width
  y: y position normalized by the thumbnail's height.

• x (number)

• y (number)

• W24BaseFeaturePosition (object): Position of the Feature on the individual thumbnails normalized by the width and height of each thumbnail.
  Each features position is indicated as a list of coordinates. If the list only has two elements, you are dealing with a line. If it has four or more, you are looking at a polygon
  Attributes: page: Position of the Feature on the Page thumbnail
  sheet: Position of the Feature on the Sheet thumbnail
  sectional: Position of the Feature on the Sectional thumbnail.

• sheet (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• canvas (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• sectional (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

- W24SizeType (string): Enumeration class for W24 size types.
Attributes:¶

NOMINAL (str): Nominal size type. DIAMETER (str): Diameter size type. WIDTH_ACROSS_FLATS (str): Width across flats size type. Must be one of: ['NOMINAL', 'DIAMETER', 'SPHERICAL_DIAMETER', 'WIDTHS_ACROSS_FLATS', 'SQUARE'].

• W24UnitLength (string): Enum of the supported length units . Must be one of: ['METER', 'DECIMETER', 'CENTIMETER', 'MILLIMETER', 'FOOT', 'INCH', 'MICRO_INCH'].

- W24Size (object): Abstract Base Class for the Sizes.
Attributes:¶

blurb: A blurb for human consumption.
size_type: The type of size for deserialization.
nominal_size: The unit-less nominal size. The unit is attached to the parent object, which also defines the toleration.
unit: Unit of the measure if known. This should typically be inch or millimeter. In some cases it might be possible that the units are unknown.

• blurb (string)

• size_type: Refer to #/definitions/W24SizeType.

• nominal_size (number)

• unit: Refer to #/definitions/W24UnitLength.

• W24Tolerance (object): Abstract Base Class to cover the Tolerances.
  Attributes: blurb (str): String representation for human consumption
  toleration_type (W24SizeToleranceType): Toleration Type for deserialization.

• blurb (string)

• toleration_type (string)

• W24RadiusLabel (object): Radius Label
  Attributes: blurb: String representation of the Radius for human consumption
  quantity: Quantity of the annotated radius, e.g., 2 x R4 returns quantity=2
  size: Size of the Radius as referred in the drawing.
  size_tolerance: Tolerance details of the Radius. Please keep in mind that Radii can carry special tolerances. If none are mentioned on the drawing, the general tolerances apply.
  unit: Length units of the size and size_tolerance. In most cases this will be be millimeter (METRIC) or inch (IMPERIAL) and be consistent for the complete drawing. Exceptions are very rare, but exist.

• blurb (string)

• quality (integer): Default: 1.

• size: Refer to #/definitions/W24Size.

• size_tolerance: Default: {'blurb': '', 'toleration_type': 'GENERAL_TOLERANCES', 'standard': None, 'standard_class': None, 'deviation_lower': None, 'deviation_upper': None, 'tolerance_grade': None}.

• unit: Refer to #/definitions/W24UnitLength.

• W24Radius (object): Radius Feature
  Attributes: radius_id: Unique UUID4 identifier. This can be used to provide automated feedback about customer changes.
  label: Label of the radius.
  confidence: Werk24 calcualtes an internal confidence score for reach radius. Depending on your use-case, you might want to consider or discard low-confidence radii. This value allows you to do so. The value ranges from 0.0 to 1.0.

• position: Refer to #/definitions/W24BaseFeaturePosition.

• radius_id (string)

• label: Refer to #/definitions/W24RadiusLabel.

• confidence (number)

W24AskVariantRoughnesses¶

With this Ask you are requesting the list of all roughnesses (surface symbols) that were detected for the variant.

Properties¶

• is_training (boolean): Default: False.

Definitions¶

W24AskVariantRoughnessesResponse¶

Response object corresponding to the W24AskVariantRoughnesses ask.

Attributes:

variant_id: Unique ID of the variant detected on
    the Technical Drawing. Refer to the documentation
    on Variants for details.

sectional_id: Unique ID of the sectional on which the
    Measure was detected. This allows you to associate
    the Measure to the SectionalThumbnail (should you
    have requested it).

roughnesses: List of Roughnesses that were found for the
    Variant on the Sectional.

Properties¶

• variant_id (string)

• sectional_id (string)

• roughnesses (array)

• Items: Refer to #/definitions/W24Roughness.

Definitions¶

• W24BaseFeatureCoordinate (object): Coordinate point
  Attributes: x: x position normalized by the thumbnail's width
  y: y position normalized by the thumbnail's height.

• x (number)

• y (number)

• W24BaseFeaturePosition (object): Position of the Feature on the individual thumbnails normalized by the width and height of each thumbnail.
  Each features position is indicated as a list of coordinates. If the list only has two elements, you are dealing with a line. If it has four or more, you are looking at a polygon
  Attributes: page: Position of the Feature on the Page thumbnail
  sheet: Position of the Feature on the Sheet thumbnail
  sectional: Position of the Feature on the Sectional thumbnail.

• sheet (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• canvas (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• sectional (array)

  • Items: Refer to #/definitions/W24BaseFeatureCoordinate.

• W24RoughnessStandard (string): Most standards that define the surface roughness use very similar symbols. However, the position of the fields varies.
  The standards listed here are understood and supported by the API.
  NOTE: the ISO 1302 standard exists in four different versions, these releases substantially modified the position and structure of the roughness symbols.
  NOTE: this list is not exhaustive, many countries have specified their own standards over the years. Do not hesitate to reach out if you wish us to implement another standard. Must be one of: ['ISO 1302:1978', 'ISO 1302:1992', 'ISO 1302:2002', 'ISO 21920-1:2021', 'ASME Y14.36-1978', 'ASME Y14.36M-1996', 'ASME Y14.36-2018'].

• W24RoughnessMaterialRemovalType (string): Most standard allow the designer to specify whether material removal is required or prohibited.
  By default both options are allowed. Must be one of: ['UNSPECIFIED', 'PROHIBITED', 'REQUIRED'].

• W24RoughnessDirectionOfLay (string): The lay of the roughness limits the manufacturing process and is sometimes required for the application. Must be one of: ['=', '⟂', 'X', 'M', 'C', 'R', 'P'].

• W24ManufacturingMethod (object): Manufacturing method specified on the drawing. Currently only the blurb is available.
  Attributes: blurb: Manufacturing method as specified on the drawing.

• blurb (string)

• W24RoughnessConditionType (string): Roughnesses can specify, the upper limit, the lower limit and the average. Must be one of: ['U', 'L', 'A'].

• W24RoughnessFilterType (string): When measuring the roughness, different filter types will result in different results. To reduce this source of ambiguity, the designer can specify the filter to be used.
  NOTE: this list is not exhaustive. If you need us to support another filter method, please reach out. Must be one of: ['G', 'RG', 'S', '"2RC"'].

• W24RoughnessParameter (string): Roughness Parameter that is specified.
  NOTE: this list is not exhaustive, but covers the most frequently used parameters. Must be one of: ['AA', 'CLA', 'PVA', 'RMS', 'Pa', 'PC', 'Pku', 'Pp', 'Pq', 'Psk', 'Pt', 'Pv', 'Py', 'Pz', 'Ra(DIN)', 'Ra(ISO)', 'Rc', 'Rku', 'Rp', 'Rq', 'Rsk', 'Rt', 'Rv', 'Ry', 'Rz', 'Wa', 'Wc', 'Wku', 'Wp', 'Wq', 'Wsk', 'Wt', 'Wv', 'Wy', 'Wz', 'N'].

• W24RoughnessEvaluationLengthType (string): An enumeration. Must be one of: ['LENGTH', 'LAMBDA_C_MULTIPLE'].

• W24UnitLength (string): Enum of the supported length units . Must be one of: ['METER', 'DECIMETER', 'CENTIMETER', 'MILLIMETER', 'FOOT', 'INCH', 'MICRO_INCH'].

• W24RoughnessEvaluationLength (object): For sophisticated application, the sample needs to be taken over a longer distances. This is specified the either the sampling length in millimeter (ISO 3012:1974, ISO 3012:1978, ISO 3012:1992) or as multiple of the main lambda (ISO 3012:2002 and ISO 3012:2021).
  
  Attributes: evaluation_length_type: Sampling length type that is specified by the applicable standard
  length: evaluation length in the specified units.
  length_unit: Millimeter for both the ISO and ASME standards
  lambda_c_multiple: multiple of the main cutoff lambda_c.

• evaluation_length_type: Refer to #/definitions/W24RoughnessEvaluationLengthType.

• length (number)

• length_unit: Refer to #/definitions/W24UnitLength.

• lambda_c_multiple (number)

• W24RoughnessAcceptanceCriterion (string): The designer can specify whether to apply the 16%-rule, the maximum- or medium- rule when deciding whether a surface complies with the specifications. Must be one of: ['16%', 'max', 'mean'].

• W24RoughnessGrade (object): ISO Roughness Grade
  Attributes: blurb: String representation for human consumption
  grade: Roughness Grade in the range N01 to N12. Valid values are N01, N0, N1, N2, N3, N4, N5, N6, N7, N8, N9, N10, N11, N12, N13, N14.

• blurb (string)

• grade (string)

• W24RoughnessCondition (object): Roughness Label
  Attributes: blurb: String representation of the Roughness for human consumption.
  condition_type: Roughness Side that is specified (upper or lower). We automatically determine this value depending on the standard and the position of the parameter
  filter_type: Filter Type to use when measuring the surface. When not specified on the drawing, we set the default value according to the applicable standard.
  lambda_s: Filter bandwidth microroughness cutoff lambda_s. When not specified, we determine the default value based on the standard and the value_limit.
  lambda_c: Filter bandwidth main cutoff lambda_c. When not specified, we determine the default value based on the standard and the value_limit.
  parameter: Parameter to be measured
  
  characteristic: Method of converting the 2D-measurement into a single number
  evaluation_length: For sophisticated application, the roughness needs to be evaluated over a longer distances. This is specified the either the sampling length in millimeter (ISO 3012:1974, ISO 3012:1978, ISO 3012:1992) or as multiple of the main lambda (ISO 3012:2002 and ISO 3012:2021).
  acceptance_criterion: Designers can specify what rule to apply when deciding whether a measured tolerance complies with the requirements
  value_limit: Specification limit
  roughness_grade: ISO roughness grade that the roughness specifications correspond to. IMPORTANT: this allows you to deal with all the standards in a simple way.

• blurb (string)

• condition_type: Refer to #/definitions/W24RoughnessConditionType.

• filter_type: Refer to #/definitions/W24RoughnessFilterType.

• lambda_s (number)

• lambda_c (number)

• parameter: Refer to #/definitions/W24RoughnessParameter.

• evaluation_length: Refer to #/definitions/W24RoughnessEvaluationLength.

• acceptance_criterion: Refer to #/definitions/W24RoughnessAcceptanceCriterion.

• value (number)

• roughness_grade: Refer to #/definitions/W24RoughnessGrade.

• W24UnitSystem (string): Unit System that is used for a certain feature . Must be one of: ['METRIC', 'IMPERIAL'].

• W24RoughnessWaviness (object): Roughness Waviness as defined in the ASME-Y14-36
  Attributes: waviness_height: Waviness height in inch waviness_width: Waviness width in inch.

• waviness_height (number)

• waviness_width (number)

• W24RoughnessLabel (object): Roughness Label
  Attributes: blurb: String for human consumption
  blurb_html: HTML for human consumption. The complex structure of the symbol makes this necessary.
  standard : Standard in which the Roughness Symbol is written NOTE: there are multiple standards that are in use
  machining_allowance: Machining Allowance in millimeter of micro-inch. See the unit attribute.
  material_removal_type: The MaterialRemovalType specifies whether material must / must not be removed.
  applies_all_around: Boolean value that specifies whether the roughness applies to all surfaces around
  direction_of_lay: The lay of the roughness limits the manufacturing process and is sometimes required for the application.
  manufacturing_method: Method by which to achieve the roughness
  conditions: Roughness conditions
  unit_system: Unit system that is used for the roughness. We are not using the explicit units as the different attributes have different units (e.g, micro and nano meters)
  waviness: Waviness defined in ASME standards.

• blurb (string)

• blurb_html (string)

• standard: Refer to #/definitions/W24RoughnessStandard.

• machining_allowance (number)

• material_removal_type: Refer to #/definitions/W24RoughnessMaterialRemovalType.

• applies_all_around (boolean)

• direction_of_lay: Refer to #/definitions/W24RoughnessDirectionOfLay.

• manufacturing_method: Refer to #/definitions/W24ManufacturingMethod.

• conditions (array)

  • Items: Refer to #/definitions/W24RoughnessCondition.

• unit_system: Refer to #/definitions/W24UnitSystem.

• waviness: Refer to #/definitions/W24RoughnessWaviness.

• W24Roughness (object): Roughness object
  Attributes: roughness_id: Unique UUID4 identifier
  label: RoughnessLabel.

• position: Refer to #/definitions/W24BaseFeaturePosition.

• roughness_id (string)

• label: Refer to #/definitions/W24RoughnessLabel.

W24AskVariantThreadElements¶

Ask object to obtain the thread elements

Properties¶

• is_training (boolean): Default: False.

Definitions¶

W24AskVariantThreadElementsResponse¶

Response object corresponding to the W24AskVariantThreadElements

Attributes:

variant_id (UUID4): Unique ID of the variant detected on the
    Technical Drawing. Refer to the documentation on Variants
    for details.

Properties¶

• variant_id (string)

• sectional_id (string)

• thread_elements (array)

• Items: Refer to #/definitions/W24ThreadElement.

Definitions¶

• W24Gender (string): Enum for the thread gender . Must be one of: ['MALE', 'FEMALE'].

• W24UnitLength (string): Enum of the supported length units . Must be one of: ['METER', 'DECIMETER', 'CENTIMETER', 'MILLIMETER', 'FOOT', 'INCH', 'MICRO_INCH'].

• W24ThreadType (string): Enum for the individual thread types
  NOTE: UTS_COARSE, UTS_FINE, UTS_EXTRAFINE and UTS_SPECIAL as individual types will be deprecated. Their information individual threads_per_inch information will be stored in the corresponding variable. Must be one of: ['ISO_METRIC', 'WHITWORTH', 'UTS', 'UTS_COARSE', 'UTS_FINE', 'UTS_EXTRAFINE', 'UTS_SPECIAL'].

• W24ThreadHandedness (string): Enum describing the direction of the thread. Must be one of: ['LEFT', 'RIGHT'].

• W24ThreadMultiStart (object): Multi-Start Thread Information
  A common example of multi-start threads are the cap on a plastic water bottle. The cap will screw on quickly because a multi-start thread.
  Attributes:
  thread_lead (Decimal, optional): Thread lead for multiple starts
  number_of_starts (int): Number of intertwined threads running in parallel to one another.

• thread_lead (number)

• number_of_starts (integer): Default: 1.

• W24Thread (object): Abstract Base Class for all Threads
  Attributes: blurb (str): String representation of the thread for human consumption
  diameter (Decimal): Diameter of the thread
  diameter_preference: Not all Threads are made equal. The standardization bodies assign different preferences to the different thread diameters.
  unit (W24UnitLength): Length unit of the diameter. This allows you to differentiate between inch and millimeter (UTS or ISO METRIC). NOTE: Whitworth inch are not 2.54mm long! (for historic reasons). Use the whitworth_size if you need to have the Whitworth inches.
  thread_type: thread type to facilitate deserialization
  pitch: Pitch of the thread in mm. Normed range: 0.25 - 9mm The value will always be set - even if the pitch is give implicitly (e.g. M10c) or when the pitch is given in threads per inch. When the Pitch is ambiguous, this value be the median pitch
  threads_per_inch: Pitch and Threads per inch are interchangeable concepts. Depending on your geographic focus, the one or the other concept is more suitable. We convert ISO pitches to UTS threads per inch and vice versa, so that you do not have to handle the conversion.
  handedness: Left of right-handedness of the thread. This will be RIGHT unless explicitly described as LEFT in the drawing.
  length (Decimal, optional): Length of the Thread if specified on the label (e.g., M15x1x20). None otherwise. NOTE: If the thread length is not specified in the label, you can still obtain the information from the W24ThreadElement NOTE: If the thread label specifies both a thread length and a bore length, only the thread length will be included here. The bore length can be found in the W24MeasureElement.depth attribute.

• blurb (string)

• diameter (number)

• unit: Default: MILLIMETER.

• thread_type: Refer to #/definitions/W24ThreadType.

• pitch (number)

• threads_per_inch (number)

• handedness: Default: RIGHT.

• multi_start: Refer to #/definitions/W24ThreadMultiStart.

• length (number)

• W24ThreadElement (object): Characterization of a Thread Element
  Attributes: quantity (int): Number of equivalent elements that are indicated by one label (e.g., 3xM5).
  gender: Gender (male or female) of the thread feature. This is determined by checking whether the thread is located on the outer contour of the part or inside the part. When the outer contour is unavailable (e.g., in detail drawings), the gender is set to None.
  length: Length of the stud corresponding to the thread. Please keep in mind that a thus can contain multiple threads with different lengths. This is considered in the threads themselves. NOTE: we are using the word length here to differentiate it from the thread depth which describes the difference between the major and minor radii.
  threads (List[W24Thread]): List of Threads that are positioned on the ThreadElements. This is a list to support multi-threads
  NOTE: Tapers are currently not considered
  NOTE: Future implementations might also consider the inclination in two angles relative to the front view.

• quantity (integer)

• gender: Refer to #/definitions/W24Gender.

• length (number)

• threads (array)

  • Items: Refer to #/definitions/W24Thread.