SwitchMaintenanceMode – включить/выключить режим технического обслуживания

Функция включает режим технического обслуживания системы. Повторный вызов отключает режим. При выполнении проверяется, что текущий пользователь входит в роль «Администраторы». Если он не является администратором, то выполнение функции завершается с ошибкой.

Синтаксис

[Public(WebApiRequestType = RequestType.Post)]

public static bool SwitchMaintenanceMode()

Возвращаемое значение

True – режим технического обслуживания успешно включен или выключен, иначе – false.

Пример. Включить/выключить режим технического обслуживания системы

POST /Integration/odata/CoreEntities/SwitchMaintenanceMode
Host: localhost
Content-Type: application/json
Authorization: Basic <base64 encoding credentials>

SwitchMaintenanceModeWithCustomMessage – включить/выключить режим технического обслуживания с указанием сообщения

Функция включает режим технического обслуживания системы с показом сообщения для пользователя на странице аутентификации. Например, в тексте можно указать причину недоступности системы. Если сообщение не задано, то отображается текст по умолчанию:

Повторный вызов функции отключает режим. При выполнении проверяется, что текущий пользователь входит в роль «Администраторы». Если он не является администратором, то выполнение функции завершается с ошибкой.

Синтаксис

[Public(WebApiRequestType = RequestType.Post)]

public static bool SwitchMaintenanceModeWithCustomMessage(string message)

Параметры

message – текст сообщения на странице аутентификации.

Возвращаемое значение

True – режим технического обслуживания успешно включен или выключен, иначе – false.

Пример. Включить режим технического обслуживания системы с сообщением для пользователей

POST /Integration/odata/CoreEntities/SwitchMaintenanceModeWithCustomMessage
Host: localhost
Content-Type: application/json
Authorization: Basic <base64 encoding credentials>
 
{
 "message": "В системе ведутся технические работы. Попробуйте выполнить вход позже."
}

TurnOnMaintenanceMode – включить режим технического обслуживания

Функция включает режим технического обслуживания системы. При выполнении проверяется, что текущий пользователь входит в роль «Администраторы». Если он не является администратором, то выполнение функции завершается с ошибкой.

Синтаксис

[Public(WebApiRequestType = RequestType.Post)]

public static bool TurnOnMaintenanceMode()

Возвращаемое значение

Успешность выполнения операции. True – режим технического обслуживания успешно включен, иначе – false.

Пример. Включить режим технического обслуживания системы

POST /Integration/odata/CoreEntities/TurnOnMaintenanceMode
Host: localhost
Content-Type: application/json
Authorization: Basic <base64 encoding credentials>

TurnOffMaintenanceMode – выключить режим технического обслуживания

Функция выключает режим технического обслуживания системы. При выполнении проверяется, что текущий пользователь входит в роль «Администраторы». Если он не является администратором, то выполнение функции завершается с ошибкой.

Синтаксис

[Public(WebApiRequestType = RequestType.Post)]

public static bool TurnOffMaintenanceMode()

Возвращаемое значение

True – режим технического обслуживания успешно выключен, иначе – false.

Пример. Выключить режим технического обслуживания системы

POST /Integration/odata/CoreEntities/TurnOffMaintenanceMode
Host: localhost
Content-Type: application/json
Authorization: Basic <base64 encoding credentials>
Authorization: Basic <base64 encoding credentials>

GetMaintenanceModeStatus – получить состояние режима технического обслуживания

Функция проверяет, включен ли режим технического обслуживания системы. При выполнении проверяется, что текущий пользователь входит в роль «Администраторы». Если он не является администратором, то выполнение функции завершается с ошибкой.

Синтаксис

[Public(WebApiRequestType = RequestType.Get)]

public static bool GetMaintenanceModeStatus()

Возвращаемое значение

Состояние режима технического обслуживания. True – режим технического обслуживания включен, false – выключен.

Пример. Получить состояние режима технического обслуживания системы

GET /Integration/odata/CoreEntities/GetMaintenanceModeStatus
Host: localhost
Content-Type: application/json
Authorization: Basic <base64 encoding credentials>

© Компания Directum, 2024