Field Lists

Currently, Search and Match API returns the default fields (entities) in the response (fields in the records array). Now with the fieldList parameter in the Search and Match API request, you can customize the fields in the API response. See the example in Table 1. Simple Search request and response with and without fieldList parameter.

• The fieldList is an optional parameter (query) that can be passed in the API request of Simple Search, Boolean Search, Free Text Search, Get Document Detail, Match, Match with ID, and Match with Multiple Sub-User Ids.

• See Fields that can be passed in fieldList parameter.
• You can customize the fields in the API response by passing the required fields in the fieldList parameter; see the sample Simple Search request with fieldList.
• The API returns the fields in the response based on the fields passed in the fieldList parameter; see the record array in the Simple Search Response with fieldList.
• If fieldList parameter is not passed in the API request, then default fields are returns in the API response; see the records array in the Simple Search Response without fieldList and The Default Fields.
• An error will be returned if the field name is wrong in the fieldList parameter in the API request.
• The id, score, and SubUserID are returned in the API response as default fields even if they are not passed in the fieldList parameter.

Sample Simple Search Request and Response

Table 1. Simple Search request and response with and without fieldList parameter

Simple Search Request without fieldList	Simple Search Response without fieldList
	Note: In below API response, the records array contains the default resume fields since fieldList parameter is not passed in the API request.
Simple Search Request with fieldList	Simple Search Response with fieldList
	Note: In below API response, the records array contains Skill, score, and JobProfile fields since fieldList parameter contains these parameters in the API request. The id, score, and SubUserID are returned in the API response as default for all records array.