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": "16cb8c32-e2bc-4eac-a2f7-4124a06d336f",
"Asset": {
"AssetId": "bf130714-7765-4175-892d-9771f59a2509",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6e04bdbb-c78e-430e-afdf-0753016fb7df",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "26217efc-2955-497a-977f-3152f3ac0626",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "17e567c2-94e3-46e9-91a0-c0e1d9f1f9e5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-11T22:27:26.4214292-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:27:26.4214292-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9abef2c8-68ba-41b9-ad49-18bd13340d19",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d9e135c8-4d35-4e94-bbed-7382996fd6e7",
"EffectiveDate": "2026-08-11T22:27:26.4214292-07:00",
"StateType": {
"StateTypeId": "3e4f5742-32df-4156-bf11-4e42741766bd",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "6e04bdbb-c78e-430e-afdf-0753016fb7df",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "26217efc-2955-497a-977f-3152f3ac0626",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b27456cc-0220-42ac-9690-8d752c6c4c5c",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f795d7a9-1c4a-4c6c-8b25-b85995378fdf",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "48c22a91-63c1-4e15-b838-536756ad95cf",
"EffectiveDate": "2026-08-11T22:27:26.4214292-07:00",
"StatusType": {
"StatusTypeId": "c27f6d19-b7ee-409c-aaf1-018e56f19d65",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "6e04bdbb-c78e-430e-afdf-0753016fb7df",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "26217efc-2955-497a-977f-3152f3ac0626",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "fb20c924-e544-458e-bf59-f706d472d946",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "39677b64-fc86-4d31-b94d-a95d74bfafcb",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-11T22:27:26.4214292-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:27:26.4214292-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "879da6d3-ad29-40bd-a6a0-83588a9e12e6",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-08-11T22:27:26.4214292-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "ed00a762-5194-4438-bb42-e6c9b07a9427",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0bbf3c96-0e16-4654-8321-d2803a139307",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "aee51a8e-5ed9-412e-a515-7e13da0918ea",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-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": "86481fdb-6428-46e5-8fc1-2b413fe556a6",
"Asset": {
"AssetId": "b4b9cec6-9592-408a-8a6d-0133a1622464",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "64c24024-cd5e-4d09-ae19-ffe786550d6a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e7760e14-44b9-4560-bcaf-5743f5213d99",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c0649080-743c-470b-9a40-fedf68e73ac8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-11T22:27:26.4214292-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:27:26.4214292-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "95e9cae4-2dd8-4657-91d9-6da70c349072",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ba5cc9c3-f5fe-4325-877b-336d897875a0",
"EffectiveDate": "2026-08-11T22:27:26.4214292-07:00",
"StateType": {
"StateTypeId": "129eb4ab-5818-4cab-b1e5-ea05c54aff86",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "64c24024-cd5e-4d09-ae19-ffe786550d6a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e7760e14-44b9-4560-bcaf-5743f5213d99",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "08cddbe6-2963-4473-9a74-0aeba7cc9fdb",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6921acda-6742-4a1d-9bd3-7e319de5bf6e",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "412d1552-ee2e-4437-b9ff-b1b52b61810b",
"EffectiveDate": "2026-08-11T22:27:26.4214292-07:00",
"StatusType": {
"StatusTypeId": "24325436-6f90-4817-9e73-3a9858c0faea",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "64c24024-cd5e-4d09-ae19-ffe786550d6a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e7760e14-44b9-4560-bcaf-5743f5213d99",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "607df0c2-dcc8-4cee-8d93-7ba928610479",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "77867d8b-d2fc-48af-8276-114195b35e16",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-11T22:27:26.4214292-07:00",
"MeasurementValueNeededDate": "2026-08-11T22:27:26.4214292-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6bf48829-b1ca-4325-8107-fc2cc2411f83",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-08-11T22:27:26.4214292-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "38defc36-a1e9-4d8a-8b4d-6d2c564fc5c6",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "458b7119-c47f-4649-9762-416737c6d65f",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5707a74f-1dc1-40ad-87bb-5a81060a775b",
"CreateDate": "2026-08-11T22:27:26.4214292-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-11T22:27:26.4214292-07:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}