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": "241cbff7-04ea-4002-bb3a-3d25d73fa99c",
"Asset": {
"AssetId": "a8364f55-a17e-44aa-a6e3-e05247244d42",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "65e4ab0d-72ab-47d8-900d-8f52f29b23ba",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5908a4a6-f794-49f1-b29b-3e9995baedd2",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "3ed4f227-84a2-4eae-82a1-bb43d5002b4d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-02T08:54:06.0322744-08:00",
"MeasurementValueNeededDate": "2026-02-02T08:54:06.0322744-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bfcdafca-001e-45f6-9e96-29350ccda8bb",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "985270bf-c6f2-4b1d-b019-08e84707d362",
"EffectiveDate": "2026-02-02T08:54:06.0322744-08:00",
"StateType": {
"StateTypeId": "f38b80cc-b0ee-4a50-b486-8134b4aef926",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "65e4ab0d-72ab-47d8-900d-8f52f29b23ba",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5908a4a6-f794-49f1-b29b-3e9995baedd2",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "691458b2-b204-451e-8ccc-e255a4a2f0e7",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "32857933-ed17-4ae6-8645-f79b4b267cf2",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8831f884-10a4-4940-ae34-d5942aa42b9c",
"EffectiveDate": "2026-02-02T08:54:06.0322744-08:00",
"StatusType": {
"StatusTypeId": "ce399430-07e4-40ba-8675-90df3dab3fc2",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "65e4ab0d-72ab-47d8-900d-8f52f29b23ba",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5908a4a6-f794-49f1-b29b-3e9995baedd2",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "35f7f38e-35d9-4b94-aec8-624c97e44978",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1acc8aec-b4e1-4352-b4e9-1a1b467496fc",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ab8fba6c-a26e-432a-9a26-ef468a06c0ce",
"EffectiveDate": "2026-02-02T08:54:06.0322744-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "ae862e1b-8a5c-4fd7-a6fb-f25d18856c9d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "75dd08a7-1fcd-467f-b98e-17b2ec26898a",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9cc29f9f-b83a-40b0-b512-06c1edc09768",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-02T08:54:06.0322744-08:00",
"MeasurementValueNeededDate": "2026-02-02T08:54:06.0322744-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1112c782-d137-46f0-878a-2cdbb0af906a",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "ec26a819-5978-455a-a193-5567b66dcca2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "65e4ab0d-72ab-47d8-900d-8f52f29b23ba",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5908a4a6-f794-49f1-b29b-3e9995baedd2",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 8"
},
"DataType": {
"DataTypeId": "c454d7ec-b284-4750-86e1-d060cc161e82",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "392b4fd5-c3c0-4d77-868b-344d16a7de3e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "650edae4-2955-44ae-bddd-316a5960b21b",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "35526f51-a894-4137-a263-89bff551a948",
"FieldId": "edbc3a4c-dd64-40af-b00e-49eae7c1c25f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "35526f51-a894-4137-a263-89bff551a948",
"FieldId": "edbc3a4c-dd64-40af-b00e-49eae7c1c25f",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "628552a4-7b0f-448e-b698-8956f1ec49eb",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d1212f10-4f1e-4ccf-87f1-97503b8c01cb",
"CreateDate": "2026-02-02T08:54:06.0322744-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T08:54:06.0322744-08:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}