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

Transaction (GET)

Retrieves information about a specific transaction.

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/transactions/transaction-id

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/transactions/1?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.

transaction-id

The transaction id.

Query Parameters

Query parameters are optional.

locale

The locale used for error messages.

Produces

application/json, application/xml, text/xml

Response

The information of the specified transaction.

JSON Example

{
  "appServerId" : "Tomcat",
  "description" : {
  },
  "errors" : [
    {
      "details" : "An internal error occured.",
    },
    ...
  ],
  "id" : 1,
  "productVersion" : "8.0",
  "project" : {
    "name" : "myproject",
  },
  "status" : "FAILURE",
  "timeCreated" : "2014-04-13T00:18:36.979Z",
  "timeUpdated" : "2014-04-14T00:18:36.979Z",
  "type" : "DELETE_ADAPTER",
  "userName" : "demouser",
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<transaction
  appServerId="Tomcat"
  id="1"
  productVersion="8.0"
  status="FAILURE"
  timeCreated="2014-04-13T00:18:36.979Z"
  timeUpdated="2014-04-14T00:18:36.979Z"
  type="DELETE_ADAPTER"
  userName="demouser">
  <description/>
  <errors>
    <error details="An internal error occured."/>
    ...
  </errors>
  <project name="myproject"/>
</transaction>

Response Properties

The response has the following properties:

appServerId

The id of the web application server.

description

The details of the transaction, depending on the transaction type.

errors

The errors occured during the transacton.

id

The id of the transaction.

productVersion

The exact product version.

project

The current project.

status

The state of the transaction: PENDING, PREPARING, COMMITTING, REJECTING, SUCCESS, FAILURE, CANCELED. Synchronous transactions can have the state SUCCESS and FAILURE. Asynchronous transactions can also have the other states.

timeCreated

The date in ISO 8601 format when the adapter was created.

timeUpdated

The date in ISO 8601 format when the adapter was updated.

type

The type of the transaction.

userName

The user that initiated the transaction.

The error has the following properties:

details

The main error message.

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 transaction is not found.

500

An internal error occurred.

Parent topic: REST API for the MobileFirst Server administration service