LMDB Public REST API

Within SAP Focused Run 4.0 FP02 we now provide a public API to read LMDB landscape and content repository data of systems, hosts, installed software components, and installed products in LMDB. The API is designed as a REST API.

Please note: This release is a beta version which could be slightly changed within the next feature pack.

Activation

You activate the REST ICF service as follows:

  1. Execute transaction SICF.
  2. Search for the "landscape_api" text in the "Service Name" field and click on the "Execute" button.
  3. Select the "sap/frun/landscape/landscape_api" ICF service in the ICF tree.
  4. Activate the ICF service via the context menu and choose Activate Service.

 

Authorizations

The general authorization concept applies also to the technical user (e.g. Communications Data) that will be used to access the ICF service "landscape_api".

The user accessing the landscape_api service needs one of the following roles:

  • SAP_FRN_LDB_ALL
  • SAP_FRN_LDB_DISP

Assign roles according to the least privilege principle, that is, define and assign only those roles that are explicitly needed, and nothing else.

Authentication

While basic authentication is a possible option, it is recommended to use Client Certificate-based authentication to consume the /sap/frun/landscape/landscape_api REST service.

Refer to this page for additional details: Using X.509 Client Certificates on the AS ABAP

API Reference

You can call the landscape_api REST service using the URL:

http(s)://<frun-host>:<frun-port>/sap/frun/landscape/landscape_api/<landscape_api_category>?sap_client=<client number>&$filter= <filter_expression>

You can use one of the following values as <landscape_api_category>:

  • SAP Focused Run 4.0 FP02
    • landscape_api_hosts: To search for hosts
    • landscape_api_systems: To search for technical systems
    • landscape_api_installed_software_components: To search for installed software components 
    • landscape_api_installed_product_versions: Search for installed product versions
  • SAP Focused Run 4.0 FP03
    • landscape_api_technical_instances: Search for instances of technical systems (For ABAP, HANA & J2EE systems)

Different filters are available for the different categories. The filter expression may include combinations of expressions with query options divided by “and” and “or”. 

  • Expressions divided with “and” must only include the same query option. Expression with “and” must be in brackets. 
  • Expressions divided by “or” must be different query options.
  • An expression with query option may have the operators “=”, “<=”, “>=”, “eq”, ”le”, ”ge”, “>”, “<”, “equals”. 
  • Please note: Operators “and” and ”or” as well as “=”, “<=”, “>=”, “eq”, ”le”, ”ge”, “>”, “<”, “equals” must be preceded and followed by spaces.

The following table contains the available filter options by category.

CategoryFilter Options
landscape_api_hosts
  • HOST_NAME
  • NAMETYPE
  • DATA_CENTER
  • CUSTOMER_NAME
  • CUSTOMER_NETWORK
landscape_api_systems
  • EXTENDED_SID
  • SYSTEM_TYPE
  • DATA_CENTER
  • CUSTOMER_NAME
  • CUSTOMER_NETWORK
  • IT_ADMIN_PRIO
  • IT_ADMIN_ROLE
  • LIFECYCLE_STATUS
  • GUID
landscape_api_installed_software_components
  • EXTENDED_SID
  • SYSTEM_TYPE
  • PPMS_ID
  • PATCH_LEVEL
  • WARRANTY_END_DATE 
  • RELEASE_TO_CUSTOMER
  • SUPPORT_PACKAGE_LEVEL
  • SOFTWARE_COMPONENT_VERSION
  • SOFTWARE_COMPONENT_NAME
  • DATA_CENTER
  • CUSTOMER_NAME
  • CUSTOMER_NETWORK
landscape_api_installed_product_versions
  • EXTENDED_SID
  • SYSTEM_TYPE
  • DATA_CENTER
  • CUSTOMER_NAME
  • CUSTOMER_NETWORK
  • INST_PRODUCT_VERSION_NAME 
  • IPV_WARRANTY_END_DATE
landscape_api_technical_instances
  • EXTENDED_SID
  • SYSTEM_TYPE
  • DATA_CENTER
  • CUSTOMER_NAME
  • CUSTOMER_NETWORK
  • INSTANCE_TYPE
  • INSTANCE_HOST
  • IT_ADMIN_ROLE
  • SYSTEM_GUID

For the filter SYSTEM_TYPE you can use the following values:

System TypeDescription
ABAPApplication Server ABAP
ATCApache Tomcat Server
BOBJSAP BusinessObjects Cluster
CLOUD_CONNSAP Cloud Platform Cloud Connector
DBSYSTEMDatabase System
DIAGNAGENTDiagnostics Agent
EXT_SRVExternal Service
HANADBSAP HANA Database
IS_EMIntroscope Enterprise Manager (Standalone)
IS_MOMIntroscope Enterprise Manager (Cluster)
JAVAApplication Server Java
LIVE_CACHESAP liveCache
MDMSAP NetWeaver Master Data Management Server
MSIISINSTMicrosoft Internet Information Services
MS_.NET.NET System
SUPSAP Mobile Platform
TREXTREX System
UNSP3TIERUnspecific 3-Tier System
UNSPAPPUnspecific Standalone Application System
UNSPECIFICUnspecific Cluster System
WEBDISPSAP Web Dispatcher
WEBSPHEREIBM WebSphere Application Server

Examples

In this section you find some sample queries for the LMDB Public REST API:

  1. Search for the technical system by one filter, Extended SID:
    • https://<frun-host>:<frun-port>/sap/frun/landscape/landscape_api/landscape_api_systems?sap-client=200&$filter=EXTENDED_SID = ABC
    • https://<frun-host>:<frun-port>/sap/frun/landscape/landscape_api/landscape_api_systems?sap-client=200&$filter=EXTENDED_SID eq ABC
  2. Search for all technical systems with Extended SID starting with AB:
    • https://<frun-host>:<frun-port>/sap/frun/landscape/landscape_api/landscape_api_systems?sap-client=200&$filter=EXTENDED_SID = AB*
    • https://<frun-host>:<frun-port>/sap/frun/landscape/landscape_api/landscape_api_systems?sap-client=200&$filter=EXTENDED_SID eq AB*
  3. Search for all technical systems with combination of two or more different filter fields – Extended SID AND System Type:
    • https://<frun-host>:<frun-port>/sap/frun/landscape/landscape_api/landscape_api_systems?sap-client=200&$filter=EXTENDED_SID = ABC* AND SYSTEM_TYPE = DBSYSTEM
    • https://<frun-host>:<frun-port>/sap/frun/landscape/landscape_api/landscape_api_systems?sap-client=200&$filter=EXTENDED_SID = ABC AND SYSTEM_TYPE = DBSYSTEM
  4. Search for all technical systems with a combination of two or more filters and a variation of values for one filter – Extended SID with 2 values (Use () when giving more than one value for one filter) AND System Type:
    • https://<frun-host>:<frun-port>/sap/frun/landscape/landscape_api/landscape_api_systems?sap-client=200&$filter=(EXTENDED_SID = ABC* OR EXTENDED_SID = FES) AND SYSTEM_TYPE = DBSYSTEM