Process Schedule Status object

The Process Schedule Status object represents the status of run schedules for a deployed process.

Structure

<ProcessScheduleStatus enabled="" id="" atomId="" processId=""/>

Field	Type	Description
filter	Filter	Filter
enabled	Boolean	If set to true, the schedules are in effect. Setting it to falsestops the schedules.
id	string	The object’s conceptual ID, which is synthesized from the process and Runtime IDs.
atomId	string	A unique ID assigned by the system to the Runtime.
processId	string	A unique ID assigned by the system to the process.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Supported	Supported	Not supported	Supported	Not supported	Not supported

Notes:

The ordinary GET operation retrieves the Process Schedule Status object with a specified conceptual ID. The bulk GET operation retrieves the Process Schedule Status objects with specific conceptual IDs to a maximum of 100. You can obtain conceptual IDs from the QUERY operation.
You can use the following fields as QUERY filters for the Process Schedule Status object:

Field Allowed values
atomId Any string value.
processId Any string value.

The operators allowed for the Process Schedules object filters are:
- BETWEEN
- EQUALS
- GREATER_THAN
- GREATER_THAN_OR_EQUAL
- IS_NOT_NULL
- IS_NULL
- LESS_THAN
- LESS_THAN_OR_EQUAL
- LIKE
- NOT_EQUALS
The UPDATE operation stops or resumes process run schedules for a deployed process. The body of the request must specify not only the conceptual Process Schedule Status object ID but also the Atom and process IDs. You can obtain the object ID from a QUERY operation.

You must have the Runtime Management privilege and the Scheduling privilege to perform the UPDATE operation. If you have the Runtime Management Read Accessprivilege, you cannot update the status of process run schedules.

Field	Allowed values
atomId	Any string value.
processId	Any string value.

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>
         <api:objectType>ProcessScheduleStatus</api:objectType>
         <api:objectId>Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg</api:objectId>
      </api:get>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:getResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <bns:result xsi:type="bns:ProcessScheduleStatus" enabled="true" id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
           atomId="3456789a-bcde-f0123-4567-89abcdef012" processId="789abcde-f012-3456-789a-bcdef0123456">
         </bns:result>
      </bns:getResponse>
   </S:Body>
</S:Envelope>

QUERY operation

The following example query returns the run schedule status for the process with ID 789abcde-f012-3456-789a-bcdef0123456 deployed to the Atom with ID 3456789a-bcde-f0123-4567-89abcdef012.

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:query>
         <api:objectType>ProcessScheduleStatus</api:objectType>
         <api:queryConfig>
             <api:QueryFilter>
                <api:expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:GroupingExpression">
                   <api:nestedExpression operator="EQUALS" property="atomId" xsi:type="api:SimpleExpression">
                      <api:argument>3456789a-bcde-f0123-4567-89abcdef012</api:argument>
                   </api:nestedExpression>
                   <api:nestedExpression operator="EQUALS" property="processId" xsi:type="api:SimpleExpression">
                      <api:argument>789abcde-f012-3456-789a-bcdef0123456</api:argument>
                   </api:nestedExpression>
                </api:expression>
             </api:QueryFilter>
         </api:queryConfig>
      </api:query>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:queryResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <bns:results numberOfResults="1">
            <bns:result xsi:type="bns:ProcessScheduleStatus" enabled="false" id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
              atomId="3456789a-bcde-f0123-4567-89abcdef012" processId="789abcde-f012-3456-789a-bcdef0123456"/>
         </bns:results>
     </bns:queryResponse>
   </S:Body>
</S:Envelope>

UPDATE operation

This example resumes schedules for the process with ID 789abcde-f012-3456-789a-bcdef0123456 deployed to the Atom with ID 3456789a-bcde-f0123-4567-89abcdef012.

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:update>
          <object xsi:type="api:ProcessScheduleStatus" enabled="true" id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
            atomId="3456789a-bcde-f0123-4567-89abcdef012" processId="789abcde-f012-3456-789a-bcdef0123456" 
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
      </api:update>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:updateResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <bns:result xsi:type="bns:ProcessScheduleStatus" enabled="true" id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
           atomId="3456789a-bcde-f0123-4567-89abcdef012" processId="789abcde-f012-3456-789a-bcdef0123456"/>
      </bns:updateResponse>
   </S:Body>
</S:Envelope>

Structure​

Supported operations​

SOAP implementation​

Structure

Supported operations

SOAP implementation