Boomi Platform API Reference (1.0.0) - Branch

Toggle Pane

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

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Branch

You can use the Branch object to create, update, and delete development branches on your account.

Creates a Branch object

• To create a branch, you need the branch ID for the branch from which you want to create a new branch. New branches return ready as false until the creating stage has cleared.
• You can also create a branch from a packaged component. To do so, use the ID of the packaged component as the packageId.
• To create a branch from a deployment, use the ID of the deployment for the packageId.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

createdBy	string The user who created the branch.
createdDate	string <date-time> The date and time when the branch was created.
deleted	boolean Whether the branch is deleted.
deploymentId	string
description	string
id	string The ID of the branch.
modifiedBy	string The user who last modified the branch.
modifiedDate	string <date-time> The date and time when the branch was updated.
name	string The name of the branch.
packageId	string The ID of the packaged component from which the branch is created.
parentId	string The ID of the parent branch.
ready	boolean Whether the branch is ready to use.
stage	string The branch status: CREATING, NORMAL (ready for use), or DELETING.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

createdBy	string The user who created the branch.
createdDate	string <date-time> The date and time when the branch was created.
deleted	boolean Whether the branch is deleted.
deploymentId	string
description	string
id	string The ID of the branch.
modifiedBy	string The user who last modified the branch.
modifiedDate	string <date-time> The date and time when the branch was updated.
name	string The name of the branch.
packageId	string The ID of the packaged component from which the branch is created.
parentId	string The ID of the parent branch.
ready	boolean Whether the branch is ready to use.
stage	string The branch status: CREATING, NORMAL (ready for use), or DELETING.

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}/Branch

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "parentId": "branchId",
• "name": "branchname"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "Branch",
• "id": "branchId",
• "name": "branchname",
• "createdBy": "userboomi.com",
• "createdDate": "2024-02-12T21:05:27.590Z",
• "parentId": "parentbranchId",
• "ready": "false",
• "deleted": "false",
• "stage": "CREATING"

}

Retrieves an instance of a Branch object

When you have the branch ID, you can query for additional information about the branch. Send an HTTP GET where {accountId} is the ID of the authenticating account and {branchId} is the ID of the branch you want to query.

Authorizations:

basicAuth

path Parameters

id required

string The ID of the branch.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

createdBy	string The user who created the branch.
createdDate	string <date-time> The date and time when the branch was created.
deleted	boolean Whether the branch is deleted.
deploymentId	string
description	string
id	string The ID of the branch.
modifiedBy	string The user who last modified the branch.
modifiedDate	string <date-time> The date and time when the branch was updated.
name	string The name of the branch.
packageId	string The ID of the packaged component from which the branch is created.
parentId	string The ID of the parent branch.
ready	boolean Whether the branch is ready to use.
stage	string The branch status: CREATING, NORMAL (ready for use), or DELETING.

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}/Branch/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "Branch": {

  • "id": "Qjox",
  • "name": "main",
  • "createdBy": "adminboomi.com",
  • "createdDate": "2023-08-24T02:10:07Z",
  • "ready": "true",
  • "deleted": "false",
  • "stage": "NORMAL",
  • "description": "main branch"

  }

}

Modifies or updates a Branch object

To update a branch, you need the branch ID. Currently, you can only update the name of the branch.

Authorizations:

basicAuth

path Parameters

id required

string The ID of the branch.

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

createdBy	string The user who created the branch.
createdDate	string <date-time> The date and time when the branch was created.
deleted	boolean Whether the branch is deleted.
deploymentId	string
description	string
id	string The ID of the branch.
modifiedBy	string The user who last modified the branch.
modifiedDate	string <date-time> The date and time when the branch was updated.
name	string The name of the branch.
packageId	string The ID of the packaged component from which the branch is created.
parentId	string The ID of the parent branch.
ready	boolean Whether the branch is ready to use.
stage	string The branch status: CREATING, NORMAL (ready for use), or DELETING.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

createdBy	string The user who created the branch.
createdDate	string <date-time> The date and time when the branch was created.
deleted	boolean Whether the branch is deleted.
deploymentId	string
description	string
id	string The ID of the branch.
modifiedBy	string The user who last modified the branch.
modifiedDate	string <date-time> The date and time when the branch was updated.
name	string The name of the branch.
packageId	string The ID of the packaged component from which the branch is created.
parentId	string The ID of the parent branch.
ready	boolean Whether the branch is ready to use.
stage	string The branch status: CREATING, NORMAL (ready for use), or DELETING.

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}/Branch/{id}

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "id": "branchId",
• "name": "branchname"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "Branch",
• "id": "branchId",
• "name": "branchname",
• "createdBy": "userboomi.com",
• "createdDate": "2024-02-12T21:05:28Z",
• "modifiedBy": "userboomi.com",
• "modifiedDate": "2024-02-14T14:20:52.402Z",
• "parentId": "parentbranchId",
• "ready": "true",
• "deleted": "false",
• "stage": "NORMAL"

}

Deletes a Branch object

Deletes a branch

Authorizations:

basicAuth

path Parameters

id required

string The ID of the branch.

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}/Branch/{id}

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

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

}

Retrieves multiple Branch 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 (Branch) 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}/Branch/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": {

      • "createdBy": "string",
      • "createdDate": "2019-08-24T14:15:22Z",
      • "deleted": true,
      • "deploymentId": "string",
      • "description": "string",
      • "id": "string",
      • "modifiedBy": "string",
      • "modifiedDate": "2019-08-24T14:15:22Z",
      • "name": "string",
      • "packageId": "string",
      • "parentId": "string",
      • "ready": true,
      • "stage": "string"

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

    }

  ]

}

Queries for a Branch object(s)

You must first retrieve the ID of your main branch, using the name of your current branch. If you haven't created any branches, your current branch will be main.

When you query a branch, it might be in one of the following states:

• CREATING: The branch is being created
• NORMAL: The branch is ready to use
• DELETING: The branch is being deleted.

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

required	object
required BranchSimpleExpression (object) or BranchGroupingExpression (object) (BranchExpression) 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 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 (Branch)

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}/Branch/query

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

Example

SimpleExpressionGroupingExpressionSimpleExpression

{

• "QueryFilter": {

  • "expression": {

    • "operator": "EQUALS",
    • "property": "name",
    • "argument": [

      • "branchname"

      ]

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "QueryResult": {

  • "numberOfResults": "1",
  • "result": {

    • "xsi_type": "Branch",
    • "id": "branchId",
    • "name": "branchname",
    • "createdBy": "userboomi.com",
    • "createdDate": "2023-09-12T18:14:39Z",
    • "ready": "true",
    • "deleted": "false",
    • "stage": "NORMAL"

    }

  }

}

Retrieves additional results for a Branch 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 (Branch)

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}/Branch/queryMore

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "QueryResult": {

  • "numberOfResults": "1",
  • "result": {

    • "xsi_type": "Branch",
    • "id": "branchId",
    • "name": "branchname",
    • "createdBy": "userboomi.com",
    • "createdDate": "2023-09-12T18:14:39Z",
    • "ready": "true",
    • "deleted": "false",
    • "stage": "NORMAL"

    }

  }

}