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": "8d859caf-82b7-4441-8ce2-25f671a27c09", "Asset": { "AssetId": "0be3536c-332f-46ac-bb1b-0e6601b77962", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "eaa61b22-3732-4f04-91cf-9d3a59d6a226", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "f4780750-4fe5-46e6-bc56-66573db2cdc9", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "8210849f-dad2-464b-a844-d377aeaea467", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T18:55:48.0206015-07:00", "MeasurementValueNeededDate": "2024-04-28T18:55:48.0206015-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d13950d5-7031-4827-8a5d-974b6fa6c884", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "5aa0838f-3c81-43db-9543-da933dbce1b1", "EffectiveDate": "2024-04-28T18:55:48.0206015-07:00", "StateType": { "StateTypeId": "010e307d-dcaa-4c1d-b788-78c5f888be18", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "eaa61b22-3732-4f04-91cf-9d3a59d6a226", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "f4780750-4fe5-46e6-bc56-66573db2cdc9", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "0ab0406e-06b5-4a3e-bc2c-d0c071eae418", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "b695166c-c5a7-428b-b595-80e31d6b4b01", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "75c644b1-48ac-444f-a76d-5f2bef4357dc", "EffectiveDate": "2024-04-28T18:55:48.0206015-07:00", "StatusType": { "StatusTypeId": "b44e366a-df72-47f4-ab8b-d919ca38c0b4", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "eaa61b22-3732-4f04-91cf-9d3a59d6a226", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "f4780750-4fe5-46e6-bc56-66573db2cdc9", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "e2cb0172-fac4-4b96-8278-136b4ef4f125", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "d505b3ab-a088-4628-b746-293286147538", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T18:55:48.0206015-07:00", "MeasurementValueNeededDate": "2024-04-28T18:55:48.0206015-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e89d2513-8727-4d4d-9a1d-391d3d50f971", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-28T18:55:48.0206015-07:00", "WellPurposeType": { "WellPurposeTypeId": "56795372-36ef-494e-809b-5f3e180b6fb1", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "6a7a9920-1623-4f51-a041-c36d8d2d3ad4", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "0c00f355-b06c-4744-a421-5e232bbde9ae", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T18:55:48.0206015-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": "78a1ca07-152b-49c6-bbba-5a280357ba7c", "Asset": { "AssetId": "fa0870b1-0be6-4d18-adb4-7c11eee36297", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "390f58fa-ef75-44f0-9ba5-068e0fe514fa", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "20f82296-a119-4571-b0f4-6558d14452ff", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "34cc3e3d-23ce-4135-9548-186fc09e2750", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T18:55:48.0206015-07:00", "MeasurementValueNeededDate": "2024-04-28T18:55:48.0206015-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a0531f64-9405-4674-bedd-0b95f6b375e9", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "c38eb484-8daa-4c46-9cf4-394a1180c2c5", "EffectiveDate": "2024-04-28T18:55:48.0206015-07:00", "StateType": { "StateTypeId": "beb67d12-c916-48b5-b633-374dd7920a09", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "390f58fa-ef75-44f0-9ba5-068e0fe514fa", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "20f82296-a119-4571-b0f4-6558d14452ff", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "ab5cce98-e138-4c16-9819-f296e3a3b507", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "d2384f5e-745e-44dc-8fc6-4b270b46edc0", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "fcb3395a-bb9a-454c-9f3d-736fb7c8d848", "EffectiveDate": "2024-04-28T18:55:48.0206015-07:00", "StatusType": { "StatusTypeId": "ed37a4ce-705c-46c7-b357-bdd2b4695433", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "390f58fa-ef75-44f0-9ba5-068e0fe514fa", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "20f82296-a119-4571-b0f4-6558d14452ff", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "ee05ef37-cf4f-4400-9888-e1b275ab8e24", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "19253d9e-bcaf-4cc2-97c2-d557ec06df79", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T18:55:48.0206015-07:00", "MeasurementValueNeededDate": "2024-04-28T18:55:48.0206015-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b43da04a-ce3d-4511-a3ce-1e4bf2563ec7", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-28T18:55:48.0206015-07:00", "WellPurposeType": { "WellPurposeTypeId": "20c3978c-996f-47b4-baf1-ad183311852c", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f73051da-2831-4b8f-ada4-eed4238e0191", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "61ead3b9-e7bd-45d3-b732-e68ba66fc348", "CreateDate": "2024-04-28T18:55:48.0206015-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T18:55:48.0206015-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }