Context
Workday's API does not include an endpoint to read offer details. To enable this, we will create a custom report for export offer data.
Prerequisites
The ISU you created in the connection flow should have the following permissions assigned:
- Get Only: Candidate Data: Job Application
- Get Only: Candidate Data: Offer Details
- Get Only: Recruiting Agency Careers
Overview
Following this guide should take no longer than 20 minutes. The required steps to set up reading offers are:
- Creating a custom report that exposes offers
- Sharing the URL to fetch the custom report
Creating the Custom Report
- In Workday, search for Create Custom Report in the search bar and click on the task.
- Set the following settings:
- Report Name: This can be anything, for example, offers
- Report Type: Advanced
- Enable As Web Service: Checked (This checkbox will only appear after setting the report type)
- Optimized for Performance: Not checked
- Data Source: Job Applications
- Press OK at the bottom of the screen to create the report
How to Edit a Custom Report
To add rows you have to click on the plus sign:
To set field values, you have to enter the desired text and select the option from the menu after hitting enter. For column headings, no menu of options will appear as the value is not restricted.
Edit the Custom Report
- In the Columns tab, add the following rows to your report:
- Application ID
- Business Object: Job Application
- Field: Workday ID
- Column Heading Override XML Alias: Application_ID
- Hired
- Business Object: Job Application
- Field: Hired
- Column Heading Override XML Alias: Hired
- Offer Completed
- Business Object: Job Application
- Field: Offer Event - Completed
- Column Heading Override XML Alias: Offer_Completed
- Hire Stage
- Business Object: Job Application
- Field: Hire Stage
- Column Heading Override XML Alias: Hire_Stage
- Offer Stage
- Business Object: Job Application
- Field: Offer Stage
- Column Heading Override XML Alias: Offer_Stage
- Candidate Start Date
- Business Object: Job Application
- Field: Candidate Start Date
- Column Heading Override XML Alias: Candidate_Start_Date
- Job Posting Start Date
- Business Object: Job Application
- Field: Job Posting Start Date
- Column Heading Override XML Alias: Job_Start_Date
- Application ID
- In the Filter tab, add the following rows to your report:
- Offer Stage
- And/Or: Or
- Field: Offer Stage
- Operator: equal to
- Comparison Type: Value specified in this filter
- Comparison Value: Checked
- Hire Stage
- And/Or: Or
- Field: Hire Stage
- Operator: equal to
- Comparison Type: Value specified in this filter
- Comparison Value: Checked
- Hired
- And/Or: Or
- Field: Hired
- Operator: equal to
- Comparison Type: Value specified in this filter
- Comparison Value: Checked
- Offer Stage
- In the Share tab, set the Report Definition Sharing Options to Share with specific authorized groups and users, and select the ISU and group that you used to create the integration.
- In the Advanced tab, ensure that Web Services Options still has Enable As Web Service checked.
- Press OK at the bottom of the screen to finalize the report
Getting the Custom Report's URL
- Click on the three dots (related actions) next to your report's name.
- Navigate to Web Service -> View URLs.
- Right-click on the JSON link, and press Copy URL
- Enter the URL in the connection flow