Redigera

Dela via

Using FlowFilters in OData URIs

  • Artikel

You can set FlowFilters on the data that your OData web service extracts from the Business Central database.

FlowFilters are a special kind of filter that you use to set ranges on calculations that are shown in FlowFields. For more information, see FlowFilter Overview. FlowFilters for a page are included in the metadata for that page when it is published as a web service. You can then use FlowFilters as filters in a URI that specifies a query against page data. However, only those FlowFilters that are required to calculate the FlowFields that are exposed on the page as controls are included.

Use FlowFilters to Query Data on the Item Card Page

In this procedure, you create and publish a web service from the Item Card page in Business Central and then query the data in that web service by using a FlowFilter.

  1. Register and publish a page web service by using the Business Central Web client. See Publishing a Web Service.

    Register and publish page 30, Item Card, and name the service ItemCard.

  2. Start an internet browser, then in the Address field, enter a URI in this format:

    https://<Server>:<WebServicePort>/<ServerInstance>/ODataV4/$metadata

    If Business Central Server is running on the local computer and uses the default Business Central Server instance and the default OData port, then the address is:

    https://localhost:7048/BC230/ODataV4/$metadata

  3. Examine the metadata that is returned by this URI. At the end of the list is a set of parameters that end in the word Filter. This is the list of FlowFilters for the page:

    <Property Type="Edm.String" Name="Location_Filter" Nullable="true"/>  
<Property Type="Edm.String" Name="Drop_Shipment_Filter" Nullable="true"/>  
<Property Type="Edm.String" Name="Variant_Filter" Nullable="true"/>  
<Property Type="Edm.String" Name="Lot_No_Filter" Nullable="true"/>  
<Property Type="Edm.String" Name="Serial_No_Filter" Nullable="true"/>  
<Property Type="Edm.String" Name="Date_Filter" Nullable="true"/>

    Note

    The set of FlowFilters that is listed in the page metadata may not match the set of FlowFilters on the equivalent page in the Business Central Web client. This is because the Business Central Web client shows all FlowFilter fields that are defined on the table on which the page is based. The metadata only shows the FlowFilters that are used to calculate the FlowField controls that are exposed on the page.

  4. Create a URI that returns information for a single item card. For example:

    https://localhost:7048/BC230/ODataV4/Company('CRONUS-International-Ltd.')/ItemCard('1906-S')

    This is the "ATHENS Mobile Pedestal" item. The value for the Qty_on_Sales_Order parameter is 33:

    "Qty_on_Purch_Order": 20

  5. Apply a FlowFilter to that item and specify GREEN as the value for the Location_Filter:

    https://localhost:7048/BC230/ODataV4/Company('CRONUS-International-Ltd.')/ItemCard('1906-S')?$filter=Location_Filter eq 'GREEN'

    The item is returned as before, the value of the FlowField that has changed. The value for the Qty_on_Sales_Order parameter is now 27:

    "Qty_on_Purch_Order": 27

    This indicates that there are 27 ATHENS Mobile Pedestals on sales orders designated for the GREEN location.

OData Web Services