SetMaintenanceMode: Operation

The SetMaintenanceMode operation changes maintenance mode status in the repository.

Comments

To execute the operation in the tMb field specify moniker of opened repository connection, and in the tArg.active field specify set maintenance mode:

The operation results in information about maintenance mode status: enabled or not enabled.

Example

Below is the example of enabling maintenance mode in the repository. The request contains moniker of opened repository connection and determines whether maintenance mode should be enabled. The response contains information about maintenance mode status.

SOAP JSON C#

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<id>NEJOFNHNBNFGGOAEGABOLMDNHJDHEPEEHIDONAKOKJMGBMEK!M</id>

</tMb>

</tArg>

</SetMaintenanceMode>

</s:Body>

</s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

</SetMaintenanceModeResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "SetMaintenanceMode" : 
  {
   "tMb" : 
    {
     "id" : "NEJOFNHNBNFGGOAEGABOLMDNHJDHEPEEHIDONAKOKJMGBMEK!M"
    },
   "tArg" : 
    {
     "active" : "true"
    }
  }
}

JSON response:

{
 "SetMaintenanceModeResult" : 
  {
   "active" : "1"
  }
}

public static MaintenanceModeState SetMaintenanceMode(string moniker, bool maintenanceMode)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tSet = new SetMaintenanceMode()
    {
        tArg = new MaintenanceModeState() { active = maintenanceMode },
        tMb = new MbId() { id = moniker }
    };
    // Change maintenance mode status
    var result = somClient.SetMaintenanceMode(tSet);
    return result;
}

SetMaintenanceMode

Syntax