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": "e3c55dea-0d41-41ee-a1d1-ded92c27b76f",
"Asset": {
"AssetId": "f1708edb-c6c9-4888-a4df-77ce7526949e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8b1d6da2-6c72-433e-bb1c-13805f7629b0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1e8037a7-fcac-4da9-914c-1e6007d85c7a",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "6cda9b4e-4d48-4788-9a78-62e4bb051c47",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-25T10:53:27.6540418-07:00",
"MeasurementValueNeededDate": "2026-07-25T10:53:27.6540418-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "abb6a4fc-8816-4f6d-81c3-17f4a34deb27",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "32ee862e-2c39-4fe9-a9fc-6eac87a79e70",
"EffectiveDate": "2026-07-25T10:53:27.6540418-07:00",
"StateType": {
"StateTypeId": "35d87514-2807-41cc-8705-aad8205887d2",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "8b1d6da2-6c72-433e-bb1c-13805f7629b0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1e8037a7-fcac-4da9-914c-1e6007d85c7a",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "75e3dfd3-bfad-49a4-b8e2-8eb65d4e2d70",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6407c2e8-b839-4c53-b05c-b7f272a4ed8d",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b41dbf2e-7766-4a80-921e-52b6fc6bea61",
"EffectiveDate": "2026-07-25T10:53:27.6540418-07:00",
"StatusType": {
"StatusTypeId": "5ec65edd-6d4a-4a9e-9aac-4a9a40ef6d30",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "8b1d6da2-6c72-433e-bb1c-13805f7629b0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1e8037a7-fcac-4da9-914c-1e6007d85c7a",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8be4e3be-68fa-4f5e-831e-9fe198728a30",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "51f9f3fe-3054-4ff7-b5b9-d5d9aaf15f25",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "85ab1c65-4b5f-41ce-85a1-329563e1fff8",
"EffectiveDate": "2026-07-25T10:53:27.6540418-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "c00026dd-81e4-4327-b8f5-26124854dc9d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "776a8adf-2e51-4a6d-8d61-04603737d170",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "41c6506f-f617-4b55-b621-c2195351a936",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-25T10:53:27.6540418-07:00",
"MeasurementValueNeededDate": "2026-07-25T10:53:27.6540418-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "98c72988-056f-4be6-8042-79fecc4b42eb",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "249525e6-253a-4f9f-bcb7-a771d1f3a7fb",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "8b1d6da2-6c72-433e-bb1c-13805f7629b0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1e8037a7-fcac-4da9-914c-1e6007d85c7a",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 8"
},
"DataType": {
"DataTypeId": "f3383e39-9bb7-4291-88b2-96847fa6c8c5",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cbdc9148-e38a-419d-a7d0-ac19369f4b3c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fb111bf4-e14f-4691-89d2-58cf0e7622dc",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f4d94dd7-029a-43c5-95b5-a1778be8d9cc",
"FieldId": "a0f5b8aa-4606-4e17-ba4d-41961e7ae614",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f4d94dd7-029a-43c5-95b5-a1778be8d9cc",
"FieldId": "a0f5b8aa-4606-4e17-ba4d-41961e7ae614",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "36f9ca3b-5ac0-4465-9735-9f29db380e25",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e86393b3-1ff3-473e-8bb5-05365461954d",
"CreateDate": "2026-07-25T10:53:27.6540418-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-25T10:53:27.6540418-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}