Change readiness status

This resource changes the current ready status of the Process Engine. Manually it can be set ON or OFF. The endpoint will then respond with READY or NOT READY. The status incorporates also the current maintenance mode activity.

The overall is calculated as follows:

Maintenance mode active: NOT READY
Maintenance mode not active: manually set status (READY or NOT READY)

In status READY the endpoint will always return with HTTP status 200.

In status NOT READY the endpoint will always return with HTTP status 500.

Request

URL: /ready/{status}

Method: POST

Authorization: required (user with role System Administrator)

GET /ibis/rest/ready/off HTTP/1.1
Accept: */*
Host: localhost:8080

Request Parameters

Name Description Required Allowed values

Name	Description	Required	Allowed values
`status`	Readiness status of the Process Engine	yes	`on` (READY) or `off` (NOT READY)

status

Readiness status of the Process Engine

yes

on (READY) or off (NOT READY)

Response

HTTP/1.1 500 ERROR
Content-Tye: application/json

{
  "status": "NOT READY",
  "message": "No Service."
}

Errors

Authorization Failed (401): Authorization with the given username and password failed. Please revisit both values and provide valid credentials.

<html>

    <head>
        <title>Status page</title>
    </head>

    <body style="font-family: sans-serif;">
        <p style="font-size: 1.2em;font-weight: bold;margin: 1em 0px;">Unauthorized</p>
        <p>The request requires user authentication</p>
        <p>You can get technical details <a
                href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">here</a>.<br>
            Please continue your visit at our <a href="/">home page</a>.
        </p>
    </body>
</html>

Server Error (500): Execution on the INUBIT server failed. Have a look into the response message, otherwise access to the INUBIT log is required to retrieve further information.
Service Unavailable (503): In maintenance mode the INUBIT server endpoint will not respond to incoming requests but return this error response. Once the maintenance mode is switched off the endpoint will respond normally.