Create Packer
Add a packer to a section of a well schematic. Packers are not allowed on OpenHole sections — supplying one returns 409 Conflict.
A packer is defined by its setting mechanism (Mechanical, Hydraulic, or Hydrostatic), its setting depth, and a setting condition (exactly one of pickupWeight or slackoffWeight). Additional fields are required depending on the setting mechanism.
POST/api/v1/designs/{designid}/well-schematic/sections/{sectionid}/packers
Add a packer to 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 section to add the packer to |
Headers
| Name | Value | Description |
|---|---|---|
apikey | YOUR_API_KEY | Your API authentication key |
Content-Type | application/json | Must be application/json |
Request Body
Packer definition with setting mechanism, depth, and condition
Packer fields
| Field | Type | Required | Description |
|---|---|---|---|
settingMechanism | string | Yes | One of Mechanical, Hydraulic, Hydrostatic |
settingDepthMDRKB | string | Yes | Setting depth, e.g. "3350|m" |
pickupWeight | string | Conditional | Pickup weight, e.g. "10|tonnes" |
slackoffWeight | string | Conditional | Slack-off weight |
surfaceSetPressure | string | Required for Hydraulic and Hydrostatic | Surface set pressure, e.g. "350|bar" |
plugDepthMDRKB | string | Required for Hydraulic | Plug depth, e.g. "3360|m" |
name | string | No | Display name |
sealBoreID | string | No | Seal-bore inner diameter |
allowedMovementUp | string | No | Allowed upward movement |
allowedMovementDown | string | No | Allowed downward movement |
movementUpRestricted | boolean | No | Whether upward movement is restricted |
movementDownRestricted | boolean | No | Whether downward movement is restricted |
envelope | object | No | Packer envelope (see below) |
index | number | No | Zero-based position within the section's packers array. Omit to append. |
id | string (UUID) | No | Pre-assigned packer identifier |
Exactly one of pickupWeight or slackoffWeight must be supplied — never both.
Conditional requirements
| Setting mechanism | Additional required fields |
|---|---|
Mechanical | None |
Hydraulic | surfaceSetPressure, plugDepthMDRKB |
Hydrostatic | surfaceSetPressure |
Envelope object
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Library or Custom |
name | string | Required when type is Library | Value must exist in the Packer Envelope library |
measurementSet | object | Required when type is Custom | Force/pressure measurement set |
id | string (UUID) | No | Pre-assigned envelope identifier |
The measurementSet is a { headers, values } table with two headers — one for force and one for pressure.
Notes
- Packers are not allowed in
OpenHolesections - All measurements must be unit-encoded strings, e.g.
"3350\|m","350\|bar","10\|tonnes" - Audit-log entries are written for every packer creation