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": "5da5839e-d403-423a-8f9f-9e564dddda4e",
"Asset": {
"AssetId": "a3a7ccc8-5bf0-44fa-ae9d-678eb75d0f47",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1c74e1f7-9f48-4d1c-ab4d-718c7ce09993",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a71e3224-6625-40b3-aebb-f3aa87b79302",
"CreateDate": "2026-11-22T12:36:59.2390291-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:36:59.2390291-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "35f35902-f485-460c-8732-b296b5621c3b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T12:36:59.2390291-08:00",
"MeasurementValueNeededDate": "2026-11-22T12:36:59.2390291-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0fd93f4f-043b-4a34-a9bb-3a9163c72229",
"CreateDate": "2026-11-22T12:36:59.2390291-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T12:36:59.2390291-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "369d979e-5980-4014-bdde-4e66f2add545",
"EffectiveDate": "2026-11-22T12:36:59.2390291-08:00",
"StateType": {
"StateTypeId": "dced0e13-f259-4dcf-a357-d487150e2377",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "1c74e1f7-9f48-4d1c-ab4d-718c7ce09993",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a71e3224-6625-40b3-aebb-f3aa87b79302",
"CreateDate": "2026-11-22T12:36:59.2390291-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:36:59.2390291-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "421da18c-f3e2-410c-9513-32f9909b25e2",
"CreateDate": "2026-11-22T12:36:59.2390291-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T12:36:59.2390291-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e8b2d398-e8ec-48ae-ba1f-ca64abfd61e8",
"CreateDate": "2026-11-22T12:36:59.2390291-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T12:36:59.2390291-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b7836d43-31a7-4cbc-b709-3138523f6412",
"EffectiveDate": "2026-11-22T12:36:59.2390291-08:00",
"StatusType": {
"StatusTypeId": "9e342fd4-89f2-405b-b9fc-e211ddb4fa94",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "1c74e1f7-9f48-4d1c-ab4d-718c7ce09993",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a71e3224-6625-40b3-aebb-f3aa87b79302",
"CreateDate": "2026-11-22T12:36:59.2390291-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:36:59.2390291-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3273d052-953a-40d2-9e8e-77b06a0f9ff0",
"CreateDate": "2026-11-22T12:36:59.2390291-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T12:36:59.2390291-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b38d694d-fa8e-4bd3-acd5-626c5d6c88eb",
"CreateDate": "2026-11-22T12:36:59.2390291-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T12:36:59.2390291-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T12:36:59.2390291-08:00",
"MeasurementValueNeededDate": "2026-11-22T12:36:59.2390291-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1b48a6bc-2bd8-429e-ae36-5683909f7e29",
"CreateDate": "2026-11-22T12:36:59.2390291-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:36:59.2390291-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-11-22T12:36:59.2390291-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "00e8e06d-78a0-41a8-bcfd-9c8e6d43c717",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f4236277-7a59-4d0c-883b-4e4b6764f4a7",
"CreateDate": "2026-11-22T12:36:59.2390291-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T12:36:59.2390291-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d116fb00-3a8c-411f-ba4a-238f71f3727d",
"CreateDate": "2026-11-22T12:36:59.2390291-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T12:36:59.2390291-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": "e5c098a9-3493-4bce-8fd1-a7b03513b60e",
"Asset": {
"AssetId": "40c5e8f2-f10a-4cc7-8e36-581781881bcc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d28237f1-4043-4561-868b-2f9acb8486b7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8ce711ba-c441-4b5d-9ce0-c54805559530",
"CreateDate": "2026-11-22T12:36:59.2546392-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:36:59.2546392-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "18176d4a-d80d-4532-b736-b893a83888ed",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T12:36:59.2546392-08:00",
"MeasurementValueNeededDate": "2026-11-22T12:36:59.2546392-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "437e1511-a27c-405d-b54f-b4f1b893e8bc",
"CreateDate": "2026-11-22T12:36:59.2546392-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T12:36:59.2546392-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "bf957fe1-b56e-4e51-8d06-7e728d8c88a6",
"EffectiveDate": "2026-11-22T12:36:59.2546392-08:00",
"StateType": {
"StateTypeId": "d12ac53f-3e74-4190-a4a9-1b5f7a43694d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d28237f1-4043-4561-868b-2f9acb8486b7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8ce711ba-c441-4b5d-9ce0-c54805559530",
"CreateDate": "2026-11-22T12:36:59.2546392-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:36:59.2546392-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2cd7be40-6bae-4764-8aa1-1628b9169982",
"CreateDate": "2026-11-22T12:36:59.2546392-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T12:36:59.2546392-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "adeb1b9e-d645-4ec7-b94b-d99e5cd0dd6d",
"CreateDate": "2026-11-22T12:36:59.2546392-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T12:36:59.2546392-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "63b0bd2f-7d37-4c4b-8eef-c9d99388f583",
"EffectiveDate": "2026-11-22T12:36:59.2546392-08:00",
"StatusType": {
"StatusTypeId": "fcd721e8-8984-482b-a5c0-566e58b0035b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d28237f1-4043-4561-868b-2f9acb8486b7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "8ce711ba-c441-4b5d-9ce0-c54805559530",
"CreateDate": "2026-11-22T12:36:59.2546392-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:36:59.2546392-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "73e7ce58-25cb-47db-8156-fec57324a520",
"CreateDate": "2026-11-22T12:36:59.2546392-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T12:36:59.2546392-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "53843015-3da6-4cb4-970b-6913151479d3",
"CreateDate": "2026-11-22T12:36:59.2546392-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T12:36:59.2546392-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T12:36:59.2546392-08:00",
"MeasurementValueNeededDate": "2026-11-22T12:36:59.2546392-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6a9e9148-8e2d-439e-90dd-7e6069255a67",
"CreateDate": "2026-11-22T12:36:59.2546392-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T12:36:59.2546392-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2026-11-22T12:36:59.2546392-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "0e7e2dc6-fd85-431c-88f6-69b3908bec06",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1780a6cc-9ec3-4dfd-8a90-07b3e9fe3059",
"CreateDate": "2026-11-22T12:36:59.2546392-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T12:36:59.2546392-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c2bd8c29-195d-4499-9133-dc9db302b5e4",
"CreateDate": "2026-11-22T12:36:59.2546392-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T12:36:59.2546392-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}