Transactions (GET)

Retrieves information of failed transactions.

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/transactions/errors

Example

https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/transactions/errors?locale=de_DE&offset=0&orderBy=created&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.

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: created, updated, type, status, user, server. The default sort mode is: created.
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, application/zip

Response

The information of the transactions.

JSON Example

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

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<transactions
  pageSize="100"
  productVersion="7.0.0"
  startIndex="0"
  totalListSize="33">
  <items>
    <item
      appServerId="Tomcat"
      id="1"
      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"/>
    </item>
    ...
  </items>
</transactions>

Response Properties

The response has the following properties:

items: The array of transations
pageSize: The page size if only a page of transactions is returned.
productVersion: The exact product version.
startIndex: The start index in the total list if only a page of transactions is returned.
totalListSize: The total number of transactions.

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

500

An internal error occurred.