For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.


Application Configuration (GET)

Retrieves the configuration of a specific application version.


Roles

Users in the following roles are authorized to perform this operation:


Method

GET


Path

/management-apis/2.0/runtimes/runtime-name/applications/application-name/application-env/application-version/config


Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/applications/myapplication/android/1.0/config?flattened=false&locale=de_DE&mode=defaults


Path Parameters

runtime-name
The name of the runtime. This is the context root of the runtime web application, without the leading slash.
application-name
The name of the application.
application-env
The application environment.
application-version
The application version number.


Query Parameters

Query parameters are optional.

flattened
If this parameter is set to true (which is the default value), the configuration is returned as a flat list of properties. Otherwise, it is returned as a hierarchy of objects.
locale
The locale used for error messages.
mode
If no mode is specified, the method returns the current user configuration. If the defaults mode is specified, the method returns the default configuration.


Produces

application/json, application/xml, text/xml


Response

The configuration of the specified application version.


JSON Example

{ "applicationAccessConfig" : { "action" : "BLOCKED", "downloadLink" : "www.ynet.co.il", "message" : "The application is blocked.", "multiLanguageMessages" : [ { "locale" : "de", "message" : "Bitte updaten!", }, ... ], }, "clientLogProfiles" : { "level" : "INFO", "name" : "com.acme.sub1", }, }


XML Example

<?xml version="1.0" encoding="UTF-8"?> <appconfig> <applicationAccessConfig action="BLOCKED" downloadLink="www.ynet.co.il" message="The application is blocked."> <multiLanguageMessages> <multiLanguageMessage locale="de" message="Bitte updaten!"/> ... </multiLanguageMessages> </applicationAccessConfig> <clientLogProfiles level="INFO" name="com.acme.sub1"/> </appconfig>


Response Properties

The response has the following properties:

applicationAccessConfig
The access configuration of an application version.
clientLogProfiles
The log filters to collect application logs from devices according to a profile.

The accessConfig has the following properties:

action
Application access status
downloadLink
The URL for the new version of the application to download.
message
The message that the user receives when opening the application.
multiLanguageMessages
The notification text in different languages.

The languages has the following properties:

locale
The locale for the language
message
The message in the locale

The logfilters has the following properties:

level
The severity level. Errors are returned from this level upwards.
name
The logical package name that is used to identify the logger in the mobile application


Errors

403

The user is not authorized to call this service. 404

The corresponding runtime or the application version is not found. 500

An internal error occurred.

Parent topic: REST API for the MobileFirst Server administration service