SAP Knowledge Base Article - Public

3141692 - SuccessFactors API: Providing API Audit Logs to Cloud Support

Symptom

You have been requested to provide API logs by SuccessFactors Cloud Product Support

This document will outline the best / optimal format in which provide these API logs & subsequently speed up the handling of your case.

 

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

 

Environment

  • SAP SuccessFactors HXM Suite
    • Compound Employee API
    • OData API
    • SFAPI

 

Resolution

When you have reported an API behaviour-related issue to SuccessFactors Cloud Product Support,

There is an optimal format in which to provide API logs that need to be analysed.

 

As the issue is related to the SuccessFactors system, the logs should be provided from the SuccessFactors system,

This is applicable any API call made to SuccessFactors (irregardless of the system the API request is originating from)

 

STEP 1

  • Please Enable All Payload for the relevant API
    (choose SFAPI for Compound Employee API)


       

Step 2

  • Wait approximately 1 - 2 minutes before reproducing the problematic API request
    (In this example we use Google Postman but it does not matter what system the API request is reproduced from)


 

STEP 3

  •  Access the OData API Audit Logs (Or SFAPI Audit Logs) & search for the request in which you reproduced the issue:

  

STEP 4

  • Please copy the full Audit Log line (as shown above) & paste this into your response in your support case
     
  • Please download all of the files associated with the request: Request Header, Response Header, Request Payload (POST), Response Payload
    Please attach all of these files (preferably consolidated in one .zip folder)


    

This format provides us with a complete picture of the API-specific issue you are facing & allows us to asses the issue from both the front-end & the back-end

Generally this format is required when engaging with API engineering or any SF Module API team(s)

 

Tip: 

  • If the API request comes from CPI & you are using the SF Adapter in CPI,
    "Correlation-Id" in Request Header will match CPI Message ID & you will see the name of the CPI process in "Process-Name"
      
  • If the API request comes from Boomi & you are using SF Adapter, 
    "x-sf-execution-id" should match the execution ID of your Boomi process

 

Keywords

KBA , LOD-SF-INT-API , API & Adhoc API Framework , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT-CPI , Standard SF to 3rd Party CPI (HCI) Content , LOD-SF-INT-MDF , Metadata Framework API (MDF) , LOD-SF-INT-EC , Employee Central SFAPI & OData Entities , LOD-SF-INT-CE , Compound Employee API , Problem

Product

SAP SuccessFactors HXM Suite all versions