GenerateStub

Class Description

Generate a Stub Interface in one of the following target languages: typescript, kotlin, php (and many more, untested). Define the Methods name to extract the request and response stubs. Response stubs will only be exported if a working testscenario was defined for that method.

RPC Configuration

Rpc Name:

Plain: GenerateStub
Sha1: 416b9a18d23b0a497756b7d3ddc4990679d446d4

Rpc Call

RPCs can be called by their plain name or their SHA1 representation.

Rpc Parameters:

"method" : string,
"targetLanguage" : string = typescript 

Requires Login:

true

Requires Context:

Context

The context providing parameter can either be a contagt-id (8-Bytes, Alphaumeric) or an integer as a building id. The context parameter name should make the choice obviouse, the type has not to be defined manually.

false

Requires WriteAccess:

WriteAccess

Only accounts that have an explicit write access to the defined context can execute this RPC, no matter if the authentication level matches or not.

true

Requires AuthenticationLevel:

Context

Authentication levels allow the SuperUser to define a by-RPC granular access configuration. If RPCs are chained in a single unified call and lenient is enabled, all allowed RPCs will be executed, while execution will fail entirely with lenient set to false.

SUPERUSER

Requires Subbuilding Merge Strategy:

SUBBUILDING_ONLY

Cache Configuration

Response Cache

All writing RPCs are not Cacheable, also Caching will be disabled by the paramters nocache and readonly.

Cache enabled:

false

Sample Request

->

{
    "method": "LoadBeacons"
}