Skip to content

Auto-complete suggestions for an AUTO_COMPLETE field.​

POST
/erupt-api/comp/auto-complete/{erupt}/{field}

Static values from @AutoCompleteType.values are matched case-insensitively, then the configured handler adds its own. The input must be at least triggerLength characters.

Authorizations​

tokenHeader

Login token from POST /erupt-api/login, or from /erupt-api/open-api/create-token for server-to-server calls.

Type
API Key (header: token)

Parameters​

Header Parameters

erupt*

Name of the @Erupt class the request is scoped to. Must match the {erupt} path segment, or name the parent erupt when the path addresses a nested erupt (tab, sub-form, reference).

Type
string
Required
Format
"string"

Path Parameters

erupt*

Simple class name of the @Erupt model

Type
string
Required
Format
"string"
field*

Field name with edit type AUTO_COMPLETE

Type
string
Required
Format
"string"

Query Parameters

val*

Text typed so far

Type
string
Required
Format
"string"

Request Body​

application/json
JSON
{
  
"any object": {
  
}
}

Responses​

OK

*/*
JSON
[
  
{
  
  
"any object": {
  
  
}
  
}
]

Playground​

Server
Authorization
Headers
Variables
Key
Value
Body

Samples​

Released under the Apache-2.0 License.