Search API to get iforms

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

Trying to search the iforms via api but unable to get result in search.
let me know how to get the forms if exists.

POST /search/forms HTTP/1.1
Content-Type: application/json
{
"filters": [
{
"name": "form.formname",
"value": ["offer_intake_global"],
"operator": "="
} ]
}
Response 400
{
"errors": [{
"errorMessage": "The following filter is either not valid or hidden: form.formname",
"errorCode": 5
}]
}

Let me know how we can search form based on owner ( workflow id ) and /or Job Id

Submitted by iCIMSUNIFIL on March 08, 2019 Permalink

Change the name variable to the example below

{
"filters": [{
"name": "formdata.form.formname",
"value": ["offer_intake_global"],
"operator": "="
}

Submitted by iCIMSUNIFIL on March 09, 2019 Permalink

This will give the result of all the forms which match with filter form name. How can we add other filters to exact match for workflow Id ( submittal id ) .

{

"filters": [

{

"name": "formdata.form.formname",

"value": ["offer_intake_global"],

"operator": "="

},
{

"name": "formdata.submittalformsubmittalid",

"value": ["385"],

"operator": "="

}
]

}

(edited) Last Updated: December 12, 2024, 6:31 PM
Submitted by iCIMSUNIFIL on March 12, 2019 Permalink

This is an example of how to retrieve a specific iForm for a person

Method: POST
URL: https://api.icims.com/customers/xxxx/search/forms

JSON:
{
"filters": [{
"name": "formdata.form.formname",
"value": ["FormName"],
"operator": "="
}, {
"name": "formdata.person.id",
"value": ["688"],
"operator": "="
}],
"operator": "&"
}

Returned Payload:
{
"searchResults": [{
"self": "https://api.icims.com/customers/xxxx/forms/45",
"id": 45
}]
}

Query the API to retrieve either a pdf, word or text version of the background form the candidate has completed.
Method: GET
URL: https://api.icims.com/customers/xxxx/forms/45.pdf
Or
https://api.icims.com/customers/xxxx/forms/45.doc
Or
https://api.icims.com/customers/xxxx/forms/45.txt