GET v2/DataPoints?SortBy={SortBy}&SortOrder={SortOrder}

Retrieves the list of data points defined for the requesting user's customer.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SortBy

Gets or sets the name of the field by which to sort

Lhp.EquipmentIntelligence.WebApi.Models.V2.DataPointSortFields

None.

SortOrder

Gets or sets the sort order.

Lhp.EquipmentIntelligence.WebApi.Models.SortOrders

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Lhp.EquipmentIntelligence.WebApi.Client.Models.DataPoint
NameDescriptionTypeAdditional information
DataPointId

Gets or sets the data point identifier.

integer

None.

MeasurementUnit

Gets or sets the measurement unit.

Lhp.EquipmentIntelligence.MeasurementUnits

None.

MeasurementUnitId

Gets or sets the measurement unit.

integer

None.

Name

Gets or sets the name.

string

None.

IsGlobal

Indicates whether the data point applies to all models or only specific models.

boolean

None.

AssociatedModels

Models specifically associated with this data point.

Collection of Lhp.EquipmentIntelligence.WebApi.Client.Models.OemEquipmentModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "DataPointId": 1,
    "MeasurementUnit": 0,
    "MeasurementUnitId": 2,
    "Name": "sample string 3",
    "IsGlobal": true,
    "AssociatedModels": [
      {
        "OemEquipmentModelId": 1,
        "OemEquipmentMakeId": 2,
        "OemEquipmentTypeId": 1,
        "CustomerId": 3,
        "Name": "sample string 4",
        "Description": "sample string 5"
      },
      {
        "OemEquipmentModelId": 1,
        "OemEquipmentMakeId": 2,
        "OemEquipmentTypeId": 1,
        "CustomerId": 3,
        "Name": "sample string 4",
        "Description": "sample string 5"
      }
    ]
  },
  {
    "DataPointId": 1,
    "MeasurementUnit": 0,
    "MeasurementUnitId": 2,
    "Name": "sample string 3",
    "IsGlobal": true,
    "AssociatedModels": [
      {
        "OemEquipmentModelId": 1,
        "OemEquipmentMakeId": 2,
        "OemEquipmentTypeId": 1,
        "CustomerId": 3,
        "Name": "sample string 4",
        "Description": "sample string 5"
      },
      {
        "OemEquipmentModelId": 1,
        "OemEquipmentMakeId": 2,
        "OemEquipmentTypeId": 1,
        "CustomerId": 3,
        "Name": "sample string 4",
        "Description": "sample string 5"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfDataPoint xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DataPoint>
    <DataPointId>1</DataPointId>
    <MeasurementUnit>None</MeasurementUnit>
    <MeasurementUnitId>2</MeasurementUnitId>
    <Name>sample string 3</Name>
    <IsGlobal>true</IsGlobal>
    <AssociatedModels>
      <OemEquipmentModel>
        <OemEquipmentModelId>1</OemEquipmentModelId>
        <OemEquipmentMakeId>2</OemEquipmentMakeId>
        <OemEquipmentTypeId>1</OemEquipmentTypeId>
        <CustomerId>3</CustomerId>
        <Name>sample string 4</Name>
        <Description>sample string 5</Description>
      </OemEquipmentModel>
      <OemEquipmentModel>
        <OemEquipmentModelId>1</OemEquipmentModelId>
        <OemEquipmentMakeId>2</OemEquipmentMakeId>
        <OemEquipmentTypeId>1</OemEquipmentTypeId>
        <CustomerId>3</CustomerId>
        <Name>sample string 4</Name>
        <Description>sample string 5</Description>
      </OemEquipmentModel>
    </AssociatedModels>
  </DataPoint>
  <DataPoint>
    <DataPointId>1</DataPointId>
    <MeasurementUnit>None</MeasurementUnit>
    <MeasurementUnitId>2</MeasurementUnitId>
    <Name>sample string 3</Name>
    <IsGlobal>true</IsGlobal>
    <AssociatedModels>
      <OemEquipmentModel>
        <OemEquipmentModelId>1</OemEquipmentModelId>
        <OemEquipmentMakeId>2</OemEquipmentMakeId>
        <OemEquipmentTypeId>1</OemEquipmentTypeId>
        <CustomerId>3</CustomerId>
        <Name>sample string 4</Name>
        <Description>sample string 5</Description>
      </OemEquipmentModel>
      <OemEquipmentModel>
        <OemEquipmentModelId>1</OemEquipmentModelId>
        <OemEquipmentMakeId>2</OemEquipmentMakeId>
        <OemEquipmentTypeId>1</OemEquipmentTypeId>
        <CustomerId>3</CustomerId>
        <Name>sample string 4</Name>
        <Description>sample string 5</Description>
      </OemEquipmentModel>
    </AssociatedModels>
  </DataPoint>
</ArrayOfDataPoint>