Runtime (GET)

Retrieves metadata for a specific runtime.

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

Example

https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime?expand=true&locale=de_DE

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.

expand: Set to true to show details of the applications and adapters. The default is false
locale: The locale used for error messages.

Produces

application/json, application/xml, text/xml

Response

The metadata for the runtime.

JSON Example

{
  "adapters" : [
    {
      "deployTime" : "2014-04-13T00:18:36.979Z",
      "description" : "My first sample adapter",
      "link" : "https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/adapters/myadapter",
      "name" : "myadapter",
      "platformVersion" : "6.1.0.00.20131126-0630",
      "procedures" : [ "getSomething", ... ],
      "projects" : [
        {
          "name" : "myproject",
        },
        ...
      ],
      "urls" : [
        {
          "formParameters" : [
            {
              "defaultValue" : "n/a",
              "javaType" : "java.lang.String",
              "name" : "param",
            },
            ...
          ],
          "javaClass" : "com.example.MyRestWrapper",
          "javaMethodName" : "multiplyNumbers",
          "method" : "POST",
          "pathParameters" : [
            {
              "defaultValue" : "n/a",
              "javaType" : "java.lang.String",
              "name" : "param",
            },
            ...
          ],
          "queryParameters" : [
            {
              "defaultValue" : "n/a",
              "javaType" : "java.lang.String",
              "name" : "param",
            },
            ...
          ],
          "uri" : "/multiply",
        },
        ...
      ],
    },
    ...
  ],
  "applications" : [
    {
      "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.0.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",
          "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",
        },
        ...
      ],
    },
    ...
  ],
  "auditEnabled" : true,
  "bitlyApiKey" : "",
  "bitlyUsername" : "",
  "name" : "myruntime",
  "numberOfActiveDevices" : 100,
  "numberOfDecommisionedDevices" : 5,
  "platformVersion" : "6.1.0.00.20131126-0630",
  "productVersion" : "7.0.0",
  "running" : true,
  "serverVersion" : "7.0.0",
  "synchronizationStatus" : "ok",
  "topology" : "STANDALONE",
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<runtime
  auditEnabled="true"
  bitlyApiKey=""
  bitlyUsername=""
  name="myruntime"
  numberOfActiveDevices="100"
  numberOfDecommisionedDevices="5"
  platformVersion="6.1.0.00.20131126-0630"
  productVersion="7.0.0"
  running="true"
  serverVersion="7.0.0"
  synchronizationStatus="ok"
  topology="STANDALONE">
  <adapters>
    <adapter
      deployTime="2014-04-13T00:18:36.979Z"
      description="My first sample adapter"
      link="https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/adapters/myadapter"
      name="myadapter"
      platformVersion="6.1.0.00.20131126-0630">
      <procedures>
        <procedure>getSomething</procedure>
        ...
      </procedures>
      <projects>
        <project name="myproject"/>
        ...
      </projects>
      <urls>
        <url
          javaClass="com.example.MyRestWrapper"
          javaMethodName="multiplyNumbers"
          method="POST"
          uri="/multiply">
          <formParameters>
            <formParameter
              defaultValue="n/a"
              javaType="java.lang.String"
              name="param"/>
            ...
          </formParameters>
          <pathParameters>
            <pathParameter
              defaultValue="n/a"
              javaType="java.lang.String"
              name="param"/>
            ...
          </pathParameters>
          <queryParameters>
            <queryParameter
              defaultValue="n/a"
              javaType="java.lang.String"
              name="param"/>
            ...
          </queryParameters>
        </url>
        ...
      </urls>
    </adapter>
    ...
  </adapters>
  <applications>
    <application
      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.0.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"
          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>
    </application>
    ...
  </applications>
</runtime>

Response Properties

The response has the following properties:

adapters: The array of adapters (shown only with expand=true).
applications: The array of applications (shown only with expand=true).
auditEnabled: Whether audit is enabled.
bitlyApiKey: The key for the Bitly service.
bitlyUsername: The user name for the Bitly service.
name: The name of the runtime. This is the context root of the runtime web application, without the leading slash.
numberOfActiveDevices: The number of active devices using this runtime.
numberOfAdapters: The number of adapters deployed in this runtime (shown only with expand=false).
numberOfApplications: The number of applications deployed in this runtime (shown only with expand=false).
numberOfDecommisionedDevices: The number of devices decommissioned for this runtime.
platformVersion: The exact version number of the IBM MobileFirst™ Platform Foundation development tools (Studio) that built the project WAR file.
productVersion: The exact product version.
running: Whether the runtime is currently active or has stopped.
serverVersion: The exact IBM MobileFirst Platform Server version number from which worklight-jee-library.jar is taken.
synchronizationStatus: The status of the nodes of the runtime. Can contain the values "ok" if all nodes of the runtime are running without error, "synchronizing" if some node is in progress of synchronizing, or an error message if some nodes failed to synchronize.
topology: Server topology. Can contain the values "STANDALONE", "CLUSTER" or "FARM"

The adapter has the following properties:

deployTime: The date in ISO 8601 format when the adapter was deployed.
description: The description of the adapter.
link: The URL to access detail information about the adapter.
name: The name of the adapter.
platformVersion: The exact version number of the IBM MobileFirst Platform Foundation development tools (Studio) that built the adapter.
procedures: The JavaScript procedures of the adapter.
projects: The projects the adapter belong to.
urls: The API documentation of the URLs of the REST API provided by the adapter.

The project has the following properties:

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

The url has the following properties:

formParameters: The form parameters.
javaClass: The Java™ class
javaMethodName: The Java method
method: The HTTP method.
pathParameters: The path parameters.
queryParameters: The query parameters.
uri: The URI of the REST API.

The REST API parameter has the following properties:

defaultValue: The default value.
javaType: The Java type name.
name: The name of the parameter.

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: iphone, android, ...
link: The URL to access detail information about the application version.
prevBuildTime: The time stamp when the app that was previously deployed was built.
publishUrl: For web applications, this is the URL under which the web application was published.
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.

Errors

403

The user is not authorized to call this service.

404

The corresponding runtime is not found.

500

An internal error occurred.