Skip to content

Click of a BUTTON field.​

POST
/erupt-api/comp/button/{erupt}/{field}

Hands the whole form to the EruptButtonHandler and returns what it wants the frontend to do: a script to evaluate, form values to populate and edit expressions to apply.

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 BUTTON

Type
string
Required
Format
"string"

Request Body​

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

Responses​

OK

*/*
JSON
{
  
"data": {
  
  
"eval": "string",
  
  
"formData": {
  
  
  
"any object": {
  
  
  
}
  
  
},
  
  
"editExpr": {
  
  
  
"mapKey": "string"
  
  
}
  
},
  
"message": "string",
  
"success": true,
  
"status": "SUCCESS",
  
"promptWay": "DIALOG"
}

Playground​

Server
Authorization
Headers
Variables
Key
Value
Body

Samples​

Released under the Apache-2.0 License.