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": "e616cf76-b1cf-474a-8520-e378567432de", "Asset": { "AssetId": "34c4db32-146e-4df0-8dbb-c52252416541", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b633f072-c3d8-49fd-b318-a6af2c74dda8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3a8bb326-7798-44b6-866f-1027a9f3c7e5", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "f18d7a24-e06a-4d36-a205-9796de9bb268", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-07-26T18:48:54.9044159-07:00", "MeasurementValueNeededDate": "2024-07-26T18:48:54.9044159-07:00", "SourceSystemId": "sample string 3", "CompanyId": "67000a0d-7afc-4fdf-8586-71b81693123b", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "780a20b5-992c-44e8-b795-9b4ab8b91954", "EffectiveDate": "2024-07-26T18:48:54.9044159-07:00", "StateType": { "StateTypeId": "2445f959-d199-4226-8868-fa7e2fb957b7", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "b633f072-c3d8-49fd-b318-a6af2c74dda8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3a8bb326-7798-44b6-866f-1027a9f3c7e5", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "830d3c55-557f-413d-901f-5f6499dcc76c", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "ba0bed03-6a32-4707-957b-320c49f14d3e", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "33017d08-d094-4b33-b08b-cb1efb05a90c", "EffectiveDate": "2024-07-26T18:48:54.9044159-07:00", "StatusType": { "StatusTypeId": "434cba73-f272-4953-b95f-64481d8e104a", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "b633f072-c3d8-49fd-b318-a6af2c74dda8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3a8bb326-7798-44b6-866f-1027a9f3c7e5", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "fdc1dd26-66de-4d87-84e0-d187580c33e0", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "105feb92-7f05-4dc3-b8be-10831bae6ff6", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "49d81aca-1baa-4e3b-96a2-aefbfcb352d5", "EffectiveDate": "2024-07-26T18:48:54.9044159-07:00", "WellPurposeType": { "WellPurposeTypeId": "21e67cd6-45af-4784-93bc-431f89a44fa4", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b17df94c-5c61-4f8b-ac2a-cba92118b58b", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "a9e018e6-091e-4df5-b155-6b11218219ae", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-07-26T18:48:54.9044159-07:00", "MeasurementValueNeededDate": "2024-07-26T18:48:54.9044159-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "0fba38a0-4528-4cdf-97e2-7ca9667ad53e", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "PropertyType": { "PropertyTypeId": "a444c18d-10cc-4df6-bd32-21ef3832fbf7", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "b633f072-c3d8-49fd-b318-a6af2c74dda8", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3a8bb326-7798-44b6-866f-1027a9f3c7e5", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 8" }, "DataType": { "DataTypeId": "2ca44a40-4b89-47bb-af61-7284a0aa2c1a", "Name": "sample string 1" }, "Unit": { "UnitId": "ea6ba663-3ad1-401f-a583-2f1b95d8902b", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a858971d-9851-47d5-b3d2-0c3b4a823bd1", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "SourceSystemId": "sample string 4", "CompanyId": "9dba34db-f471-4be5-abdc-68cb3647680d", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "62c2b7aa-9a4c-45d9-bd58-a7ebec4c0673", "CreateDate": "2024-07-26T18:48:54.9044159-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-07-26T18:48:54.9044159-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }