/Administration/search/fields GET

Overview

[ADMIN] Search field configuration

Summary

This endpoint lists the full text search configuration of all fields for the full text search enabled modules. This endpoint is only available to administrators.

Request Arguments

Name	Type	Description	Required
module_list	String	Comma delimited list of modules to return. If omitted, all search enabled modules will be returned. Example: `Accounts,Contacts`	False
search_only	Boolean	When set, only searchable fields are returned. Defaults to false.	False
order_by_boost	Boolean	When set, a flat list of searchable fields is returned ordered by boost value.	False

Response

{
    "Accounts":{
        "name":{
            "name":"name",
            "type":"name",
            "searchable":true,
            "boost":1
        },
        "date_modified":{
            "name":"date_modified",
            "type":"datetime",
            "searchable":false
        }
    }
}

Response using order_by_boost

{
    "Quotes.quote_num":1.5,
    "Manufacturers.name":1,
    "Bugs.name":0.9,
    "ProjectTask.name":0.5,
}

Change Log

Version	Change
v10	Added `/Administration/search/fields` GET endpoint.