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": "6f682b69-cd58-46b3-ac0d-487873778bf5", "Asset": { "AssetId": "23e49182-874f-4ea4-8499-389b7113bf6c", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b99208f8-e63c-4da3-934c-fdf61439a26d", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "044831f6-bf2e-4167-96db-7d0c4a9daeff", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "cbcf629c-97dd-4df2-adc8-ae6a86a15f1f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-30T23:26:36.292136-07:00", "MeasurementValueNeededDate": "2025-07-30T23:26:36.292136-07:00", "SourceSystemId": "sample string 3", "CompanyId": "059fd28e-24dd-4f42-9c31-c91a75f98c0d", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "612f4b27-8d3c-4949-af1d-75573d25dd74", "EffectiveDate": "2025-07-30T23:26:36.292136-07:00", "StateType": { "StateTypeId": "315bb45f-62e9-4ed8-aff2-9704c6ba187c", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "b99208f8-e63c-4da3-934c-fdf61439a26d", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "044831f6-bf2e-4167-96db-7d0c4a9daeff", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "e802914b-cda0-4b38-bba0-b6f0dc1b86d3", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "72c4f550-401a-443a-a1e2-e17c1a370e0a", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "57e690d2-02d9-4b58-bfde-94200f3eeba3", "EffectiveDate": "2025-07-30T23:26:36.292136-07:00", "StatusType": { "StatusTypeId": "a07ae6fe-016b-4612-b45e-a763ddcf532c", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "b99208f8-e63c-4da3-934c-fdf61439a26d", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "044831f6-bf2e-4167-96db-7d0c4a9daeff", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "b902e4d0-91cd-4caf-b932-be7007c8a1a4", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "80835072-6709-40b1-b823-a0e0a52393c0", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-30T23:26:36.292136-07:00", "MeasurementValueNeededDate": "2025-07-30T23:26:36.292136-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "425476bf-233b-43e2-a3d6-f74e19c26113", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-07-30T23:26:36.292136-07:00", "WellPurposeType": { "WellPurposeTypeId": "f0b76c88-9669-4432-8b1a-55d51e39b081", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "fbdd935e-cab4-4b8f-88a0-d8da0a4d6c13", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "6c64fe11-75b0-46dc-9877-af4bba40870b", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:26:36.292136-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": "9fbf7aa0-8d18-4fa1-ba99-52e03855a488", "Asset": { "AssetId": "e39deceb-b245-48c0-8043-f7d9d06772f0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d85afcc9-28fa-4503-8864-ff49bdc69c3c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "39693c0b-a04f-49b2-974a-f7f3bb77d37b", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "81b5fada-1193-441a-be13-d29fb3056a43", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-30T23:26:36.292136-07:00", "MeasurementValueNeededDate": "2025-07-30T23:26:36.292136-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d328505b-6766-4209-b997-3df81a4c131e", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "e9ecc8ac-f74b-4aa1-ac86-412909bdbea7", "EffectiveDate": "2025-07-30T23:26:36.292136-07:00", "StateType": { "StateTypeId": "c0e53156-8869-44b2-b3cb-8b587d93f93e", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "d85afcc9-28fa-4503-8864-ff49bdc69c3c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "39693c0b-a04f-49b2-974a-f7f3bb77d37b", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "2ad0a8cc-8456-42b9-9ef2-baab725b49d4", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "5fe8154f-0dd3-41c6-aa35-4d8a63f52e6c", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "f83d4a1c-5986-4a76-8e6c-00343221b131", "EffectiveDate": "2025-07-30T23:26:36.292136-07:00", "StatusType": { "StatusTypeId": "33f46e3a-ce25-4683-87d0-064ff6704eab", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "d85afcc9-28fa-4503-8864-ff49bdc69c3c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "39693c0b-a04f-49b2-974a-f7f3bb77d37b", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "4cef245d-5e49-4aa2-b67b-7f022b967e54", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "4e4ff650-6a9f-4b8c-aef7-3fb6916c3854", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-30T23:26:36.292136-07:00", "MeasurementValueNeededDate": "2025-07-30T23:26:36.292136-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d1b85d49-c8f2-44a0-9d60-e76029c824b5", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-07-30T23:26:36.292136-07:00", "WellPurposeType": { "WellPurposeTypeId": "a958798b-b014-4aad-9f7d-31dff35c02e8", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "20287ad6-71c7-435b-8eab-9d16b2c410cd", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "17a6f056-05da-476c-b81a-09d862808b27", "CreateDate": "2025-07-30T23:26:36.292136-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-30T23:26:36.292136-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }