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
| Name | Type | Required | Description |
|---|---|---|---|
designid | string (UUID) | ✓ | The UUID of the design |
sectionid | string (UUID) | ✓ | The UUID of the parent section |
packerid | string (numeric index) | ✓ | Zero-based position of the packer within the section's packers array |
Headers
| Name | Value | Description |
|---|---|---|
apikey | YOUR_API_KEY | Your API authentication key |
Content-Type | application/json | Must 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.
| Field | Type | Description |
|---|---|---|
settingMechanism | string | One of Mechanical, Hydraulic, Hydrostatic |
settingDepthMDRKB | string | Setting depth, e.g. "3360|m" |
pickupWeight | string | Pickup weight (mutually exclusive with slackoffWeight) |
slackoffWeight | string | Slack-off weight (mutually exclusive with pickupWeight) |
surfaceSetPressure | string | Surface set pressure (required for Hydraulic / Hydrostatic) |
plugDepthMDRKB | string | Plug depth (required for Hydraulic) |
name | string | Display name |
sealBoreID | string | Seal-bore inner diameter |
allowedMovementUp | string | Allowed upward movement |
allowedMovementDown | string | Allowed downward movement |
movementUpRestricted | boolean | Whether upward movement is restricted |
movementDownRestricted | boolean | Whether downward movement is restricted |
envelope | object | Packer envelope (see Create Packer) |
index | number | New zero-based position within the section's packers array |
See Create Packer for the full field reference and conditional requirements.
Notes
packeridis 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