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": "df9d38df-9a5b-4e28-be0b-3bd557dd53f7",
"Asset": {
"AssetId": "bae7cde1-2544-496e-a6ab-03125d59e2f8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2177cf2e-4fdf-4d0e-aba0-9a31198dd58a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f1e10e3e-2b8d-42a0-b0e8-d460697de17d",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4c9e026f-7227-4278-b618-abd4a34019c3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T18:52:41.4260141-07:00",
"MeasurementValueNeededDate": "2026-06-28T18:52:41.4260141-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7039a2ea-71cf-4073-9e69-2090964c0a5f",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "1c7f687c-74d7-4d91-8ee8-9cff85608294",
"EffectiveDate": "2026-06-28T18:52:41.4260141-07:00",
"StateType": {
"StateTypeId": "48acd3f5-08ea-4d60-a1ed-02ea5051fccf",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2177cf2e-4fdf-4d0e-aba0-9a31198dd58a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f1e10e3e-2b8d-42a0-b0e8-d460697de17d",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "9737c7ea-5a47-4a05-b260-9429aef150da",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1619fac0-f929-41e8-87be-5ada0ae66cc6",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b6680db1-6193-44ef-a129-53db2eecd5c0",
"EffectiveDate": "2026-06-28T18:52:41.4260141-07:00",
"StatusType": {
"StatusTypeId": "770d6250-a64d-49b0-9638-e0bb16c9438a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2177cf2e-4fdf-4d0e-aba0-9a31198dd58a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f1e10e3e-2b8d-42a0-b0e8-d460697de17d",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e7829398-d9fd-46b7-a64a-9bc3a0eabdb4",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5eb30873-d53f-474e-ba76-c94ad86e0d67",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-28T18:52:41.4260141-07:00",
"MeasurementValueNeededDate": "2026-06-28T18:52:41.4260141-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e9db60a7-2a0b-46d2-a686-1c4890c11dc5",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-06-28T18:52:41.4260141-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "c865cb0c-1c9b-4372-93fe-b2ea3ab321e9",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8eef20e2-fdaa-4ca4-807f-be144cacb2fd",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c38564c9-64e0-4da5-8a2b-87841c04ad59",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-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": "bd1760c8-affc-40a5-85b8-eb1bf6efa979",
"Asset": {
"AssetId": "c7a7609d-e657-4f1e-b018-a2d547370814",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c051a28c-9f84-459f-8be5-043ff1731fd1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ef6fde4e-109e-4de5-967a-15ca12246365",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d14e4cb7-8509-44ab-8962-e3ffd6d1ed91",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-28T18:52:41.4260141-07:00",
"MeasurementValueNeededDate": "2026-06-28T18:52:41.4260141-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f0f7fa5c-769a-4e2f-85df-0fcb30e88c02",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c176bbb1-7fed-4289-9fcd-436dc0157623",
"EffectiveDate": "2026-06-28T18:52:41.4260141-07:00",
"StateType": {
"StateTypeId": "1302af09-db66-4d03-bd9e-2fdc533398c3",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "c051a28c-9f84-459f-8be5-043ff1731fd1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ef6fde4e-109e-4de5-967a-15ca12246365",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2c9fcd6b-4ee4-4f1b-b9a4-4b55354fda2f",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "283247e8-47d8-46d9-af73-3e20b9c32394",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f74ef872-5fb5-4950-925f-88ba5f021b86",
"EffectiveDate": "2026-06-28T18:52:41.4260141-07:00",
"StatusType": {
"StatusTypeId": "b39b6026-6873-4d5c-b80b-001326912634",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "c051a28c-9f84-459f-8be5-043ff1731fd1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ef6fde4e-109e-4de5-967a-15ca12246365",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "be61ddc0-9e63-471d-8feb-549e349f53ea",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8b96b4c7-021a-4875-8bf6-eb60f8108c5a",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-28T18:52:41.4260141-07:00",
"MeasurementValueNeededDate": "2026-06-28T18:52:41.4260141-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2164138b-94da-40ef-b1e6-8214c606bbe5",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-06-28T18:52:41.4260141-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "601ec330-02ce-415e-a1e3-7fb444b4adf0",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c1bc44c5-f944-47ef-97bb-fc5206548879",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "107c6c1e-2b40-43d4-8972-c764b6e8d54e",
"CreateDate": "2026-06-28T18:52:41.4260141-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-28T18:52:41.4260141-07:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}