Boomi Platform API Reference (1.0.0) - ComponentMetadata

Toggle Pane

• ComponentMetadata
  • postCreates a ComponentMetadata object
  • getRetrieves an instance of a ComponentMetadata object
  • postModifies or updates a ComponentMetadata object
  • delDeletes a ComponentMetadata object
  • postRetrieves multiple ComponentMetadata objects by identifier
  • postQueries for a ComponentMetadata object(s)
  • postRetrieves additional results for a ComponentMetadata query

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ComponentMetadata

The Component Metadata object represents the summary information for a component in the service. You can use the object to retrieve metadata information for a given component, such as name, component type, folder location, and more. The Component Metadata object also supports the ability to update the metadata information; as well as, delete and restore deleted components. This lets you rename or move components programmatically.

Note: The ability to create a new component is not supported at this time.

You can also retrieve the full configuration details for a component, using the Component object. You can use the Component Metadata object's GET and QUERY operations to find:

• Components created within a specific date range
• Components modified by a specific user
• Components of a certain type
• Revision history for a specified component For example, you can use a combination of these operations to retrieve the revision history for a given component, or to create audit reports of which users changed a component.

  Note: The ComponentMetadata API is available only with certain permissions:

• In order to use the Get and Query operations, Build Read access is needed.
• In order to use the Update, Create, and Delete operations, Read and Write Access privileges are needed.
• If Folder Restrictions are enabled, you need sufficient edit access on the folder and parent folder to use these operations.
• If Component Locking is enabled, including being locked by the same user credentials that were used in the API, the component cannot be modified.

Component types

Use the following table to determine the component types that are available for use within the Component Metadata object. Note that connector subtype fields are not defined in the following table; you can retrieve subtype values using the Connector object.

Component type field	Component type description
certificate	X.509 Certificate
certificate.pgp	PGP Certificate
connector-action	Connector Operation
connector-settings	Connector Connection
crossref	Cross Reference Table
documentcache	Document Cache
transform.map	Map
transform.function	Map Function
process	Process
processproperty	Process Property
profile.db	Database Profile
profile.edi	EDI Profile
profile.flatfile	Flat File Profile
profile.xml	XML Profile
profile.json	JSON Profile
queue	Queue
tradingpartner	Trading Partner
tpgroup	Processing Group
tporganization	Organization
tpcommoptions	Communication Channel
webservice	API Service
webservice.external	API Proxy
processroute	Process Route
customlibrary	Custom Library
flowservice	Flow Service
script.processing	Process Script
script.mapping	Map Script
xslt	XSLT Stylesheet

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 AtomSphere API: Component Metadata Query Examples demonstrates how to use the 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 Query filters.

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>
</QueryConfig>

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. For the full list of valid Component Type values, refer to Component Types section above.

<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>

Required Privileges

Write access

• Build Read and Write Acccess

Read access

• Build Read Access

Creates a ComponentMetadata object

The ability to create a new component is not supported at this time. Although, you can create a deleted component, but you cannot create a new component. You will receive an error if you do not specify the deleted component ID in the create request.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

branchId	string If specified, the branch on which you want to manage the component.
branchName	string
componentId	string Required. Read only. The ID of the component. The component ID is available on the Revision History dialog, which you can access from the Build page in the service.
copiedFromComponentId	string Read only. If you copied the component, this field is the ID of the original component from where you copied the component.
copiedFromComponentVersion	integer <int32> Read only. If you copied the component, this field is the revision number of the original component you copied.
createdBy	string Read only. User name of the user who created the component.
createdDate	string <date-time> Read only. Date and time.
currentVersion	boolean Read only. Indicates if the value specified in the version field is the most current and latest revision number created for the component on the Build tab. A value of True indicates that the revision number is the most current revision number on the Build tab, whereas False indicates that the version field value is not the most current revision number.
deleted	boolean Read only. Indicates if the component is deleted. A value of True indicates a deleted status, whereas False indicates an active status.
folderId	string The ID of the folder where the component currently resides.
folderName	string Read only. The folder location of the component within Component Explorer.
modifiedBy	string Read only. User name of the user who last modified the component.
modifiedDate	string <date-time> Read only. Date and time.
name	string Read only.
subType	string Read only. Used by connector-related components (connections and operations) to identify the connector type. Subtype values are the internal connector ID, not the user-facing name. Refer to the topic Connector object.
type	string Enum: "certificate" "connector-action" "connector-settings" "crossref" "documentcache" "transform.map" "transform.function" "certificate.pgp" "process" "processproperty" "profile.db" "profile.edi" "profile.flatfile" "profile.xml" "profile.json" "queue" "tradingpartner" "tpgroup" "tporganization" "tpcommoptions" "webservice" "webservice.external" "processroute" "customlibrary" "edistandard" "flowservice" "script.processing" "script.mapping" "xslt" Read only. The type of component. Refer to the section Component Types later in this topic for a complete list of component type values
version	integer <int32> Read only.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

branchId	string If specified, the branch on which you want to manage the component.
branchName	string
componentId	string Required. Read only. The ID of the component. The component ID is available on the Revision History dialog, which you can access from the Build page in the service.
copiedFromComponentId	string Read only. If you copied the component, this field is the ID of the original component from where you copied the component.
copiedFromComponentVersion	integer <int32> Read only. If you copied the component, this field is the revision number of the original component you copied.
createdBy	string Read only. User name of the user who created the component.
createdDate	string <date-time> Read only. Date and time.
currentVersion	boolean Read only. Indicates if the value specified in the version field is the most current and latest revision number created for the component on the Build tab. A value of True indicates that the revision number is the most current revision number on the Build tab, whereas False indicates that the version field value is not the most current revision number.
deleted	boolean Read only. Indicates if the component is deleted. A value of True indicates a deleted status, whereas False indicates an active status.
folderId	string The ID of the folder where the component currently resides.
folderName	string Read only. The folder location of the component within Component Explorer.
modifiedBy	string Read only. User name of the user who last modified the component.
modifiedDate	string <date-time> Read only. Date and time.
name	string Read only.
subType	string Read only. Used by connector-related components (connections and operations) to identify the connector type. Subtype values are the internal connector ID, not the user-facing name. Refer to the topic Connector object.
type	string Enum: "certificate" "connector-action" "connector-settings" "crossref" "documentcache" "transform.map" "transform.function" "certificate.pgp" "process" "processproperty" "profile.db" "profile.edi" "profile.flatfile" "profile.xml" "profile.json" "queue" "tradingpartner" "tpgroup" "tporganization" "tpcommoptions" "webservice" "webservice.external" "processroute" "customlibrary" "edistandard" "flowservice" "script.processing" "script.mapping" "xslt" Read only. The type of component. Refer to the section Component Types later in this topic for a complete list of component type values
version	integer <int32> Read only.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/ComponentMetadata

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "componentId": "ae9e0ac0-fbdf-486a-8b27-6702c82dbba0"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "ComponentMetadata",
• "componentId": "ae9e0ac0-fbdf-486a-8b27-6702c82dbba0",
• "version": "15",
• "name": "Process2",
• "type": "process",
• "createdDate": "2023-02-08T18:50:46Z",
• "createdBy": "userboomi.com",
• "modifiedDate": "2023-02-08T19:15:44Z",
• "modifiedBy": "userboomi.com",
• "deleted": "false",
• "currentVersion": "true",
• "folderName": "Folder123",
• "folderId": "RjoxMDU2NTMx",
• "copiedFromComponentId": "123456a-bcde-f4567-8901-23abcdef456",
• "copiedFromComponentVersion": "6",
• "branchName": "main",
• "branchId": "QjoxNDMxNg"

}

Retrieves an instance of a ComponentMetadata object

Returns the latest component revision if you do not provide the version. Providing the version in the format of <componentId> ~ <version>, returns the specific version of the component.

Authorizations:

basicAuth

path Parameters

id required

string Required. Read only. The ID of the component. The component ID is available on the Revision History dialog, which you can access from the Build page in the service.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

branchId	string If specified, the branch on which you want to manage the component.
branchName	string
componentId	string Required. Read only. The ID of the component. The component ID is available on the Revision History dialog, which you can access from the Build page in the service.
copiedFromComponentId	string Read only. If you copied the component, this field is the ID of the original component from where you copied the component.
copiedFromComponentVersion	integer <int32> Read only. If you copied the component, this field is the revision number of the original component you copied.
createdBy	string Read only. User name of the user who created the component.
createdDate	string <date-time> Read only. Date and time.
currentVersion	boolean Read only. Indicates if the value specified in the version field is the most current and latest revision number created for the component on the Build tab. A value of True indicates that the revision number is the most current revision number on the Build tab, whereas False indicates that the version field value is not the most current revision number.
deleted	boolean Read only. Indicates if the component is deleted. A value of True indicates a deleted status, whereas False indicates an active status.
folderId	string The ID of the folder where the component currently resides.
folderName	string Read only. The folder location of the component within Component Explorer.
modifiedBy	string Read only. User name of the user who last modified the component.
modifiedDate	string <date-time> Read only. Date and time.
name	string Read only.
subType	string Read only. Used by connector-related components (connections and operations) to identify the connector type. Subtype values are the internal connector ID, not the user-facing name. Refer to the topic Connector object.
type	string Enum: "certificate" "connector-action" "connector-settings" "crossref" "documentcache" "transform.map" "transform.function" "certificate.pgp" "process" "processproperty" "profile.db" "profile.edi" "profile.flatfile" "profile.xml" "profile.json" "queue" "tradingpartner" "tpgroup" "tporganization" "tpcommoptions" "webservice" "webservice.external" "processroute" "customlibrary" "edistandard" "flowservice" "script.processing" "script.mapping" "xslt" Read only. The type of component. Refer to the section Component Types later in this topic for a complete list of component type values
version	integer <int32> Read only.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/ComponentMetadata/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "ComponentMetadata",
• "componentId": "456789a-bcde-f0123-4567-89abcdef012",
• "version": 14,
• "name": "Component123",
• "type": "process",
• "createdDate": "2016-11-17T19:30:39Z",
• "createdBy": "johndoe@boomi.com",
• "modifiedDate": "2019-04-30T15:03:44Z",
• "modifiedBy": "janedoe@boomilcom",
• "deleted": false,
• "currentVersion": true,
• "folderName": "Test Folder 1234",
• "folderId": "PloxRzM5OTk",
• "copiedFromComponentId": "123456a-bcde-f4567-8901-23abcdef456",
• "copiedFromComponentVersion": "6",
• "branchName": "main",
• "branchId": "QjoxNDMxNg"

}

Modifies or updates a ComponentMetadata object

Only name and folderId may be updated. They are optional and will only be modified if included in the UPDATE request. folderId must be a valid, non-deleted folder. If folderId is included in the request but with a blank value, it defaults to the root folder.

Authorizations:

basicAuth

path Parameters

id required

string Required. Read only. The ID of the component. The component ID is available on the Revision History dialog, which you can access from the Build page in the service.

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

branchId	string If specified, the branch on which you want to manage the component.
branchName	string
componentId	string Required. Read only. The ID of the component. The component ID is available on the Revision History dialog, which you can access from the Build page in the service.
copiedFromComponentId	string Read only. If you copied the component, this field is the ID of the original component from where you copied the component.
copiedFromComponentVersion	integer <int32> Read only. If you copied the component, this field is the revision number of the original component you copied.
createdBy	string Read only. User name of the user who created the component.
createdDate	string <date-time> Read only. Date and time.
currentVersion	boolean Read only. Indicates if the value specified in the version field is the most current and latest revision number created for the component on the Build tab. A value of True indicates that the revision number is the most current revision number on the Build tab, whereas False indicates that the version field value is not the most current revision number.
deleted	boolean Read only. Indicates if the component is deleted. A value of True indicates a deleted status, whereas False indicates an active status.
folderId	string The ID of the folder where the component currently resides.
folderName	string Read only. The folder location of the component within Component Explorer.
modifiedBy	string Read only. User name of the user who last modified the component.
modifiedDate	string <date-time> Read only. Date and time.
name	string Read only.
subType	string Read only. Used by connector-related components (connections and operations) to identify the connector type. Subtype values are the internal connector ID, not the user-facing name. Refer to the topic Connector object.
type	string Enum: "certificate" "connector-action" "connector-settings" "crossref" "documentcache" "transform.map" "transform.function" "certificate.pgp" "process" "processproperty" "profile.db" "profile.edi" "profile.flatfile" "profile.xml" "profile.json" "queue" "tradingpartner" "tpgroup" "tporganization" "tpcommoptions" "webservice" "webservice.external" "processroute" "customlibrary" "edistandard" "flowservice" "script.processing" "script.mapping" "xslt" Read only. The type of component. Refer to the section Component Types later in this topic for a complete list of component type values
version	integer <int32> Read only.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

branchId	string If specified, the branch on which you want to manage the component.
branchName	string
componentId	string Required. Read only. The ID of the component. The component ID is available on the Revision History dialog, which you can access from the Build page in the service.
copiedFromComponentId	string Read only. If you copied the component, this field is the ID of the original component from where you copied the component.
copiedFromComponentVersion	integer <int32> Read only. If you copied the component, this field is the revision number of the original component you copied.
createdBy	string Read only. User name of the user who created the component.
createdDate	string <date-time> Read only. Date and time.
currentVersion	boolean Read only. Indicates if the value specified in the version field is the most current and latest revision number created for the component on the Build tab. A value of True indicates that the revision number is the most current revision number on the Build tab, whereas False indicates that the version field value is not the most current revision number.
deleted	boolean Read only. Indicates if the component is deleted. A value of True indicates a deleted status, whereas False indicates an active status.
folderId	string The ID of the folder where the component currently resides.
folderName	string Read only. The folder location of the component within Component Explorer.
modifiedBy	string Read only. User name of the user who last modified the component.
modifiedDate	string <date-time> Read only. Date and time.
name	string Read only.
subType	string Read only. Used by connector-related components (connections and operations) to identify the connector type. Subtype values are the internal connector ID, not the user-facing name. Refer to the topic Connector object.
type	string Enum: "certificate" "connector-action" "connector-settings" "crossref" "documentcache" "transform.map" "transform.function" "certificate.pgp" "process" "processproperty" "profile.db" "profile.edi" "profile.flatfile" "profile.xml" "profile.json" "queue" "tradingpartner" "tpgroup" "tporganization" "tpcommoptions" "webservice" "webservice.external" "processroute" "customlibrary" "edistandard" "flowservice" "script.processing" "script.mapping" "xslt" Read only. The type of component. Refer to the section Component Types later in this topic for a complete list of component type values
version	integer <int32> Read only.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/ComponentMetadata/{id}

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "componentId": "ae9e0ac0-fbdf-486a-8b27-6702c82dbba0",
• "name": "New Process Update"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "Component",
• "componentId": "ae9e0ac0-fbdf-486a-8b27-6702c82dbba0",
• "version": "2",
• "name": "New Process Update",
• "type": "process",
• "createdDate": "2023-07-05T15:43:18Z",
• "createdBy": "admin1@boomi.com",
• "modifiedDate": "2023-07-05T15:47:26Z",
• "modifiedBy": "admin1@boomi.com",
• "deleted": "false",
• "currentVersion": "true",
• "folderName": "Admin",
• "folderId": "RjozMDk2OQ",
• "copiedFromComponentId": "6ea0e652-5e19-4ba8-8f86-4355adca9942",
• "copiedFromComponentVersion": "7",
• "branchName": "main",
• "branchId": "QjoxNDMxNg"

}

Deletes a ComponentMetadata object

Lets you delete required components. Note that deleting a component does NOT delete dependent components.

Authorizations:

basicAuth

path Parameters

id required

string Required. Read only. The ID of the component. The component ID is available on the Revision History dialog, which you can access from the Build page in the service.

Responses

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/ComponentMetadata/{id}

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "message": "Access denied due to insufficient permissions."

}

Retrieves multiple ComponentMetadata objects by identifier

To learn more about bulk, refer to the topic Bulk GET operations.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	Array of objects (BulkId)
type	string Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	Array of objects
Array required object (ComponentMetadata) index integer <int32> id string statusCode integer <int32> errorMessage string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/ComponentMetadata/bulk

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "request": [

  • {

    • "id": "56789abc-def0-1234-5678-9abcdef01234"

    }

  ],
• "type": "GET"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "response": [

  • {

    • "Result": {

      • "branchId": "string",
      • "branchName": "string",
      • "componentId": "456789a-bcde-f0123-4567-89abcdef012",
      • "copiedFromComponentId": "123456a-bcde-f4567-8901-23abcdef456",
      • "copiedFromComponentVersion": "6",
      • "createdBy": "johndoeboomi.com",
      • "createdDate": "2019-11-05T20:13:25Z",
      • "currentVersion": "false",
      • "deleted": "true",
      • "folderId": "\"PloxRzM5OTk\"",
      • "folderName": "Boomi",
      • "modifiedBy": "janedoeboomi.com",
      • "modifiedDate": "2019-11-26T21:23:55Z",
      • "name": "Component123",
      • "subType": "process",
      • "type": "process",
      • "version": "7"

      },
    • "index": 0,
    • "id": "string",
    • "statusCode": 0,
    • "errorMessage": "string"

    }

  ]

}

Queries for a ComponentMetadata object(s)

• By default, QUERY results include previous revisions including deleted versions. Use query filters to exclude previous and deleted versions if desired. For more examples of querying components, see Component Metadata API example requests mentioned above in the API description.
• The version field must be accompanied by the componentId field. You can query all other fields.
• The copiedFromComponentId field must accompany the copiedFromComponentVersion field.

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

Possible properties include: accountId, componentId, version, name, type, subType, createdDate, createdBy, modifiedDate, modifiedBy, deleted, currentVersion, folderName, folderId, copiedFromComponentId, copiedFromComponentVersion, branchName, branchId

required

object

required ComponentMetadataSimpleExpression (object) or ComponentMetadataGroupingExpression (object) (ComponentMetadataExpression) One of operator required string Enum: "EQUALS" "LIKE" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL" "CONTAINS" "NOT_CONTAINS" property required string Enum: "accountId" "componentId" "version" "name" "type" "subType" "createdDate" "createdBy" "modifiedDate" "modifiedBy" "deleted" "currentVersion" "folderName" "folderId" "copiedFromComponentId" "copiedFromComponentVersion" "branchName" "branchId" argument Array of strings

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

numberOfResults	integer <int32>
queryToken	string By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.
	Array of objects (ComponentMetadata)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/ComponentMetadata/query

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

Example

SimpleExpressionGroupingExpressionSimpleExpression

{

• "QueryFilter": {

  • "expression": {

    • "argument": [

      • "000b7e59-8dd6-4219-9be6-8d31512f0b66"

      ],
    • "operator": "EQUALS",
    • "property": "componentId"

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "QueryResult",
• "result": [

  • {

    • "@type": "ComponentMetadata",
    • "componentId": "000b7e59-8dd6-4219-9be6-8d31512f0b66",
    • "version": 1,
    • "name": "TP API CREATE Response",
    • "type": "profile.xml",
    • "createdDate": "2017-09-19T16:36:10Z",
    • "createdBy": "johndeer@boomi.com",
    • "modifiedDate": "2017-09-19T16:36:10Z",
    • "modifiedBy": "janedoe@boomi.com",
    • "deleted": false,
    • "currentVersion": false,
    • "folderName": "TEST-16471",
    • "folderId": "PloxRzM5OTk",
    • "copiedFromComponentId": "123456a-bcde-f4567-8901-23abcdef456",
    • "copiedFromComponentVersion": 1

    }

  ],
• "numberOfResults": 1

}

Retrieves additional results for a ComponentMetadata query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:

basicAuth

Request Body schema: text/plain

required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

numberOfResults	integer <int32>
queryToken	string By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.
	Array of objects (ComponentMetadata)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/ComponentMetadata/queryMore

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "QueryResult",
• "result": [

  • {

    • "@type": "ComponentMetadata",
    • "componentId": "000b7e59-8dd6-4219-9be6-8d31512f0b66",
    • "version": 1,
    • "name": "TP API CREATE Response",
    • "type": "profile.xml",
    • "createdDate": "2017-09-19T16:36:10Z",
    • "createdBy": "johndeer@boomi.com",
    • "modifiedDate": "2017-09-19T16:36:10Z",
    • "modifiedBy": "janedoe@boomi.com",
    • "deleted": false,
    • "currentVersion": false,
    • "folderName": "TEST-16471",
    • "folderId": "PloxRzM5OTk",
    • "copiedFromComponentId": "123456a-bcde-f4567-8901-23abcdef456",
    • "copiedFromComponentVersion": 1

    }

  ],
• "numberOfResults": 1

}