Applications (GET)

Retrieves metadata for the list of deployed applications.

Roles

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

worklightadmin
worklightdeployer
worklightmonitor
worklightoperator

Method

GET

Path

/management-apis/1.0/runtimes/runtime-name/applications

Example

https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/applications?bookmark=ABC&locale=de_DE&offset=0&orderBy=name&pageSize=100

Path Parameters

runtime-name: The name of the runtime. This is the context root of the runtime web application, without the leading slash.

Query Parameters

Query parameters are optional.

bookmark: The bookmark for the page if only a part of the list (a page) should be returned. If a bookmark is specified, the offset parameter is ignored.
locale: The locale used for error messages.
offset: The offset from the beginning of the list if only a part of the list (a page) should be returned.
orderBy: The sort mode. By default, the elements are sorted in increasing order. If the sort mode starts with - (minus sign), the elements are sorted in decreasing order. Possible sort modes are: name. The default sort mode is: name.
pageSize: The number of elements if only a part of the list (a page) should be returned. The default value is 100.

Produces

application/json, application/xml, text/xml

Response

The metadata of the deployed applications.

JSON Example

{
  "items" : [
    {
      "description" : "My first sample application",
      "displayName" : "My Sample Application",
      "environments" : [
        {
          "applicationEnvironmentDataAccess" : {
            "action" : "NOTIFY",
            "createdTime" : "2014-04-13T00:18:36.979Z",
            "message" : "This version is no longer supported.",
          },
          "authenticityConfig" : "BASIC",
          "buildTime" : "2014-03-29T00:18:36.979Z",
          "deployTime" : "2014-04-13T00:18:36.979Z",
          "deviceProvisioningRealm" : "myProvRealm",
          "envPlatformVersion" : "7.1.0",
          "environment" : "android",
          "link" : "https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/applications/myapplication/android/1.0",
          "prevBuildTime" : "2014-03-29T00:18:36.979Z",
          "resourceSize" : 5120,
          "securityTest" : "mobileTest",
          "supportRemoteDisable" : true,
          "supportsAuthenticity" : true,
          "userAuthenticationRealm" : "myAuthRealm",
          "version" : "1.0",
          "versionLocked" : false,
        },
        ...
      ],
      "link" : "https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/applications/myapplication",
      "name" : "myapplication",
      "platformVersion" : "6.1.0.00.20131126-0630",
      "projects" : [
        {
          "name" : "myproject",
        },
        ...
      ],
    },
    ...
  ],
  "nextPageBookmark" : "DEF",
  "pageNumber" : 2,
  "pageSize" : 100,
  "prevPageBookmark" : "ABC",
  "productVersion" : "7.1.0",
  "startIndex" : 0,
  "totalListSize" : 33,
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<applications
  nextPageBookmark="DEF"
  pageNumber="2"
  pageSize="100"
  prevPageBookmark="ABC"
  productVersion="7.1.0"
  startIndex="0"
  totalListSize="33">
  <items>
    <item
      description="My first sample application"
      displayName="My Sample Application"
      link="https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/applications/myapplication"
      name="myapplication"
      platformVersion="6.1.0.00.20131126-0630">
      <environments>
        <environment
          authenticityConfig="BASIC"
          buildTime="2014-03-29T00:18:36.979Z"
          deployTime="2014-04-13T00:18:36.979Z"
          deviceProvisioningRealm="myProvRealm"
          envPlatformVersion="7.1.0"
          environment="android"
          link="https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/applications/myapplication/android/1.0"
          prevBuildTime="2014-03-29T00:18:36.979Z"
          resourceSize="5120"
          securityTest="mobileTest"
          supportRemoteDisable="true"
          supportsAuthenticity="true"
          userAuthenticationRealm="myAuthRealm"
          version="1.0"
          versionLocked="false">
          <applicationEnvironmentDataAccess
            action="NOTIFY"
            createdTime="2014-04-13T00:18:36.979Z"
            message="This version is no longer supported."/>
        </environment>
        ...
      </environments>
      <projects>
        <project name="myproject"/>
        ...
      </projects>
    </item>
    ...
  </items>
</applications>

Response Properties

The response has the following properties:

items: The array of application metadata
nextPageBookmark: The bookmark of the next page if only a page of applications is returned.
pageNumber: The page index if only a page of applications is returned.
pageSize: The page size if only a page of applications is returned.
prevPageBookmark: The bookmark of the previous page if only a page of applications is returned.
productVersion: The exact product version.
startIndex: The start index in the total list if only a page of applications is returned.
totalListSize: The total number of applications.

The application has the following properties:

description: The description of the application.
displayName: The display name of the application.
environments: The array of application environments.
link: The URL to access detail information about the application.
name: The name of the application.
platformVersion: The exact version number of the IBM MobileFirst™ Platform Foundation development tools (Studio) that built the application.
projects: The projects the application belong to.

The environment has the following properties:

applicationEnvironmentDataAccess: The access rule to be executed when the app version is disabled.
authenticityConfig: The application authenticity configuration. Possible values are: NONE, BASIC, EXTENDED.
buildTime: The time stamp when the app version was built.
deployTime: The date in ISO 8601 format when the application was deployed.
deviceProvisioningRealm: The name of the realm used for device provisioning.
envPlatformVersion: The version of the platform of the environment.
environment: The platform environment of the app version: android, iphone, ...
link: The URL to access detail information about the application version.
prevBuildTime: The time stamp when the app that was previosuly deployed was built.
publishUrl: For web applications, this is the URL under which the web application was published.
resourceSize: The size of the wlapp file of the application version.
securityTest: The name of the security test for a protected resource.
supportRemoteDisable: true if the application version supports remote disabling.
supportsAuthenticity: true if the application version supports authentication.
userAuthenticationRealm: The name of the realm used to authenticate users.
version: The version number of the app version.
versionLocked: Whether the version is locked.

The applicationEnvironmentDataAccess has the following properties:

action: The action to be done when a disabled app version is accessed. Possible values are: NOTIFY, BLOCK, NA.
createdTime: The date in ISO 8601 format when the app version access rule was created.
downloadLink: The download link where to obtain a new version of the application.
message: The message to be displayed when a disabled app version is accessed.
multiLanguageMessage: Internationalized variants of the message to be displayed when a disabled app version is accessed.

The project has the following properties:

name: The name of the project, which is the context root of the runtime.

Errors

403

The user is not authorized to call this service.

404

The corresponding runtime is not found or not running.

500

An internal error occurred.