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": "e1cce429-ad44-4483-8bc7-52fd83a6dae7", "Asset": { "AssetId": "a468b230-9682-47d1-90f9-fd64166adbac", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "fc8b5119-7318-4dcf-9e7e-f385dffe11ae", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ddcd9e63-3f25-4481-95af-39d4562d3cbf", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "348a0a26-ab1b-4ef3-be56-81cd96057a96", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-20T01:38:55.740435-07:00", "MeasurementValueNeededDate": "2025-07-20T01:38:55.740435-07:00", "SourceSystemId": "sample string 3", "CompanyId": "42305fe8-d931-4883-85a1-4509ba3f2873", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "fdf55456-ac7c-4201-a32d-45e417377a93", "EffectiveDate": "2025-07-20T01:38:55.740435-07:00", "StateType": { "StateTypeId": "f511fba6-7559-4237-bbf4-1fe66a0c7844", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "fc8b5119-7318-4dcf-9e7e-f385dffe11ae", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ddcd9e63-3f25-4481-95af-39d4562d3cbf", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "8904df63-8f95-48ee-8a96-75253040edc5", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "11b0f81c-1318-4a10-8e93-bd3254327920", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "3495b102-632c-44e9-bc14-c09c43266810", "EffectiveDate": "2025-07-20T01:38:55.740435-07:00", "StatusType": { "StatusTypeId": "b60fdb58-806c-49f9-b2d0-a0da7420d75d", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "fc8b5119-7318-4dcf-9e7e-f385dffe11ae", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ddcd9e63-3f25-4481-95af-39d4562d3cbf", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "8f4412f5-a88e-4425-84e6-5f41f9e8064b", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "e8332491-f843-4e35-b0cd-bff2f129e479", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-20T01:38:55.740435-07:00", "MeasurementValueNeededDate": "2025-07-20T01:38:55.740435-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "6b1a5666-477c-4afe-8d0f-cdeb40177f08", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-07-20T01:38:55.740435-07:00", "WellPurposeType": { "WellPurposeTypeId": "9a943dea-fd54-4488-a2d0-4397ed0aaf97", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f2cb627a-b868-4d13-a506-4645a3cfc26d", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "4da450ea-925e-4f45-9d1f-5f785cd48b26", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-20T01:38:55.740435-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": "47b15be6-8a1a-4274-a499-36d37271d725", "Asset": { "AssetId": "ccd99141-109c-4a7d-bb1c-eb59acc9c10f", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "6a27f45c-e5d7-4d16-8dbe-67ddf898c1f2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c8b49ab2-bdbb-43b4-8458-56e907cd1e38", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "b157180d-74f7-4cab-9db0-de2b2ddd3912", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-20T01:38:55.740435-07:00", "MeasurementValueNeededDate": "2025-07-20T01:38:55.740435-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f55e5f0f-fe8a-48b8-824d-830b8c54766d", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "05367d7b-70cf-4121-bd1a-6e9e60ce6554", "EffectiveDate": "2025-07-20T01:38:55.740435-07:00", "StateType": { "StateTypeId": "78ea88d5-6666-4500-abaa-22111ff9aa32", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "6a27f45c-e5d7-4d16-8dbe-67ddf898c1f2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c8b49ab2-bdbb-43b4-8458-56e907cd1e38", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "1bf20cd9-0263-48d4-9c3b-0e4ad04bafab", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "d915acc9-0c05-4036-a027-5d38c8f1dfda", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "0c54de4b-66c3-4809-a89f-4c11a6903932", "EffectiveDate": "2025-07-20T01:38:55.740435-07:00", "StatusType": { "StatusTypeId": "18a89e64-99e6-4db7-9d5f-b65f53893f17", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "6a27f45c-e5d7-4d16-8dbe-67ddf898c1f2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c8b49ab2-bdbb-43b4-8458-56e907cd1e38", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "7e52987e-38df-4e08-acf1-edbb471c9b78", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "bbb1d3fc-051c-4198-81fa-c9d0488572d6", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-20T01:38:55.740435-07:00", "MeasurementValueNeededDate": "2025-07-20T01:38:55.740435-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ddbead78-6bcf-4759-b7df-c4ec3d045598", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-07-20T01:38:55.740435-07:00", "WellPurposeType": { "WellPurposeTypeId": "8a95d4d8-561e-45d6-88d7-218a576525e7", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b11565f0-5a36-4eb0-b288-4e54c025efe6", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "1a921c3f-4932-43b4-9765-21ea16dfd1c1", "CreateDate": "2025-07-20T01:38:55.740435-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-20T01:38:55.740435-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }