SAP Advanced Analytics Rest API

The FRUN AAI REST interface (available since SAP Focused Run 3.0 FP01) provides external access to the ALM Grafana Plugin (or generic third party analytic tools) for most of the SAP Focused Run metrics.


The service is not enabled during the configuration of the "SAP Focused Run Application Foundation" task list, therefore it should be explicitly activated to be used. 

As for any ICF service, it is recommended to activate it only in case it's needed for a specific purpose.

Activation

You activate the AAI REST ICF service as follows:

  1. Execute transaction SICF.
  2. Search for the "DP" text in the "Service Name" field and click on the "Execute" button.
  3. Select the "DP" ICF service in the ICF tree.
  4. Activate the ICF service in one of the following ways:
  5. Using menu option Service/Host  →  Activate
  6. Using the context menu and choosing Activate Service.

 

Authorizations

The general authorization concept described in the Expert Portal (Dashboard Authorizations) applies to the technical user (e.g. Communications Data) that can  be used to access the DP ICF service.

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

Required roles are SAP_FRN_FI_ADMIN and any display role mentioned in the "Dialog User Roles with Application Authorization" section of the SAP Focused Run Security Guide, depending on the Data Provider/use case used in the queries.

A dedicated role (e.g. SAP_FRN_CNW_ACCESS) must be also used to enable and restrict access to specific customer namespaces.

API Reference

/sap/frun/fi/dp/providers (GET)

Returns the list of available data providers in the FRUN System (DP_SUM, DP_RUM, etc.) 

Example:

https://<frunhost>:<frunport>/sap/frun/fi/dp/providers


/sap/frun/fi/dp/providers/data (POST with body payload)

Returns multiple datasets matching different queries accessing Focused Run data providers for a selected period.

The body of the request (required) contains the description of the requested format and the queries attributes.

Example:

https://<frunhost>:<frunport>/sap/frun/fi/dp/providers/data

Request body example: 

{"format":"time_series","timestampFormat":"unix","timeRange":{"semantic":"C2H","from":"20211104093015","to":"20211104113015"},"resolution":"R","timezone":"+01:00","queries":[{"name":"","provider":"DP_SYSMON","columns":{"dimensions":[],"metrics":[]},"filters":[{"key":"GUID","values":["98f2b203-2cd3-1eab-a010-c47df058b45a"]},{"key":"METRIC_NAMES","values":["CPU_USER_UTILIZATION"]}],"refId":"B"}]}


/sap/frun/fi/dp/providers/filters (POST with body payload)

Returns the list of filters of a given data provider.

Example:

https://<frunhost>:<frunport>/sap/frun/fi/dp/providers/filters

Request body example:

{"providerName":"DP_SYSMON","providerVersion":""}