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": "554ecab6-d3a5-4a33-b9f8-02ee4c405650",
"Asset": {
"AssetId": "c1ce0d1b-17d3-440b-97f5-1a1e54dc482c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "767d8691-dd83-4274-aeb2-8080f63651d8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "378abbae-a2cb-4a61-b569-ea9f54a1504e",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "382ae484-6ce9-477c-a453-21f887df4239",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-09T17:14:28.7637132-08:00",
"MeasurementValueNeededDate": "2026-02-09T17:14:28.7637132-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "764f12ac-2c7f-438b-a3d6-7a91c527fdc7",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "2c5facdb-9ffb-4ac9-a546-4f5297168920",
"EffectiveDate": "2026-02-09T17:14:28.7637132-08:00",
"StateType": {
"StateTypeId": "8d63b62a-2d73-4ed5-87a1-7a3681484bc9",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "767d8691-dd83-4274-aeb2-8080f63651d8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "378abbae-a2cb-4a61-b569-ea9f54a1504e",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "7cb73336-c5a5-4580-8c89-177c1f759b56",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d7ab4ca8-3657-4665-872a-3ec23da688c3",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "92757ef8-8fa1-48cb-8cf2-0bb9ad0a1725",
"EffectiveDate": "2026-02-09T17:14:28.7637132-08:00",
"StatusType": {
"StatusTypeId": "725d79d6-18ca-4732-91cb-797563ac2844",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "767d8691-dd83-4274-aeb2-8080f63651d8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "378abbae-a2cb-4a61-b569-ea9f54a1504e",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b3876c6b-adcc-4b55-b0fc-8c241712286e",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c4e45f64-ae9a-44d0-b686-150d5c0598ad",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ec77c3eb-ad38-4e5d-bcaf-03b5f8b5ec24",
"EffectiveDate": "2026-02-09T17:14:28.7637132-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "966f631c-f0dd-4ff0-8249-1213f1624030",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c471b120-f43f-4dfc-afdd-28646dbce919",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ba23bae6-200d-46fd-ba62-33e4d804fc5d",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-09T17:14:28.7637132-08:00",
"MeasurementValueNeededDate": "2026-02-09T17:14:28.7637132-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a42fb22c-8da6-4847-ad58-6895149c2866",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "6091f18f-738b-40ae-8569-dee3c7e7a0b1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "767d8691-dd83-4274-aeb2-8080f63651d8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "378abbae-a2cb-4a61-b569-ea9f54a1504e",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 8"
},
"DataType": {
"DataTypeId": "0354c5c0-056d-43cd-92eb-03ff3bb3a553",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d0dc5005-6894-4e2b-8e2c-1b59935230a9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d4fe318b-b0eb-4c97-942a-2a0b4f0816c2",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "75f7c188-e313-4aa6-b200-c6b7e7cf6af4",
"FieldId": "de8e53d2-fa67-46bd-bf9c-26d0097cacb4",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "75f7c188-e313-4aa6-b200-c6b7e7cf6af4",
"FieldId": "de8e53d2-fa67-46bd-bf9c-26d0097cacb4",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "ba3500ce-100a-45a1-ab26-0bb5a6bfb93a",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d0fda9b4-adc5-47fb-9247-42e521355825",
"CreateDate": "2026-02-09T17:14:28.7637132-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-09T17:14:28.7637132-08:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}