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": "6d13c535-35e0-4b96-b668-417d98e52b16", "Asset": { "AssetId": "536d3e6e-356d-48e1-94a8-8f0053ae1052", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "f41aa54f-41ba-4edd-8ee5-c354306fda36", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c928b9cb-4a00-4032-a644-a17ccff39000", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "d24a7db6-dc4d-4658-b694-4686d4daf172", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T15:24:03.4916057-07:00", "MeasurementValueNeededDate": "2025-10-13T15:24:03.4916057-07:00", "SourceSystemId": "sample string 3", "CompanyId": "2064abe6-1b0e-433b-891a-575cc1fbc552", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "2b90c0dc-da2c-479e-882b-56f2a122fff8", "EffectiveDate": "2025-10-13T15:24:03.4916057-07:00", "StateType": { "StateTypeId": "c825e81c-61f7-4c9c-9e1a-16fc72bc9ad2", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "f41aa54f-41ba-4edd-8ee5-c354306fda36", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c928b9cb-4a00-4032-a644-a17ccff39000", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "4ad84c67-ebf1-49c5-9320-d0e36ea0dc84", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "797b0e59-8149-4820-a61b-ad5977602ae7", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "747ccdbd-472f-4e26-81ff-68e9b73ef580", "EffectiveDate": "2025-10-13T15:24:03.4916057-07:00", "StatusType": { "StatusTypeId": "34139af1-5e82-4a90-873c-45317c35874b", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "f41aa54f-41ba-4edd-8ee5-c354306fda36", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c928b9cb-4a00-4032-a644-a17ccff39000", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "eef39569-7661-4ddb-8d0b-06960159093f", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "3ff75ed0-5d32-4c53-afba-f04c16c4d148", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "3c30979b-5ba6-468b-bfa0-8dc800fa135f", "EffectiveDate": "2025-10-13T15:24:03.4916057-07:00", "WellPurposeType": { "WellPurposeTypeId": "87475c15-476a-464c-8228-311bdaa27106", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "75e5954e-c0d4-4eaf-a42c-ee8a48b50191", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "474f4818-3581-430d-87c3-286d6d4106da", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-10-13T15:24:03.4916057-07:00", "MeasurementValueNeededDate": "2025-10-13T15:24:03.4916057-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "68e438c8-ed66-4dbd-96a6-67691f793534", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "DisplayText": "sample string 2", "PropertyType": { "PropertyTypeId": "0cc3b445-e41a-44f5-95d5-db0357549587", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "f41aa54f-41ba-4edd-8ee5-c354306fda36", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c928b9cb-4a00-4032-a644-a17ccff39000", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 8" }, "DataType": { "DataTypeId": "5ccf85f8-0b45-49fd-8a65-4d0f70658f50", "Name": "sample string 1" }, "Unit": { "UnitId": "4c88cb2e-c827-4dd6-ab75-d66f6e9e09b2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "6aee55ae-19d4-4700-b542-f8584719d533", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "d1f27b8c-e242-4da4-8084-a296fd27a468", "FieldId": "da667e7e-f691-4d27-a8c0-a28de135e975", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "d1f27b8c-e242-4da4-8084-a296fd27a468", "FieldId": "da667e7e-f691-4d27-a8c0-a28de135e975", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "SourceSystemId": "sample string 4", "CompanyId": "52e4ebb7-623f-40cc-aac3-790fc08ab528", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "f6e89855-e4dc-4f87-8f5b-e76132f375ab", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:24:03.4916057-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": "c0cbda69-6171-407b-835b-411ef7e97611", "Asset": { "AssetId": "e3b9a2e1-a7ee-4158-b527-e02e2154e4ca", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "8a51f45a-3493-4810-bcba-6c2778e70e9a", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3ce451bb-9442-4f2a-a9ea-758ffcec5f8a", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "cef8d0c2-a8d8-4a2b-912b-6e2f7c4fc105", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T15:24:03.4916057-07:00", "MeasurementValueNeededDate": "2025-10-13T15:24:03.4916057-07:00", "SourceSystemId": "sample string 3", "CompanyId": "52e34543-a490-4509-ad0d-9d08f1f79cf5", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "bc41791b-7cee-420c-abec-73b8db082305", "EffectiveDate": "2025-10-13T15:24:03.4916057-07:00", "StateType": { "StateTypeId": "41d02a8b-6d98-4637-861a-3802c407be4e", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "8a51f45a-3493-4810-bcba-6c2778e70e9a", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3ce451bb-9442-4f2a-a9ea-758ffcec5f8a", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "797b9273-0a2d-4915-8e93-ea2b7b388c10", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "d80b87e7-2c4a-459d-a858-1d437918064d", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "a5bdb146-2c32-420a-9a18-8b149e531af4", "EffectiveDate": "2025-10-13T15:24:03.4916057-07:00", "StatusType": { "StatusTypeId": "1d9774ee-2f71-4009-bde3-5d264b2447f8", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "8a51f45a-3493-4810-bcba-6c2778e70e9a", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3ce451bb-9442-4f2a-a9ea-758ffcec5f8a", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "072e56e3-2ffb-4bec-bb00-1508268548bc", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "8aeadf3b-10a8-4d36-8780-369df4ef7b30", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "4ced9344-8dee-4ed5-aa74-401c7c9febf6", "EffectiveDate": "2025-10-13T15:24:03.4916057-07:00", "WellPurposeType": { "WellPurposeTypeId": "e0572a04-4e86-4694-9345-cbec9f9efbb2", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "07e989c8-e456-4e24-8f10-d4645d84120a", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "8e9d30b6-d67b-4b80-bd6a-31f3d3b35fe2", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-10-13T15:24:03.4916057-07:00", "MeasurementValueNeededDate": "2025-10-13T15:24:03.4916057-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "41dc83dc-fef4-4f89-bdb4-01ffbd0a0440", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "DisplayText": "sample string 2", "PropertyType": { "PropertyTypeId": "e78e2335-e763-49ac-bb8b-aab544e658b2", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "8a51f45a-3493-4810-bcba-6c2778e70e9a", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3ce451bb-9442-4f2a-a9ea-758ffcec5f8a", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 8" }, "DataType": { "DataTypeId": "776f6f4b-89ba-438c-b4fd-8d87d09c5265", "Name": "sample string 1" }, "Unit": { "UnitId": "781b40aa-ae68-4061-bf11-5318577caf57", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "07dde20b-d911-4d6a-9cf5-7088d7c31f07", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "5965532a-d9d7-4984-bacc-c9bb82197763", "FieldId": "f5f0d106-4d05-42ae-bc6e-852c74aacf6b", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "5965532a-d9d7-4984-bacc-c9bb82197763", "FieldId": "f5f0d106-4d05-42ae-bc6e-852c74aacf6b", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "SourceSystemId": "sample string 4", "CompanyId": "6ed433ba-b0b1-4d70-af69-47c96065534d", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "74ad39e9-e281-43ff-a992-eaf7a078acae", "CreateDate": "2025-10-13T15:24:03.4916057-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:24:03.4916057-07:00", "LastModifiedUser": "sample string 8" }, "Total": 1, "Message": "sample string 1" }