PUT OData/DocPlungerLifts({DocIDPlungerLift})

Updates an entity based on the provided values (all fields will be updated)

Request Information

Header Parameters

Header Name Description Type Additional information
Accept Mime Type

The accept header used to specify the acceptable response mime type

 string

Optional
Authorization Scheme

The authorization method (should always be Basic)

 string

Required
Security Token

The security token obtained by successfully authenticating a user with the Account API

 globally unique identifier

Required
Accept: application/json
Authorization: Basic 38da62b6-ecde-432f-9a0e-d8b87c22086e

URI Parameters

Name Description Type Additional information
key

The key of the entity to update

 integer

Required
https://apps.fielddirect.com/DataServices/OData/DocPlungerLifts(1)

Body Parameters

The updates to be applied to the entity

docPlungerLift

application/json, text/json: 
{
  "DocIDPlungerLift": 1,
  "PlungerLiftID": 2,
  "UserID": "sample string 3",
  "docDate": "2025-10-30T08:02:17.6540471",
  "InitCasingPress": 1.1,
  "FinalCasingPress": 1.1,
  "InitFlowPress": 1.1,
  "FinalFlowPress": 1.1,
  "InitShutInPress": 1.1,
  "FinalShutInPress": 1.1,
  "ShutInTubingPress": 1.1,
  "ShutInCasingPress": 1.1,
  "ShutInTime": 1.1,
  "VentTime": 1.1,
  "FlowTime": 1.1,
  "AfterFlowTime": 1.1,
  "PlungerTravelTime": 1.1,
  "Cycles": 1.1,
  "Arrivals": 1.1,
  "VentGas": 1.1,
  "Delay": 1.1,
  "DaysInHole": 1,
  "Inspected": true,
  "Stamp": "2025-10-30T08:02:17.6540471",
  "Notes": "sample string 6",
  "InputByID": "sample string 7",
  "DocSourceCode": 1,
  "PlungerSize": 1.1,
  "PlungerTypeID": 1
}

Response Information

Success Response

docPlungerLift

application/json, text/json: 
{
  "DocIDPlungerLift": 1,
  "PlungerLiftID": 2,
  "UserID": "sample string 3",
  "docDate": "2025-10-30T08:02:17.6540471",
  "InitCasingPress": 1.1,
  "FinalCasingPress": 1.1,
  "InitFlowPress": 1.1,
  "FinalFlowPress": 1.1,
  "InitShutInPress": 1.1,
  "FinalShutInPress": 1.1,
  "ShutInTubingPress": 1.1,
  "ShutInCasingPress": 1.1,
  "ShutInTime": 1.1,
  "VentTime": 1.1,
  "FlowTime": 1.1,
  "AfterFlowTime": 1.1,
  "PlungerTravelTime": 1.1,
  "Cycles": 1.1,
  "Arrivals": 1.1,
  "VentGas": 1.1,
  "Delay": 1.1,
  "DaysInHole": 1,
  "Inspected": true,
  "Stamp": "2025-10-30T08:02:17.6540471",
  "Notes": "sample string 6",
  "InputByID": "sample string 7",
  "DocSourceCode": 1,
  "PlungerSize": 1.1,
  "PlungerTypeID": 1
}

Error Response

An error response containing the details about a failed api request

ErrorResponse

application/json, text/json: 
{
  "error": {
    "batcherror": {
      "operationindex": 1,
      "requestindex": 2
    },
    "code": "UnknownError",
    "innererror": {
      "innererror": {
        "message": {
          "lang": "en-US",
          "value": "sample string 3"
        },
        "type": "sample string 5",
        "trace": "sample string 4"
      },
      "message": {
        "lang": "en-US",
        "value": "sample string 6"
      },
      "type": "sample string 8",
      "trace": "sample string 7"
    },
    "message": {
      "lang": "en-US",
      "value": "sample string 9"
    }
  }
}