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": "b7864d54-9154-4400-af28-c141a2f4d00a", "Asset": { "AssetId": "8a810a40-b160-4597-b430-12fc5c59b548", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "ecdfc4e0-2d1a-403d-be62-e14605a2d801", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9b6b11ac-a7e8-42d8-a4ec-8da822785ff6", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "b4634c6e-b5af-43c5-96ec-bc37cac8133f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-02-22T08:09:29.1283896-08:00", "MeasurementValueNeededDate": "2025-02-22T08:09:29.1283896-08:00", "SourceSystemId": "sample string 3", "CompanyId": "1b411d66-98a5-47ae-86f2-b2a1d43707e5", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "1456e882-2674-4bea-a44e-839189d73aec", "EffectiveDate": "2025-02-22T08:09:29.1283896-08:00", "StateType": { "StateTypeId": "c8c4c150-4593-4af9-956f-685c1f18a73b", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "ecdfc4e0-2d1a-403d-be62-e14605a2d801", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9b6b11ac-a7e8-42d8-a4ec-8da822785ff6", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "e6c25a21-5092-4586-80de-78ccd2824197", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "c0cdb804-4373-48be-95f6-2f2493bb7b73", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "7452b617-bd18-421f-8a29-6831f4203ab7", "EffectiveDate": "2025-02-22T08:09:29.1283896-08:00", "StatusType": { "StatusTypeId": "d1b4cacd-51c0-4e49-8a39-7ebada146c98", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "ecdfc4e0-2d1a-403d-be62-e14605a2d801", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9b6b11ac-a7e8-42d8-a4ec-8da822785ff6", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "a195b9ee-51c8-468f-8a09-6bfefd6fc8a0", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "ca78b0dc-2e0f-4c78-a50d-f3b9a6908c1f", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-02-22T08:09:29.1283896-08:00", "MeasurementValueNeededDate": "2025-02-22T08:09:29.1283896-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "78b24202-cbe6-4605-bb0a-353fd07d19a4", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-02-22T08:09:29.1283896-08:00", "WellPurposeType": { "WellPurposeTypeId": "f83e47c9-2b97-4ef5-8480-cbd78077bccb", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c86700d2-5eb9-4537-88dd-cf1c45e561dd", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "bae099d6-92fc-4755-9ca2-66e7f088733f", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08: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": "82841742-4366-4125-aada-5af03ac04deb", "Asset": { "AssetId": "f7403d81-4ffd-4ade-b58b-22293a253df7", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "96902295-ac51-4544-8dc8-1f6760a00e53", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "94c9e4a2-7206-4cac-a6d3-232d37b05da2", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "22b121b2-5bbc-434c-8aa4-dbb7b015ca5f", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-02-22T08:09:29.1283896-08:00", "MeasurementValueNeededDate": "2025-02-22T08:09:29.1283896-08:00", "SourceSystemId": "sample string 3", "CompanyId": "47eacdef-aea9-4416-823f-2eae9a8b66d7", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "0d40c044-f8f6-4e44-8f87-16df4c90087f", "EffectiveDate": "2025-02-22T08:09:29.1283896-08:00", "StateType": { "StateTypeId": "296bd993-f64c-4702-849b-e216d39dde84", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "96902295-ac51-4544-8dc8-1f6760a00e53", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "94c9e4a2-7206-4cac-a6d3-232d37b05da2", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "1476e4d7-8cb9-40b8-824e-03e6cdfbcef4", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "bd6d1ef9-bd8c-468b-af6d-8fe8d5e3d1fe", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "d203cd10-95e7-4d65-a972-050906da463a", "EffectiveDate": "2025-02-22T08:09:29.1283896-08:00", "StatusType": { "StatusTypeId": "5fb9ee63-e30f-4b6b-b4ec-0b4c3aef2420", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "96902295-ac51-4544-8dc8-1f6760a00e53", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "94c9e4a2-7206-4cac-a6d3-232d37b05da2", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "adf39af9-70bf-4e1d-8a94-3ca15190acc3", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "c16e96ca-9b83-4ec3-acae-b0480246e715", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-02-22T08:09:29.1283896-08:00", "MeasurementValueNeededDate": "2025-02-22T08:09:29.1283896-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "189e3f63-f473-4bfd-a1f5-e1b39c144d23", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-02-22T08:09:29.1283896-08:00", "WellPurposeType": { "WellPurposeTypeId": "49e59b2b-ec42-4b08-a613-1d32dd36c6d8", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0e6087a3-33d2-41d6-bba6-6f04e15e5c98", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "3681644d-bc25-4165-8e6c-f0f6e0e572af", "CreateDate": "2025-02-22T08:09:29.1283896-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-02-22T08:09:29.1283896-08:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }