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

How to check and understand 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.

• SAP SuccessFactors HXM Suite - Odata API

1. Steps to Download Odata API Audit Logs:

• Login to the SF instance-> Admin center -> Tool Search-> Odata API Audit log.

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

2. Log details

• Request Header show details from API call received and source.

• Response header show the response from SuccessFactors to API call source. 

Some common status:

• 200 OK
• 400 Bad Request
• 401 Unauthorized 
• 403 permisssion issues
• 404 Not Found
• 500 Internal Server Error
• 502 / 504 Gateway timeout
• 503 Service Temporarily unavaliable
  
  
• Request payload will appear only if you enable the complete payloads. To enable it, please follow KBA 3141692.

• Response payload show the data that SF system send to API call source as response from API call (response payload will appear only if you enable the complete payloads. To enable it, please follow KBA 3141692).

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.

SAP SuccessFactors HCM Suite OData API: Reference Guide

SAP SuccessFactors Employee Central OData API: Reference Guide

SAP SuccessFactors HCM Suite OData API: Developer Guide

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