• Register

Report To Zucchetti

The ReportToZucchetti API is protected by the OAuth2.0 authentication protocol. For more details about it you can refer to the Authentication Overview section.


Request

The ReportToZucchetti API is exposed at the following endpoint:

In order to build the complete URL you can refer to the following guide: How to build API URL .

As input you need to pass the following information:

Headers

Header Value
Authorization Bearer <access_token>
Accept application/json

Query Parameters

No query parameters are required.

Body

No request body is required (GET request).


Response

A typical valid response looks like this:

{
  "status": "200 OK",
}

This means that the report generation ended successfully and the Report.csv file has been created in the configured shared folder.


Errors

In case of technical issues (DB not reachable, mapping errors, filesystem problems), the service can return an error response.

500 – Internal Server Error

{
  "status": "KO",
  "errorCode": "REPORT_GENERATION_FAILED",
  "message": "Error during DB query, mapping, or file creation"
}

503 – Service Unavailable

{
  "status": "KO",
  "errorCode": "SERVICE_UNAVAILABLE",
  "message": "Database or filesystem unavailable"
}

Additional Notes

During execution, the service performs the following high-level steps:

  1. Reads employee data from DB (EmpJob + PersonalInfo staging tables)
  2. Transcodes/mappings fields (SuccessFactors → Zucchetti) using the ReportToZucchettiHandler mapper
  3. Creates the output file in: /mnt/share/tibco-bwce/Zucchetti/ReportCSV/

If the access token expires, it won’t be valid anymore and a new access token must be retrieved before calling this endpoint again.

Docs Navigation