Public - Using the Boomi Enterprise Platform API to query a Branch based upon a Branch Name

Introduction:

Boomi’s November 2024 release introduced Branch and Merge functionality into the Boomi Platform. This how-to guide walks through some new functionality with the Boomi Enterprise Platform API showcasing using the branch name to query the branch ID for use with other Boomi Enterprise Platform API calls.

Disclaimer: This process and design is in no way intended to serve as an authoritative way of performing this query, but is instead aimed at showcasing functionality and empowering you as a developer to build upon this functionality.
Note: At the time of this writing, the API call to the Boomi Enterprise Platform API is currently not supported with the branded Boomi Enterprise Platform API connector. I am instead using the REST Client technology connector.

Before you Begin:

A connection to the Boomi Enterprise Platform API is required. Within the Platform Settings, there is a tab to create new Boomi Enterprise Platform API Tokens

When creating the token, it will be visible once. Save the token somewhere secure.

Configuring the REST Client Technology Connector:

Base URL - https://api.boomi.com/api/rest/v1/{Account ID}
Authentication Type - Basic
User - BOOMI_TOKEN.{Platform Login Email}
Password - {Boomi Enterprise Platform API Token}

Configuration Steps:

Start Step - Data Passthrough

This is configured as a data pass through to allow the document flow from the parent process that calls it.

Message - Construct Query Request

This step converts the current document into the XML request payload to the Boomi Enterprise Platform API.

Message -

<QueryConfig xmlns="http://api.platform.boomi.com/">
  <QueryFilter>
    <expression operator="EQUALS" property="name" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
      <argument>{1}</argument> 
    </expression>
  </QueryFilter>
</QueryConfig>

Variables -

{1} - Dynamic Process property name of ‘DPP_BRANCH_NAME’

REST Client

This step executes the Boomi Enterprise Platform API Call passing in the payload set in the previous Message step.

Connection - Boomi Enterprise Platform API Connection

Operation - Query Branch

Path - /Branch/query

Sample Response -

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bns:QueryResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" numberOfResults="1">
    <bns:result xsi:type="bns:Branch" id="{ID of Queried Branch}" name="main" createdBy="admin@boomi.com" createdDate="2023-11-11T08:43:28Z" ready="true" deleted="false" stage="NORMAL"/>
</bns:QueryResult>

Return Documents

This step passes back the document containing the ID back to the main process marking the end of the process.