Waiting for engine...
Skip to main content

Packaged Component object

The Packaged Component object represents a component packaged for deployment to an environment. You can use the Packaged Component object to create, query, or restore deleted packaged components.

In addition to processes, you can convert the following types of components into packaged components and deploy them to an environment independently:

  • API Proxy

  • API Service

  • Certificate (public X.509)

  • Custom Library

  • Flow Service

  • Process Route

  • Processing Group

note

You must have the Packaged Component Management privilege to use the Packaged Component object.

Structure​

<PackagedComponent>
   <packageId/> 
   <packageVersion/> 
   <componentId/>
   <componentVersion/>
   <componentType/> 
   <createdDate/> 
   <createdBy/> 
   <notes/> 
   <deleted/> 
   <shareable/> 
</PackagedComponent>
FieldTypeDescription
packageIdstringThe ID of the packaged component.
packageVersionstringThe user-defined version of the packaged component. Generates a value automatically based on the component's revision number if you do not specify a packaged component version.
componentIdstringThe ID of the component.The component ID is available on the Revision History dialog, which you can access from the Build page in the user interface.
componentVersionstringWhen you save the component configuration change on the Build tab, this is the assigned Revision History number. You can find the component version 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
createdDatedateTime, for example yyyy-MM-dd'T'HH:mm:ss'Z'The creation date and time of the packaged component.
createdBystringThe user ID of the person who created the packaged component.
notesstringNotes that describe the packaged component.
shareableboolean(For processes and API Service components only) Identifies whether you can share the packaged component in the Process Library or as part of an integration pack.Note: You cannot share processes that contain Process Route components in the Process Library or as part of an integration pack.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
SupportedSupportedSupportedNot supportedNot supportedSupported

Using the GET operation​

  • The ordinary GET operation retrieves the packaged component with the specified ID. The bulk GET operation retrieves the packaged components with the specified IDs to a maximum of 100.

Using the QUERY operation​

  • The operators allowed for the Packaged Component object filters are

    • BETWEEN

    • EQUALS

    • GREATER_THAN

    • GREATER_THAN_OR_EQUAL

    • LESS_THAN

    • LESS_THAN_OR_EQUAL

    • LIKE

    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.

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

    FieldAllowed values
    componentIdAny string value (valid component ID).
    componentType- certificate
    - customlibrary
    - flowservice
    - process
    - processroute
    - tpgroup
    - webservice
    componentVersionAny integer value (valid revision history number).
    packageVersionAny string value (valid package version).
    createdDateDate with the format yyyy-MM-dd'T'HH:mm:ss'Z'.
    createdByAny string value (valid user ID).
    shareabletrue or false.
    deletedtrue or false. Indicates if you deleted the packaged component.

Using the CREATE operation​

  • You can use the CREATE operation to perform two different actions. For example, you can create a new packaged component from a specific component ID, or you can restore a deleted packaged component. Both actions use the same object endpoint. However, the information required in the request body differs.

    • To create a new packaged component, you must include a component ID in the request body. You create a packaged component for the specified componentId. Optionally, you can specify a packageVersion value and notes about the package version.

      Note: You cannot add package versions and notes after creating the packaged component. However, if not specified,  automatically assigns a numerical version number to your new packaged component.

    • To restore or recover a deleted packaged component, you must specify the packageId, componentId, and packageVersion. You can query the Packaged Component object for a list of deleted packaged components.

Using the DELETE operation​

  • The DELETE operation deletes a specific packaged component version. The id that you provide in the endpoint represents a Packaged Component ID. You can retrieve the Packaged Component ID (packageId) using the GET and QUERY operations, or by viewing the Packaged Component History dialog for a specific version in the Integration user interface.

    Note: You can restore deleted packaged components using the CREATE operation. See the section Using the CREATE operation for more details.

  • You cannot delete a packaged component if it is already in use. If currently deployed, a packaged component is considered in use if it is used in the Process Library or as part of an integration pack.

