Field Types
The sections below describe the different field types available and their representation when retrieving their values as well as the expected representations when modifying them.
For any field types, a null or empty string can be provided as the value to delete its value from the Profile.
Term | Description |
GET |
Returns the text value
{ |
SET | A text value is expected |
Term | Description |
GET |
Returns the URL value. Any text values can be stored to this field, so a "real" URL is not guaranteed.
{ |
SET | A URL value is expected. Any text values can be stored to this field, so a "real" URL is not enforced. |
Term | Description |
GET |
Returns the email value. Any text values can be stored to this field, so the "real" email is not guaranteed.
{ |
SET | An email value is expected. Any text values can be stored to this field, so the "real" email is not guaranteed. |
Term | Description |
GET |
Returns a whole number value
{ |
SET | A whole number value is expected |
Term | Description |
GET |
Returns a decimal value
{ |
SET | A decimal value is expected |
Term | Description |
GET |
Returns a string of text
{ |
SET | A string of text is expected |
Term | Description |
GET |
Returns a string of text that may contain HTML markup
{ |
SET | A string of text that may contain HTML markup is expected |
Term | Description |
GET |
Returns the date and time value in UTC in the format yyyy-mm-dd hh:mm a
{ |
SET | The date and time value in UTC in the format yyyy-mm-dd hh:mm a is expected |
Term | Description |
GET |
Returns the date value in the format yyyy-mm-dd
{ |
SET | The date value in the format yyyy-mm-dd is expected |
Term | Description |
GET |
Returns the value of the selected drop-down option
{ |
SET |
[text] is expected
{ |
Term | Description |
GET |
{ "<Field Integration Id>": [ { "id": <List Node Id>, |
SET |
{ “<Field Integration Id>”:[ |
Term | Description |
GET |
Returns the JSON object containing the ID and display value of the selected list node
{ |
SET |
The Default ID or Custom ID of a list node that is part of the n-level list that is associated with this field is expected.
Or by value (not recommended). By Default ID (reference same n-level list node across customers, a value that comes with the system and is not individually made for a specific customer), use the D prefix and then the SystemID of the node: { By Custom ID (reference a specific n-level list node on a specific customer's system, that is unique to this customer), use the C prefix and the NodeId of the node: { By value, use the display value: { If both the id and value are provided, the id will always take priority over the value. |
Note: For additional information about patching values for the School, Major, and Degree lists, please see the Person Profile Data Model page.
Term | Description |
GET |
Returns a JSON array of JSON objects that contain the ID and display value of the selected list nodes
{ |
SET |
A JSON array of list node IDs that are part of the n-level list that is associated with this field is expected.
This is the same format as the Single Select List Editor field where a specific Default ID, Custom ID, or Value can be set to reference the n-level list node. { |
Term | Description |
GET |
All the Profile Link fields (person, job, company, except the Company Address Profile Link field) will be in the following format.
This action returns a JSON object containing the display value (as it would on the Profile) and the performanceId. The display value will be formatted in the following way for each type of field:
{ |
SET |
The ProfileID (PersonID, JobID, CompanyID, PerformanceID) OR External ID can be used.
{ OR { OR { |
Term | Description |
GET |
Returns a JSON object just like the Profile Link fields return with the difference being a companyId is also given and an API URL to access the address is given in. The id provided by this field is an addressId that points to a specific address on the specified company Profile.
{ |
SET |
Multiple options exist to set an addresslink field, including a specific address ID or a reference (ID or external ID) to a specific company profile Specific Address ID: With this option, the addresslink field is set with a specific address from a company profile { Company Profile ID or External ID: With this option, the addresslink field is set with the default address from the referenced company profile
{
"location": {
"company":{
"id": 7
}
}
}
OR
{
"location": {
"company":{
"externalid": "Northeast Region"
}
}
}
|
Term | Description |
GET |
Returns a JSON object containing the currency symbol, amount value, amount string, and time frame of the salary field
{ |
SET |
The same JSON object containing the currency symbol, amount value, amount string, and time frame is expected
{ |
Term | Description |
GET |
Returns a JSON object containing the currency symbol and amount value of the currency field
{ |
SET |
The same JSON object containing the currency symbol and amount value is expected
{ |
Term | Description |
GET |
Returns an API URL to the image
{ } |
SET | The value of this field cannot be set as with other Profile fields. Users must POST the URL directly to the field. Use the same URL as shown in the example above. |
Term | Description |
GET |
Returns an API URL to the file
{ |
SET | The value of this field cannot be set as with other Profile fields. Users must POST the URL directly to the field. Use the same URL as shown in the example above. |
Term | Description |
GET |
Returns a JSON array of up to a 100 (maximum capped, even if the system has more) collection groups JSON objects ordered in the same ordering as in the iCIMS Talent Platform, which is customizable per collection.
{ |
SET |
The same format as when retrieving Collections that support having a group marked as default can be set by specifying Default: true as an attribute value in the JSON. To delete a collection group, specifying Delete: true as an attribute value in the JSON will trigger it. Excluding child fields does not mean their values will be deleted. Deleting a specific child field’s value is the same as for normal fields. A null or blank must be specified. If an entry is provided, iCIMS will try to update the group if it exists. If one is not provided, iCIMS will assume the entry is creating a new group. (The field is an entry ID or the ID of the entry in the collection group.)
Note: When attempting to add a collection containing data that is an exact duplicate of an existing collection, the update will be ignored, and a new entry will not be created.
Additionally, when attempting to delete data within an existing collection and replace it with an identical collection, the existing collection data will be deleted, but the new collection will not be created.
{
"phones":[
{
"entry":23,
"phonenumber": "212-555-1234",
"phonetype": {
"value": "Home"
},
{
"phonenumber": "212-555-5678",
"phonetype": {
"value": "Work"
},
"default": true
},
{
"entry":25,
"delete":true
}
]
}
|