Skip to main content

Edit Packer

Update an existing packer within a section. All fields are optional — include only what you want to change. You can also reposition the packer within its section by supplying index.

The path parameter packerid is the zero-based index of the packer within the section's packers array, not a UUID.

PATCH/api/v1/designs/{designid}/well-schematic/sections/{sectionid}/packers/{packerid}

Update fields on an existing packer within a well-schematic section

Path Parameters

NameTypeRequiredDescription
designidstring (UUID)The UUID of the design
sectionidstring (UUID)The UUID of the parent section
packeridstring (numeric index)Zero-based position of the packer within the section's packers array

Headers

NameValueDescription
apikeyYOUR_API_KEYYour API authentication key
Content-Typeapplication/jsonMust be application/json

Request Body

Partial packer fields — at least one

Request body fields

All fields are optional, but at least one must be present.

FieldTypeDescription
settingMechanismstringOne of Mechanical, Hydraulic, Hydrostatic
settingDepthMDRKBstringSetting depth, e.g. "3360|m"
pickupWeightstringPickup weight (mutually exclusive with slackoffWeight)
slackoffWeightstringSlack-off weight (mutually exclusive with pickupWeight)
surfaceSetPressurestringSurface set pressure (required for Hydraulic / Hydrostatic)
plugDepthMDRKBstringPlug depth (required for Hydraulic)
namestringDisplay name
sealBoreIDstringSeal-bore inner diameter
allowedMovementUpstringAllowed upward movement
allowedMovementDownstringAllowed downward movement
movementUpRestrictedbooleanWhether upward movement is restricted
movementDownRestrictedbooleanWhether downward movement is restricted
envelopeobjectPacker envelope (see Create Packer)
indexnumberNew zero-based position within the section's packers array

See Create Packer for the full field reference and conditional requirements.

Notes

  • packerid is the index, not a UUID — after a delete or insert the indices may shift
  • Omitting a field leaves its existing value untouched
  • All measurements must be unit-encoded strings, e.g. "3360\|m", "380\|bar"
  • Audit-log entries record the diff between the previous and updated packer