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.
WellPurposeName | Description | 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": "07bf3e58-a0db-44d7-94ec-0bde0b75eb1c", "Asset": { "AssetId": "c4d50e33-4b29-468b-862a-b888a2699100", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "a5d4de6c-77ca-4c02-95c3-3d44225fe08f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "e0133d97-3434-4425-b7d1-a14dfcd1e740", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "e44f3722-1bd1-426b-ba14-8f6fb0caa248", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T15:26:28.4222765-07:00", "MeasurementValueNeededDate": "2025-06-02T15:26:28.4222765-07:00", "SourceSystemId": "sample string 3", "CompanyId": "730fac0f-d3f5-42b7-9d91-85f78b05e6e6", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "7b8b82ea-df58-4643-bc44-aced615ad98d", "EffectiveDate": "2025-06-02T15:26:28.4222765-07:00", "StateType": { "StateTypeId": "5113e17a-5b92-4e01-8327-960cf5ab8010", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "a5d4de6c-77ca-4c02-95c3-3d44225fe08f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "e0133d97-3434-4425-b7d1-a14dfcd1e740", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "3cc5170f-5ee5-4f24-838e-a852f3f5ad35", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "7a6da319-6fde-4a6e-9764-38ceffab7dcc", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "fa4c8f5d-209a-4893-bc7d-86bdf0068bb6", "EffectiveDate": "2025-06-02T15:26:28.4222765-07:00", "StatusType": { "StatusTypeId": "94b5d0ca-0a58-44b7-b88e-1c387c1a5634", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "a5d4de6c-77ca-4c02-95c3-3d44225fe08f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "e0133d97-3434-4425-b7d1-a14dfcd1e740", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "5fdd5077-dbb1-491b-a9e8-fd47c357694c", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "5d6f0df0-f641-4c08-af31-103611247e71", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-02T15:26:28.4222765-07:00", "MeasurementValueNeededDate": "2025-06-02T15:26:28.4222765-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "f0599fed-ea43-452f-b886-a6278d37f479", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-06-02T15:26:28.4222765-07:00", "WellPurposeType": { "WellPurposeTypeId": "2c3a2053-c007-4dac-b416-a211f156c8cb", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a568dc44-de5c-4c8a-aa90-8fc6d25dc00e", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d6daf319-19df-472b-a79e-c7a196c6ff89", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 4" }
Response Information
Resource Description
On success, the created well purpose.
Name | Description | Type | Additional information |
---|---|---|---|
Data | WellPurpose |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "WellPurposeId": "0aea63c7-fc2a-4c79-8fad-fedc698873d9", "Asset": { "AssetId": "471a6372-a212-452b-8c8f-c15c9ea15182", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "4b338252-7c71-45a0-92de-8be3649c1920", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "13d99d21-b4f0-417e-9029-88a2250e2851", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "b2f7cbfd-8f68-4afe-87da-7be87b6e1bf7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T15:26:28.4222765-07:00", "MeasurementValueNeededDate": "2025-06-02T15:26:28.4222765-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e879c385-b6bf-4e51-8c3f-21fdcc23ec49", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "8ea19b62-8e55-4540-a7ed-9c08b1a9ca27", "EffectiveDate": "2025-06-02T15:26:28.4222765-07:00", "StateType": { "StateTypeId": "65154cc7-1175-49e8-933e-c126a06de662", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "4b338252-7c71-45a0-92de-8be3649c1920", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "13d99d21-b4f0-417e-9029-88a2250e2851", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "65ed7ae5-578b-40f3-831f-5d4a5e71c2ac", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "239c3598-f481-4a5b-a385-9b8adf034de0", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "fbc1e1cf-6d3c-424f-a0cc-e51534f309bc", "EffectiveDate": "2025-06-02T15:26:28.4222765-07:00", "StatusType": { "StatusTypeId": "1c7c445c-b595-4988-9106-da7f60c978ec", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "4b338252-7c71-45a0-92de-8be3649c1920", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "13d99d21-b4f0-417e-9029-88a2250e2851", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "379f0074-65c5-483f-9a62-a77bd3961d99", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "a7a32bf3-37f2-45ab-a697-349a6d56d828", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-02T15:26:28.4222765-07:00", "MeasurementValueNeededDate": "2025-06-02T15:26:28.4222765-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "f5d35424-c9dd-481e-b144-ddd0cf34267d", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-06-02T15:26:28.4222765-07:00", "WellPurposeType": { "WellPurposeTypeId": "a98cd01d-8648-41e5-b508-182920f7ae49", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3325f318-dbc6-4589-bcba-026f1c21a4a9", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "88c776bc-7a2c-4adb-a1cc-5f5d248a8818", "CreateDate": "2025-06-02T15:26:28.4222765-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:26:28.4222765-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }