Waiting for engine...
Skip to main content

Runtime Release Schedule object

The Runtime Release Schedule object allows you to configure a schedule for automatically receiving updates on a runtime, Runtime cluster, or Runtime cloud.

note

You must have the Runtime Management privilege to use the Runtime Release Schedule object.

Structure​


<RuntimeReleaseSchedule>
   <atomId></atomId>
   <scheduleType></scheduleType>
   <hourOfDay></hourOfDay>
   <timeZone></timeZone>
</RuntimeReleaseSchedule>
FieldTypeDescription
FilterFilterFilter
atomIDstringThe ID of the container for which you want to set a schedule.
scheduleTypestringRequired. Determines whether you want to receive the updates when available, and if so, whether you receive them in the first or second (last) week they are available prior to the .- FIRST - Update within the first week that updates are available
1. LAST - Update within the second week that updates are available
2. NEVER - Update with the
dayOfWeekstringThe day of the week that you want to receive updates on the runtime, Runtime cluster, or Runtime cloud.
1. Required if scheduleType is set to FIRST or LAST
hourOfDayintegerThe hour of the day that you want to receive updates on the runtime, Runtime cluster, or Runtime cloud. 1. Must be between 0-23
2. Required if scheduleType is set to FIRST or LAST
timeZonestringThe time zone of your set schedule.
1. Must be a valid time zone
2. Required if scheduleType is set to FIRST or LAST

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
Supported Not Supported  SupportedSupported Not Supported   Supported

Notes:

  • The GET operation returns the current schedule for receiving updates on a specified runtime, Runtime cluster, or Runtime cloud.

  • The CREATE operation sets a schedule for receiving updates with the scheduleType, dayOfWeek, hourOfDay, and timeZone fields.

  • The UPDATE operation modifies a set schedule for receiving updates.

  • The DELETE operation sets the scheduleType to NEVER, meaning that the runtime, Runtime cluster, or Runtime cloud receives updates only during the .

SOAP implementation​

  • GET operation

    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>ATOMSPHERE_USER_NAME</wsse:Username>
                    <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
                </wsse:UsernameToken>
            </wsse:Security>
        </soapenv:Header>
        <soapenv:Body>
            <api:get
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <!--Optional:-->
                <api:objectType>RuntimeReleaseSchedule</api:objectType>
                <!--Optional:-->
                <api:objectId>2f717303-f3a1-4c09-8195-29d105b35620</api:objectId>
                <!--Optional:-->
            </api:get>
        </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope
        xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
        <S:Body>
            <bns:getResponse
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xmlns:bns="http://api.platform.boomi.com/">
                <bns:result xsi:type="bns:RuntimeReleaseSchedule">
                    <bns:atomId>2f717303-f3a1-4c09-8195-29d105b35620</bns:atomId>
                    <bns:scheduleType>FIRST</bns:scheduleType>
                    <bns:dayOfWeek>WEDNESDAY</bns:dayOfWeek>
                    <bns:hourOfDay>21</bns:hourOfDay>
                    <bns:timeZone>America/New_York</bns:timeZone>
                </bns:result>
            </bns:getResponse>
        </S:Body>
    </S:Envelope>

  • CREATE operation

    The following example creates a schedule where a Runtime receives the updates in the first week after the on Sunday at 23:00 in the America/Puerto_Rico time zone.

    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>ATOMSPHERE_USERNAME</wsse:Username>
                    <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
                </wsse:UsernameToken>
            </wsse:Security>
        </soapenv:Header>
        <soapenv:Body>
            <api:create>
                <object xsi:type="api:RuntimeReleaseSchedule"
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
                    <atomId>407e55c8-b4b8-452a-8163-8e8989e64bc8</atomId>
                    <scheduleType>FIRST</scheduleType>
                    <dayOfWeek>SUNDAY</dayOfWeek>
                    <hourOfDay>23</hourOfDay>
                    <timeZone>America/Puerto_Rico</timeZone>
                </object>
            </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/">
                <result xsi:type="bns:RuntimeReleaseSchedule">
                    <bns:atomId>407e55c8-b4b8-452a-8163-8e8989e64bc8</bns:atomId>
                    <bns:scheduleType>FIRST</bns:scheduleType>
                    <bns:dayOfWeek>SUNDAY</bns:dayOfWeek>
                    <bns:hourOfDay>23</bns:hourOfDay>
                    <bns:timeZone>America/Puerto_Rico</bns:timeZone>
                </result>
            </bns:createResponse>
        </S:Body>
    </S:Envelope>

  • UPDATE operation

    This example updates the scheduleType of a set schedule to NEVER, resulting in the Atom receiving updates only during the .

    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>ATOMSPHERE_USERNAME</wsse:Username>
                    <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
                </wsse:UsernameToken>
            </wsse:Security>
        </soapenv:Header>
        <soapenv:Body>
            <api:update>
                <object xsi:type="api:RuntimeReleaseSchedule"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" >
                   <atomId>407e55c8-b4b8-452a-8163-8e8989e64bc8</atomId>
                   <scheduleType>NEVER</scheduleType>
                </object>
            </api:update>
        </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope
        xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
        <S:Body>
            <bns:updateResponse
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xmlns:bns="http://api.platform.boomi.com/">
                <result xsi:type="bns:RuntimeReleaseSchedule">
                    <bns:atomId>407e55c8-b4b8-452a-8163-8e8989e64bc8</bns:atomId>
                    <bns:scheduleType>NEVER</bns:scheduleType>
                    <bns:hourOfDay>0</bns:hourOfDay>
                </result>
            </bns:updateResponse>
        </S:Body>
    </S:Envelope>

  • DELETE operation

    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>ATOMSPHERE_USER_NAME</wsse:Username>
                    <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
                </wsse:UsernameToken>
            </wsse:Security>
        </soapenv:Header>
        <soapenv:Body>
            <api:delete>
                <!--Optional:-->
                <objectType>RuntimeReleaseSchedule</objectType>
                <!--Optional:-->
                <objectId>2f717303-f3a1-4c09-8195-29d105b35620</objectId>
                <!--Optional:-->
            </api:delete>
        </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope
        xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
        <S:Body>
            <bns:deleteResponse
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xmlns:bns="http://api.platform.boomi.com/">
                <successful>true</successful>
            </bns:deleteResponse>
        </S:Body>
    </S:Envelope>

On this Page