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": "88b64ec3-9d88-4777-9e58-f720e735c45e", "Asset": { "AssetId": "bc8eaa03-8243-4d27-97ad-01b877cd490c", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "56235d7a-49b3-44a2-bdc8-c1fa58467b6e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4a3c8ae8-6616-4528-976c-243dcb1a61ae", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:20:04.0771545-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "5278f014-0f9e-460d-bb31-c981cdf35b2d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T07:20:04.0771545-07:00", "MeasurementValueNeededDate": "2025-06-27T07:20:04.0771545-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ef8cd222-70f1-4896-ba55-30a124ac3277", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T07:20:04.0771545-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "468c2185-9ebc-4c48-a9ad-5788a18c841f", "EffectiveDate": "2025-06-27T07:20:04.0771545-07:00", "StateType": { "StateTypeId": "8da554f4-e656-495d-80c7-905cdbd18417", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "56235d7a-49b3-44a2-bdc8-c1fa58467b6e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4a3c8ae8-6616-4528-976c-243dcb1a61ae", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:20:04.0771545-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "7beec619-c788-42c4-b5a6-525d3abb2765", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T07:20:04.0771545-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "eaeaf6e6-b33b-445a-b7ac-25fad06937a9", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:20:04.0771545-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "da6311d4-b47f-4612-bd95-083f1d7fa729", "EffectiveDate": "2025-06-27T07:20:04.0771545-07:00", "StatusType": { "StatusTypeId": "0efa66a2-9306-4191-9d92-7899093ec805", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "56235d7a-49b3-44a2-bdc8-c1fa58467b6e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4a3c8ae8-6616-4528-976c-243dcb1a61ae", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:20:04.0771545-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "fdce9f2b-7ce3-4eb1-a377-b614abbc6cee", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:20:04.0771545-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "07673c80-dd08-4084-a008-0fbffb460758", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:20:04.0771545-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "639da4c1-54d9-4673-98b2-46b1f0f348bb", "EffectiveDate": "2025-06-27T07:20:04.0771545-07:00", "WellPurposeType": { "WellPurposeTypeId": "98a3e26b-88b7-4da3-bfec-1f1f05439921", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "04b7126f-9489-45d4-b60e-11104cf62c88", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:20:04.0771545-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "1c48ee3c-0d5d-4631-9294-26f5a643ba7c", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:20:04.0771545-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-27T07:20:04.0771545-07:00", "MeasurementValueNeededDate": "2025-06-27T07:20:04.0771545-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "5b876a11-154a-484d-aa12-e5a64930c1ce", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:20:04.0771545-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "DisplayText": "sample string 2", "PropertyType": { "PropertyTypeId": "377e0445-a8de-4b20-9a43-45061d9621d7", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "56235d7a-49b3-44a2-bdc8-c1fa58467b6e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4a3c8ae8-6616-4528-976c-243dcb1a61ae", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:20:04.0771545-07:00", "LastModifiedUser": "sample string 8" }, "DataType": { "DataTypeId": "b6ad71e0-9492-4ac3-8d9d-4e1232f91385", "Name": "sample string 1" }, "Unit": { "UnitId": "9771a130-5057-42d3-b2f4-78458b3f5e4a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "03d3f09a-ff06-45d0-b3e8-3dbe01ac9d6d", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T07:20:04.0771545-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "959a9c32-1886-4535-a8a9-de616f71002a", "FieldId": "0df02480-8b25-4bed-b22e-dfaed0c1ea9b", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "959a9c32-1886-4535-a8a9-de616f71002a", "FieldId": "0df02480-8b25-4bed-b22e-dfaed0c1ea9b", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "SourceSystemId": "sample string 4", "CompanyId": "911f3a5f-6675-4112-989a-524e80b03ec9", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:20:04.0771545-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "151051df-0508-464f-81cc-e59f64a01318", "CreateDate": "2025-06-27T07:20:04.0771545-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:20:04.0771545-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": "ba537410-189c-4928-b466-e13561ddd8b5", "Asset": { "AssetId": "6c3337d1-3ac5-4511-be11-9a67b1d21053", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "eed9018f-c5d7-42f9-b49d-0725546b9081", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4cde2927-7223-4309-8397-2231c54475c7", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "4ee019f4-cd6a-4713-b438-12eb096c1101", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-27T07:20:04.0927204-07:00", "MeasurementValueNeededDate": "2025-06-27T07:20:04.0927204-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3b57d4ac-c3ca-4a1f-8de0-51af70d3ec96", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "7a518e6b-940d-450f-bc67-d8ada4ffcffb", "EffectiveDate": "2025-06-27T07:20:04.0927204-07:00", "StateType": { "StateTypeId": "07d2800e-5f52-4de9-aa15-0b807dd40177", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "eed9018f-c5d7-42f9-b49d-0725546b9081", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4cde2927-7223-4309-8397-2231c54475c7", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "3b95bb07-74b6-4157-b8fa-95eef56fda3f", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "79fafdcf-1bf0-46a3-9726-8881dc733640", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "0f8d4406-c1c6-4c5c-8f2f-b71f6743ea2d", "EffectiveDate": "2025-06-27T07:20:04.0927204-07:00", "StatusType": { "StatusTypeId": "850b8971-d5cf-498f-9b29-820a4a8415ac", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "eed9018f-c5d7-42f9-b49d-0725546b9081", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4cde2927-7223-4309-8397-2231c54475c7", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "0158c89c-865c-4009-be6e-3656ecabc4bf", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "28037747-79e4-477c-8b02-264a7d46a2f8", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "7ebba3e8-a318-441b-aa7e-2fb203b9bcae", "EffectiveDate": "2025-06-27T07:20:04.0927204-07:00", "WellPurposeType": { "WellPurposeTypeId": "ca78e5db-a43d-47e4-86e9-3e837d32abfb", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8dfe7f52-8380-40df-8d6a-266cc0be001d", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "f101b200-fec0-4e73-a757-6035a6001646", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-27T07:20:04.0927204-07:00", "MeasurementValueNeededDate": "2025-06-27T07:20:04.0927204-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "25b38897-0c22-4260-b79d-7e34f57e6906", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "DisplayText": "sample string 2", "PropertyType": { "PropertyTypeId": "85d10449-42e9-4e69-91ef-cb33d7dcbb72", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "eed9018f-c5d7-42f9-b49d-0725546b9081", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4cde2927-7223-4309-8397-2231c54475c7", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 8" }, "DataType": { "DataTypeId": "48c7f282-dbf3-4ba4-b389-4c6a9e39b467", "Name": "sample string 1" }, "Unit": { "UnitId": "f88632bc-be05-4007-acc5-18147b21e1c3", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "6cb38bf9-6d1e-43b7-bf43-754769122ad1", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "04bbb54e-4bc6-4bc3-9992-d878ab06cb0f", "FieldId": "06d7dbd9-361b-4e06-8de3-49ac3eb91e37", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "04bbb54e-4bc6-4bc3-9992-d878ab06cb0f", "FieldId": "06d7dbd9-361b-4e06-8de3-49ac3eb91e37", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "SourceSystemId": "sample string 4", "CompanyId": "9ce2c9ec-f1ba-41d0-a397-4a2d2eefccc0", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c5b1c7c2-7806-4108-84b8-f58c0e159ee1", "CreateDate": "2025-06-27T07:20:04.0927204-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-27T07:20:04.0927204-07:00", "LastModifiedUser": "sample string 8" }, "Total": 1, "Message": "sample string 1" }