Runtime Restart Request object

The Runtime Restart Request object allows you to restart the runtime when performing runtime maintenance or configuration. Restarting runtime is captured in the audit log entries.

note

You must have the Runtime Management and Environment Management privileges to restart the runtime.

Structure

<RuntimeRestartRequest runtimeId =""/>

Field	Type	Description
runtimeId	string	A unique ID for the runtime. Cloud attachments cannot be restarted.

Executes an action on a Runtime Restart Request object

Restarts the runtime.

• The client sends a runtime restart request to the platform API that specifies the runtimeId that you want to restart.
• The platform returns the status code and message while the request is in progress. A successful response implies the restart request was submitted, not when the runtime restart is completed.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
  <soapenv:Header>
     <wsse:Security
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
       <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
         <wsse:Username>admin@boomi.com</wsse:Username>
         <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">boomi</wsse:Password>
       </wsse:UsernameToken>
     </wsse:Security>
  </soapenv:Header>
  <soapenv:Body>
    <api:create>
        <!--Optional:-->
        <api:objectType>RuntimeRestartRequest</api:objectType>
         <!--Optional:-->
      <api:objectId>657ff9d7-ad4c-4f46-bb4e-06827b12221b</api:objectId>
         <!--Optional:-->
         <object xsi:type="api:RuntimeRestartRequest" runtimeId="657ff9d7-ad4c-4f46-bb4e-06827b12221b" 
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> 
     </api:create>
  </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
       <bns:createResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
           <bns:results xsi:type="bns:RuntimeRestartRequest" statusCode="200" messageRestart request submitted for runtimeId "3456789a-bcde-f012-3456-789abcdef012". Use the Atom object to retrieve the current runtime status."/>
       </bns:createResponse>
   </S:Body>
</S:Envelope>