PUT OData/DocCompressors({DocIDCompressors})

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 79c34bbe-c1e6-4e80-965c-82b8efb01d51

URI Parameters

Name Description Type Additional information
key

The key of the entity to update

integer

Required

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

Body Parameters

The updates to be applied to the entity

docCompressor

application/json, text/json:
{
  "DocIDCompressors": 1,
  "UserID": "sample string 2",
  "CompressorID": 3,
  "docDate": "2024-11-13T23:27:21.1860629",
  "SuctionPressure": 1.1,
  "SuctionTemperature": 1.1,
  "DischargePressure": 1.1,
  "DischargeTemperature": 1.1,
  "RPM": 1.1,
  "RunTime": 1.1,
  "AmbientTemp": 1.1,
  "InterStage1Press": 1.1,
  "InterStage2Press": 1.1,
  "InterStage3Press": 1.1,
  "InterStage4Press": 1.1,
  "InterStage1Temp": 1.1,
  "InterStage2Temp": 1.1,
  "InterStage3Temp": 1.1,
  "InterStage4Temp": 1.1,
  "OilPressure": 1.1,
  "OilTemp": 1.1,
  "WaterTemp": 1.1,
  "Stamp": "2024-11-13T23:27:21.1860629",
  "Notes": "sample string 6",
  "InputByID": "sample string 7",
  "DocSourceCode": 1
}

Response Information

Success Response

docCompressor

application/json, text/json:
{
  "DocIDCompressors": 1,
  "UserID": "sample string 2",
  "CompressorID": 3,
  "docDate": "2024-11-13T23:27:21.1870713",
  "SuctionPressure": 1.1,
  "SuctionTemperature": 1.1,
  "DischargePressure": 1.1,
  "DischargeTemperature": 1.1,
  "RPM": 1.1,
  "RunTime": 1.1,
  "AmbientTemp": 1.1,
  "InterStage1Press": 1.1,
  "InterStage2Press": 1.1,
  "InterStage3Press": 1.1,
  "InterStage4Press": 1.1,
  "InterStage1Temp": 1.1,
  "InterStage2Temp": 1.1,
  "InterStage3Temp": 1.1,
  "InterStage4Temp": 1.1,
  "OilPressure": 1.1,
  "OilTemp": 1.1,
  "WaterTemp": 1.1,
  "Stamp": "2024-11-13T23:27:21.1870713",
  "Notes": "sample string 6",
  "InputByID": "sample string 7",
  "DocSourceCode": 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"
    }
  }
}