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": "3f51f4a3-6af0-4ee3-9509-91459270e66d", "Asset": { "AssetId": "05268cd3-2325-4525-a422-d4312a95c4e7", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "6e0f519d-e922-47cb-acb8-879c25fd481a", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "217b65fe-9c49-4cc3-b160-5113af6c7106", "CreateDate": "2025-08-29T17:19:09.8969581-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:19:09.8969581-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "26f118dd-5cc6-492f-af86-8c1c872de146", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:19:09.8969581-07:00", "MeasurementValueNeededDate": "2025-08-29T17:19:09.8969581-07:00", "SourceSystemId": "sample string 3", "CompanyId": "920c76d4-5c3e-4390-a863-6f1a144ef049", "CreateDate": "2025-08-29T17:19:09.8969581-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:19:09.8969581-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "11c9a716-80d3-48f9-8a8e-56a7c5b803b2", "EffectiveDate": "2025-08-29T17:19:09.8969581-07:00", "StateType": { "StateTypeId": "7a8b93f7-03bd-4767-a9d0-e059a89cc096", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "6e0f519d-e922-47cb-acb8-879c25fd481a", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "217b65fe-9c49-4cc3-b160-5113af6c7106", "CreateDate": "2025-08-29T17:19:09.8969581-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:19:09.8969581-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "cb7db3b7-1ee3-4333-a5cd-7cc8b6686ffe", "CreateDate": "2025-08-29T17:19:09.8969581-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:19:09.8969581-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "80b70bf0-1bba-4bae-a67f-f268619eac59", "CreateDate": "2025-08-29T17:19:09.8969581-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:19:09.8969581-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "6eeb5a1f-6937-4990-8934-118ee5fbbe83", "EffectiveDate": "2025-08-29T17:19:09.8969581-07:00", "StatusType": { "StatusTypeId": "0d58ce4e-b550-4bab-9ba7-b4c120e29478", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "6e0f519d-e922-47cb-acb8-879c25fd481a", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "217b65fe-9c49-4cc3-b160-5113af6c7106", "CreateDate": "2025-08-29T17:19:09.8969581-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:19:09.8969581-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "544344d9-8c3c-40fa-95a0-57c503f6e96b", "CreateDate": "2025-08-29T17:19:09.8969581-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-29T17:19:09.8969581-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "1d632e76-f003-4613-8868-626ecc865a21", "CreateDate": "2025-08-29T17:19:09.8969581-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:19:09.8969581-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-08-29T17:19:09.8969581-07:00", "MeasurementValueNeededDate": "2025-08-29T17:19:09.8969581-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "4bbefabc-2ebc-4c5c-8896-f5c83d3fc3a1", "CreateDate": "2025-08-29T17:19:09.8969581-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:19:09.8969581-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-08-29T17:19:09.8969581-07:00", "WellPurposeType": { "WellPurposeTypeId": "0131e6ba-a443-419c-9501-4d6839cac952", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "249802d2-26b4-4a1d-9147-5b0a79b30127", "CreateDate": "2025-08-29T17:19:09.8969581-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-29T17:19:09.8969581-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "0ccdc7e3-7963-480c-b28a-9a3271b33036", "CreateDate": "2025-08-29T17:19:09.8969581-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:19:09.8969581-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": "ec6de304-b58e-4c93-8aa7-1e2e9e08cd0d", "Asset": { "AssetId": "e8b55543-542a-40e7-b1ac-b60043a86415", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "9ca5c243-428c-4b6d-824b-3669577d5a01", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9b689d6c-516e-4c0f-9d32-a53e6f97f017", "CreateDate": "2025-08-29T17:19:09.9281389-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:19:09.9281389-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "9c905e28-50bb-4abf-ac5d-5a2327578227", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:19:09.9281389-07:00", "MeasurementValueNeededDate": "2025-08-29T17:19:09.9281389-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b20fce40-8aed-4333-b10e-ec9adad74c5e", "CreateDate": "2025-08-29T17:19:09.9281389-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:19:09.9281389-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "2934af82-7665-45ec-8683-e27932352a7d", "EffectiveDate": "2025-08-29T17:19:09.9281389-07:00", "StateType": { "StateTypeId": "4670d4ba-6c77-4cc1-a0f0-5dcb346d674e", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "9ca5c243-428c-4b6d-824b-3669577d5a01", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9b689d6c-516e-4c0f-9d32-a53e6f97f017", "CreateDate": "2025-08-29T17:19:09.9281389-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:19:09.9281389-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "c182071a-4789-4054-966b-a127cb77d702", "CreateDate": "2025-08-29T17:19:09.9281389-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:19:09.9281389-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "00aad115-0022-43f4-998c-99aec134d412", "CreateDate": "2025-08-29T17:19:09.9281389-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:19:09.9281389-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "0ff31f35-62ee-44cc-a031-9e96ac697bff", "EffectiveDate": "2025-08-29T17:19:09.9281389-07:00", "StatusType": { "StatusTypeId": "b283b5f3-9539-4995-a845-68b15a02fa8a", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "9ca5c243-428c-4b6d-824b-3669577d5a01", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9b689d6c-516e-4c0f-9d32-a53e6f97f017", "CreateDate": "2025-08-29T17:19:09.9281389-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:19:09.9281389-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "cb45e3b6-cbbe-4944-9442-52ad0cb8a64b", "CreateDate": "2025-08-29T17:19:09.9281389-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-29T17:19:09.9281389-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "0ff47003-5d99-48b5-8716-9c466de8b330", "CreateDate": "2025-08-29T17:19:09.9281389-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:19:09.9281389-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-08-29T17:19:09.9281389-07:00", "MeasurementValueNeededDate": "2025-08-29T17:19:09.9281389-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "216ed3ad-31d8-4aab-84a6-f42c538d335d", "CreateDate": "2025-08-29T17:19:09.9281389-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:19:09.9281389-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-08-29T17:19:09.9281389-07:00", "WellPurposeType": { "WellPurposeTypeId": "82fd06a5-2745-4005-8b1e-9e88dc8ea7d5", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f55c7d54-9ede-4587-81cd-7cfacb31ee8b", "CreateDate": "2025-08-29T17:19:09.9281389-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-29T17:19:09.9281389-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "0b647505-c5c2-47fb-a089-42a426a78d25", "CreateDate": "2025-08-29T17:19:09.9281389-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:19:09.9281389-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }