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": "7f59489b-60bd-4922-8eb7-314e2203fc1b", "Asset": { "AssetId": "62019462-6e34-4f5d-8ec2-7cb5789a7255", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "053d6778-9184-499d-801f-ffd26e5c5699", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9519fb3b-e9c6-4bc4-ad46-cac2373e6614", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "694ff140-d68b-4854-b3bc-d9ad3d1bed9a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T15:26:30.1083946-07:00", "MeasurementValueNeededDate": "2025-10-13T15:26:30.1083946-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ccbdf1aa-bbb6-4076-979a-8026b7f5ba25", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "739139a3-810c-44bf-802c-47e365703505", "EffectiveDate": "2025-10-13T15:26:30.1083946-07:00", "StateType": { "StateTypeId": "374dbac5-1243-4b4d-8e93-84a943a201f3", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "053d6778-9184-499d-801f-ffd26e5c5699", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9519fb3b-e9c6-4bc4-ad46-cac2373e6614", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "99f2da84-93d1-42f7-a4bf-e0c65c091bc5", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "1705fde5-d4d7-4206-958d-9196d509c5af", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "cb1e36b2-6277-432e-b743-2a9118e38cb3", "EffectiveDate": "2025-10-13T15:26:30.1083946-07:00", "StatusType": { "StatusTypeId": "e1f980aa-43fb-4a86-8d9d-95b82f47ce95", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "053d6778-9184-499d-801f-ffd26e5c5699", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9519fb3b-e9c6-4bc4-ad46-cac2373e6614", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "f43585e6-cc64-4b46-8eac-5d767a1b4672", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "39f114d1-4f35-445c-8615-7bf23f476a4a", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-10-13T15:26:30.1083946-07:00", "MeasurementValueNeededDate": "2025-10-13T15:26:30.1083946-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "f6c2817d-04dc-4443-90f2-5a35c5576809", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-10-13T15:26:30.1083946-07:00", "WellPurposeType": { "WellPurposeTypeId": "afac3d97-6c61-412b-afe3-bb0739c27bff", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "aed92103-6f5e-481f-82f4-993061552551", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7dba9669-f923-40fe-9379-9e6153f31117", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:26:30.1083946-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": "5a023df0-fb8b-460c-a925-7115b5ee2342", "Asset": { "AssetId": "e7653afe-ef41-4f1f-b327-c7a286107109", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "286bc843-0406-4fcc-8b94-b704a33f49d8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "885537a0-5447-42d3-810b-92b646919516", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "58690880-b932-4bf8-b8d5-a063fcfc0a95", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T15:26:30.1083946-07:00", "MeasurementValueNeededDate": "2025-10-13T15:26:30.1083946-07:00", "SourceSystemId": "sample string 3", "CompanyId": "68e07be5-7fa7-4ffb-bde0-8f89c26a2247", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "8ed4f0e3-1e01-468c-ba38-99dbd467b034", "EffectiveDate": "2025-10-13T15:26:30.1083946-07:00", "StateType": { "StateTypeId": "c2c542ec-8634-4562-80be-2c35f869c926", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "286bc843-0406-4fcc-8b94-b704a33f49d8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "885537a0-5447-42d3-810b-92b646919516", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "d8f18935-f579-41b2-ac9f-380837030af2", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "1f770447-5cd8-4978-9d83-162a6835a22c", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "8a3b386e-0272-43ef-a8e6-ff2ac7bd3fbd", "EffectiveDate": "2025-10-13T15:26:30.1083946-07:00", "StatusType": { "StatusTypeId": "286a3734-1bab-4f9c-8536-94c4a0d5ebf6", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "286bc843-0406-4fcc-8b94-b704a33f49d8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "885537a0-5447-42d3-810b-92b646919516", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "f50b3057-8116-4437-b577-de7687e71eb4", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7f742c02-2ea0-4f42-83c1-8855e8489359", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-10-13T15:26:30.1083946-07:00", "MeasurementValueNeededDate": "2025-10-13T15:26:30.1083946-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a8b2a5a3-09a4-4e77-849e-9cc9e6ae0257", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-10-13T15:26:30.1083946-07:00", "WellPurposeType": { "WellPurposeTypeId": "f268b60f-de29-44d4-b520-24de7030b3b0", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "223f12e9-fe7f-4011-bcbb-dcd3d1f0f9d3", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "72a0e693-8ec5-4570-a235-7b0c4392c0db", "CreateDate": "2025-10-13T15:26:30.1083946-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:26:30.1083946-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }