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": "0cb52a5c-aead-42c6-955d-defd494478ac",
"Asset": {
"AssetId": "f8ae358c-b0a9-45a7-b078-91b32027b0c1",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3e09c0a2-13cf-45cf-8afc-4a115ad0a232",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6e5dc6b2-b0dc-4038-920f-13615154d488",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "2651454e-4373-437e-be8a-a84f14ee0b4b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-04T00:02:56.0567762-08:00",
"MeasurementValueNeededDate": "2025-11-04T00:02:56.0567762-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7180d7ea-ef9d-454c-902b-972cf86bc3f0",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "4e9208fb-86db-4a2c-8640-6f9b73064c04",
"EffectiveDate": "2025-11-04T00:02:56.0567762-08:00",
"StateType": {
"StateTypeId": "02ca1ecb-7778-45c2-b21b-b77b930158f7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "3e09c0a2-13cf-45cf-8afc-4a115ad0a232",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6e5dc6b2-b0dc-4038-920f-13615154d488",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "58bb4c8d-3866-4c7c-b094-6d6d46ee1b92",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "20347dca-94db-4175-8fd7-6df604944d42",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f0d47bb4-c879-452e-bc04-3ff62e2b508a",
"EffectiveDate": "2025-11-04T00:02:56.0567762-08:00",
"StatusType": {
"StatusTypeId": "513089f9-ab50-442e-9270-74fd131f1528",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "3e09c0a2-13cf-45cf-8afc-4a115ad0a232",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6e5dc6b2-b0dc-4038-920f-13615154d488",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "2687e8ac-d714-4f5e-b2c3-75a7eec407bc",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0c9f1530-5999-40e4-9e4a-90cd919b0e16",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e0afc6a8-b60e-41a0-86c3-0beff56d23d1",
"EffectiveDate": "2025-11-04T00:02:56.0567762-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "ab60e253-09e8-44d3-bcda-75fb3fe9e741",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dfc8fe6d-1c79-45fc-a630-7aa8155016cc",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "25da79fb-62d5-4aa0-bbcb-db2c1c12944d",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-04T00:02:56.0567762-08:00",
"MeasurementValueNeededDate": "2025-11-04T00:02:56.0567762-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c1cf388e-c8bc-494e-9533-0c679f9f71c8",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "df1c5820-7ae3-45e2-af0c-d507b0aaa418",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3e09c0a2-13cf-45cf-8afc-4a115ad0a232",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6e5dc6b2-b0dc-4038-920f-13615154d488",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 8"
},
"DataType": {
"DataTypeId": "41cd8062-7a97-419b-bfcf-f529e306b67f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a0e2d946-abd8-44cb-a474-0a97ee3792b1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ce931b09-cd5a-41ef-a777-a634a80d6db0",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a90be89f-6775-4486-9a03-2567ff34014c",
"FieldId": "14803cff-01e6-4dec-ad70-29a54b84dd92",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a90be89f-6775-4486-9a03-2567ff34014c",
"FieldId": "14803cff-01e6-4dec-ad70-29a54b84dd92",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "3fc4620e-9040-484c-9749-35eecbf558ea",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0adc80f2-ff68-482e-ba88-4357f82abc5f",
"CreateDate": "2025-11-04T00:02:56.0567762-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-04T00:02:56.0567762-08:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}