Relationship between Job and iForm

Posted by Anonymous (not verified) on in Standard Integration Questions

There's a one-to-many relationship between person-form and person-job.

How do I find the associated job to an specific person-form (or forms related to a specific person-job)?

Is there a relationship between applicantworkflow and forms associate with that person-job?

Submitted by iCIMSUNIFIL on October 26, 2018 Permalink

The Applicant Workflow ID is the record of the person-job. If you have the applicant workflow ID you can issue a GET request to retrieve the associated profile with the person ID.

example GET URL to retrieve associatedprofile by applicantworkflow ID

https://api.icims.com/customers/1234/applicantworkflows/{workflowid}?fields=associatedprofile
Sample Results
{
"associatedprofile": {
"profile": "https://api.icims.com/customers/1234/people/111",
"id": 111,
"value": "Test Testperson"
},

Using the person ID and Form IDs - use the Search API to retrieve the Form Data ID (completed form for that person)

example POST URL to Search for completed iForm Data IDs by Person ID

https://api.icims.com/customers/1234/search/forms/

Note – List all iForms IDs is documented here https://developer.icims.com/REST-API/Object-Types-Commands/iFORMS

Payload
Search Criteria – Person system ID and iForm ID. This example shows 3 separate iForms

{"children":[{"filters":[{"name":"formdata.formid","value":["123"],"operator":"="},{"name":"formdata.formid","value":["456"],"operator":"="},{"name":"formdata.formid","value":["789"],"operator":"="}],"operator":"|"}],"filters":[{"name":"formdata.person.id","value":["111"],"operator":"="}],"operator":"&"}

Sample Results
{"searchResults": [
{
"self": "https://api.icims.com/customers/1234/forms/6",
"id": 6},
{
"self": "https://api.icims.com/customers/1234/forms/7",
"id": 7},
{
"self": "https://api.icims.com/customers/1234/forms/8",
"id": 8
},

Submitted by ThirumalaR on August 10, 2024 Permalink

Hello,

I'm new to ICIMS. We are trying to retrieve IForms from ICIMS. Can I check list of documents associated with profile ID and count through API. If possible, can you please help me with API Endpoints to fetch those details and another Way can I check count of documents by Document ID?

I have looked into API document, But still unable to find out. How to check above data.