GET Properties?propertyId={propertyId}
Retrieves a property by its Id.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
propertyId |
Id of the property |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
On success, the property.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Property |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "PropertyId": "ed0f5daa-db28-4a20-a740-f0074a50b18e", "Asset": { "AssetId": "37a01cfa-6c53-4bc3-abdf-dffc59f5d378", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e90af509-29b8-497f-b0ef-e1a7a1fff3e9", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "62634ac2-91ca-4743-bb43-b1b7642355d3", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "537c16ad-263b-492c-93bb-90c6dc1fc754", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T15:30:43.3447408-07:00", "MeasurementValueNeededDate": "2025-06-02T15:30:43.3447408-07:00", "SourceSystemId": "sample string 3", "CompanyId": "414b04d4-356b-44be-b5cd-04f8100eff9c", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "63d732f2-a74c-4d64-b022-0671da120cb2", "EffectiveDate": "2025-06-02T15:30:43.3447408-07:00", "StateType": { "StateTypeId": "92a5c9bd-811d-44eb-9a04-0c7ad27c04b8", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "e90af509-29b8-497f-b0ef-e1a7a1fff3e9", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "62634ac2-91ca-4743-bb43-b1b7642355d3", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "f72deb41-b133-4332-bf01-d4d30c658b0e", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "718aea57-1490-4743-9474-c2b62d18e2d0", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "d9b9069b-57d7-4ef3-9b4b-1a8b665130bd", "EffectiveDate": "2025-06-02T15:30:43.3447408-07:00", "StatusType": { "StatusTypeId": "38af206b-4fec-49f3-a62a-c63b0f3b2d7a", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "e90af509-29b8-497f-b0ef-e1a7a1fff3e9", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "62634ac2-91ca-4743-bb43-b1b7642355d3", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "d4ee35a8-7866-41f3-8489-7053e906cdee", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "c48c1896-9f44-4bb2-beb2-87b883329fd4", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "3afbb846-e6c8-49ea-a978-61c1602adb9a", "EffectiveDate": "2025-06-02T15:30:43.3447408-07:00", "WellPurposeType": { "WellPurposeTypeId": "a3eb3093-27ac-4d07-b216-a20e09ce7bbd", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a42f099e-3e2a-4c5d-9b5c-f88b949fb77e", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "cb441c3f-d7f9-4cf8-a924-896e97015860", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-02T15:30:43.3447408-07:00", "MeasurementValueNeededDate": "2025-06-02T15:30:43.3447408-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "4e1f3f72-db11-4583-bd48-fe3fb6e9b627", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "DisplayText": "sample string 2", "PropertyType": { "PropertyTypeId": "71b33ccd-316b-4429-9ddd-e3053241eec6", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e90af509-29b8-497f-b0ef-e1a7a1fff3e9", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "62634ac2-91ca-4743-bb43-b1b7642355d3", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 8" }, "DataType": { "DataTypeId": "cbb28835-4cee-4156-b34c-c6160097409f", "Name": "sample string 1" }, "Unit": { "UnitId": "8bc4218a-7393-4b04-9f1d-ac5921fdfd23", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "7e010956-5df3-4e53-8361-457833665b96", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "48f664a1-64ce-4021-b4e3-4c8b5e951495", "FieldId": "3baf5f8e-c269-400d-b673-7c76405c5ea5", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "48f664a1-64ce-4021-b4e3-4c8b5e951495", "FieldId": "3baf5f8e-c269-400d-b673-7c76405c5ea5", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "SourceSystemId": "sample string 4", "CompanyId": "2813eaae-df29-45e0-9b6c-dfa8b92328c1", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6662d11a-3bd7-41c0-8bdf-8164347a7c1b", "CreateDate": "2025-06-02T15:30:43.3447408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T15:30:43.3447408-07:00", "LastModifiedUser": "sample string 8" }, "Total": 1, "Message": "sample string 1" }