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

Runtime Lock (GET)

Retrieves information about the transaction lock of a runtime.

Description

Transactions are performed sequentually. Hence each transaction such as deploying an application or adapter takes the runtime lock. The next transaction waits until the lock is released. This API allowed to retrieve whether a runtime is currently busy with a 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/lock

Example

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

locale

The locale used for error messages.

Produces

application/json, application/xml, text/xml

Response

JSON Example

{
  "busy" : true,
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<lock busy="true"/>

Response Properties

The response has the following properties:

busy

Whether the runtime is currently busy with a transaction.

Errors

403

The user is not authorized to call this service.

500

An internal error occurred.

Parent topic: REST API for the MobileFirst Server administration service