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": "66daad12-f1cf-4f84-9644-65089292a493",
"Asset": {
"AssetId": "bcdf99e2-6b7d-4495-8e5e-8338a1f65176",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "60313f67-81fc-44c9-be25-2052beec99bc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "93811e3b-53bd-4b8d-a532-5f8f37411f83",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7041f4c2-4a60-44a2-9041-240949516df7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-11T11:20:43.5029844-07:00",
"MeasurementValueNeededDate": "2026-05-11T11:20:43.5029844-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2ae7b615-4c30-47c3-b1c6-0dabf6e736e5",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "77cc0639-987a-4b02-94ab-56356663c2dc",
"EffectiveDate": "2026-05-11T11:20:43.5029844-07:00",
"StateType": {
"StateTypeId": "affd7198-56d3-4677-a0a7-f24b8b36bf72",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "60313f67-81fc-44c9-be25-2052beec99bc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "93811e3b-53bd-4b8d-a532-5f8f37411f83",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "046f28ca-e656-4cdf-81f0-620a1de9aa3f",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "89fdba63-abe2-41cc-ba37-aaf1c033ee88",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "4511c8ff-a63f-4073-ba91-07a9794a60c1",
"EffectiveDate": "2026-05-11T11:20:43.5029844-07:00",
"StatusType": {
"StatusTypeId": "df0c7c73-5294-4a62-8440-5523bcae871a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "60313f67-81fc-44c9-be25-2052beec99bc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "93811e3b-53bd-4b8d-a532-5f8f37411f83",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "d3258a4c-f7d8-461d-a233-239d7e73282a",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8df3d0cb-16c7-44d1-80ab-f08d1dbfd560",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "845b82f5-d6ed-4d44-ac52-efdca6a08b42",
"EffectiveDate": "2026-05-11T11:20:43.5029844-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "15c086ee-3034-45df-a929-a4aaf831fc5a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "49999f6a-bdd9-4cf4-a2e7-e805ecc0efeb",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "66b89207-b4c4-4785-a1bd-277b63a22c1b",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-11T11:20:43.5029844-07:00",
"MeasurementValueNeededDate": "2026-05-11T11:20:43.5029844-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "76ca4e28-d71f-41fe-a42a-4d3b12fa3332",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "95fe14ac-d4b6-415a-bd0a-bf41bfee91d5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "60313f67-81fc-44c9-be25-2052beec99bc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "93811e3b-53bd-4b8d-a532-5f8f37411f83",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 8"
},
"DataType": {
"DataTypeId": "d94adf11-11ff-4cde-a89c-187078b357d3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d865f0a1-a7a1-49df-97ee-b98371b07687",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c2fdf169-f203-4df5-9008-86d741f73f15",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "404a1053-cdd9-4c13-8dfa-610430f3da6b",
"FieldId": "6b64a55b-73b1-41bb-ac31-2da28f25f73b",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "404a1053-cdd9-4c13-8dfa-610430f3da6b",
"FieldId": "6b64a55b-73b1-41bb-ac31-2da28f25f73b",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "98646468-8af6-4247-95d2-b16d14242120",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1796820e-cb34-429e-a796-63730eeae79c",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 8"
},
{
"PropertyId": "66daad12-f1cf-4f84-9644-65089292a493",
"Asset": {
"AssetId": "bcdf99e2-6b7d-4495-8e5e-8338a1f65176",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "60313f67-81fc-44c9-be25-2052beec99bc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "93811e3b-53bd-4b8d-a532-5f8f37411f83",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7041f4c2-4a60-44a2-9041-240949516df7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-11T11:20:43.5029844-07:00",
"MeasurementValueNeededDate": "2026-05-11T11:20:43.5029844-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2ae7b615-4c30-47c3-b1c6-0dabf6e736e5",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "77cc0639-987a-4b02-94ab-56356663c2dc",
"EffectiveDate": "2026-05-11T11:20:43.5029844-07:00",
"StateType": {
"StateTypeId": "affd7198-56d3-4677-a0a7-f24b8b36bf72",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "60313f67-81fc-44c9-be25-2052beec99bc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "93811e3b-53bd-4b8d-a532-5f8f37411f83",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "046f28ca-e656-4cdf-81f0-620a1de9aa3f",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "89fdba63-abe2-41cc-ba37-aaf1c033ee88",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "4511c8ff-a63f-4073-ba91-07a9794a60c1",
"EffectiveDate": "2026-05-11T11:20:43.5029844-07:00",
"StatusType": {
"StatusTypeId": "df0c7c73-5294-4a62-8440-5523bcae871a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "60313f67-81fc-44c9-be25-2052beec99bc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "93811e3b-53bd-4b8d-a532-5f8f37411f83",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "d3258a4c-f7d8-461d-a233-239d7e73282a",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8df3d0cb-16c7-44d1-80ab-f08d1dbfd560",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "845b82f5-d6ed-4d44-ac52-efdca6a08b42",
"EffectiveDate": "2026-05-11T11:20:43.5029844-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "15c086ee-3034-45df-a929-a4aaf831fc5a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "49999f6a-bdd9-4cf4-a2e7-e805ecc0efeb",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "66b89207-b4c4-4785-a1bd-277b63a22c1b",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-11T11:20:43.5029844-07:00",
"MeasurementValueNeededDate": "2026-05-11T11:20:43.5029844-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "76ca4e28-d71f-41fe-a42a-4d3b12fa3332",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"DisplayText": "sample string 2",
"PropertyType": {
"PropertyTypeId": "95fe14ac-d4b6-415a-bd0a-bf41bfee91d5",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "60313f67-81fc-44c9-be25-2052beec99bc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "93811e3b-53bd-4b8d-a532-5f8f37411f83",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 8"
},
"DataType": {
"DataTypeId": "d94adf11-11ff-4cde-a89c-187078b357d3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d865f0a1-a7a1-49df-97ee-b98371b07687",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "c2fdf169-f203-4df5-9008-86d741f73f15",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "404a1053-cdd9-4c13-8dfa-610430f3da6b",
"FieldId": "6b64a55b-73b1-41bb-ac31-2da28f25f73b",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "404a1053-cdd9-4c13-8dfa-610430f3da6b",
"FieldId": "6b64a55b-73b1-41bb-ac31-2da28f25f73b",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "98646468-8af6-4247-95d2-b16d14242120",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1796820e-cb34-429e-a796-63730eeae79c",
"CreateDate": "2026-05-11T11:20:43.5029844-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-11T11:20:43.5029844-07:00",
"LastModifiedUser": "sample string 8"
}
],
"Total": 1,
"Message": "sample string 1"
}