POST WellPurposes

Back to endpoints

POST WellPurposes

Creates a new well purpose.

Request Information

URI Parameters

None.

Body Parameters

Well purpose to be created. WellPurposeId should not be filled in.

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": "e4f96d5a-5b42-4ad7-96a3-d8a340b5670d",
  "Asset": {
    "AssetId": "ea662bf7-3d5d-4599-8320-2d0139977459",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "DisplayOrder": 1,
    "AssetType": {
      "AssetTypeId": "7a83ae69-60d9-45c2-85b7-68578e653281",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "IsWell": true,
      "DisplayColor": "sample string 4",
      "SourceSystemId": "sample string 5",
      "CompanyId": "1a6d9f0b-f517-4ecf-b360-9622c86a567d",
      "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "AssetGroup": {
      "AssetGroupId": "e5ea7f77-8384-44af-9c1a-9b9f9aee88c1",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ParentGroup": null,
      "DisplayOrder": 1,
      "FormValueNeededDate": "2026-06-05T07:22:42.6592732-07:00",
      "MeasurementValueNeededDate": "2026-06-05T07:22:42.6592732-07:00",
      "SourceSystemId": "sample string 3",
      "CompanyId": "feb31e42-136d-4d01-90fe-1e8a2b067fc2",
      "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
      "LastModifiedUser": "sample string 6"
    },
    "ParentAsset": null,
    "Location": "sample string 3",
    "Barcode": {
      "Format": 0,
      "Code": "sample string 1"
    },
    "State": {
      "StateId": "9bfe562c-719a-43fc-bea8-015375b84dfd",
      "EffectiveDate": "2026-06-05T07:22:42.6592732-07:00",
      "StateType": {
        "StateTypeId": "eb489670-d389-4242-8693-2558e71c2b9b",
        "Name": "sample string 1",
        "IsOperational": true,
        "AssetType": {
          "AssetTypeId": "7a83ae69-60d9-45c2-85b7-68578e653281",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "1a6d9f0b-f517-4ecf-b360-9622c86a567d",
          "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
          "LastModifiedUser": "sample string 8"
        },
        "SourceSystemId": "sample string 3",
        "CompanyId": "45225ccd-576a-4352-85f9-b2fcaff79aea",
        "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
        "LastModifiedUser": "sample string 6"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "78916fdc-7770-4abc-950a-971dbf196437",
      "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
      "LastModifiedUser": "sample string 4"
    },
    "Status": {
      "StatusId": "f4b02943-cc92-459c-9791-56d37a53d5aa",
      "EffectiveDate": "2026-06-05T07:22:42.6592732-07:00",
      "StatusType": {
        "StatusTypeId": "976c5034-ba11-4b83-9a29-3010100ca3c8",
        "Name": "sample string 1",
        "IsProducing": true,
        "IsInjecting": true,
        "AssetType": {
          "AssetTypeId": "7a83ae69-60d9-45c2-85b7-68578e653281",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "1a6d9f0b-f517-4ecf-b360-9622c86a567d",
          "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
          "LastModifiedUser": "sample string 8"
        },
        "SourceSystemId": "sample string 4",
        "CompanyId": "4a578c60-adc1-4f4e-bfc2-358bddbfd651",
        "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
        "LastModifiedUser": "sample string 7"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "cae6daa7-691e-4a4e-a647-c963c1053ff5",
      "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
      "LastModifiedUser": "sample string 4"
    },
    "FormValueNeededDate": "2026-06-05T07:22:42.6592732-07:00",
    "MeasurementValueNeededDate": "2026-06-05T07:22:42.6592732-07:00",
    "HasChildren": true,
    "SourceSystemId": "sample string 5",
    "CompanyId": "449cfc92-d8a1-42ac-9810-cc9bf950d74d",
    "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
    "LastModifiedUser": "sample string 8"
  },
  "EffectiveDate": "2026-06-05T07:22:42.6592732-07:00",
  "WellPurposeType": {
    "WellPurposeTypeId": "b63084e1-cb56-492e-bcac-80228b2bc1ae",
    "IsProducer": true,
    "IsInjector": true,
    "Name": "sample string 3",
    "SourceSystemId": "sample string 4",
    "CompanyId": "8da17acf-ecfe-4216-82c6-a79862f9bbef",
    "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
    "CreateUser": "sample string 6",
    "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
    "LastModifiedUser": "sample string 7"
  },
  "SourceSystemId": "sample string 1",
  "CompanyId": "1ad01495-d9df-4d70-8173-3e8f59f88cfa",
  "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
  "CreateUser": "sample string 3",
  "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
  "LastModifiedUser": "sample string 4"
}

Response Information

Resource Description

On success, the created well purpose.

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

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "WellPurposeId": "e4e17365-a72f-495d-8bb3-2c9e40f895da",
    "Asset": {
      "AssetId": "14d67094-e72f-49ec-89a7-b10665b9080e",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayOrder": 1,
      "AssetType": {
        "AssetTypeId": "4ea4856e-d120-405f-b581-84e77d135268",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "5a026648-f9b9-48e4-8b51-9315ce02ba36",
        "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
        "LastModifiedUser": "sample string 8"
      },
      "AssetGroup": {
        "AssetGroupId": "2a5e5ad2-898d-4822-946d-12ddefde256a",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ParentGroup": null,
        "DisplayOrder": 1,
        "FormValueNeededDate": "2026-06-05T07:22:42.6592732-07:00",
        "MeasurementValueNeededDate": "2026-06-05T07:22:42.6592732-07:00",
        "SourceSystemId": "sample string 3",
        "CompanyId": "7c2aae6f-9c71-413d-9b5b-7286c7034a97",
        "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
        "LastModifiedUser": "sample string 6"
      },
      "ParentAsset": null,
      "Location": "sample string 3",
      "Barcode": {
        "Format": 0,
        "Code": "sample string 1"
      },
      "State": {
        "StateId": "9ca0d9ec-0195-49d2-9517-60fefb3ab9a9",
        "EffectiveDate": "2026-06-05T07:22:42.6592732-07:00",
        "StateType": {
          "StateTypeId": "07d0bae7-6ad5-44a4-8232-0d7847658f44",
          "Name": "sample string 1",
          "IsOperational": true,
          "AssetType": {
            "AssetTypeId": "4ea4856e-d120-405f-b581-84e77d135268",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "5a026648-f9b9-48e4-8b51-9315ce02ba36",
            "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 3",
          "CompanyId": "add9fbd9-7032-4a42-8f7d-04d4636bcb1e",
          "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
          "LastModifiedUser": "sample string 6"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "67d033da-d0be-4eb0-bc35-30a2c71a6512",
        "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
        "LastModifiedUser": "sample string 4"
      },
      "Status": {
        "StatusId": "d729a66b-090c-4ee0-8838-25abed22f542",
        "EffectiveDate": "2026-06-05T07:22:42.6592732-07:00",
        "StatusType": {
          "StatusTypeId": "2e80ddee-03bd-478f-8746-52d8d22b521c",
          "Name": "sample string 1",
          "IsProducing": true,
          "IsInjecting": true,
          "AssetType": {
            "AssetTypeId": "4ea4856e-d120-405f-b581-84e77d135268",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "5a026648-f9b9-48e4-8b51-9315ce02ba36",
            "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 4",
          "CompanyId": "43f7529c-0692-42ba-b25c-862adeac9e0b",
          "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "e90452d7-2ca4-4b1b-826d-9359ffdcc805",
        "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
        "LastModifiedUser": "sample string 4"
      },
      "FormValueNeededDate": "2026-06-05T07:22:42.6592732-07:00",
      "MeasurementValueNeededDate": "2026-06-05T07:22:42.6592732-07:00",
      "HasChildren": true,
      "SourceSystemId": "sample string 5",
      "CompanyId": "bac78dae-1908-410e-bf3c-dcd947156fa1",
      "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "EffectiveDate": "2026-06-05T07:22:42.6592732-07:00",
    "WellPurposeType": {
      "WellPurposeTypeId": "28637c1f-3b67-48ad-b953-3d4d2454afaf",
      "IsProducer": true,
      "IsInjector": true,
      "Name": "sample string 3",
      "SourceSystemId": "sample string 4",
      "CompanyId": "c68397f1-eb57-4149-8f6b-86d01e67495a",
      "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
      "CreateUser": "sample string 6",
      "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
      "LastModifiedUser": "sample string 7"
    },
    "SourceSystemId": "sample string 1",
    "CompanyId": "3d77e55d-87dd-49f3-89c1-8937d1d25337",
    "CreateDate": "2026-06-05T07:22:42.6592732-07:00",
    "CreateUser": "sample string 3",
    "LastModifiedDate": "2026-06-05T07:22:42.6592732-07:00",
    "LastModifiedUser": "sample string 4"
  },
  "Total": 1,
  "Message": "sample string 1"
}