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": "44ababc5-1a54-40cb-8ccc-9e373ed6931f",
"Asset": {
"AssetId": "6cecd129-5956-4b2d-a8ed-2384a7c7e177",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4344c7e1-a90f-4984-af41-5b182d8eccbf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "948332db-62f1-43c0-ab0c-8789b97915b1",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "78bcbb9d-6b80-4f0c-babe-a289f83efa2c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-05-08T16:24:29.7581658-07:00",
"MeasurementValueNeededDate": "2025-05-08T16:24:29.7581658-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "82783cfa-4a96-499b-afe6-b4714beaa83f",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d3774375-530e-4606-8a6f-19edb96fb53e",
"EffectiveDate": "2025-05-08T16:24:29.7581658-07:00",
"StateType": {
"StateTypeId": "c6161a91-416e-4356-a45a-46cb79e1cf5b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4344c7e1-a90f-4984-af41-5b182d8eccbf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "948332db-62f1-43c0-ab0c-8789b97915b1",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f7adfa5d-fece-4c76-9b42-86965b480651",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c05bb865-84ba-43b4-8019-7a20c2a06178",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8fe111d1-cd48-4cd6-ba80-28f678238923",
"EffectiveDate": "2025-05-08T16:24:29.7581658-07:00",
"StatusType": {
"StatusTypeId": "ff3e1677-bbe8-4893-980e-4988a2ccfd61",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4344c7e1-a90f-4984-af41-5b182d8eccbf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "948332db-62f1-43c0-ab0c-8789b97915b1",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "303f9064-4966-4c5b-b63c-9978255361e3",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "163e2810-80fa-4e3d-8e68-fda2e71078dc",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-05-08T16:24:29.7581658-07:00",
"MeasurementValueNeededDate": "2025-05-08T16:24:29.7581658-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "da486603-d164-495c-8018-71c4e76232a1",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-05-08T16:24:29.7581658-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "14a2b8db-2ae1-47ea-bc89-49d04ce89db6",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ffd04b6b-0630-46cc-b5d1-fd6d587323be",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7a86362e-0e86-45d8-ab64-6971e655070a",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-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": "855c5cba-8b2d-492c-b5ef-98a55b69b69c",
"Asset": {
"AssetId": "0afcb0c4-bc99-4532-9d58-21b01ac8ecdc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "220a901a-dd18-4334-a748-e9182bf2700b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5c26be18-086a-41fc-8cd5-fb655222b334",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e562a0a2-5b32-44ad-a19a-0f899d48b6a9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-05-08T16:24:29.7581658-07:00",
"MeasurementValueNeededDate": "2025-05-08T16:24:29.7581658-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3671f52f-73c8-4380-9800-3a0f924716d3",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a9eb73d3-3ae2-4ce9-aa61-468066e5baa1",
"EffectiveDate": "2025-05-08T16:24:29.7581658-07:00",
"StateType": {
"StateTypeId": "26f9c7cf-77bd-41bc-a1b8-26c37ccaad5b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "220a901a-dd18-4334-a748-e9182bf2700b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5c26be18-086a-41fc-8cd5-fb655222b334",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "42e5ed34-9c14-4b33-8110-0f2509411caf",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5b71f4c8-e72d-49c3-95c8-7fc9383857fc",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "49b4c0c6-ad36-450e-aee3-19f828deaebf",
"EffectiveDate": "2025-05-08T16:24:29.7581658-07:00",
"StatusType": {
"StatusTypeId": "e3fbea09-921e-44b0-a1ed-d47f3345d764",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "220a901a-dd18-4334-a748-e9182bf2700b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5c26be18-086a-41fc-8cd5-fb655222b334",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "709d6f80-d8c3-44db-9a0f-0b08cabf5472",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3ba44666-16f2-468a-a681-1302b41c260c",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-05-08T16:24:29.7581658-07:00",
"MeasurementValueNeededDate": "2025-05-08T16:24:29.7581658-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "57364207-d599-430d-93d6-0dcff44b57f3",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-05-08T16:24:29.7581658-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d4dfe65f-5a47-428b-90a9-5733fcfde602",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6c90aa18-b41e-4fb7-be09-988dfbf1d62b",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3b9bf471-6e8a-447e-9bfa-e74135c35751",
"CreateDate": "2025-05-08T16:24:29.7581658-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-08T16:24:29.7581658-07:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}