Filtering by Equipment properties
- Last UpdatedOct 05, 2022
- 1 minute read
You can filter the GetEquipment list by Equipment properties. The returned results would be an AND of the specified filters.
For example, if you want Company Name equipments with property Speed defined on them, you search by Equipment Property Id equal to Speed so there are two Pumps returned.
Request | Filtering by ID property
This is an example of the GetEquipmentRequestMessage, when filtered by ID property.
<GetEquipmentRequestMessage
xmlns="http://www.citect.com/Ampla/B2MML/2008/07">
<Request>
<Credentials>
<Username>User</Username>
<Password>********</Password>
</Credentials>
<Properties>
<Property>
<Id schemeName="Fullname" match="Exact">Speed</Id>
</Property>
</Properties>
<EquipmentElementLevel>NotSpecified</EquipmentElementLevel>
</Request>
</GetEquipmentRequestMessage>
Response | Filtering by ID property
This is an example of the GetEquipmentResponseMessage, when filtered by ID property.
<GetEquipmentResponseMessage
xmlns="http://www.citect.com/Ampla/B2MML/2008/07"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ShowEquipment releaseID="" xmlns="http://www.wbf.org/xml/b2mmlv0400">
<ApplicationArea>
<CreationDateTime>20180904T06:32:02.4471405Z</CreationDateTime>
</ApplicationArea>
<DataArea>
<Show />
<Equipment>
<ID xsi:type="EquipmentIDType" schemeName="Fullname">Company Name.Site</ID>
<EquipmentProperty>
<ID xsi:type="PropertyIDType">Name</ID>
<Value>
<ValueString>Site</ValueString>
<DataType>String</DataType>
<UnitOfMeasure />
</Value>
</EquipmentProperty>
<Location>
<EquipmentID />
<EquipmentElementLevel>Site</EquipmentElementLevel>
</Location>
</Equipment>
</DataArea>
</ShowEquipment>
</GetEquipmentResponseMessage>
Request | Filtering by Value property
This is an example of the GetEquipmentRequestMessage, when filtered by Value property.
<GetEquipmentRequestMessage
xmlns="http://www.citect.com/Ampla/B2MML/2008/07">
<Request>
<Credentials>
<Username>User</Username>
<Password>********</Password>
</Credentials>
<Properties>
<Property>
<Id schemeName="Fullname" match="Exact">Speed</Id>
<Value schemeName="Fullname" match="Exact">100</Value>
</Property>
</Properties>
<EquipmentElementLevel>NotSpecified</EquipmentElementLevel>
</Request> </GetEquipmentRequestMessage>
Response | Filtering by Value property
This is an example of the GetEquipmentResponseMessage, when filtered by Value property.
<GetEquipmentResponseMessage
xmlns="http://www.citect.com/Ampla/B2MML/2008/07">
<ShowEquipment releaseID="" xmlns="http://www.wbf.org/xml/b2mml-v0400">
<ApplicationArea>
<CreationDateTime>2018-09-07T06:09:59.8115756Z</CreationDateTime>
</ApplicationArea>
<DataArea>
<Show />
</DataArea>
</ShowEquipment>
</GetEquipmentResponseMessage>