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": "42a659ae-ea5f-431d-9ee6-df3f3713c6dc",
"Asset": {
"AssetId": "b172283e-5c11-452a-9fad-6a194e10b4c9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6dabc074-5487-4a74-9edb-611619c8f65c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7bbcb585-0610-42a2-bb0b-b8f4d16eaec3",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "5ce5b64e-bcb8-440d-bca5-9161f3ffe052",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-04T06:23:36.8637256-07:00",
"MeasurementValueNeededDate": "2026-07-04T06:23:36.8637256-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "40897e94-9c33-4044-b228-68ace809ba55",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "83f2067a-c78b-46ff-bbab-5bb471c9fdf6",
"EffectiveDate": "2026-07-04T06:23:36.8637256-07:00",
"StateType": {
"StateTypeId": "ab56a299-b050-48cd-9dd0-e655930d8448",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "6dabc074-5487-4a74-9edb-611619c8f65c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7bbcb585-0610-42a2-bb0b-b8f4d16eaec3",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "30e82aec-d658-4ff6-8c68-f598b1dfdb43",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d6f86365-7b8f-439f-bdaa-5442389548b3",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "259d708e-c0eb-4bc3-ac93-66ca15cc947c",
"EffectiveDate": "2026-07-04T06:23:36.8637256-07:00",
"StatusType": {
"StatusTypeId": "d35ab148-0731-4475-a9ce-3787040c9c5f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "6dabc074-5487-4a74-9edb-611619c8f65c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7bbcb585-0610-42a2-bb0b-b8f4d16eaec3",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "49cebc84-02a6-4b3b-ad1f-14b39a109c27",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "aa1e7456-9a03-42df-b64b-043321ec07b6",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "606c074f-8bb2-4a3e-b657-db3c189eb5fb",
"EffectiveDate": "2026-07-04T06:23:36.8637256-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "eed29340-2905-4f05-ad8a-3cbe075fa794",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e410a215-10cc-4a73-a3ee-d18b403093f4",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "70b7bf26-7355-4658-b9ed-76741d21dbd1",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-04T06:23:36.8637256-07:00",
"MeasurementValueNeededDate": "2026-07-04T06:23:36.8637256-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3323ed30-8ae7-4443-892e-260f2e48ed6d",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "8edaaf79-8620-410b-b5bd-3e27b48afc70",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6dabc074-5487-4a74-9edb-611619c8f65c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7bbcb585-0610-42a2-bb0b-b8f4d16eaec3",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 8"
},
"DataType": {
"DataTypeId": "3db03cd2-90d3-44b5-8477-17f621222934",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "e63f4825-e77c-4ffb-b250-789c138f1963",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7a4503f5-f9ea-40ca-9e52-df2df5722906",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f335fbae-4f95-4710-b7f4-aab015835c1d",
"FieldId": "58d03a6f-0545-4406-beef-ddc00b5555ff",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f335fbae-4f95-4710-b7f4-aab015835c1d",
"FieldId": "58d03a6f-0545-4406-beef-ddc00b5555ff",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "479d8d82-216b-4920-9254-82be9d8ad0c3",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "63cb6c8a-5a3c-49e7-98b4-1d637c975abb",
"CreateDate": "2026-07-04T06:23:36.8637256-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-04T06:23:36.8637256-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}