Skip to content

Execute a row operation.​

POST
/erupt-api/data/{erupt}/operator/{code}

Body is {"ids": [...], "param": {...}}: ids are the selected rows, param the operation form values (validated against the operation erupt). The handler may return a script for the frontend to evaluate; it comes back in data.

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"
code*

@RowOperation.code

Type
string
Required
Format
"string"

Request Body​

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

Responses​

OK

*/*
JSON
{
  
"data": {
  
},
  
"message": "string",
  
"success": true,
  
"status": "SUCCESS",
  
"promptWay": "DIALOG"
}

Playground​

Server
Authorization
Headers
Variables
Key
Value
Body

Samples​

Released under the Apache-2.0 License.