Waiting for engine...
Skip to main content

Deployment object (Legacy deployment, Deprecated)

The Deployment object represents a component deployment.

caution

The Deployment object is a deprecated API and should no longer be used. Boomi recommends that you take advantage of the API functionality provided by the Packaged Component and Deployed Package objects instead. This change is to support the introduction of Packaged Component Deployments, which leverages the way Legacy account users deploy components to environments. For more information about 's API object deprecation status, refer to the API deprecation and versioning policy topic.

Boomi encourages administrators of Legacy deployment accounts to take advantage of the new Packaged Components Deployment by upgrading their accounts. Learn more about the new Deployment workflow and How to upgrade Legacy accounts to use the new deployment workflow. In the meantime, do not use the replacement API without first converting your Legacy account.

You cannot deploy processes that contain Process Route components as a unit with the API. You must deploy the parent process, the Process Route component, and any subprocesses that the process route calls independently.

Structure​

<Deployment>
  <id/>
  <digest/>
  <environmentId/>
  <processId/>
  <componentId/>
  <componentType/> 
  <current/>
  <notes/>
  <version/>

  <deployedOn/>
  <deployedBy/>
  <listenerStatus/> 
</Deployment>
FieldTypeDescription
FilterFilterFilter
idstringThe ID of the component deployment.
digeststringA hash of the configurations for the components that are included in the deployment. This digest is important for performing the deployComponent or deployProcess operation. You can obtain the value with a GET operation only.
environmentIdstringThe ID of the environment of this component deployment.

Note: When users with Basic environment accounts make CREATE requests without specifying the environmentID, the Deployment API deploys the process to all active environments.
processIdstringThe ID of the process.
componentIdstringThe ID of the component.
componentTypestringThe type of component: certificate, customlibrary, process, processroute, tpgroup, or webservice
currentbooleanIf set to true, this component is the most recently deployed version.
notesstringDeployment notes logged when this component deployment occurred.
versionintThe version of the component deployment.
deployedOndateTime (yyyy-MM-dd'T'HH:mm:ss'Z' — for example, 2013-01-31T15:32:00Z)The date and time at which the component deployment occurred.
deployedBystringThe user ID (email address) of the user who requested this component deployment.
listenerStatusstring(Optional, for listener processes only) The status of a listener process as RUNNING or PAUSED. If you do not specify listenerStatus (or you specify an invalid value), the current status remains unchanged. By default, the deployment of listener processes are in a running state.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
SupportedSupportedSupportedNot SupportedNot SupportedNot Supported

Notes:

  • The ordinary GET operation retrieves the component deployment having the specified ID. The bulk GET operation retrieves the component deployments having the specified IDs, to a maximum of 100.

  • The following fields can be used as QUERY filters for the Deployment object:

    FieldAllowed values
    FilterFilter
    environmentIdAny string value (valid environment ID).
    processIdAny string value (valid process ID). If you set both processId and componentId, the values must be the same. However, you need only one of the two fields.
    componentIdAny string value (valid component ID). If you set both processId and componentId, the values must be the same. However, you need only one of the two fields.
    componentTypecertificate, customlibrary, process, processroute, tpgroup, or webservice
    currentThis parameter returns true as the most recently deployed version of the component only. Also, false returns previous versions of the component deployment.

    The operators allowed for the Deployment object filters are:

    • BETWEEN

    • EQUALS

    • GREATER_THAN

    • GREATER_THAN_OR_EQUAL

    • LESS_THAN

    • LESS_THAN_OR_EQUAL

    • LIKE

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

  • The CREATE operation deploys the component with a specific ID to the environment with a specific ID. If you include a version number in the CREATE request that already exists in the deployment history, that version is re-deployed as the newest version.

    note

    By default, listener processes are deployed in a running state. To deploy a listener in a paused state, include the listenerStatus field with a value of PAUSED.

    When users with Basic environment accounts make CREATE requests without specifying the environmentID, the Deployment API deploys the process to all active environments.

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>Deployment</api:objectType>
             <api:objectId>6e75e2ae-cfba-44de-bada-5e2b5d5cddf9</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:Deployment">
                <bns:id>6e75e2ae-cfba-44de-bada-5e2b5d5cddf9</bns:id>
                <bns:digest>acc7b4a6a693af4ee7f1f157b74e92c6</bns:digest>
                <bns:environmentId>3f32254b-2544-4fdb-8388-bd55527762d1</bns:environmentId>
                <bns:processId>aa270ba9-b0ba-4b59-bf59-c92ff2d6ccb9</bns:processId>
                <bns:componentId>aa270ba9-b0ba-4b59-bf59-c92ff2d6ccb9</bns:componentId>
                <bns:current>true</bns:current>
                <bns:notes>via SOAP request: Re-deployment of version 54</bns:notes>
                <bns:version>2</bns:version>
                <bns:deployedOn>2017-02-17T17:16:29Z</bns:deployedOn>
                <bns:deployedBy>user123@company.biz</bns:deployedBy>
                <bns:componentType>process</bns:componentType>
             </bns:result>
          </bns:getResponse>
       </S:Body>
    </S:Envelope>

  • QUERY operation

    The following example query returns non-current deployments of the component whose ID is 789abcde-f012-3456-789a-bcdef0123456 to the environment whose ID is 456789ab-cdef-0123-4567-89abcdef0123.

    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>Deployment</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="environmentId"
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                           <api:argument>456789ab-cdef-0123-4567-89abcdef0123</api:argument>
                        </api:nestedExpression>
                        <api:nestedExpression operator="EQUALS" property="componentId"
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                           <api:argument>789abcde-f012-3456-789a-bcdef0123456</api:argument>
                        </api:nestedExpression>
                        <api:nestedExpression operator="EQUALS" property="current"  
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                            <api:argument>false</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="100">
                <bns:queryToken>EXAMPLE_QUERY_TOKEN</bns:queryToken>
                <bns:result xsi:type="bns:Deployment">
                   <bns:id>89abcdef-0123-4567-89ab-cdef01234567</bns:id>
                   <bns:environmentId>456789ab-cdef-0123-4567-89abcdef0123</bns:environmentId>
                   <bns:processId>789abcde-f012-3456-789a-bcdef0123456</bns:processId>
                   <bns:componentId>789abcde-f012-3456-789a-bcdef0123456</bns:componentId>
                   <bns:componentType>process</bns:componentType>
                   <bns:current>false</bns:current>
                   <bns:notes>Initial</bns:notes>
                   <bns:version>1</bns:version>
                   <bns:deployedOn>2012-09-43T11:48:27Z</bns:deployedOn>
                   <bns:deployedBy>user123@company.biz</bns:deployedBy>
                </bns:result>
                ...
                <bns:result xsi:type="bns:Deployment">
                   <bns:id>76543210-fedc-ba98-7654-3210fedcba98</bns:id>
                   <bns:environmentId>456789ab-cdef-0123-4567-89abcdef0123</bns:environmentId>
                   <bns:processId>789abcde-f012-3456-789a-bcdef0123456</bns:processId>
                   <bns:componentId>789abcde-f012-3456-789a-bcdef0123456</bns:componentId>
                   <bns:componentType>process</bns:componentType>
                   <bns:current>false</bns:current>
                   <bns:notes>Added process properties</bns:notes>
                   <bns:version>50</bns:version>
                   <bns:deployedOn>2013-07-29T13:01:14Z</bns:deployedOn>
                   <bns:deployedBy>user123@company.biz</bns:deployedBy>
                </bns:result>
          </bns:queryResponse>
       </S:Body>
    </S:Envelope>

    The maximum number of results returned per QUERY response is 100. This response includes a queryToken element, which means there are more than 100 results to retrieve. The Query paging topic describes how to use a queryMore call to retrieve more results.

  • CREATE 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:create>
             <object xsi:type="api:Deployment" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <api:environmentId>456789ab-cdef-0123-4567-89abcdef0123</api:environmentId>
                <api:componentId>789abcde-f012-3456-789a-bcdef0123456</api:componentId>
                <api:notes>via SOAP request: Re-deployment of version 54</api:notes>
             </object>
          </api:create>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:


    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:createResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:result xsi:type="bns:Deployment">
                <bns:id>89abcdef-0123-4567-89ab-cdef01234567</bns:id>
                <bns:environmentId>456789ab-cdef-0123-4567-89abcdef0123</bns:environmentId>
                <bns:processId>789abcde-f012-3456-789a-bcdef0123456</bns:processId>
                <bns:componentId>789abcde-f012-3456-789a-bcdef0123456</bns:componentId>
                <bns:componentType>process</bns:componentType>
                <bns:current>true</bns:current>
                <bns:notes>via SOAP request: Re-deployment of version 54</bns:notes>
                <bns:version>55</bns:version>
                <bns:deployedOn>2013-09-23T16:33:53.413Z</bns:deployedOn>
                <bns:deployedBy>user123@company.biz</bns:deployedBy>
             </bns:result>
          </bns:createResponse>
       </S:Body>
    </S:Envelope>

    If this is a listener process, the response includes the following: <bns:listenerStatus>RUNNING</bns:listenerStatus>.

    ::

On this Page