Pick list of a REFERENCE_TABLE field.
POST
/erupt-api/data/{erupt}/reference-table/{fieldName}
Pages through the referenced erupt with the same query shape as the table request. When @ReferenceTableType.dependField is set the current value of that field must be sent as dependValue.
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
Requiredstring
Format
"string"Path Parameters
erupt*
Simple class name of the @Erupt model
Type
Requiredstring
Format
"string"fieldName*
Field name with edit type REFERENCE_TABLE
Type
Requiredstring
Format
"string"Query Parameters
dependValue
Value of the depend field, required when one is configured
Type
object
tabRef
true when called from a TAB_TABLE_REFER field
Type
boolean
Example
trueFormat
"boolean"Request Body
application/json
JSON "pageIndex": 0, "pageSize": 0, "sort": [ { "field": "string", "direction": "ASC" } ], "totalPage": 0, "total": 0, "list": [ { "any object": { } } ], "alert": { "message": "string", "closeable": true, "uiType": "success" }, "extraContent": "string", "linkTreeVal": [ { "any object": { } } ], "condition": [ { "key": "string", "expression": "AUTO", "value": { } } ], "vis": "string", "any object": { }
{
}
Responses
OK
*/*
JSON "pageIndex": 0, "pageSize": 0, "sort": [ { "field": "string", "direction": "ASC" } ], "totalPage": 0, "total": 0, "list": [ { "any object": { } } ], "alert": { "message": "string", "closeable": true, "uiType": "success" }, "extraContent": "string"
{
}