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": "6aff1ca7-1e71-4662-9e89-c2f52c876410", "Asset": { "AssetId": "9d82b67f-75e4-41dd-beef-e7f32c19207e", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "4ef0c16a-d7db-48f4-94fd-c47c3f5aefdb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cb6e3ba1-99c9-411e-9f96-a647ba806372", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "216b07ce-e2b8-47ae-b94c-113a2fd3ca63", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T14:00:13.2289974-07:00", "MeasurementValueNeededDate": "2025-06-30T14:00:13.2289974-07:00", "SourceSystemId": "sample string 3", "CompanyId": "087017fe-248d-4d6b-a9f8-d5b60e2c3aac", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "e500f3f4-c84d-4ece-a7b1-45039ced54de", "EffectiveDate": "2025-06-30T14:00:13.2289974-07:00", "StateType": { "StateTypeId": "b88b5756-2d34-4c4c-967a-a15ec62f722f", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "4ef0c16a-d7db-48f4-94fd-c47c3f5aefdb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cb6e3ba1-99c9-411e-9f96-a647ba806372", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "9f8e1b5d-68ae-472d-b309-2018cb86312e", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "f4fc1747-8e28-4e7b-b58b-272a41fe0986", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "92f78a77-094d-47e9-ad75-b5a0e549b975", "EffectiveDate": "2025-06-30T14:00:13.2289974-07:00", "StatusType": { "StatusTypeId": "42572444-fc13-4e7a-a096-745e5045f3c1", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "4ef0c16a-d7db-48f4-94fd-c47c3f5aefdb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cb6e3ba1-99c9-411e-9f96-a647ba806372", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "dca1d558-cc07-40c0-b6e4-76baf1a04fe6", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7f2e708d-4ccd-41f3-a1a0-0ed5238e20a6", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-30T14:00:13.2289974-07:00", "MeasurementValueNeededDate": "2025-06-30T14:00:13.2289974-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "6d686a3f-5fd5-4a8d-bdae-904cf868cb41", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-06-30T14:00:13.2289974-07:00", "WellPurposeType": { "WellPurposeTypeId": "e1af5d22-6653-47f1-bcfe-489e2880fc2c", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "477b90b8-fccc-4b24-a659-98ca4bce5f50", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7ca91c58-353d-49a3-b982-48c628ba7d0b", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-30T14:00:13.2289974-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": "339be9c3-6dde-4c41-ba20-0e994e9087e5", "Asset": { "AssetId": "434718f5-fd54-4c38-ba1c-8c480aa6b1be", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b453e5ee-3f5a-4225-8b47-586ff000a566", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8f61616e-a545-47cf-8ba1-5f5ec08ee24b", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "8e1a5e82-40c9-49d8-ac8d-f83a5149dbc1", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T14:00:13.2289974-07:00", "MeasurementValueNeededDate": "2025-06-30T14:00:13.2289974-07:00", "SourceSystemId": "sample string 3", "CompanyId": "81b77a6d-5d99-4b12-8f75-9eb3899f760e", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "fa323c49-25b1-45ea-84e4-a3473b69015e", "EffectiveDate": "2025-06-30T14:00:13.2289974-07:00", "StateType": { "StateTypeId": "620cf4a5-02f1-4ad3-a76c-7a0e6d537b0d", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "b453e5ee-3f5a-4225-8b47-586ff000a566", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8f61616e-a545-47cf-8ba1-5f5ec08ee24b", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "d06c0721-7287-4905-8962-b3fe937b9bee", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "4e16aed2-a71e-4356-8aab-1ca702a95323", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "ed8ded75-701b-44ed-9d39-7fa61b268fd8", "EffectiveDate": "2025-06-30T14:00:13.2289974-07:00", "StatusType": { "StatusTypeId": "92b4dc31-60d5-47b2-9e42-5076ba7f1ce1", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "b453e5ee-3f5a-4225-8b47-586ff000a566", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8f61616e-a545-47cf-8ba1-5f5ec08ee24b", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "afbab07e-7b3f-49eb-92c0-bc48e988e38c", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "59579682-77e2-4c15-b6a2-decfe6666636", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-30T14:00:13.2289974-07:00", "MeasurementValueNeededDate": "2025-06-30T14:00:13.2289974-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a9f04e3e-50d0-4759-8460-80ba391f4355", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-06-30T14:00:13.2289974-07:00", "WellPurposeType": { "WellPurposeTypeId": "6d22755f-33f0-447c-9014-cf1117ec5a19", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c96364ca-5e26-45e6-9291-00bd06225fd7", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7eb3bcbd-99ee-44eb-a972-2d4bc7af38d8", "CreateDate": "2025-06-30T14:00:13.2289974-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-30T14:00:13.2289974-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }