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": "dcfa7fed-4a92-494e-a722-1cd6a514f618",
"Asset": {
"AssetId": "aa037078-1158-4d28-814d-80f373524f41",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "51746237-d9ee-4190-af1f-7c491e114c1c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "10d572ea-b4c6-4348-aa4b-c5a672868447",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "415446f2-3816-4072-b160-d7cfa4b1624e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-24T11:12:33.2113802-07:00",
"MeasurementValueNeededDate": "2026-04-24T11:12:33.2113802-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c50533ce-51db-42ba-853c-adcb1d879165",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "75648202-287a-421f-9317-35a086c3e854",
"EffectiveDate": "2026-04-24T11:12:33.2113802-07:00",
"StateType": {
"StateTypeId": "c60cf629-5d74-4327-82ca-f9af2da039b6",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "51746237-d9ee-4190-af1f-7c491e114c1c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "10d572ea-b4c6-4348-aa4b-c5a672868447",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "97c8ed42-693b-4a6b-ba25-bec1a1f3f470",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e107875c-39d3-4517-bd46-326311a75508",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "1bebba60-fda3-47dd-9a16-b7b34a92c1a7",
"EffectiveDate": "2026-04-24T11:12:33.2113802-07:00",
"StatusType": {
"StatusTypeId": "cbbd2eb4-b048-4f17-840c-90a51ef90718",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "51746237-d9ee-4190-af1f-7c491e114c1c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "10d572ea-b4c6-4348-aa4b-c5a672868447",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b2ba3731-277e-4e05-a44d-5ef5bf5874b7",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1c51a20c-7042-4197-80fd-f708af71d33f",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "6898024c-db62-4e68-92e8-973e11439a6a",
"EffectiveDate": "2026-04-24T11:12:33.2113802-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "e7f55bdc-4783-4782-9263-557cb370f09f",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4d2aaaf0-62a0-49b6-9a8e-7a8aea2a6ef9",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "926bf6cb-c755-415c-a2cc-8feb2bcd174e",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-24T11:12:33.2113802-07:00",
"MeasurementValueNeededDate": "2026-04-24T11:12:33.2113802-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "30930e49-85b0-4b4b-89ff-13159c1e4fe0",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "c69f97c2-19a5-4a3d-9a19-0ef225006e94",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "51746237-d9ee-4190-af1f-7c491e114c1c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "10d572ea-b4c6-4348-aa4b-c5a672868447",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 8"
},
"DataType": {
"DataTypeId": "973ae456-0a09-4bbc-97c4-60a01354a92d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "fd4c171c-de6e-4bd2-9aed-dba27f957a7c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b6f5d03f-eb50-492a-a90d-3f8891289c7a",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3f39672f-7933-418b-956a-485de87513a1",
"FieldId": "78e72b49-b7bf-417a-a97d-d8946bdcd22d",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3f39672f-7933-418b-956a-485de87513a1",
"FieldId": "78e72b49-b7bf-417a-a97d-d8946bdcd22d",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "538e2488-e7f7-4cb8-9751-ede12b9635e2",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6276e5e2-35d7-4eb5-a941-309e3225c564",
"CreateDate": "2026-04-24T11:12:33.2113802-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-24T11:12:33.2113802-07:00",
"LastModifiedUser": "sample string 8"
},
"Total": 1,
"Message": "sample string 1"
}