Form Search API
I'm trying to find the right filter condition to get the exact match of the form , I don't know the form data id.
Sample Data -
{
"formname": "Offer_Intake_Global",
"owner": {
"profile": "https://applyuat.microsoft.com/customers/7929/applicantworkflows/386196",
"id": 386196,
"value": "Manager 31012019"
},
"links": [{
"rel": "self",
"title": "the current form being viewed.",
"url": "https://xxxx/customers/yyy/forms/offer_intake_global%20/data/97837"
}, {
"rel": "formAbout",
"title": "the profile this Form is owned by.",
"url": "https://xxxx/customers/yyy/applicantworkflows/386196"
}]
}
Search Query - below are the query but unable to find the right form id.
POST XXXX/search/forms HTTP/1.1
{
"filters": [
{
"name": "formdata.form.formname",
"value": ["ms_offer_intake_global"],
"operator": "="
},
{
"name": "applicantworkflow.person.id",
"value": ["386196"],
"operator": "="
}
]
}
Please let me know if we can get the right condition for search. based on owner and form name would like to get the form data id and based on form data id get all the question/answer.
In the example you are showing you are inserting the Applicant Workflow ID (submittalid) in the person.id value. If you only have the Applicant Workflow ID you can retrieve the associated person ID by issuing a GET request.
GET https://api.icims.com/customers/xxxx/applicantworkflows/386196
results:
"associatedprofile": {
"profile": "https://client.com/customers/xxxx/people/882158",
"id": 882158,
"value": "xxxxxxx xxxxxxxxx"
Then use the Search API inserting the person ID to get the form data ID.
POST https://api.icims.com/customers/xxxx/search/forms
{
"filters": [{
"name": "formdata.form.formname",
"value": ["offer_intake_global"],
"operator": "="
}, {
"name": "formdata.person.id",
"value": ["882158"],
"operator": "="
}],
"operator": "&"
}
results:
{
"searchResults": [
{
"self": "https://client.com/customers/xxxx/forms/97837",
"id": 97837
}
]
}