Sign in
pages

Update Page

Merge-update a page's sheet_number / sheet_title (e.g. user rename).

Only the fields present in the PATCH body are written, each stamped source='user' so a later Step-3 auto re-run won't overwrite the edit.

patch/api/v1/pages/{page_id}

Path parameters

page_idstring uuid required

Request body

sheet_numberstring nullable
sheet_titlestring nullable

Response

Successful Response

idstring uuid required
drawing_idstring uuid required
page_numberinteger required
sheet_numberstring nullable
sheet_titlestring nullable
widthstring required
heightstring required
view_x0number nullable required
view_y0number nullable required
view_x1number nullable required
view_y1number nullable required
user_unitnumber required
rotateinteger required
scalestring nullable
scale_ratiostring nullable
scale_source'autoset' | 'user' | 'import' nullable
syntheticboolean
scale_read_countinteger
has_takeoffboolean required
has_noteboolean required
markup_countinteger required
open_markup_countinteger required
current_extraction_idstring uuid nullable
sheet_number_source'vlm' | 'user' nullable
sheet_title_source'vlm' | 'user' nullable
text_element_countinteger

Changes

No recorded changes to this endpoint across all 1 revision of this API.