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": "6bfa05de-2d6f-4e7c-977e-a2200997322f",
"Asset": {
"AssetId": "566062da-18e6-43c1-943e-15e9183161d2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "da39db56-8d9b-474e-84a4-40f10142f86d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ea26892d-c51f-4ddf-8f16-eaede37cedb0",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "489cf1eb-ad86-4e5d-996a-bd11cfeedd34",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-07T11:36:13.5238978-08:00",
"MeasurementValueNeededDate": "2026-03-07T11:36:13.5238978-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "523d9ea8-5b11-4ce8-8592-8f5d67b498ce",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "cd817f3e-1543-4bea-9377-f4599aa1ae66",
"EffectiveDate": "2026-03-07T11:36:13.5238978-08:00",
"StateType": {
"StateTypeId": "2cf8b5e2-3a79-4337-ab94-981e879b35de",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "da39db56-8d9b-474e-84a4-40f10142f86d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ea26892d-c51f-4ddf-8f16-eaede37cedb0",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "19f47c26-0ae6-4f58-9172-5092bb61fe90",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "81c856a9-0925-408a-ba3d-7b2593675816",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "0fa1e9af-311a-4f7a-acd3-fac2139158da",
"EffectiveDate": "2026-03-07T11:36:13.5238978-08:00",
"StatusType": {
"StatusTypeId": "72afbc15-bbbc-4a4c-b09c-b16ff603c90e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "da39db56-8d9b-474e-84a4-40f10142f86d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ea26892d-c51f-4ddf-8f16-eaede37cedb0",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "565fe16c-2bd5-4aed-89e1-4038e5c8d6ba",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a118b58a-6b02-4585-8862-43283f39b8ea",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-07T11:36:13.5238978-08:00",
"MeasurementValueNeededDate": "2026-03-07T11:36:13.5238978-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "34beecec-3c6c-44a9-bfc7-01d3afa7f6d3",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-03-07T11:36:13.5238978-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "15853580-b55c-46f9-9c13-d4acc76de01a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3fdf0105-a708-4503-b0dc-4b6986650603",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4dc80f3e-2593-490b-ab24-b3b96e883c92",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-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": "bb511868-6b69-4523-83bf-557954b6384f",
"Asset": {
"AssetId": "e8aa7812-36e1-4461-b000-7a1b7fe8c108",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "521d6ae5-1e2e-4b9b-8027-b3f0c4790bd3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "10a0349b-4c70-4873-b195-3017bd901576",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "84da1165-5f86-4855-9d65-cd4b87966787",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-07T11:36:13.5238978-08:00",
"MeasurementValueNeededDate": "2026-03-07T11:36:13.5238978-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "236466f1-12b6-4207-990e-56f7f3185e5c",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "9b1fecd3-c73a-42b8-812a-0ab0802136c6",
"EffectiveDate": "2026-03-07T11:36:13.5238978-08:00",
"StateType": {
"StateTypeId": "fd026a40-52e6-4431-97d9-30f3af3ffc45",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "521d6ae5-1e2e-4b9b-8027-b3f0c4790bd3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "10a0349b-4c70-4873-b195-3017bd901576",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e5dfaab5-a002-4528-b9e7-981857a1ea77",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bfebcb34-6e9b-43be-846f-7d3bb9119562",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "645e50d7-7b3e-415b-873d-6ab49cb3c2d4",
"EffectiveDate": "2026-03-07T11:36:13.5238978-08:00",
"StatusType": {
"StatusTypeId": "727ac698-b035-4c95-9ca4-448b1974322b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "521d6ae5-1e2e-4b9b-8027-b3f0c4790bd3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "10a0349b-4c70-4873-b195-3017bd901576",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e0f14252-3212-4abf-a16e-88bd40aa97e0",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f365cdc1-b220-4bc1-b9cf-51a93a0052f9",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-07T11:36:13.5238978-08:00",
"MeasurementValueNeededDate": "2026-03-07T11:36:13.5238978-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b44ea942-311e-4aa6-92ec-b58a776498f4",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-03-07T11:36:13.5238978-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "b75adc4e-85a4-42ed-a63b-299db983aeb8",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "72c9bc45-151a-45cf-a6f6-8cdb0b1f2887",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "491096cb-e750-4481-84b4-66b8a0c265df",
"CreateDate": "2026-03-07T11:36:13.5238978-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-07T11:36:13.5238978-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}