iForms Data Model

iForms are additional electronic paperwork that may be completed by a candidate, employee, or hiring manager in addition to their person profiles. iForms must be completed in order to retrieve data.  The data can be retrieved using the completed iForm's ID.

Note: At this time, there are no standard integrations that utilize the iForm data model.

Manipulating iForms Using the API

iForms can be created and updated using the iForms API.

Form Question Types and Field Options

Type Relevant Options on Platform Valid Answers
text

Minimum # of characters

Maximum # of characters

 "text"
"this is text"
"333224444"
number

Minimum value

Maximum value

 2.5
0
-5
textarea

Minimum # of characters

Maximum # of characters

 same as text
dateonly Collect month/year only "yyy-mm-dd"
if collect month/year only
"yyyy-mm"
datetime N/A Time in UTC
"yyyy-mm-dd hh:mm a"
salary N/A

{“currency”: “3 letter abbreviation”,
 “amount”: #
 “timeframe”: “entry from the Compensation Types list, 
capitalization matters” }

Expected Values for timeframe: Hourly, Daily, Weekly, Monthly and Yearly
currency N/A {“currency”: “3 letter abbreviation”,
  “amount”: # }
dropdown List items "Any value from the drop down"
multiselect List items ["value1", "value2"]
checkbox Require re-check each time True = checked
False = unchecked
radiogroup N/A "value from radio button"
radio Not supported True = checked
False = unchecked

Radio questions will not be validated or supported by the Web Services team.

 

Field Validation

All text field and text area iForm questions will validate responses by default, including those passed via the iForm API, as of the 14.2 Release of the iCIMS Talent Platform. The following will not be permitted in responses (when they are enclosed in an instance of <>, << >>, or ><, such as << some text here >>): < > \' \" \\ \/ `

Note that existing answers that have these characters will cause subsequent submits of the iForm to fail validation, meaning that the user will have to clean up the existing data before submitting.