Show TOC

BPM OData Service for Accessing Value HelpLocate this document in the navigation structure

You can access value help through the OData service.You can implement a custom UI with remote access to value help by using OData.

The Value Help OData API allows you to do the following:
  • Bind the user interface directly
  • Expose the services of value help

For more information about the BPM OData service, see the BPM OData blog series in SCN.Information published on SAP site

URIs for OData Access
You use the Value Help OData API to suit your needs, depending on the values available on your ABAP or DB system. You can also specify an option to filter the value help data, and choose to use the language option. The structures of the URIs for OData access are as follows:
  • The generic URI for Value Help (no filter)

    http://<host>:<port>/bpmodata/valuehelp.svc/<AliasName>/HelpValues

    Example http://<host>:<port>/bpmodata/valuehelp.svc/Country/HelpValues
  • The generic URI for ABAP with filter and with language:

    http://<host>:<port>/bpmodata/valuehelp.svc/<AliasName>/HelpValues?filter=<filterAliasName>:<filter value>,operation(EQ|CP|LT|NE|LT|LE|GE|GT) & lang=<languageCode>

  • The generic URI for DB with filter and with language:

    http://<host>:<port>/bpmodata/valuehelp.svc/<AliasName>/HelpValues?filter=<filterAliasName>:<filter value>,operation(EQ|CP) &lang=<languageCode>

    Example For both ABAP and DB with filter and language:http://<host>:<port>/bpmodata/valuehelp.svc/Country/HelpValues?lang=EN&filter=CountryName:Af*,operation:CP
  • The generic URI for ABAP with filter (language not specified):

    http://<host>:<port>/bpmodata/valuehelp.svc/<AliasName>/HelpValues? filter=<filterAliasName>:<filter value>,operation(EQ|CP|LT|NE|LT|LE|GE|GT)

  • The generic URI for DB with filter (language not specified):

    http://<host>:<port>/bpmodata/valuehelp.svc/<AliasName>/HelpValues?filter=<filterAliasName>:<filter value>,operation(EQ|CP)

    Example For both ABAP and DB with filter (language not specified)

    http://<host>:<port>/bpmodata/valuehelp.svc/Country/HelpValues?filter=CountryName:Af*,operation:CP

  • The generic URI for ABAP and DB with multiple filters (language not specified):

    http://<host>:<port>/bpmodata/valuehelp.svc/<AliasName>/HelpValues? filter=<filterAliasName>:<filter value>,operation(EQ|CP|LT|NE|LT|LE|GE|GT);<filterAliasName>:<filter value>,operation(EQ|CP|LT|NE|LT|LE|GE|GT);<filterAliasName>:<filter value>,operation(EQ|CP|LT|NE|LT|LE|GE|GT)

    Example http://<host>:<port>/bpmodata/valuehelp.svc/Country/HelpValues?filter=CountryName:Af*,operation:CP;filter=CityName:Kabul,operation:EQ