POST Properties
Creates a new property.
Request Information
URI Parameters
None.
Body Parameters
Property to be created. PropertyId should not be filled in.
PropertyName | Description | Type | Additional information |
---|---|---|---|
PropertyId | globally unique identifier |
None. |
|
Asset | Asset |
None. |
|
ValueText | string |
None. |
|
DisplayText | string |
None. |
|
PropertyType | PropertyType |
None. |
|
IsValid | boolean |
None. |
|
IsValidMessage | string |
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:
{ "PropertyId": "8a3335a7-8d4e-4a3d-9214-85a7166f7ba6", "Asset": { "AssetId": "17dfe7d1-2d22-45da-8dd3-b4c9842aef4a", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "ef64125a-5a2d-42bf-b927-40f2e6e4575c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "fbe6e90a-4b7f-485c-a108-fc9c0f787ffc", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "dc159e6b-f4c8-4c61-9e33-b23bc2149068", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-11T20:18:43.694113-07:00", "MeasurementValueNeededDate": "2025-07-11T20:18:43.694113-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f5d4a916-7797-48ef-acf1-a8581405252b", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "ba14ec90-473d-42a9-9549-e0c9df1464d2", "EffectiveDate": "2025-07-11T20:18:43.694113-07:00", "StateType": { "StateTypeId": "a779d660-1846-4162-b50b-768967c7e379", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "ef64125a-5a2d-42bf-b927-40f2e6e4575c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "fbe6e90a-4b7f-485c-a108-fc9c0f787ffc", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "03661cda-6402-4fac-9ac3-7d6f893aec82", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "f73d64d8-faaf-42c4-9f60-bceaf79cdd3e", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "f6ae6efc-ddf8-4a43-922a-3298cd6fa850", "EffectiveDate": "2025-07-11T20:18:43.694113-07:00", "StatusType": { "StatusTypeId": "1477d2f3-e509-4eea-87d4-0b58f78be3c0", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "ef64125a-5a2d-42bf-b927-40f2e6e4575c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "fbe6e90a-4b7f-485c-a108-fc9c0f787ffc", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "bf43278b-618f-4d26-b52c-dc14c267d7d9", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "bad8e7df-5bfd-4d72-a403-cb8b43143b3a", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "445e92cc-6f4b-407a-a283-36d2289a1df3", "EffectiveDate": "2025-07-11T20:18:43.694113-07:00", "WellPurposeType": { "WellPurposeTypeId": "ef2e887e-51ce-4808-be45-cd414fa57beb", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "75eb8a17-fa45-4511-a221-80fecfeaa2e9", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "5f09f0a1-8317-4841-acd0-3da1392cd9b9", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-11T20:18:43.694113-07:00", "MeasurementValueNeededDate": "2025-07-11T20:18:43.694113-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "901f1b10-95ca-494a-8808-b65e876bb987", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "DisplayText": "sample string 2", "PropertyType": { "PropertyTypeId": "b3205e3b-addf-4d2f-a6e1-ed4f7cc76334", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "ef64125a-5a2d-42bf-b927-40f2e6e4575c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "fbe6e90a-4b7f-485c-a108-fc9c0f787ffc", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 8" }, "DataType": { "DataTypeId": "c37ef3df-db79-4325-a95d-9018d1bbaeeb", "Name": "sample string 1" }, "Unit": { "UnitId": "606e89db-f435-4052-b237-c120213b823a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8bb63898-391f-4f29-9aff-5f71d7e08f22", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "8b0f9504-36b7-44c5-b2d4-1d49dd05b5c4", "FieldId": "e02385c1-da3c-48c4-8f93-91a33e356d63", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "8b0f9504-36b7-44c5-b2d4-1d49dd05b5c4", "FieldId": "e02385c1-da3c-48c4-8f93-91a33e356d63", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "SourceSystemId": "sample string 4", "CompanyId": "842b2d0a-75d4-4707-a1a7-762e185cff2c", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8c7c31f5-51f6-455c-b427-234853fbae5e", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 8" }
Response Information
Resource Description
On success, the created property.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Property |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "PropertyId": "15f92af1-014d-4f93-913b-d0b6da7f9199", "Asset": { "AssetId": "1d3dc537-2e2f-4fe9-acf2-ddb950d3c06f", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "c175b3c5-2df5-40de-ac2c-55231f3930eb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf61290d-a33d-4613-8ad2-d945b5d6a586", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "e3021d83-a870-4f6f-aac8-fde8bc257770", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-11T20:18:43.694113-07:00", "MeasurementValueNeededDate": "2025-07-11T20:18:43.694113-07:00", "SourceSystemId": "sample string 3", "CompanyId": "614d1e26-4a71-41a7-8329-1a51b438f2d1", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "b1cf541f-b2c3-434d-9e4e-c7e3c65d5875", "EffectiveDate": "2025-07-11T20:18:43.694113-07:00", "StateType": { "StateTypeId": "747561c3-e26f-48cd-a6d5-e591231a2549", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "c175b3c5-2df5-40de-ac2c-55231f3930eb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf61290d-a33d-4613-8ad2-d945b5d6a586", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "7e97869a-56dd-4922-a69c-0bb5a8d0d1a0", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "e6fe3452-f688-4f55-88de-7653ccb40e94", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "1647834b-c15a-4ec3-a413-06b82e41470e", "EffectiveDate": "2025-07-11T20:18:43.694113-07:00", "StatusType": { "StatusTypeId": "bdaa99e8-dddc-42db-842f-66457bcf4617", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "c175b3c5-2df5-40de-ac2c-55231f3930eb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf61290d-a33d-4613-8ad2-d945b5d6a586", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "7580c738-6f30-486f-b40b-6dba2b31393c", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "dbf4405d-ace3-473c-9c9a-502bffbacda3", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "c56655b0-56a6-405c-8059-33b929fe5e2a", "EffectiveDate": "2025-07-11T20:18:43.694113-07:00", "WellPurposeType": { "WellPurposeTypeId": "1431d325-7c3f-48c1-b3ae-3a45ede80584", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "dd5f1e60-fb76-4cb1-a87a-261cbfc126ba", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "104ed763-b2e9-4226-9f7c-734f99adb121", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-11T20:18:43.694113-07:00", "MeasurementValueNeededDate": "2025-07-11T20:18:43.694113-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "fa56bb7d-8519-4d6d-9633-6c0c1b67ff5d", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "DisplayText": "sample string 2", "PropertyType": { "PropertyTypeId": "b01da18c-7b3b-4723-be14-968bc24fb4bd", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "c175b3c5-2df5-40de-ac2c-55231f3930eb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bf61290d-a33d-4613-8ad2-d945b5d6a586", "CreateDate": "2025-07-11T20:18:43.694113-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T20:18:43.694113-07:00", "LastModifiedUser": "sample string 8" }, "DataType": { "DataTypeId": "42dd7a9a-ed7b-47e9-a222-d9d207278532", "Name": "sample string 1" }, "Unit": { "UnitId": "602ac6d8-50f7-4585-bd3c-afb677e5c54f", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a64040e0-531f-4e9a-a730-00eaadb2483b", "CreateDate": "2025-07-11T20:18:43.7097324-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-11T20:18:43.7097324-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a07898b8-8eca-4f0f-aaf6-87c9135ef18e", "FieldId": "ec7fe253-b3b9-414a-8f7f-f3e78b076682", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a07898b8-8eca-4f0f-aaf6-87c9135ef18e", "FieldId": "ec7fe253-b3b9-414a-8f7f-f3e78b076682", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "SourceSystemId": "sample string 4", "CompanyId": "75dd2041-16b8-40da-9124-11eb4dbae0b4", "CreateDate": "2025-07-11T20:18:43.7097324-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-11T20:18:43.7097324-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "283bcf03-d8e4-40db-9b26-9e73f0e06429", "CreateDate": "2025-07-11T20:18:43.7097324-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-11T20:18:43.7097324-07:00", "LastModifiedUser": "sample string 8" }, "Total": 1, "Message": "sample string 1" }