GET WellPurposes?wellPurposeId={wellPurposeId}

Retrieves a well purpose by its Id.
Request Information

URI Parameters

Name	Description	Type	Additional information
wellPurposeId	Id of the well purpose	globally unique identifier	Required
Body Parameters

None.
Response Information

Resource Description

On success, the well purpose.
Name	Type	Additional information
Data	WellPurpose	None.
Total	integer	None.
Message	string	None.
Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "WellPurposeId": "ce068b5e-53c8-44f3-bc02-58811ccbccc6",
    "Asset": {
      "AssetId": "479c9d0e-efce-4c4c-9925-df09aed90c7c",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayOrder": 1,
      "AssetType": {
        "AssetTypeId": "3fd4ab55-510f-4424-8254-7b69498d0823",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "c4afedf2-2c25-4d57-b342-560d038d6deb",
        "CreateDate": "2025-07-30T23:28:27.94862-07:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2025-07-30T23:28:27.94862-07:00",
        "LastModifiedUser": "sample string 8"
      },
      "AssetGroup": {
        "AssetGroupId": "cad36366-f849-407b-bd5a-73fb20c280b9",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ParentGroup": null,
        "DisplayOrder": 1,
        "FormValueNeededDate": "2025-07-30T23:28:27.94862-07:00",
        "MeasurementValueNeededDate": "2025-07-30T23:28:27.94862-07:00",
        "SourceSystemId": "sample string 3",
        "CompanyId": "29a74d43-8f78-41e2-a7d9-21d21565f249",
        "CreateDate": "2025-07-30T23:28:27.94862-07:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2025-07-30T23:28:27.94862-07:00",
        "LastModifiedUser": "sample string 6"
      },
      "ParentAsset": null,
      "Location": "sample string 3",
      "Barcode": {
        "Format": 0,
        "Code": "sample string 1"
      },
      "State": {
        "StateId": "2ed5ed19-dbcc-487c-a887-a5bfe6944fd7",
        "EffectiveDate": "2025-07-30T23:28:27.94862-07:00",
        "StateType": {
          "StateTypeId": "c3d4a77a-e6a5-4270-b02d-4d186bba98a0",
          "Name": "sample string 1",
          "IsOperational": true,
          "AssetType": {
            "AssetTypeId": "3fd4ab55-510f-4424-8254-7b69498d0823",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "c4afedf2-2c25-4d57-b342-560d038d6deb",
            "CreateDate": "2025-07-30T23:28:27.94862-07:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2025-07-30T23:28:27.94862-07:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 3",
          "CompanyId": "b85f6796-f816-4a75-94ca-d1c6aef0c0d8",
          "CreateDate": "2025-07-30T23:28:27.94862-07:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2025-07-30T23:28:27.94862-07:00",
          "LastModifiedUser": "sample string 6"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "5ed684d2-382e-4731-b765-b44c0aef2ffe",
        "CreateDate": "2025-07-30T23:28:27.94862-07:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2025-07-30T23:28:27.94862-07:00",
        "LastModifiedUser": "sample string 4"
      },
      "Status": {
        "StatusId": "6fbd47fe-539d-4fce-afa2-e191b361bdc2",
        "EffectiveDate": "2025-07-30T23:28:27.94862-07:00",
        "StatusType": {
          "StatusTypeId": "18ffdcf6-523c-4ea9-815f-c2f2a9d6cb35",
          "Name": "sample string 1",
          "IsProducing": true,
          "IsInjecting": true,
          "AssetType": {
            "AssetTypeId": "3fd4ab55-510f-4424-8254-7b69498d0823",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "c4afedf2-2c25-4d57-b342-560d038d6deb",
            "CreateDate": "2025-07-30T23:28:27.94862-07:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2025-07-30T23:28:27.94862-07:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 4",
          "CompanyId": "1ef5626b-fe48-4f26-803d-8f7fa649a5c3",
          "CreateDate": "2025-07-30T23:28:27.94862-07:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2025-07-30T23:28:27.94862-07:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "defcb3e2-a68c-4ec8-abcc-f6249b8330ce",
        "CreateDate": "2025-07-30T23:28:27.94862-07:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2025-07-30T23:28:27.94862-07:00",
        "LastModifiedUser": "sample string 4"
      },
      "FormValueNeededDate": "2025-07-30T23:28:27.94862-07:00",
      "MeasurementValueNeededDate": "2025-07-30T23:28:27.94862-07:00",
      "HasChildren": true,
      "SourceSystemId": "sample string 5",
      "CompanyId": "97ea6392-b9c4-4286-b6b5-f98ebb614274",
      "CreateDate": "2025-07-30T23:28:27.94862-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2025-07-30T23:28:27.94862-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "EffectiveDate": "2025-07-30T23:28:27.94862-07:00",
    "WellPurposeType": {
      "WellPurposeTypeId": "7b58006e-a757-4707-9f96-c10458a59297",
      "IsProducer": true,
      "IsInjector": true,
      "Name": "sample string 3",
      "SourceSystemId": "sample string 4",
      "CompanyId": "eb71d417-b4a8-4a1c-97ea-c5454f138dc8",
      "CreateDate": "2025-07-30T23:28:27.94862-07:00",
      "CreateUser": "sample string 6",
      "LastModifiedDate": "2025-07-30T23:28:27.94862-07:00",
      "LastModifiedUser": "sample string 7"
    },
    "SourceSystemId": "sample string 1",
    "CompanyId": "ebb1c273-7abc-4e36-a8b7-d2881d50f654",
    "CreateDate": "2025-07-30T23:28:27.94862-07:00",
    "CreateUser": "sample string 3",
    "LastModifiedDate": "2025-07-30T23:28:27.94862-07:00",
    "LastModifiedUser": "sample string 4"
  },
  "Total": 1,
  "Message": "sample string 1"
}