SOAP implementation​

  • GET operation

    POST:

    https://api.boomi.com/api/soap/v1/<accountID>

    where accountID is the ID of the authenticating account for the request.

    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>user@boomi.com</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:get>
             <api:objectType>PackagedComponent</api:objectType>
             <api:objectId>e8dbc278-e970-49e5-84bd-af39d7d38140</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:PackagedComponent">
                <bns:packageId>e8dbc278-e970-49e5-84bd-af39d7d38140</bns:packageId>
                <bns:packageVersion>2.0</bns:packageVersion>
                <bns:componentId>730a0b21-5497-4ffc-ad64-413b7a877479</bns:componentId>
                <bns:componentVersion>2.0</bns:componentVersion>
                <bns:componentType>process</bns:componentType>
                <bns:createdDate>2017-03-16T13:34:01Z</bns:createdDate>
                <bns:createdBy>user@boomi.com</bns:createdBy>
                <bns:notes>Created for component publication with GUID xxx</bns:notes>
                <bns:shareable>true</bns:shareable>
                <bns:deleted>false</bns:deleted>
             </bns:result>
          </bns:getResponse>
       </S:Body>
    </S:Envelope>

  • QUERY operation

    POST:

    https://api.boomi.com/api/soap/v1<accountID>

    where accountId is the ID of the authenticating account for the request.

    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>user@boomi.com</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
          </soapenv:Header>
       <soapenv:Body>
          <api:query>
             <!--Optional:-->
             <api:objectType>PackagedComponent</api:objectType>
             <!--Optional:-->
             <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="componentType"
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                           <api:argument>process</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>66d665d1-3ec7-479c-9e24-8df3fa728cf8</api:argument>
                        </api:nestedExpression>
                        <api:nestedExpression operator="EQUALS" property="packageVersion"  
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                            <api:argument>1.0</api:argument>
                        </api:nestedExpression>
                        <api:nestedExpression operator="EQUALS" property="shareable"  
                          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="createdBy"  
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                            <api:argument>user@boomi.com</api:argument>
                        </api:nestedExpression>
                        <api:nestedExpression operator="BETWEEN" property="createdDate"  
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                            <api:argument>2017-01-01T00:00:00Z</api:argument>
                            <api:argument>2017-11-01T00:00:00Z</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:PackagedComponent">
                   <bns:packageId>a4543ff8-5acf-4090-8094-ec8dbb6a7406</bns:packageId>
                   <bns:packageVersion>1.0</bns:packageVersion>
                   <bns:componentId>730a0b21-5497-4ffc-ad64-413b7a877479</bns:componentId>
                   <bns:componentVersion>2.0</bns:componentVersion>
                   <bns:componentType>process</bns:componentType>
                   <bns:createdDate>2017-01-12T17:29:55Z</bns:createdDate>
                   <bns:createdBy>user@boomi.com</bns:createdBy>
                   <bns:notes>Created for component publication with GUID xxx</bns:notes>
                   <bns:shareable>true</bns:shareable>
                   <bns:deleted>false</bns:deleted>
                </bns:result>
             </bns:results>
          </bns:queryResponse>
       </S:Body>
    </S:Envelope>

  • CREATE operation (creating a new packaged component)

    POST:

    https://api.boomi.com/api/soap/v1/<accountID>

    where accountId is the ID of the authenticating account for the request.

    The following example creates a package for the process whose ID is 66d665d1-3ec7-479c-9e24-8df3fa728cf8.

    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>user@boomi.com</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
          </soapenv:Header>
       <soapenv:Body>
          <api:create>
             <!--Optional:-->
             <object xsi:type="api:PackagedComponent" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <api:componentId>730a0b21-5497-4ffc-ad64-413b7a877479</api:componentId>
             <api:notes>Process1</api:notes>
             <api:packageVersion>1.5</api:packageVersion>
             <api:shareable>true</api:shareable>
             </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">
             <result xsi:type="bns:PackagedComponent">
                <bns:packageId>fedfde2d-014f-42eb-ab68-b9dbe9b0f3bd</bns:packageId>
                <bns:packageVersion>1.5</bns:packageVersion>
                <bns:componentId>730a0b21-5497-4ffc-ad64-413b7a877479</bns:componentId>
                <bns:componentVersion>2.0</bns:componentVersion>
                <bns:componentType>process</bns:componentType>
                <bns:createdDate>2017-11-01T20:03:43Z</bns:createdDate>
                <bns:createdBy>user@boomi.com</bns:createdBy>
                <bns:notes>Process1</bns:notes>
                <bns:shareable>true</bns:shareable>
             </result>
          </bns:createResponse>
       </S:Body>
    </S:Envelope>

  • CREATE operation (restoring a deleted packaged component)

    POST

    https://api.boom.com/api/soap/v1<accountID>

    where accountId is the ID of the authenticating account for the request.

    The following example restores a package for the process whose ID is 66d665d1-3ec7-479c-9e24-8df3fa728cf8.

    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>user@boomi.com</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:create>
             <object xsi:type="api:PackagedComponent" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <api:componentId>730a0b21-5497-4ffc-ad64-413b7a877479</api:componentId>
             <api:packageId>261129c2-f75b-4ae0-854d-35e55edc6800</api:packageId>
             <api:notes></api:notes>
             <api:packageVersion>5.0</api:packageVersion>
             </object>
          </api:create>
       <api:query/></soapenv:Body>
    </soapenv:Envelope>

    Response:

    <?xml version='1.0' encoding='UTF-8'?>
    <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:PackagedComponent">
                    <bns:packageId>261129c2-f75b-4ae0-854d-35e55edc6800</bns:packageId>
                    <bns:packageVersion>5.0</bns:packageVersion>
                    <bns:componentId>730a0b21-5497-4ffc-ad64-413b7a877479</bns:componentId>
                    <bns:componentVersion>6</bns:componentVersion>
                    <bns:componentType>process</bns:componentType>
                    <bns:createdDate>2021-01-21T00:53:48Z</bns:createdDate>
                    <bns:createdBy>user@boomi.com</bns:createdBy>
                    <bns:notes>Package for publishing</bns:notes>
                    <bns:deleted>false</bns:deleted>
                    <bns:shareable>false</bns:shareable>
                </result>
            </bns:createResponse>
        </S:Body>
    </S:Envelope>

  • DELETE operation

    POST

    https://api.boomi,com/api/soap/v1/<accountID>

    where accountId is the ID of the authenticating account for the request.

    Response:

    <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>user@boomi.com</wsse:Username>
              <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
            </wsse:UsernameToken>
          </wsse:Security>
       </soapenv:Header>
       <soapenv:Body>
          <api:create>
             <object xsi:type="api:PackagedComponent" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <api:componentId>730a0b21-5497-4ffc-ad64-413b7a877479</api:componentId>
             <api:packageId>261129c2-f75b-4ae0-854d-35e55edc6800</api:packageId>
             <api:notes></api:notes>
             <api:packageVersion>5.0</api:packageVersion>
             </object>
          </api:create>
       <api:query/></soapenv:Body>
    </soapenv:Envelope>
On this Page