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.
WellPurpose| Name | 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": "849e5779-66f8-4961-aa04-511977f4864b",
"Asset": {
"AssetId": "b52f19fe-56ea-451f-aa51-05023e9a704e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c94cc824-b013-44c6-8069-05f940a1e9c5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "85543471-11ec-4437-abe1-dd42cfcb47ff",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "2a4fd5a0-2346-4e67-bc26-0433287be28e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T11:57:13.0312491-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:13.0312491-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "18ff4bfc-de67-487a-97b7-45f3eeca1fab",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8a2f98e9-f2fb-4ed9-9498-ad894562f591",
"EffectiveDate": "2026-11-21T11:57:13.0312491-08:00",
"StateType": {
"StateTypeId": "cc5036f1-9b5c-4299-9174-6382ac142f57",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "c94cc824-b013-44c6-8069-05f940a1e9c5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "85543471-11ec-4437-abe1-dd42cfcb47ff",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "243a1f7a-b248-48cc-9b52-2d7876808a07",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0653f581-a8fd-42da-ba2d-3893ca90d66d",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "26e72b3c-7221-4841-adaf-2231a6eff4d3",
"EffectiveDate": "2026-11-21T11:57:13.0312491-08:00",
"StatusType": {
"StatusTypeId": "f256fa40-c85e-47e3-a7e8-b1586c68f621",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "c94cc824-b013-44c6-8069-05f940a1e9c5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "85543471-11ec-4437-abe1-dd42cfcb47ff",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b57d2c2e-2ed8-4e8b-9344-ef90f22ecddd",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3f707e0a-80a1-4370-8c04-8ac30b754fb8",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-21T11:57:13.0312491-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:13.0312491-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f4ce5ef9-5dcd-4d4e-934b-f4fce1796981",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-11-21T11:57:13.0312491-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "698c9bf5-f054-4b33-adb5-f01abf954614",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e56da3ab-d53a-4912-9ce9-578075ea19f3",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5130bb32-0793-4bd7-8e78-d93999bb4bf4",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-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": "838e8dd8-8566-462b-99fd-e65aa5cd50d7",
"Asset": {
"AssetId": "80a18327-5e97-4d83-a5e2-90b96684e95c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1187d459-7ad4-49ab-ad11-85ebf527778b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5129cb03-2d93-452d-b13f-39585b690eb9",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f489d74a-5244-4d9a-9c55-91d30e50e5cd",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T11:57:13.0312491-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:13.0312491-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8636217f-1be9-4ce3-b7e6-41b8a5ea4260",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b72a9ce7-d628-4d0e-8019-7e8857167643",
"EffectiveDate": "2026-11-21T11:57:13.0312491-08:00",
"StateType": {
"StateTypeId": "279234d0-2728-4cf2-894e-b56b9198a1c0",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1187d459-7ad4-49ab-ad11-85ebf527778b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5129cb03-2d93-452d-b13f-39585b690eb9",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "9a51ebc0-beeb-4d78-b2af-cb435cbe2d44",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "967dd6c6-02ed-44d7-98b3-6df5aa19356a",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "0ea0d577-3f56-4857-9b27-15124d0e03a4",
"EffectiveDate": "2026-11-21T11:57:13.0312491-08:00",
"StatusType": {
"StatusTypeId": "1f9cd2d8-9671-4e8a-a128-42446d83b901",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1187d459-7ad4-49ab-ad11-85ebf527778b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5129cb03-2d93-452d-b13f-39585b690eb9",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "954b14c0-1c9a-4550-afe6-08cd28f2e0d1",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1d080651-11e5-4987-8825-c148fa3197f0",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-21T11:57:13.0312491-08:00",
"MeasurementValueNeededDate": "2026-11-21T11:57:13.0312491-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e93e16de-5671-42dc-9340-5f2d14dfbade",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-11-21T11:57:13.0312491-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "96b66b21-cf84-4634-9fa4-f4f75c99718a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5c104346-29e2-4e12-a4de-f3c84e86ce86",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "87c6a9a1-f38a-4760-b4df-7e8bea66b3d1",
"CreateDate": "2026-11-21T11:57:13.0312491-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T11:57:13.0312491-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}