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.
WellPurposeName | 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": "e1259556-1078-4e6e-9220-6fd85683967f", "Asset": { "AssetId": "e4bc3561-0e7f-4a6d-9b3e-d7bf64dc7951", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e2d78eef-fed3-45e4-a373-818178e330b7", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "183ef887-3c28-4ee7-8827-172ee3a75a07", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "4092f5de-d3da-4ca8-89e7-025a2e5192c8", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-23T05:27:08.7837582-07:00", "MeasurementValueNeededDate": "2024-04-23T05:27:08.7837582-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b3b92ea9-4321-4bac-b227-8541a3e22679", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "938ddb76-3853-43c7-84c5-4d342ae40816", "EffectiveDate": "2024-04-23T05:27:08.7837582-07:00", "StateType": { "StateTypeId": "f1ada55e-a8a1-4be8-b2ea-a2b1af07b858", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "e2d78eef-fed3-45e4-a373-818178e330b7", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "183ef887-3c28-4ee7-8827-172ee3a75a07", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "d1f2d24e-1c94-4623-93a5-3f871d170259", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "826ca79a-1192-4179-aef2-c10ac69072af", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "ae7d6ad8-9fdb-4f0c-9362-8ea1b4dd725a", "EffectiveDate": "2024-04-23T05:27:08.7837582-07:00", "StatusType": { "StatusTypeId": "1a4d5000-66a1-43c1-b814-2651e5d15de0", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "e2d78eef-fed3-45e4-a373-818178e330b7", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "183ef887-3c28-4ee7-8827-172ee3a75a07", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "1e5695fb-1c63-43d2-b77a-bd09304d7bf4", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "c9198e3a-c662-428a-b8cc-75864b273700", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-23T05:27:08.7837582-07:00", "MeasurementValueNeededDate": "2024-04-23T05:27:08.7837582-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d544b781-a959-4538-92cf-0c4f4a4e4525", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-23T05:27:08.7837582-07:00", "WellPurposeType": { "WellPurposeTypeId": "5eb9e5bf-aa76-4106-bf07-892c522a7e0b", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "61d1ad9a-3c22-486d-a493-2e27cdcdc934", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "9095fe97-26a0-4240-be9f-931cfc4bab2f", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-23T05:27:08.7837582-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": "115d312c-6edc-45a9-9a56-4b50e3becb27", "Asset": { "AssetId": "41ba2ff1-e194-4ea6-9f45-26b13d99bb6e", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "56bdab2e-3e50-409c-9d65-99f961d0a20d", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ce825b5d-79bc-40ca-987f-3f05fe6184f1", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "826542e7-6a02-4d03-9f9f-4c01b08a20ee", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-23T05:27:08.7837582-07:00", "MeasurementValueNeededDate": "2024-04-23T05:27:08.7837582-07:00", "SourceSystemId": "sample string 3", "CompanyId": "2679bd06-f290-4ee3-9805-9e07e2dc49b8", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "7071a456-545b-4b1e-b350-a377fc80d28c", "EffectiveDate": "2024-04-23T05:27:08.7837582-07:00", "StateType": { "StateTypeId": "eb86e7e1-b2e6-41f3-b72a-259c0a193a66", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "56bdab2e-3e50-409c-9d65-99f961d0a20d", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ce825b5d-79bc-40ca-987f-3f05fe6184f1", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "7c8ebf8a-77cd-43ca-8980-7b0c38d43ed9", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "29e43d42-d5d2-4386-955b-80f18a7af1ed", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "c36c5740-0456-4a43-82c4-c81da786b024", "EffectiveDate": "2024-04-23T05:27:08.7837582-07:00", "StatusType": { "StatusTypeId": "768df93d-6bf9-48ab-a579-8ee178797a89", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "56bdab2e-3e50-409c-9d65-99f961d0a20d", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ce825b5d-79bc-40ca-987f-3f05fe6184f1", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "5de76942-fb84-4ab1-a5eb-e89a6462836e", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "1738ef8c-3563-4d1b-9c1c-22a3c82cd8ba", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-23T05:27:08.7837582-07:00", "MeasurementValueNeededDate": "2024-04-23T05:27:08.7837582-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "34d822d1-8b29-4609-8f9c-bbfea761f4b0", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2024-04-23T05:27:08.7837582-07:00", "WellPurposeType": { "WellPurposeTypeId": "9ada550b-51db-4bac-aafd-ae2a0151d44a", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8e591cd1-74fa-403f-acd8-0781dead2424", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "dd565bd7-ad62-4caf-a5d7-2539ee2878ff", "CreateDate": "2024-04-23T05:27:08.7837582-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-23T05:27:08.7837582-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }