Waiting for engine...
Skip to main content

Component Metadata API example requests

Use a list of API call examples for quick insight into the various requests you can make using the Component Metadata object.

The process available in the community article Boomi Enterprise Platform API: Component Metadata Query Examples demonstrates how to use the Boomi Enterprise Platform API connector to create various Component Metadata queries and map them to a CSV report.

General tips for using the Component Metadata object​

  • Include a filter for currentVersion = true for most calls to avoid returning previous component versions.
  • Include a filter for deleted = false for most calls to avoid returning deleted component versions.
  • For information about which query filters you can use, refer to the Query filters topic.

Get the current component Name for an ID​

This query retrieves the current version including the name for a specific component ID. You can use this query in conjunction with other APIs that only return a component ID, such as PackagedComponent and DeployedPackage.

<QueryConfig xmlns="http://api.platform.boomi.com/">
  <QueryFilter>
    <expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="GroupingExpression">
        <nestedExpression operator="EQUALS" property="currentVersion" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>true</argument>
    	</nestedExpression>
        <nestedExpression operator="EQUALS" property="componentId" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>c9fa4b5d-de31-4018-9bb5-6ea4b074a039</argument>
    	</nestedExpression>
    </expression>
  </QueryFilter>
</QueryConfig>

Get all current component versions​

This query retrieves all the current, non-deleted component versions in your account, similar to the list you see in Component Explorer on the Build tab by default.

<QueryConfig xmlns="http://api.platform.boomi.com/">
       <QueryFilter>
<expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="GroupingExpression">
<nestedExpression operator="EQUALS" property="currentVersion" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>true</argument>
    	</nestedExpression>
<nestedExpression operator="EQUALS" property="deleted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>false</argument>
    	</nestedExpression>
      </expression>
   </QueryFilter>
</QueryConfig>

Get all versions for a component​

This query retrieves the full version history for a component, to see when and by whom modified it.

<QueryConfig xmlns="http://api.platform.boomi.com/">
       <QueryFilter>
         <expression operator="EQUALS" property="componentId" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
         <argument>1234a5-67a8-912f-a345-a6ed7891c2b</argument>
      </expression>
   </QueryFilter>
</QueryConfig>

Get all current components in a folder​

This query retrieves all the non-deleted components currently stored in a specific folder.

<QueryConfig xmlns="http://api.platform.boomi.com/">
  <QueryFilter>
    <expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="GroupingExpression">
        <nestedExpression operator="EQUALS" property="currentVersion" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>true</argument>
        </nestedExpression>
        <nestedExpression operator="EQUALS" property="deleted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>false</argument>
        </nestedExpression>
        <nestedExpression operator="EQUALS" property="folderName" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>#Common Utilities</argument>
        </nestedExpression>
    </expression>
  </QueryFilter>
</QueryConfig>

Get all changes made by a user during a specific timeframe​

This query retrieves all the component changes made by a specific user during a specific time window. You can use this query to create audit reports.

<QueryConfig xmlns="http://api.platform.boomi.com/">
  <QueryFilter>
    <expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="GroupingExpression">
        <nestedExpression operator="EQUALS" property="modifiedBy" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>boomi_user@mycompany.com</argument>
    	</nestedExpression>
        <nestedExpression operator="BETWEEN" property="modifiedDate" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>2020-01-01T00:00:00Z</argument>
        	<argument>2020-03-01T00:00:00Z</argument>
    	</nestedExpression>
    </expression>
  </QueryFilter>

Get all components of a specific type​

This query retrieves all non-deleted components of a given type, similar to filtering by Component Type in Component Explorer on the Build tab. The example below filters for Map components. refer to the topic Component Metadata object for the full list of valid Component Type values.

<QueryConfig xmlns="http://api.platform.boomi.com/">
  <QueryFilter>
    <expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="GroupingExpression">
        <nestedExpression operator="EQUALS" property="currentVersion" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>true</argument>
    	</nestedExpression>
        <nestedExpression operator="EQUALS" property="deleted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>false</argument>
        </nestedExpression>
        <nestedExpression operator="EQUALS" property="type" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>transform.map</argument>
    	</nestedExpression>
    </expression>
  </QueryFilter>
</QueryConfig>

Get all components of a specific subtype (Connectors)​

This query retrieves all non-deleted components of a given subtype, similar to filtering by Component Type in Component Explorer on the Build tab. The subtype is currently applicable only for Connector component types. The example below filters for HTTP Client Connector connection components.

note

To obtain the connector subtype value, you can query a specific component of that subtype.

<QueryConfig xmlns="http://api.platform.boomi.com/">
  <QueryFilter>
    <expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="GroupingExpression">
        <nestedExpression operator="EQUALS" property="currentVersion" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>true</argument>
    	</nestedExpression>
        <nestedExpression operator="EQUALS" property="deleted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>false</argument>
        </nestedExpression>
        <nestedExpression operator="EQUALS" property="type" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>connector-settings</argument>
    	</nestedExpression>
        <nestedExpression operator="EQUALS" property="subType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>http</argument>
    	</nestedExpression>
    </expression>
  </QueryFilter>
</QueryConfig>

Get all connection components not in a specific folder​

This query retrieves all non-deleted connection type components that do not reside in a specific folder. This query helps ensure that you save all connections in a shared folder and avoid possible duplicate connections.

<QueryConfig xmlns="http://api.platform.boomi.com/">
  <QueryFilter>
    <expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="GroupingExpression">
        <nestedExpression operator="EQUALS" property="currentVersion" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>true</argument>
    	</nestedExpression>
        <nestedExpression operator="EQUALS" property="deleted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>false</argument>
        </nestedExpression>
        <nestedExpression operator="EQUALS" property="type" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>connector-settings</argument>
    	</nestedExpression>
        <nestedExpression operator="NOT_EQUALS" property="folderName" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>#Shared Connections</argument>
    	</nestedExpression>
    </expression>
  </QueryFilter>
</QueryConfig>

Get all currently deleted components​

This query retrieves all deleted components currently in your account. Components are “soft deleted,” which means the current revision of a given component marked as deleted = true.

<QueryConfig xmlns="http://api.platform.boomi.com/">
  <QueryFilter>
    <expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="GroupingExpression">
        <nestedExpression operator="EQUALS" property="currentVersion" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>true</argument>
    	</nestedExpression>
        <nestedExpression operator="EQUALS" property="deleted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
        	<argument>true</argument>
    	</nestedExpression>
    </expression>
  </QueryFilter>
</QueryConfig>

On this Page