SAP Knowledge Base Article - Public

2209703 - How to check and understand OData API Audit Logs - OData API

Symptom

How to check Odata API Audit logs in Successfactors System?

Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental.

Environment

  • Successfactors
  • BizX

Reproducing the Issue

1. Steps to Download Odata API Audit Logs:

  • Login to the SF instance->Admin tools-> Integration Tool-> Odata API Audit log.

 odata1_edit.jpg

Below screenshot explains the Audit log page and you may observe the tabs that are of interest.

Odata2_edit.jpg

2. The next screenshot gives a detailed view on the Http Request and Rest Response.

 odata3_edit.jpg

odata4_edit.jpg

Cause

A session is created and a Session id is generated whenever a Login call takes place to the API server.

For example, The below session id is generated when an API call was triggered.

7CB2CED34DEBA560D172D18B5D******.PS4BAPI01

(This could happen via Boomi , Soap UI or any other Integration tools etc)

Resolution

We can observe the following -
It is a Query operation to Select firstName of an employee whose ExternalId is XXXX from Odata API PerPersonal entity in json format.
The results are fetched as per the request and can be noticed from the Response xml.

Filters can be used to narrow down the search from all the payloads (Audit logs) to obtain the required one.Filters are seen in the left hand side of the screen (referring to the above screenshots)

Filters available to Narrow search results -

Login ID (Id of the user who triggered the API)
Session ID
Request ID
Status (Success / Failed)
Odata API Call (Login / Query / Update etc,)
Entity Name (Name of the API entity)
Request Time (Timestamp of the process execution)
Response Time (Run Time of the API operation - Rarely used filter)

These logs explain the behaviour of the API in the respective call. This helps in understanding the source of API errors if there are any.

See Also

SAP SuccessFactors HCM Suite OData API: Developer Guide

Keywords

API Audit Logs, Session id , request xml , response xml, OData Audit logs , KBA , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT , Integrations , Problem

Product

SAP SuccessFactors HXM Suite all versions