GET Properties?assetId={assetId}&propertyTypeId={propertyTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves properties for the given parameters. This will only retrieve properties that have a value. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
propertyTypeId |
Id of the property type |
globally unique identifier |
None. |
take |
Number of properties to retrieve. Default is all properties |
integer |
None. |
skip |
Number of properties to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the properties before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of properties.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Property |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "PropertyId": "67d44060-8e15-4fa9-8a7a-ec9263311631", "Asset": { "AssetId": "e1b4c410-8c05-4bac-9480-9c3eceac43ab", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "f2320af1-8acc-4ed1-ab39-47df17f25cdf", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cf997041-7bbe-4154-bd61-56b6017b5b45", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "b43b5860-162b-4bbd-85a6-3b32b7b52888", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T04:43:49.5113098-07:00", "MeasurementValueNeededDate": "2025-07-19T04:43:49.5113098-07:00", "SourceSystemId": "sample string 3", "CompanyId": "2c59877d-806f-440b-bf63-392de195696c", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "90b510ce-89ee-478d-b6e7-d03b428b6a8b", "EffectiveDate": "2025-07-19T04:43:49.5113098-07:00", "StateType": { "StateTypeId": "08a509a6-1215-47cd-aeb0-6cc5e320eca8", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "f2320af1-8acc-4ed1-ab39-47df17f25cdf", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cf997041-7bbe-4154-bd61-56b6017b5b45", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "d2de8704-67f3-4e64-920e-b4939084e579", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "f5563a23-e19d-4774-b981-9c834bebf45a", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "c55ff107-fb80-4a09-a245-9a979ea4ab35", "EffectiveDate": "2025-07-19T04:43:49.5113098-07:00", "StatusType": { "StatusTypeId": "aeb3ac80-e626-4a23-a7de-b88f2128309f", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "f2320af1-8acc-4ed1-ab39-47df17f25cdf", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cf997041-7bbe-4154-bd61-56b6017b5b45", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "b472599b-2fa0-4b20-aef2-5c0fe94fbcfe", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "9a3a6821-2a34-4899-8340-1827c1aea583", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "c2e800d4-f5c3-48a1-b778-d5028f1ed0a6", "EffectiveDate": "2025-07-19T04:43:49.5113098-07:00", "WellPurposeType": { "WellPurposeTypeId": "5ec566fc-437a-4720-a57c-32633cd2e684", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "9c3b6245-f592-4110-92d1-8522ddf1e1cd", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "f0846186-7fc7-4698-a455-134437fe7c3b", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-19T04:43:49.5113098-07:00", "MeasurementValueNeededDate": "2025-07-19T04:43:49.5113098-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a56b96a7-6682-4d3e-95e9-f5d99f392bea", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "DisplayText": "sample string 2", "PropertyType": { "PropertyTypeId": "9bab1b58-e681-46c6-a8a9-12e1d99d7657", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "f2320af1-8acc-4ed1-ab39-47df17f25cdf", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cf997041-7bbe-4154-bd61-56b6017b5b45", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 8" }, "DataType": { "DataTypeId": "80c72871-9fe5-46b4-985f-a5c43a789b3f", "Name": "sample string 1" }, "Unit": { "UnitId": "10940519-24fc-4ea3-abd1-9a2b50791acc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f323029a-54e1-4972-85f5-7058c123ba95", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "b4e171c4-e1b6-46fa-85da-7d102e52595e", "FieldId": "e9d809a9-dd8d-43ca-a943-6959ef19b659", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "b4e171c4-e1b6-46fa-85da-7d102e52595e", "FieldId": "e9d809a9-dd8d-43ca-a943-6959ef19b659", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "SourceSystemId": "sample string 4", "CompanyId": "cae22c86-7717-47fc-8c4a-3759c66e26c1", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "145c8876-7156-4596-8ea1-2e58bab44662", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 8" }, { "PropertyId": "67d44060-8e15-4fa9-8a7a-ec9263311631", "Asset": { "AssetId": "e1b4c410-8c05-4bac-9480-9c3eceac43ab", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "f2320af1-8acc-4ed1-ab39-47df17f25cdf", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cf997041-7bbe-4154-bd61-56b6017b5b45", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "b43b5860-162b-4bbd-85a6-3b32b7b52888", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T04:43:49.5113098-07:00", "MeasurementValueNeededDate": "2025-07-19T04:43:49.5113098-07:00", "SourceSystemId": "sample string 3", "CompanyId": "2c59877d-806f-440b-bf63-392de195696c", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "90b510ce-89ee-478d-b6e7-d03b428b6a8b", "EffectiveDate": "2025-07-19T04:43:49.5113098-07:00", "StateType": { "StateTypeId": "08a509a6-1215-47cd-aeb0-6cc5e320eca8", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "f2320af1-8acc-4ed1-ab39-47df17f25cdf", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cf997041-7bbe-4154-bd61-56b6017b5b45", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "d2de8704-67f3-4e64-920e-b4939084e579", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "f5563a23-e19d-4774-b981-9c834bebf45a", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "c55ff107-fb80-4a09-a245-9a979ea4ab35", "EffectiveDate": "2025-07-19T04:43:49.5113098-07:00", "StatusType": { "StatusTypeId": "aeb3ac80-e626-4a23-a7de-b88f2128309f", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "f2320af1-8acc-4ed1-ab39-47df17f25cdf", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cf997041-7bbe-4154-bd61-56b6017b5b45", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "b472599b-2fa0-4b20-aef2-5c0fe94fbcfe", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "9a3a6821-2a34-4899-8340-1827c1aea583", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "c2e800d4-f5c3-48a1-b778-d5028f1ed0a6", "EffectiveDate": "2025-07-19T04:43:49.5113098-07:00", "WellPurposeType": { "WellPurposeTypeId": "5ec566fc-437a-4720-a57c-32633cd2e684", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "9c3b6245-f592-4110-92d1-8522ddf1e1cd", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "f0846186-7fc7-4698-a455-134437fe7c3b", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-19T04:43:49.5113098-07:00", "MeasurementValueNeededDate": "2025-07-19T04:43:49.5113098-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a56b96a7-6682-4d3e-95e9-f5d99f392bea", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 8" }, "ValueText": "sample string 1", "DisplayText": "sample string 2", "PropertyType": { "PropertyTypeId": "9bab1b58-e681-46c6-a8a9-12e1d99d7657", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "f2320af1-8acc-4ed1-ab39-47df17f25cdf", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cf997041-7bbe-4154-bd61-56b6017b5b45", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 8" }, "DataType": { "DataTypeId": "80c72871-9fe5-46b4-985f-a5c43a789b3f", "Name": "sample string 1" }, "Unit": { "UnitId": "10940519-24fc-4ea3-abd1-9a2b50791acc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f323029a-54e1-4972-85f5-7058c123ba95", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "b4e171c4-e1b6-46fa-85da-7d102e52595e", "FieldId": "e9d809a9-dd8d-43ca-a943-6959ef19b659", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "b4e171c4-e1b6-46fa-85da-7d102e52595e", "FieldId": "e9d809a9-dd8d-43ca-a943-6959ef19b659", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "SourceSystemId": "sample string 4", "CompanyId": "cae22c86-7717-47fc-8c4a-3759c66e26c1", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 7" }, "IsValid": true, "IsValidMessage": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "145c8876-7156-4596-8ea1-2e58bab44662", "CreateDate": "2025-07-19T04:43:49.5113098-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:43:49.5113098-07:00", "LastModifiedUser": "sample string 8" } ], "Total": 1, "Message": "sample string 1" }