Process object

The Process object represents a process that is available to the requesting account.

The primary use of this object is to assist with integration packs and extensions for multi-install integration packs.

To retrieve general information about a process or other type of component, use the Component Metadata object instead.

Structure

<Process id="" name="">
   <IntegrationPack integrationPackInstanceId="" integrationPackId=""/>
   .
   .
   .
   <IntegrationPack integrationPackInstanceId="" integrationPackId=""/>
</Process>

Field	Type	Description
id	string	A unique ID assigned by the system to the process. For deployed processes and processes belonging to single-install integration packs, this value is the process component ID.For processes belonging to multi-install integration packs, this is an synthetic ID and does not match an actual process component. You can use this value as the extensionGroupId when querying the Environment Extensions object.
name	string	The name of the process.
integrationPackInstanceId	string	If the process is in an installed integration pack, this is the unique ID assigned by the system to the installed instance of the integration pack.
integrationPackId	string	If the process is in an installed integration pack, this is the unique ID assigned by the system to the integration pack.

Supported operations

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

Notes:

• The ordinary GET operation retrieves the properties of the process having the specified ID. The bulk GET operation retrieves the properties of the processes having the specified IDs, to a maximum of 100.

• You can use the following fields as QUERY filters for the Process object:

  Field	Allowed values
  id	Any string value.
  name	Any string value.
  integrationPackId	Any string value.
  integrationPackInstanceId	Any string value.

  The operators allowed for the Process object filters are:

  • BETWEEN

  • EQUALS

  • GREATER_THAN

  • GREATER_THAN_OR_EQUAL

  • IS_NULL

  • IS_NOT_NULL

  • LESS_THAN

  • LESS_THAN_OR_EQUAL

  • LIKE

  • NOT_EQUALS

  For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.

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>Process</api:objectType>
           <api:objectId>56789abc-def0-1234-5678-9abcdef01234</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:Process" id="56789abc-def0-1234-5678-9abcdef01234" name="Order Intake">
              <bns:IntegrationPack integrationPackInstanceId="76543210FEDCBA9876543210FEDCBA98" 
                integrationPackId="89abcdef-0123-4567-89ab-cdef01234567"/>
           </bns:result>
        </bns:getResponse>
     </S:Body>
  </S:Envelope>

• QUERY operation

  The following example query returns all processes named Order Intake available to the requesting account.

  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>Process</api:objectType>
           <api:queryConfig>
               <api:QueryFilter>
                  <api:expression operator="EQUALS" property="name"
                     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                     <api:argument>Order Intake</api:argument>
                  </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="4">
              <bns:result xsi:type="bns:Process" id="56789abc-def0-1234-5678-9abcdef01234" name="Order Intake">
                 <bns:IntegrationPack integrationPackInstanceId="76543210FEDCBA9876543210FEDCBA98" 
                   integrationPackId="89abcdef-0123-4567-89ab-cdef01234567"/>
              </bns:result>
              ...
              <bns:result xsi:type="bns:Process" id="6789abcd-ef01-2345-6780-abcdef012345" name="Order Intake">
                 <bns:IntegrationPack integrationPackInstanceId="876543210FEDCBA9876543210FEDCBA9" 
                   integrationPackId="9abcdef0-1234-5678-9abc-def012345678"/>
              </bns:result>
           </bns:results>
       </bns:queryResponse>
     </S:Body>
  </S:Envelope>