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


Application Descriptor (GET)

Retrieves the application descriptor 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/descriptor


Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/applications/myapplication/android/1.0/descriptor?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.
application-name
The name of the application.
application-env
The application environment.
application-version
The application version number.


Query Parameters

Query parameters are optional.

locale
The locale used for error messages.


Produces

application/json, application/xml, text/xml


Response

The application descriptor of the specified application version.


JSON Example

{ "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}", "productVersion" : "8.0", "project" : { "name" : "myproject", }, "resourceName" : "abc", "resourceType" : "APP_DESCRIPTOR", }


XML Example

<?xml version="1.0" encoding="UTF-8"?> <appdescriptor 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}" productVersion="8.0" resourceName="abc" resourceType="APP_DESCRIPTOR"> <project name="myproject"/> </appdescriptor>


Response Properties

The response 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.
productVersion
The exact product version.
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 or the application is not found. 500

An internal error occurred.

Parent topic: REST API for the MobileFirst Server administration service