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


Adapter (GET)

Retrieves metadata of a specific adapter.


Roles

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


Method

GET


Path

/management-apis/2.0/runtimes/runtime-name/adapters/adapter-name


Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/adapters/myadapter?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.
adapter-name
The name of the adapter.


Query Parameters

Query parameters are optional.

locale
The locale used for error messages.


Produces

application/json, application/xml, text/xml


Response

The metadata of the specified adapter.


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}", "name" : "SampleAdapter", "productVersion" : "8.0", "project" : { "name" : "myproject", }, "resourceName" : "abc", "resourceType" : "APP_DESCRIPTOR", "runtimeInfo" : { "descriptorXML" : "", "resources" : { "basePath" : "/mfp/api/adapters/demoAdapter", "info" : { "description" : "The adapter for bank-end service", "title" : "demoAdapter", }, "paths" : { }, "swagger" : "2.0", }, }, }


XML Example

<?xml version="1.0" encoding="UTF-8"?> <adapter 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}" name="SampleAdapter" productVersion="8.0" resourceName="abc" resourceType="APP_DESCRIPTOR"> <project name="myproject"/> <runtimeInfo descriptorXML=""> <resources basePath="/mfp/api/adapters/demoAdapter" swagger="2.0"> <info description="The adapter for bank-end service" /> <paths/> </resources> </runtimeInfo> </adapter>


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.
name
The name of the adatper
productVersion
The exact product version.
project
The project the artifact belong to.
resourceName
The name of the artifact.
resourceType
The type of the artifact.
runtimeInfo
The runtime information of the adapter

The project has the following properties:

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

The runtime-info has the following properties:

descriptorXML
The adapter description in XML
resources
Adapter resource information

The resource-info has the following properties:

basePath
The base api path to the adatper
info
The information about the adapter
paths
The adapter methods
swagger
The Swagger version

The adapter-info has the following properties:

description
The description of the adapter
title
The title of the adapter


Errors

403

The user is not authorized to call this service. 404

The corresponding runtime or the adapter is not found. 500

An internal error occurred.

Parent topic: REST API for the MobileFirst Server administration service