Collection Fields
Supported commands for Collection Fields are as follows.
Collection field groups can be created for all profiles.
Notes:
- "Content-Type: application/json" must be set for calls sending JSON payloads
- The iCIMS system does not allow for duplicate collection entries. API calls that result in duplicate collection entries to be created or updated will return success without modifying the collection data.
api.icims.com/customers/{customerId}/{profileType}/{profileID}/fields/{collectionFieldId}
api.icims.com/customers/1234/people/1289/fields/phones
Content-Type: application/json
{
"phonetype": {
"value": "Mobile"
},
"phonenumber":
"666 222 2222"
}
Response: HTTP/1.1 201 Created
Location:“api.icims.com/customers/1234/people/1289/fields/phones/332"
The value returned for the field will be the value returned in the JSON of the entire Profile. See the Field Types sections for details on what each field type returns.
Note: The iCIMS system does not allow for duplicate collection entries. API calls that result in duplicate collection entries to be created or updated will return success without modifying the collection data.
https://api.icims.com/customers/{customerId}/{profileType}/{profileID}/fields/{collectionFieldId}/{groupId}
https://api.icims.com/customers/1234/people/5/fields/addresses/35
HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
“addressstreet1”:“Apple St”,
“addresscity”:“Hazlet”,
“addresstype”{
“entry”:“D1334”,
“value”:“Home”
}
"primary" : true
}
Note: For JSON schema GET calls of collections (described here), the value for primary will look like:
"primary" : {
"type" : "boolean"
}
https://api.icims.com/customers/1234/people/1289/fields/addresses/332
Content-Type: application/json
{
“addressstreet1”:“Apple St”,
“addresscity”:“Hazlet”,
“addresstype”{
“entry”:“D1334”,
“value”:“Home”
}
}
api.icims.com/customers/1234/people/1289/fields/phones/332 (no payload required)