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

Applications (GET)

Retrieves metadata for the list of deployed applications.

Roles

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

• mfpadmin
• mfpdeployer
• mfpmonitor
• mfpoperator

Method

GET

Path

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

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/applications?bookmark=ABC&expand=true&locale=de_DE&offset=0&orderBy=displayName&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.

expand

Whether an expanded version of the result should be shown. If this parameter is set to false, only a flat list of applications are returned. If the parameter is set to true, the entire hierarchy of environment and versions is returned, too.

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: displayName, deployTime. The default sort mode is: displayName.

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" : [
    {
      "deployTime" : "2014-04-13T00:18:36.979Z",
      "displayName" : "MyApplication",
      "link" : "https://www.example.com/mfpadmin/management-apis/2.0/runtimes/{runtime-name}/applications/{app-name}/{app-env}/{app-version}",
      "project" : {
        "name" : "myproject",
      },
      "resourceName" : "abc",
      "resourceType" : "APP_DESCRIPTOR",
    },
    ...
  ],
  "nextPageBookmark" : "DEF",
  "pageNumber" : 2,
  "pageSize" : 100,
  "prevPageBookmark" : "ABC",
  "productVersion" : "8.0",
  "startIndex" : 0,
  "totalListSize" : 33,
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<applications
  nextPageBookmark="DEF"
  pageNumber="2"
  pageSize="100"
  prevPageBookmark="ABC"
  productVersion="8.0"
  startIndex="0"
  totalListSize="33">
  <items>
    <item
      deployTime="2014-04-13T00:18:36.979Z"
      displayName="MyApplication"
      link="https://www.example.com/mfpadmin/management-apis/2.0/runtimes/{runtime-name}/applications/{app-name}/{app-env}/{app-version}"
      resourceName="abc"
      resourceType="APP_DESCRIPTOR">
      <project name="myproject"/>
    </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 one page of applications is returned.

pageNumber

The page index if only one page of applications is returned.

pageSize

The page size if only one page of applications is returned.

prevPageBookmark

The bookmark of the previous page if only one page of applications is returned.

productVersion

The exact product version.

startIndex

The start index in the total list if only one page of applications is returned.

totalListSize

The total number of applications.

The configlink has the following properties:

deployTime

The date in ISO 8601 format when the artifact was deployed.

displayName

The optional display name of the artifact.

link

The URL to access detailed information about the deployed artifacts such as application, adapter etc.

project

The project the artifact belong to.

resourceName

The name of the artifact.

resourceType

The type of the artifact.

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.

500

An internal error occurred.

Parent topic: REST API for the MobileFirst Server administration service