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": "e80d3170-aca5-43b1-a4f7-8b7c3fbec630", "Asset": { "AssetId": "358c0e80-f131-48a8-808a-8a4aba760731", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "85b38a0d-6f04-4e9f-babb-ff14240f5f84", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "57838c1d-2467-40bd-8bc8-3a5190dc313c", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "aa3bcea4-d832-4028-bc0b-752402e20ffd", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-25T13:33:27.4000018-07:00", "MeasurementValueNeededDate": "2025-04-25T13:33:27.4000018-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a5c5269d-9224-4a6e-a296-20560722c014", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "65f75ac6-8948-4ecf-9b57-e3f2a1d7352b", "EffectiveDate": "2025-04-25T13:33:27.4000018-07:00", "StateType": { "StateTypeId": "f01afb98-7465-4bf3-9098-f15d449abc4b", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "85b38a0d-6f04-4e9f-babb-ff14240f5f84", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "57838c1d-2467-40bd-8bc8-3a5190dc313c", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "56898d94-7d41-4ff9-86d7-6a7d4704729c", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "7c3b9448-9391-4ac4-80ed-224c09ca6a2a", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "65289967-a671-47b0-b3f1-6896e11c3bd9", "EffectiveDate": "2025-04-25T13:33:27.4000018-07:00", "StatusType": { "StatusTypeId": "2b079a3a-2447-410f-aa8f-bce4f10328de", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "85b38a0d-6f04-4e9f-babb-ff14240f5f84", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "57838c1d-2467-40bd-8bc8-3a5190dc313c", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "3477f0c4-53fc-469d-b26a-192d70bb40f3", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "aa352cb3-45c2-4a27-8153-0bc0a6d2f989", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-04-25T13:33:27.4000018-07:00", "MeasurementValueNeededDate": "2025-04-25T13:33:27.4000018-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "7add4b2c-16dd-4c8b-90c3-3e0ec5f082b2", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-04-25T13:33:27.4000018-07:00", "WellPurposeType": { "WellPurposeTypeId": "fb67169a-1435-4460-a17d-226e87e26a04", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "20975acb-518f-4f56-8c08-e38a14ab3f8b", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "3acc6da0-b41e-46dd-a123-a13e56277613", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T13:33:27.4000018-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": "58811605-fe79-4298-9b65-6c3664ce4683", "Asset": { "AssetId": "30a49d36-5240-4222-9f58-3c72339257ed", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7504bb1c-d176-45c4-849d-e5350ca67ecd", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "11ce0b9f-4c71-4aa3-a824-dceefbf4f51b", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "f968f66e-a074-4948-9f32-b9a717df21fa", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-25T13:33:27.4000018-07:00", "MeasurementValueNeededDate": "2025-04-25T13:33:27.4000018-07:00", "SourceSystemId": "sample string 3", "CompanyId": "aa0a60aa-e4a0-4c8d-bbe8-f8f16189b537", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "1c5064b8-0fe9-4932-a56c-08db1e29af2b", "EffectiveDate": "2025-04-25T13:33:27.4000018-07:00", "StateType": { "StateTypeId": "ffe7644a-3244-4c29-aacd-83e4bae8dbcf", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "7504bb1c-d176-45c4-849d-e5350ca67ecd", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "11ce0b9f-4c71-4aa3-a824-dceefbf4f51b", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "4b012d35-d148-4a9a-9e16-818afcd0c79e", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "ed8da38f-9b72-45e3-bb26-1f7284f8c0da", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "e3f2eb4e-baf0-40c5-a387-716e1583cc2b", "EffectiveDate": "2025-04-25T13:33:27.4000018-07:00", "StatusType": { "StatusTypeId": "fbb6c294-4f78-4350-a22a-b5e4ce73d59a", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "7504bb1c-d176-45c4-849d-e5350ca67ecd", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "11ce0b9f-4c71-4aa3-a824-dceefbf4f51b", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "002c31df-8473-42a1-8459-057e2002fa02", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d5af2efd-3abc-4b32-a111-1a1e1770d81b", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-04-25T13:33:27.4000018-07:00", "MeasurementValueNeededDate": "2025-04-25T13:33:27.4000018-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "4dfb0b48-b898-4363-a4f8-d4cf435e5d2c", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-04-25T13:33:27.4000018-07:00", "WellPurposeType": { "WellPurposeTypeId": "bee1dc4a-e782-4a13-9157-4549365f1b8d", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4a6c81e0-4095-48ab-b253-152149ba5219", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "07b5e7d7-6eac-4b43-abae-3a426be2e3bd", "CreateDate": "2025-04-25T13:33:27.4000018-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T13:33:27.4000018-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }