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": "3f4c6ab9-19a7-4637-819d-e61e43a281c3",
"Asset": {
"AssetId": "602fddb2-f891-47ad-9d8e-154f4a02286a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2ae579fe-e9a4-4c75-9f35-dc2f8dbcdcab",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bcedc83f-fd3a-4f48-81fe-ab499b4356b1",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7d6d7675-f036-41ac-a897-f32d045cfed9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-21T20:19:45.013226-07:00",
"MeasurementValueNeededDate": "2026-04-21T20:19:45.013226-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b7d7b0ca-2c96-47d2-8226-52e638847a2d",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d20e6d5f-e3c4-4b3b-8f67-a5771c40024b",
"EffectiveDate": "2026-04-21T20:19:45.013226-07:00",
"StateType": {
"StateTypeId": "cfcce201-e8a1-49af-a4f4-9696a179145b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2ae579fe-e9a4-4c75-9f35-dc2f8dbcdcab",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bcedc83f-fd3a-4f48-81fe-ab499b4356b1",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2083c6d4-830e-4baa-8ad9-cff35b454613",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dc17c983-f2a5-42c0-a4d3-c3a0ceff3668",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "951005c1-4ae3-4d34-a2eb-f86915bb0ddd",
"EffectiveDate": "2026-04-21T20:19:45.013226-07:00",
"StatusType": {
"StatusTypeId": "046c6a67-ba52-40a3-b748-4cf550034c3e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2ae579fe-e9a4-4c75-9f35-dc2f8dbcdcab",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bcedc83f-fd3a-4f48-81fe-ab499b4356b1",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "55a332fe-c4fc-4a59-91f1-52c110502e52",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9b57102b-7de4-4c90-9d41-df10d1762b20",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "dfe0f159-0d28-4fa4-bcf5-94dce1d9e059",
"EffectiveDate": "2026-04-21T20:19:45.013226-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "7dcc9ed8-3372-4426-9912-4ab6d373dbad",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "04e4baa9-4425-499a-91ab-caf0d4ecc24e",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f63dffba-ea49-4c9e-976b-a88c9b2c7205",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-21T20:19:45.013226-07:00",
"MeasurementValueNeededDate": "2026-04-21T20:19:45.013226-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b507ccd5-0018-4870-a71e-e9421aae9b08",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "7a4da074-8817-4224-8384-6dd92241e590",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2ae579fe-e9a4-4c75-9f35-dc2f8dbcdcab",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bcedc83f-fd3a-4f48-81fe-ab499b4356b1",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 8"
},
"DataType": {
"DataTypeId": "b9153d1a-f678-43e7-ae32-feca024d2c34",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "07276da8-6488-4e3a-a2b0-6caef8081640",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "dbaa786b-7c42-4273-95f2-6f5fb5270de9",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "049baccc-4b65-4457-a62e-860df5a9fdc3",
"FieldId": "6fd88db3-ba4b-4050-9d7a-11b672832d36",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "049baccc-4b65-4457-a62e-860df5a9fdc3",
"FieldId": "6fd88db3-ba4b-4050-9d7a-11b672832d36",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "feb50b99-9e44-4703-927b-2683b66d072d",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5fb6ea09-f628-422d-be3b-bd43b5da788a",
"CreateDate": "2026-04-21T20:19:45.013226-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-21T20:19:45.013226-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}