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": "5fa5c338-ef32-4637-b6a1-03f014110256",
"Asset": {
"AssetId": "a4852cb6-3340-44f3-a3f2-8febe0888078",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "11d329b5-dab9-4039-8a10-b5d137191c9a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e23efb77-ee78-44b0-9c73-f323d034f59a",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "be0eac4c-d201-4e69-90d6-7e4159d761f6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-10T20:13:39.6666472-07:00",
"MeasurementValueNeededDate": "2026-07-10T20:13:39.6666472-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b24a5899-8358-4393-922c-fe94e8fea3f8",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ff50e0cf-6983-4557-bee2-4964a6ac50e0",
"EffectiveDate": "2026-07-10T20:13:39.6666472-07:00",
"StateType": {
"StateTypeId": "d4d7a2db-077d-48c2-aef9-f45a7872a541",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "11d329b5-dab9-4039-8a10-b5d137191c9a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e23efb77-ee78-44b0-9c73-f323d034f59a",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "58f692c4-0329-470d-a275-2628dd184ac9",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c2abcbf9-131d-4352-9cce-580722aa9e03",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b5322efa-18fc-451a-8373-cf6e4fd174c7",
"EffectiveDate": "2026-07-10T20:13:39.6666472-07:00",
"StatusType": {
"StatusTypeId": "388dd5cf-e912-4f55-a4e6-9d019cd08900",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "11d329b5-dab9-4039-8a10-b5d137191c9a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e23efb77-ee78-44b0-9c73-f323d034f59a",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c8acd133-114c-460f-9941-7a8c76bf765a",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c7b01a1f-35bd-4fb0-8102-e87912c11345",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e4ca60d5-078c-4d95-9ed2-010f4ab03aa8",
"EffectiveDate": "2026-07-10T20:13:39.6666472-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "ebb3ff4b-a821-4cce-beea-154536f25fce",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bca592c9-ba72-465b-8960-8e3f851da0fd",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "12e64d07-783f-42a8-8f5b-e6730077dbc8",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-10T20:13:39.6666472-07:00",
"MeasurementValueNeededDate": "2026-07-10T20:13:39.6666472-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ac576c81-573d-4ea1-9b19-adfa70216848",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "6164e1dd-c167-4d0b-ba96-9628e8df85cb",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "11d329b5-dab9-4039-8a10-b5d137191c9a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e23efb77-ee78-44b0-9c73-f323d034f59a",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 8"
},
"DataType": {
"DataTypeId": "ba433064-d37d-46f4-9dfc-90d5d83375f5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e95dabff-fb41-44f4-a2f5-40e3ab11c0c8",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0385d228-8868-43da-9e0b-b34cce42f0d3",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "2a7a0907-a181-4ba9-bf16-75ea47e35d4c",
"FieldId": "ee03095d-b573-4895-8676-4bd07b197b45",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "2a7a0907-a181-4ba9-bf16-75ea47e35d4c",
"FieldId": "ee03095d-b573-4895-8676-4bd07b197b45",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "3bfbba1a-ba56-4883-9a9d-0fdbae9791c6",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1b5e5445-c4f8-4d7b-9926-e1c237bede32",
"CreateDate": "2026-07-10T20:13:39.6666472-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-10T20:13:39.6666472-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}