Waiting for engine...
Skip to main content

Deployed Package object

The Deployed Package object represents a packaged component deployed to an environment.

You must have the Packaged Component Deployment privilege (formerly known as the Process Deployment privilege) to use the Deployed Package object. If you want to use the CREATE operation to create a packaged component and deploy it in a single operation, you must also have the Packaged Component Management privilege (formerly known as the Package Management privilege).

Structure​

<DeployedPackage>
   <deploymentId/>
   <version/> 
   <packageId/>
   <packageVersion/> 
   <environmentId/> 
   <componentId/>
   <componentVersion/> 
   <componentType/> 
   <deployedDate/> 
   <deployedBy/> 
   <notes/> 
   <active/>
   <listenerStatus/>
   <branchName/>
   <message/>
</DeployedPackage>
FieldTypeDescription
FilterFilterFilter
deploymentIdstringThe ID of the deployment.
versionintThe version number generated automatically for a deployment.
packageIdstringThe ID of the packaged component. You can use packageId to deploy an existing packaged component. The packaged component ID is available from the:
- Packaged Component object
- The Packaged Component Details page on the Deploy > Packaged Components page in the user interface.
packageVersionstringThe user-defined version of the packaged component.
environmentIdstringThe ID of the environment.
componentIdstringThe ID of the component. You can use the componentId to create and deploy a new packaged component. The component ID is available in the Revision History dialog, which you can access from the Build page in the user interface.
componentVersionintegerThe Revision History number assigned to each saved configuration change made to a component on the Build tab. The component version is available in the Revision History dialog, which you can access from the Build page in the service.
componentTypestringThe type of component:
- certificate
- customlibrary
- flowservice
- process
- processroute
- tpgroup
- webservice
deployedDatedateTime(yyyy-MM-dd'T'HH:mm:ss'Z')The date and time you deployed the packaged component.
deployedBystringThe user ID of the user who deployed the packaged component.
notesstringNotes that describe the deployment.
activebooleanIdentifies if the packaged component is actively deployed.
listenerStatusstring(Optional, for packaged 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.
Important: This field is only available for the CREATE operation. To retrieve the status of deployed listeners, use the Listener Status object.
branchNamestring
messagestringThis tag is returned with the following message only when a successful additional deployment is performed after utilizing all the available connections in the account for CREATE operation:
Your packaged components were successfully deployed. You have exceeded the usage count in your current connection licenses by 15. Contact a Boomi representative to purchase a higher connection licenses count.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
SupportedSupportedSupportedNot supportedNot supportedSupported

Using the GET operation​

  • The ordinary GET operation returns a single Deployed Package object based on the deployment ID. The bulk GET operation returns multiple Deployed Package objects based on the supplied IDs, to a maximum of 100.

Using the Query operation​

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

    FieldAllowed values
    FilterFilter
    packageIdAny string value (valid packaged component ID).
    environmentIdAny string value (valid environment ID).
    componentIdAny string value (valid component ID).
    componentVersionAny integer value (valid revision history number).
    componentType- certificate
    - customlibrary
    - flowservice
    - process
    - processroute
    - tpgroup
    - webservice
    deployedDateDate with the format yyyy-MM-dd'T'HH:mm:ss'Z'.
    deployedByAny string value (valid user ID).
    activetrue or false.
    packageVersionAny string value (valid packaged component version).
    versionAny integer value (valid deployment version).

    The operators allowed for the Deployed Package object filters are EQUALS and NOT_EQUALS. If the QUERY includes multiple filters, you can connect the filters with a logical AND or a logical OR operator.

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

Using the CREATE operation​

  • You can use the CREATE operation in two ways:

    • With environmentId and packageId, CREATE deploys the specified packaged component to the identified environment.

    • With environmentId and componentId, CREATE packages with the specified component and deploys the package to the specified environment.

    Note: By default, deployment of listener processes are in a running state. To deploy a packaged listener process in a paused state, include the listenerStatus field with a value of PAUSED.

Using the DELETE operation​

  • The DELETE operation removes the packaged component from the environment each with a specific IDs.

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>DeployedPackage</api:objectType>
             <api:objectId>75bdf0f7-e9d5-46f7-b90f-37e77df03c0a</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:DeployedPackage">
                <bns:deploymentId>75bdf0f7-e9d5-46f7-b90f-37e77df03c0a</bns:deploymentId>
                <bns:version>3</bns:version>
                <bns:packageId>7f436a84-f9dd-4417-ac3e-ee01a1343a3b</bns:packageId>
                <bns:packageVersion>3.0</bns:packageVersion>
                <bns:environmentId>e7fc610a-c1ef-4b66-8bb5-a01a1f8970e2</bns:environmentId>
                <bns:componentId>5b4746bc-6a3e-4b18-838c-57887dae41e3</bns:componentId> 
                <bns:componentVersion>2.0</bns:componentVersion>
                <bns:componentType>process</bns:componentType>
                <bns:deployedDate>2017-04-04T15:15:36Z</bns:deployedDate>
                <bns:deployedBy>admin@boomi.com</bns:deployedBy>
                <bns:notes>Deployment through API
    Deployment of version 1 from environment Test_acct_envDeployment through API
    Deployment of version 1 from environment Test_acct_env</bns:notes>
                <bns:active>false</bns:active>
             </bns:result>
          </bns:getResponse>
       </S:Body>
    </S:Envelope>

  • QUERY 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:query>
             <api:objectType>DeployedPackage</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>983870bd-3e41-4fcc-a622-c3cb6042d9c2</api:argument>
                        </api:nestedExpression>
                        <api:nestedExpression operator="EQUALS" property="active"
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                           <api:argument>true</api:argument>
                        </api:nestedExpression>
                        <api:nestedExpression operator="EQUALS" property="componentType"
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                           <api:argument>process</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="9">
               <bns:result xsi:type="bns:DeployedPackage">
                   <bns:deploymentId>8720160b-ad1a-4fcf-a36c-ed9e9a14b626</bns:deploymentId>
                   <bns:version>1</bns:version>
                   <bns:packageId>1ee2411e-00b9-4223-9882-b211ec3629f4</bns:packageId>
                   <bns:packageVersion>6.0</bns:packageVersion>
                   <bns:environmentId>983870bd-3e41-4fcc-a622-c3cb6042d9c2</bns:environmentId>
                   <bns:componentId>5b4746bc-6a3e-4b18-838c-57887dae41e3</bns:componentId>
                   <bns:componentVersion>2.0</bns:componentVersion>
                   <bns:componentType>process</bns:componentType>
                   <bns:deployedDate>2017-04-04T15:20:46Z</bns:deployedDate>
                   <bns:deployedBy>admin@boomi.com</bns:deployedBy>
                   <bns:notes>Deployment of version 1 from environment Test_acct_envDeployment of version 1 from environment Test_acct_env</bns:notes>
                   <bns:active>true</bns:active>
                </bns:result>
                ...
                <bns:result xsi:type="bns:DeployedPackage">
                   <bns:deploymentId>90d14e55-fbcc-4121-b8c5-d37bd754abab</bns:deploymentId>
                   <bns:version>4</bns:version>
                   <bns:packageId>3a069907-4f55-46b4-90e8-27663d28112c</bns:packageId>
                   <bns:packageVersion>6.0</bns:packageVersion>
                   <bns:environmentId>983870bd-3e41-4fcc-a622-c3cb6042d9c2</bns:environmentId>
                   <bns:componentId>1fa6c6c7-4847-4c57-8db2-587ea53afe33</bns:componentId>
                   <bns:componentVersion>2.0</bns:componentVersion>
                   <bns:componentType>process</bns:componentType>
                   <bns:deployedDate>2017-11-16T16:04:51Z</bns:deployedDate>
                   <bns:deployedBy>admin@boomi.com</bns:deployedBy>
                   <bns:notes>Package deployment via Rest request</bns:notes>
                   <bns:active>true</bns:active>
                </bns:result>
             </bns:results>
          </bns:queryResponse>
       </S:Body>
    </S:Envelope>

  • CREATE operation

    The following example deploys the existing package with an ID of a77ab23f-fbf1-41e3-9b29-d046b9fd4dc4 to the environment with an ID of 1ff27719-ae76-4c0e-9555-b161922350be.

    Request (Deploy):

    <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:DeployedPackage" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <api:environmentId>1ff27719-ae76-4c0e-9555-b161922350be</api:environmentId>
                <api:packageId>a77ab23f-fbf1-41e3-9b29-d046b9fd4dc4</api:packageId>
                <api:notes>Trying to deploy http listener via api</api:notes>
                <api:listenerStatus>PAUSED</api:listenerStatus>
             </object>
          </api:create>
       </soapenv:Body>
    </soapenv:Envelope>

    Response (Deploy):

    <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">
             <result xsi:type="bns:DeployedPackage">
                <bns:deploymentId>ad8c25a3-74f7-4ce5-9b94-9f8b08484ac1</bns:deploymentId>
    <bns:version>1</bns:version>
                <bns:packageId>a77ab23f-fbf1-41e3-9b29-d046b9fd4dc4</bns:packageId>
    <bns:packageVersion>version_1</bns:packageVersion>
                <bns:environmentId>1ff27719-ae76-4c0e-9555-b161922350be</bns:environmentId>
                <bns:componentId>6023ff5f-f28c-4a83-b714-180649da6c55</bns:componentId>
                <bns:componentVersion>2.0</bns:componentVersion>
                <bns:componentType>process</bns:componentType>
                <bns:deployedDate>2017-11-16T15:59:57.118Z</bns:deployedDate>
                <bns:deployedBy>admin@boomi.com</bns:deployedBy>
                <bns:notes>Trying to deploy http listener via api</bns:notes>
                <bns:active>true</bns:active>
                <bns:listenerStatus>PAUSED</bns:listenerStatus>
             </result>
          </bns:createResponse>
       </S:Body>
    </S:Envelope>

    The following example packages the component whose ID is 1fa6c6c7-4847-4c57-8db2-587ea53afe33 to the environment whose ID is 983870bd-3e41-4fcc-a622-c3cb6042d9c2.

    Request (Package and deploy):

    <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:DeployedPackage" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <api:environmentId>983870bd-3e41-4fcc-a622-c3cb6042d9c2</api:environmentId>
                <api:componentId>1fa6c6c7-4847-4c57-8db2-587ea53afe33</api:componentId>
                <api:notes>Trying to deploy web service listener via api</api:notes>
                <api:listenerStatus>RUNNING</api:listenerStatus>
             </object>
          </api:create>
       </soapenv:Body>
    </soapenv:Envelope>

    Response (Package and deploy):

    <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">
             <result xsi:type="bns:DeployedPackage">
                <bns:deploymentId>6556d03f-8d7d-4637-a4c3-5e72fc6c999e</bns:deploymentId>
    <bns:version>2</bns:version>
                <bns:packageId>8686007c-1165-4580-87e1-6b2b73486547</bns:packageId>
    <bns:packageVersion>4.0</bns:packageVersion>            <bns:environmentId>983870bd-3e41-4fcc-a622-c3cb6042d9c2</bns:environmentId>
                <bns:componentId>1fa6c6c7-4847-4c57-8db2-587ea53afe33</bns:componentId>
                <bns:componentVersion>2.0</bns:componentVersion>
                <bns:componentType>process</bns:componentType>
                <bns:deployedDate>2017-11-16T15:54:57.587Z</bns:deployedDate>
                <bns:deployedBy>admin@boomi.com</bns:deployedBy>
                <bns:notes>Trying to deploy web service listener via api</bns:notes>
                <bns:active>true</bns:active>
                <bns:listenerStatus>RUNNING</bns:listenerStatus>
             </result>
          </bns:createResponse>
       </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>
             <objectType>DeployedPackage</objectType>
             <objectId>4aa639c9-e180-420a-bcdb-5d4ac9e49e3f</objectId>
          </api:delete>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

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

On this Page