PUT WellPurposes

Back to endpoints

PUT WellPurposes

Updates the given well purpose.

Request Information

URI Parameters

None.

Body Parameters

Well purpose to be updated

WellPurpose

Name	Type	Additional information
WellPurposeId	globally unique identifier	None.
Asset	Asset	None.
EffectiveDate	date	None.
WellPurposeType	WellPurposeType	None.
SourceSystemId	string	None.
CompanyId	globally unique identifier	None.
CreateDate	date	None.
CreateUser	string	None.
LastModifiedDate	date	None.
LastModifiedUser	string	None.

Request Formats

application/json, text/json

Sample:

{
  "WellPurposeId": "c8da5dc3-1620-431d-8c55-2b165e1b740b",
  "Asset": {
    "AssetId": "466a040d-6907-421d-bac0-3c494b356776",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "DisplayOrder": 1,
    "AssetType": {
      "AssetTypeId": "58dd9cd8-a0f4-4ec1-b3ae-78e22020d77f",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "IsWell": true,
      "DisplayColor": "sample string 4",
      "SourceSystemId": "sample string 5",
      "CompanyId": "a71078bc-bb8e-4858-ac3d-099526a3121e",
      "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
      "LastModifiedUser": "sample string 8"
    },
    "AssetGroup": {
      "AssetGroupId": "7289d41b-564e-4986-b272-b99d16378205",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ParentGroup": null,
      "DisplayOrder": 1,
      "FormValueNeededDate": "2025-12-17T04:31:57.5732427-08:00",
      "MeasurementValueNeededDate": "2025-12-17T04:31:57.5732427-08:00",
      "SourceSystemId": "sample string 3",
      "CompanyId": "285a88e4-e5e7-4b4c-b203-3b97cd8bf6df",
      "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
      "LastModifiedUser": "sample string 6"
    },
    "ParentAsset": null,
    "Location": "sample string 3",
    "Barcode": {
      "Format": 0,
      "Code": "sample string 1"
    },
    "State": {
      "StateId": "621cea20-a633-4335-a24b-5931b9161e1a",
      "EffectiveDate": "2025-12-17T04:31:57.5732427-08:00",
      "StateType": {
        "StateTypeId": "3335e33f-ea0c-4692-a636-16ce62f510c3",
        "Name": "sample string 1",
        "IsOperational": true,
        "AssetType": {
          "AssetTypeId": "58dd9cd8-a0f4-4ec1-b3ae-78e22020d77f",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "a71078bc-bb8e-4858-ac3d-099526a3121e",
          "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
          "LastModifiedUser": "sample string 8"
        },
        "SourceSystemId": "sample string 3",
        "CompanyId": "1c1c7be7-3004-428a-bd07-4b3e7771f166",
        "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
        "LastModifiedUser": "sample string 6"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "b27a9911-12ac-41ac-aee8-2beefd6a21ac",
      "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
      "LastModifiedUser": "sample string 4"
    },
    "Status": {
      "StatusId": "58a6d04b-caaf-4e00-b2a2-a78e0aee7efe",
      "EffectiveDate": "2025-12-17T04:31:57.5732427-08:00",
      "StatusType": {
        "StatusTypeId": "04650189-9de4-4c62-a4eb-d85b20e8cc9c",
        "Name": "sample string 1",
        "IsProducing": true,
        "IsInjecting": true,
        "AssetType": {
          "AssetTypeId": "58dd9cd8-a0f4-4ec1-b3ae-78e22020d77f",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "a71078bc-bb8e-4858-ac3d-099526a3121e",
          "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
          "LastModifiedUser": "sample string 8"
        },
        "SourceSystemId": "sample string 4",
        "CompanyId": "54f005b4-bf2a-486d-bd5b-2aa1f0622bae",
        "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
        "LastModifiedUser": "sample string 7"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "8d8eafe5-098e-47f4-982a-672610c93f67",
      "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
      "LastModifiedUser": "sample string 4"
    },
    "FormValueNeededDate": "2025-12-17T04:31:57.5732427-08:00",
    "MeasurementValueNeededDate": "2025-12-17T04:31:57.5732427-08:00",
    "HasChildren": true,
    "SourceSystemId": "sample string 5",
    "CompanyId": "85e85ad2-61bf-41b9-bb0e-f8370498c607",
    "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
    "LastModifiedUser": "sample string 8"
  },
  "EffectiveDate": "2025-12-17T04:31:57.5732427-08:00",
  "WellPurposeType": {
    "WellPurposeTypeId": "8eed7991-5eee-4425-9d55-83e455c78f67",
    "IsProducer": true,
    "IsInjector": true,
    "Name": "sample string 3",
    "SourceSystemId": "sample string 4",
    "CompanyId": "8c4226fd-85ce-49c2-8f39-2a0b338fa9dd",
    "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
    "CreateUser": "sample string 6",
    "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
    "LastModifiedUser": "sample string 7"
  },
  "SourceSystemId": "sample string 1",
  "CompanyId": "dd3268eb-b065-485a-a5e5-20a36ed2f80e",
  "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
  "CreateUser": "sample string 3",
  "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
  "LastModifiedUser": "sample string 4"
}

Response Information

Resource Description

On success, the updated well purpose.

Name	Type	Additional information
Data	WellPurpose	None.
Total	integer	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "WellPurposeId": "e3ed9b1d-da5a-4304-b8e8-352e346d0b8f",
    "Asset": {
      "AssetId": "e9013f16-2a0d-4239-9838-0bda266d3314",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayOrder": 1,
      "AssetType": {
        "AssetTypeId": "92e10493-6329-474e-874c-a9027f0b0d8b",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "1875e0ff-0a93-4429-973d-e42c08d18ecd",
        "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
        "LastModifiedUser": "sample string 8"
      },
      "AssetGroup": {
        "AssetGroupId": "0b8f26a9-eae6-456b-87ac-ddc812ef818c",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ParentGroup": null,
        "DisplayOrder": 1,
        "FormValueNeededDate": "2025-12-17T04:31:57.5732427-08:00",
        "MeasurementValueNeededDate": "2025-12-17T04:31:57.5732427-08:00",
        "SourceSystemId": "sample string 3",
        "CompanyId": "335374f8-a549-4f02-9904-0efd7b59bff6",
        "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
        "LastModifiedUser": "sample string 6"
      },
      "ParentAsset": null,
      "Location": "sample string 3",
      "Barcode": {
        "Format": 0,
        "Code": "sample string 1"
      },
      "State": {
        "StateId": "60619617-5d7f-43db-9fd4-472dd45f8575",
        "EffectiveDate": "2025-12-17T04:31:57.5732427-08:00",
        "StateType": {
          "StateTypeId": "20aa6369-b70f-459b-b20e-b288e4da85bc",
          "Name": "sample string 1",
          "IsOperational": true,
          "AssetType": {
            "AssetTypeId": "92e10493-6329-474e-874c-a9027f0b0d8b",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "1875e0ff-0a93-4429-973d-e42c08d18ecd",
            "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 3",
          "CompanyId": "c89ae605-0d1f-4307-bd1d-1b2c5f1ae706",
          "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
          "LastModifiedUser": "sample string 6"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "ce71dfbd-9e13-46eb-816a-a31d3a50d51e",
        "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "Status": {
        "StatusId": "6cf6f4b3-a239-4de3-9b29-8e6984ebd710",
        "EffectiveDate": "2025-12-17T04:31:57.5732427-08:00",
        "StatusType": {
          "StatusTypeId": "dcc40d59-4af1-433f-96cf-018a4f2dd362",
          "Name": "sample string 1",
          "IsProducing": true,
          "IsInjecting": true,
          "AssetType": {
            "AssetTypeId": "92e10493-6329-474e-874c-a9027f0b0d8b",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "1875e0ff-0a93-4429-973d-e42c08d18ecd",
            "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 4",
          "CompanyId": "447b4adc-9c5c-485c-8e92-cf0add475885",
          "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "d9219f36-26e7-4964-b5fa-4cedaccef1c4",
        "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "FormValueNeededDate": "2025-12-17T04:31:57.5732427-08:00",
      "MeasurementValueNeededDate": "2025-12-17T04:31:57.5732427-08:00",
      "HasChildren": true,
      "SourceSystemId": "sample string 5",
      "CompanyId": "2fff22ab-0cdc-407a-971c-c972739a364f",
      "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
      "LastModifiedUser": "sample string 8"
    },
    "EffectiveDate": "2025-12-17T04:31:57.5732427-08:00",
    "WellPurposeType": {
      "WellPurposeTypeId": "627748af-8548-48df-bf85-e17c98eb5808",
      "IsProducer": true,
      "IsInjector": true,
      "Name": "sample string 3",
      "SourceSystemId": "sample string 4",
      "CompanyId": "23d0ac02-3fc0-4498-bfba-34cc98c024d4",
      "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
      "CreateUser": "sample string 6",
      "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
      "LastModifiedUser": "sample string 7"
    },
    "SourceSystemId": "sample string 1",
    "CompanyId": "5e13dcb1-dfa4-4317-8f6e-2b1ccf6433b1",
    "CreateDate": "2025-12-17T04:31:57.5732427-08:00",
    "CreateUser": "sample string 3",
    "LastModifiedDate": "2025-12-17T04:31:57.5732427-08:00",
    "LastModifiedUser": "sample string 4"
  },
  "Total": 1,
  "Message": "sample string 1"
}