Create a search setting

post

https://rls.congacloud.com/api/search/v1/setting

Creates a search setting for a particular object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Search setting

ObjectName

string | null

Name of the object

EnableAllSearchFields

boolean

Enable All Search Fields from metadata.

SearchFields

array of objects | null

Search Fields - Perform search on SearchFields set.

SearchFields

GlobalSearchFields

array of objects | null

Global Search Fields - Perform search on GlobalSearchFields set.

GlobalSearchFields

TypeAheadFields

array of objects | null

TypeAhead Fields - Provide suggestions for users as they type in a query and return list of fields in result.

TypeAheadFields

SelectFields

array of objects | null

Select Fields - users as they type in a query and return list of fields in result.

SelectFields

IgnoreFields

array of objects | null

Ignore fields - should not return in results.

IgnoreFields

PriorityFields

array of objects | null

Based on Priority fields - result should be sort.

PriorityFields

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

404

Not Found

500

Internal Server Error

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created