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": "e8d4b24b-c2f0-4d69-89f1-a421517d054a",
"Asset": {
"AssetId": "ef5fccca-5a2d-41df-b1c7-97d789727428",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "71d5552d-f595-4206-9907-5abce7418586",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "94857928-4127-4fab-bce3-681864083afd",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4355c73a-caec-4781-91c9-231d5b3f238b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-23T10:53:45.5580923-07:00",
"MeasurementValueNeededDate": "2026-04-23T10:53:45.5580923-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "835d4759-db6a-42a6-affe-043816a7f2c2",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "5987a606-c5a6-4997-b9ba-98ced8306f68",
"EffectiveDate": "2026-04-23T10:53:45.5580923-07:00",
"StateType": {
"StateTypeId": "9fc2b7da-4687-4cf3-98ec-da939285828d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "71d5552d-f595-4206-9907-5abce7418586",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "94857928-4127-4fab-bce3-681864083afd",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "a531ecdf-6a11-416d-a08a-3936365737ca",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "08fddf84-26ea-48a2-8af0-e3c8da462d7a",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "25ae3202-b1a0-4ad6-b5f0-ef1318777056",
"EffectiveDate": "2026-04-23T10:53:45.5580923-07:00",
"StatusType": {
"StatusTypeId": "538bbe19-7adc-4594-88bc-ee158791e121",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "71d5552d-f595-4206-9907-5abce7418586",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "94857928-4127-4fab-bce3-681864083afd",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "64630746-386c-42d5-a5e2-d718593aa602",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1e9de6e0-2265-4d5d-92ff-8b3b0bba1c43",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d3453baa-421b-429e-8e81-f6970d2bbb07",
"EffectiveDate": "2026-04-23T10:53:45.5580923-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "35711292-d4a4-46c9-ad63-587d8f790259",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "17484f27-a87a-41ef-aefb-124bcabc2255",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d4e5d30b-33fe-489d-916b-aa4222a28474",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-23T10:53:45.5580923-07:00",
"MeasurementValueNeededDate": "2026-04-23T10:53:45.5580923-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5c9d8e53-4079-41a2-b310-9551db7679df",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "90aa6e17-a0e7-44f9-9532-fa317a2e8708",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "71d5552d-f595-4206-9907-5abce7418586",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "94857928-4127-4fab-bce3-681864083afd",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 8"
},
"DataType": {
"DataTypeId": "b803a63d-b6ea-4242-ad97-3ca6a100c592",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "693d536c-8bd8-45e9-bc5e-c4daf38d1831",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "41657df3-9a76-4f68-898a-1f6e52d6bad2",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ab605060-b7d6-461c-925b-a1c2abc08b27",
"FieldId": "eca51f6f-66bb-4f2f-9ddb-c0850cd0e89f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ab605060-b7d6-461c-925b-a1c2abc08b27",
"FieldId": "eca51f6f-66bb-4f2f-9ddb-c0850cd0e89f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "f8eaa8a7-7292-489b-8458-fa5fa14e9cc9",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "009d137b-6e4f-4dc3-a0a4-9f37073a5447",
"CreateDate": "2026-04-23T10:53:45.5580923-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-23T10:53:45.5580923-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}