Common Parameters

The following parameters are common to all API calls:


Request
Parameter

Header
Variable

Description

roleid IV-User

The user name to use for authentication.

When the request parameter is used the value must be base 64 encoded.

Note: For boe and biprws platforms, Trusted Authentication must be enabled.

token n/a

The logon token to use for authentication.

When the request parameter is used the value must be base 64 encoded.

ess n/a

The serialized session to use to reconnect to an existing BO enterprise session.

When the request parameter is used the value must be encrypted.

app LBI-Application Use this parameter to specify the application.  If not specified, then the default application is used (name='default').
env LBI-Environment Use this parameter to specify the environment.  If not specified, then the default environment is used.