Recruiting Workflow Data Model

The table below describes the different standard field types available and their representation when retrieving their values as well as the expected representations when modifying them.

Notes:

  • Child fields are listed below their Parent field, indicated by an em dash (e.g., "— addresscity").

  • Click the red plus sign to the right of each row to view a field's options, if applicable.

  • For any field types, a null or empty string can be provided as the value to delete its value from the Profile.

  • For information on fields required for successful imports, please see the "Missing Required Columns" section of the What Might Cause My Import to Fail? under Imports on the File-Based Transfers page.

  • Click here to download an Excel file containing the information below.

Manipulating the Recruiting Workflow Profile Using the API

Recruiting Workflow Profiles can be created and updated using the Profiles API. The endpoint for the Recruiting Workflow Profile is as follows:

https://api.icims.com/customers/{customerId}/applicantworkflows/{applicantworkflowId}

Integrations that use this Data Model: 

The combination of a Job Profile and Person Profile relationship is known as the Recruiting Workflow.  This arrangement allows a many to many relationship from Jobs to People.  Assessments, Video Interviewing, and Tax Credits all utilize the Recruiting Workflow data model.

File Contents
WebService Field ID Label FlatFile Header Type Max +
acceptdeclinedate Accept or Decline Date rcf3320 DATEONLY N/A +
assessmentresults Assessment Results N/A Field Group N/A +
— assessmentdate Assessment Date N/A DATETIME N/A +
— assessmentname Assessment Name N/A LISTEDITOR_SINGLE N/A +
— assessmentnotes Assessment Notes N/A TEXTFIELD 192 +
— assessmentresult Assessment Result N/A TEXTFIELD 128 +
— assessmentscore Assessment Score N/A DECIMAL N/A +
— assessmentstatus Assessment Status N/A LISTEDITOR_SINGLE N/A +
— assessmenturl Assessment URL N/A URL 2083 +
associatedprofile Candidate N/A PERSONLINK N/A +
baseprofile Job N/A JOBLINK N/A +
bonus Bonus rcf3315 CURRENCY N/A +
counteroffer Counter Offer rcf3319 SALARY N/A +
fixedplacementfee Fixed Placement Fee rcf3325 CURRENCY N/A +
mobilehiringmanagerreviewreason Mobile Hiring Manager Review Reason N/A LISTEDITOR_SINGLE N/A +
offeramount Offer Amount rcf3314 SALARY N/A +
offerdate Offer Date rcf3316 DATEONLY N/A +
offerexpiration Offer Expiration rcf3318 DATEONLY N/A +
placementfeepercentage Placement Fee Percentage rcf3324 DECIMAL N/A +
portal Source Portal rcf3300 DROPDOWN_SINGLE N/A +
proposedstartdate Proposed Start Date rcf3317 DATEONLY N/A +
ptoallowance PTO Allowance rcf3321 DECIMAL N/A +
relocationamount Relocation Amount rcf3322 CURRENCY N/A +
source Source rcf3167 DROPDOWN_SINGLE 128 +
sourcechannel Source Channel rcf3168 DROPDOWN_SINGLE 64 +
sourcedevice Source Device rcf3177 DROPDOWN_SINGLE N/A +
sourceemail Source Email rcf3170 EMAIL 128 +
sourceexternalid Source External ID rcf3313 TEXTFIELD 64 +
sourcename Source Name rcf3169 LISTEDITOR_SINGLE_VALUE 128 +
sourceorigin Source Origin rcf3323 LISTEDITOR_SINGLE N/A +
sourceperson Source Person rcf3172 PERSONLINK N/A +
sourcephone Source Phone rcf3171 TEXTFIELD 64 +
status Status N/A LISTEDITOR_SINGLE N/A +
taxcrediteligible Tax Credit Eligible rcf3236 LISTEDITOR_SINGLE N/A +
taxcreditnotes Tax Credit Notes rcf3250 TEXTAREA 255 +
taxcreditoptedout Tax Credit Opted Out rcf3237 LISTEDITOR_SINGLE N/A +
videointerview Video Interview N/A Field Group N/A +
— videointerviewdate Date/Time N/A DATETIME N/A +
— videointerviewresultname Result Name N/A TEXTFIELD 128 +
— videointerviewstatus Interview Status N/A LISTEDITOR_SINGLE N/A +
— videointerviewurl Interview URL N/A URL 2083 +
— videointerviewvideoshareurl Share Video URL N/A URL 2083 +
wotcurl Tax Credits (WOTC) Url rcf3238 URL 2083 +