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": "2adcc792-4f06-450d-8fec-16521e2a1bc2",
"Asset": {
"AssetId": "2722d19a-8a77-4b62-b354-8d576902f6d0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3b66a617-1d69-40e5-a399-9ee04ce6b545",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "75ca4c78-917c-4447-8f24-ffd6d300901b",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d66482f0-b96e-47b3-b0a8-e9d3707f4756",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T08:56:20.0410019-08:00",
"MeasurementValueNeededDate": "2026-11-01T08:56:20.0410019-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "15ae16fe-99db-4e61-817e-2c1cd5ebb118",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "5f9247cc-f27c-45d7-b904-b7dd06317673",
"EffectiveDate": "2026-11-01T08:56:20.0410019-08:00",
"StateType": {
"StateTypeId": "802b20a4-112a-40b4-b185-bb7274a563cf",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "3b66a617-1d69-40e5-a399-9ee04ce6b545",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "75ca4c78-917c-4447-8f24-ffd6d300901b",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ac2d1745-33f0-47d1-8014-7f2c9617003c",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b791e13d-5c6b-4af2-875c-991d6b560e97",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "599e4364-99b5-412c-b8ea-4c5ca30384a5",
"EffectiveDate": "2026-11-01T08:56:20.0410019-08:00",
"StatusType": {
"StatusTypeId": "55d3a6d5-f8bf-46ac-a4a9-0a54b709481f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "3b66a617-1d69-40e5-a399-9ee04ce6b545",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "75ca4c78-917c-4447-8f24-ffd6d300901b",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "5eea9702-5871-4e7a-9bbb-45f1b4870fd9",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9198d2b1-0184-4ed1-84e5-8bb92b5a6765",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-01T08:56:20.0410019-08:00",
"MeasurementValueNeededDate": "2026-11-01T08:56:20.0410019-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "554f6a38-652e-4f17-bbd4-ff802c96fdd6",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-11-01T08:56:20.0410019-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "7dadd5e9-4901-40cc-b889-e760c80d7b3d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2f046a2f-609f-4a7e-a73e-52af6462db59",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6b9cce71-4461-4e2b-a119-dd26fb807922",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-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": "d5a3cd4b-a667-4086-9267-b2ab61312f5c",
"Asset": {
"AssetId": "ca91082b-5a05-481a-8051-b0559c5cc157",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d91e27fa-693f-43cc-961d-f822c5ba035d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0ed18d44-9f92-41cd-8944-1a2d59cbb0ed",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ebdb5a32-a0da-4120-94bf-6892a216d395",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T08:56:20.0410019-08:00",
"MeasurementValueNeededDate": "2026-11-01T08:56:20.0410019-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3196397a-c7a4-4c0c-979b-43e2ccf5c474",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "aa0c20bb-6c5c-446c-aeef-1df3bb86ca4f",
"EffectiveDate": "2026-11-01T08:56:20.0410019-08:00",
"StateType": {
"StateTypeId": "3739d055-4b16-46bd-8b12-b8ef5c8b46f8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d91e27fa-693f-43cc-961d-f822c5ba035d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0ed18d44-9f92-41cd-8944-1a2d59cbb0ed",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "a4267920-455a-4d87-aa68-5397030ac98b",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ea115a36-e88d-4006-b5af-fb6bdd408a0c",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "a8e79dcc-6bfd-4103-9eca-e67778df1d5e",
"EffectiveDate": "2026-11-01T08:56:20.0410019-08:00",
"StatusType": {
"StatusTypeId": "0b7a22a9-49af-4a42-8e05-1822627b30ab",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d91e27fa-693f-43cc-961d-f822c5ba035d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0ed18d44-9f92-41cd-8944-1a2d59cbb0ed",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "52a39db9-a3df-4c00-ac52-6b2acc4ca7e6",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c0305981-f455-466d-a91a-a51246adf977",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-01T08:56:20.0410019-08:00",
"MeasurementValueNeededDate": "2026-11-01T08:56:20.0410019-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3e305569-0789-4ccc-83fd-180db57a26d0",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-11-01T08:56:20.0410019-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "18a6a862-1482-4d2b-bcfd-a54b97ffb90c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "30572703-462d-48b5-8c5c-95d10bb629e8",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6583090a-6dba-491f-9053-cfeb6eb9ffc1",
"CreateDate": "2026-11-01T08:56:20.0410019-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:56:20.0410019-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}