update.get_trains
=================

Returns available trains dict and the currently configured train as well as the train of currently booted environment.

.. raw:: html

    <div id="json-schema"> <span class="badge badge-dark value-type">Type: object</span><br/> <div class="accordion" id="accordionCall_parameters"> <div class="card"> <div class="card-header" id="headingCall_parameters"> <h2 class="mb-0"> <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters"> <div class="card-body pl-5"> <span class="badge badge-dark value-type">Type: array</span><br/> <span class="badge badge-info no-additional">No Additional Items</span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value"> <div class="card"> <div class="card-header" id="headingReturn_value"> <h2 class="mb-0"> <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button> </h2> </div> <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value"> <div class="card-body pl-5"> <h4>UpdateGetTrainsResult</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_trains"> <div class="card"> <div class="card-header" id="headingReturn_value_trains"> <h2 class="mb-0"> <button aria-controls="Return_value_trains" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_trains" data-toggle="collapse" onclick="setAnchor('#Return_value_trains')" type="button"><span class="property-name">trains</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_trains" class="collapse property-definition-div" data-parent="#accordionReturn_value_trains" id="Return_value_trains"> <div class="card-body pl-5"> <h4>Trains</h4><span class="badge badge-dark value-type">Type: object</span><br/> <div class="accordion" id="accordionReturn_value_trains_additionalProperties"> <div class="card"> <div class="card-header" id="headingReturn_value_trains_additionalProperties"> <h2 class="mb-0"> <button aria-controls="Return_value_trains_additionalProperties" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_trains_additionalProperties" data-toggle="collapse" onclick="setAnchor('#Return_value_trains_additionalProperties')" type="button"><em><span class="property-name">Additional Properties</span></em></button> </h2> </div> <div aria-labelledby="headingReturn_value_trains_additionalProperties" class="collapse property-definition-div" data-parent="#accordionReturn_value_trains_additionalProperties" id="Return_value_trains_additionalProperties"> <div class="card-body pl-5"><p class="additional-properties">Each additional property must conform to the following schema</p> <h4>UpdateTrain</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_trains_additionalProperties_description"> <div class="card"> <div class="card-header" id="headingReturn_value_trains_additionalProperties_description"> <h2 class="mb-0"> <button aria-controls="Return_value_trains_additionalProperties_description" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_trains_additionalProperties_description" data-toggle="collapse" onclick="setAnchor('#Return_value_trains_additionalProperties_description')" type="button"><span class="property-name">description</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_trains_additionalProperties_description" class="collapse property-definition-div" data-parent="#accordionReturn_value_trains_additionalProperties_description" id="Return_value_trains_additionalProperties_description"> <div class="card-body pl-5"> <h4>Description</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_current"> <div class="card"> <div class="card-header" id="headingReturn_value_current"> <h2 class="mb-0"> <button aria-controls="Return_value_current" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_current" data-toggle="collapse" onclick="setAnchor('#Return_value_current')" type="button"><span class="property-name">current</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_current" class="collapse property-definition-div" data-parent="#accordionReturn_value_current" id="Return_value_current"> <div class="card-body pl-5"> <h4>Current</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_selected"> <div class="card"> <div class="card-header" id="headingReturn_value_selected"> <h2 class="mb-0"> <button aria-controls="Return_value_selected" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_selected" data-toggle="collapse" onclick="setAnchor('#Return_value_selected')" type="button"><span class="property-name">selected</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_selected" class="collapse property-definition-div" data-parent="#accordionReturn_value_selected" id="Return_value_selected"> <div class="card-body pl-5"> <h4>Selected</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div><br><br>

*Required roles:* SYSTEM_UPDATE_READ