Skip to content

Build model of the erupt referenced by a field.​

GET
/erupt-api/build/{erupt}/{field}

Resolves the target class of a reference, tab or link-tree field and returns its build model, so a nested erupt can be rendered without knowing its class name up front.

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 on the erupt; its declared type is the erupt to build

Type
string
Required
Format
"string"

Responses​

OK

*/*
JSON
{
  
"eruptModel": {
  
  
"mapKey": "[Circular Reference]"
  
},
  
"tabErupts": "[Circular Reference]",
  
"combineErupts": {
  
  
"mapKey": "[Circular Reference]"
  
},
  
"operationErupts": {
  
  
"mapKey": "[Circular Reference]"
  
},
  
"power": {
  
  
"add": true,
  
  
"edit": true,
  
  
"delete": true,
  
  
"query": true,
  
  
"viewDetails": true,
  
  
"export": true,
  
  
"importable": true,
  
  
"print": true,
  
  
"copy": true,
  
  
"cellEdit": true,
  
  
"batchEdit": true,
  
  
"ai": true,
  
  
"comment": true,
  
  
"revision": true
  
},
  
"scope": {
  
  
"name": "string",
  
  
"bind": [
  
  
  
"""",""""
  
  
]
  
}
}

Playground​

Server
Authorization
Headers
Variables
Key
Value

Samples​

Released under the Apache-2.0 License.