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": "45f2dcc4-f3ad-438e-97ab-ccdbc0b11fde",
"Asset": {
"AssetId": "0d68a5b3-77b6-4504-9c46-040f772f0b2a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "859fc53d-3ce2-4b1d-89c0-427581278ab8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f6bcc59c-8cc1-4b04-96e6-d240d7d6b4d8",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a480ea28-7921-4644-a67b-84e7a40c0884",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-29T14:31:36.655137-07:00",
"MeasurementValueNeededDate": "2025-10-29T14:31:36.655137-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e8b9bc44-e03a-4ae1-afc3-253b86a17017",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8ea7b172-3d2c-4c10-8e3e-1399833343b5",
"EffectiveDate": "2025-10-29T14:31:36.655137-07:00",
"StateType": {
"StateTypeId": "bff9b408-3cf2-463b-a8f8-a28f7d2b3748",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "859fc53d-3ce2-4b1d-89c0-427581278ab8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f6bcc59c-8cc1-4b04-96e6-d240d7d6b4d8",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "31be28a2-3445-48a3-aec2-ffe87f0df461",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5e248b95-83aa-46af-8113-8f65c99de1ae",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c2804a42-7707-4372-9bcb-bc67e9d76af9",
"EffectiveDate": "2025-10-29T14:31:36.655137-07:00",
"StatusType": {
"StatusTypeId": "67aa0340-20cd-4b2d-98fc-d0d8eeef0ba9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "859fc53d-3ce2-4b1d-89c0-427581278ab8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f6bcc59c-8cc1-4b04-96e6-d240d7d6b4d8",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "512466f1-9225-4f79-9dd3-7d72a1a72601",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7f0db037-0aa0-40c5-93af-eb39cf724b91",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-10-29T14:31:36.655137-07:00",
"MeasurementValueNeededDate": "2025-10-29T14:31:36.655137-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5089e395-a752-4280-a21f-e7feb147f4b5",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-10-29T14:31:36.655137-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "41331649-6890-4f0f-a61b-1628e115812e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6a8ab9c0-304d-4510-ac98-51444ef107f2",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "73904041-06e4-4eec-8a68-d8768a4a702b",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-29T14:31:36.655137-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": "9a49e5f7-d9c2-4d30-8fff-7b76ea47b0b1",
"Asset": {
"AssetId": "55e37b13-377a-4937-b1cc-0bd1dec5c212",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5df2b6ad-549e-4b9c-99bc-bd2754616760",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e7b08e2e-51a5-4809-a3e4-122cb0c28526",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b05ecbc1-1ca1-419a-8264-a419a5083aed",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-29T14:31:36.655137-07:00",
"MeasurementValueNeededDate": "2025-10-29T14:31:36.655137-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "908a0c22-969e-4aec-8a5d-9ae09b85346c",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "bf486d19-d935-4352-bc40-6a4655646335",
"EffectiveDate": "2025-10-29T14:31:36.655137-07:00",
"StateType": {
"StateTypeId": "1ef3a504-d481-4366-9f1f-049abea7d321",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "5df2b6ad-549e-4b9c-99bc-bd2754616760",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e7b08e2e-51a5-4809-a3e4-122cb0c28526",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "5729c80c-b186-43d5-aaa5-52e59a7820f1",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "eb818d1b-691d-48cb-9a41-b2c5a6edf577",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "2d0abf34-2865-4285-98c7-3c49138f61c1",
"EffectiveDate": "2025-10-29T14:31:36.655137-07:00",
"StatusType": {
"StatusTypeId": "5d3f5ebf-959a-4c59-99f6-f69db54ca6ee",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "5df2b6ad-549e-4b9c-99bc-bd2754616760",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e7b08e2e-51a5-4809-a3e4-122cb0c28526",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8eae3166-4cdb-441c-aa63-a3d8b30348c1",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d86e5044-fc1a-4cd4-90ce-6f53bf29d79a",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-10-29T14:31:36.655137-07:00",
"MeasurementValueNeededDate": "2025-10-29T14:31:36.655137-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "34618a4f-7bcd-4793-88a3-ae785018b810",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-10-29T14:31:36.655137-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "184d3723-3895-42aa-bc36-95aa24f3ea2c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "aed6d479-e6a6-4acf-bc54-462f7fdbcb96",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5d8e1fe5-faec-453a-a305-cbcdb8561602",
"CreateDate": "2025-10-29T14:31:36.655137-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-29T14:31:36.655137-07:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}