Boomi MFT - AFT Management API Reference (v1) - Flow

Toggle Pane

• Flow
  • getRetrieves a specific flow configuration by ID
  • getRetrieves a specific flow configuration by name
  • getRetrieves a list of all flow configurations
  • postUpdates the operational status of a flow
  • putUpdates an existing flow configuration
  • postCreates a new flow configuration
  • delDeletes a flow configuration
  • postApplies and activates a flow configuration
  • getImmediately executes a specific flow endpoint
  • postImmediately executes a specific flow endpoint using request body
  • getRetrieves the current operational state of a flow
  • getRetrieves recent activity for flows
  • getRetrieves FileZilla FTP client configuration for a flow
  • postRetrieves FileZilla FTP client configuration for multiple flows
  • postExports multiple flow configurations for backup or migration
  • getExports a single flow configuration by flow code
  • postImports flow configurations from JSON data
  • getRetrieves transfer requests for a flow
  • getRetrieves client responses for a specific transfer request
  • getRetrieves active schedules for a flow
  • getRetrieves available nodes for a flow
  • postInitiates an asynchronous job to apply a flow configuration
  • getRetrieves the status of a flow apply job

API docs by Redocly

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

Flow

Retrieves a specific flow configuration by ID

Requires flow read permissions to access flow configuration data.

Authorizations:

ApiKeyBearer

query Parameters

flowId

integer <int32> The unique identifier of the flow to retrieve

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
tenantId	integer <int32>
name	string or null
flowStatusId	integer <int32>
isBroadcast	boolean
isPublished	boolean
isIPaaSSubscription	boolean
connectorId	integer <int32>
code	string or null
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
contactId	integer or null <int32>

https://us.thruinc.com/api/Flow/getFlow

https://uk.thruinc.com/api/Flow/getFlow

https://eu.thruinc.com/api/Flow/getFlow

https://au.thruinc.com/api/Flow/getFlow

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves a specific flow configuration by name

Requires flow read permissions to access flow configuration data.

Authorizations:

ApiKeyBearer

query Parameters

flowName

string The name of the flow to retrieve

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
tenantId	integer <int32>
name	string or null
flowStatusId	integer <int32>
isBroadcast	boolean
isPublished	boolean
isIPaaSSubscription	boolean
connectorId	integer <int32>
code	string or null
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
contactId	integer or null <int32>

https://us.thruinc.com/api/Flow/getFlowByName

https://uk.thruinc.com/api/Flow/getFlowByName

https://eu.thruinc.com/api/Flow/getFlowByName

https://au.thruinc.com/api/Flow/getFlowByName

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves a list of all flow configurations

Requires flow read permissions to access flow configuration list.

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
flowStatusId	integer <int32>
name	string or null
code	string or null
isPublished	boolean
isIPaaSSubscription	boolean
isBroadcast	boolean
retentionPolicyId	integer <int32>
connectorId	integer <int32>
description	string or null
subscriberCount	integer <int32>
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>

https://us.thruinc.com/api/Flow/getFlowList

https://uk.thruinc.com/api/Flow/getFlowList

https://eu.thruinc.com/api/Flow/getFlowList

https://au.thruinc.com/api/Flow/getFlowList

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates the operational status of a flow

Requires flow update permissions to modify flow operational status. Request body must contain valid FlowUpdate model data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Flow update request containing flow ID and new enabled status

flowId	integer <int32>
enabled	boolean

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
tenantId	integer <int32>
name	string or null
flowStatusId	integer <int32>
isBroadcast	boolean
isPublished	boolean
isIPaaSSubscription	boolean
connectorId	integer <int32>
code	string or null
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
contactId	integer or null <int32>

https://us.thruinc.com/api/Flow/updateFlowStatus

https://uk.thruinc.com/api/Flow/updateFlowStatus

https://eu.thruinc.com/api/Flow/updateFlowStatus

https://au.thruinc.com/api/Flow/updateFlowStatus

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "flowId": 0,
• "enabled": true

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing flow configuration

Requires flow update permissions to modify flow configurations. Request body must contain valid Flows model data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Complete flow model with updated configuration settings

id	integer <int32>
tenantId	integer <int32>
name	string or null
flowStatusId	integer <int32>
isBroadcast	boolean
isPublished	boolean
isIPaaSSubscription	boolean
connectorId	integer <int32>
code	string or null
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
contactId	integer or null <int32>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
tenantId	integer <int32>
name	string or null
flowStatusId	integer <int32>
isBroadcast	boolean
isPublished	boolean
isIPaaSSubscription	boolean
connectorId	integer <int32>
code	string or null
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
contactId	integer or null <int32>

https://us.thruinc.com/api/Flow/updateFlow

https://uk.thruinc.com/api/Flow/updateFlow

https://eu.thruinc.com/api/Flow/updateFlow

https://au.thruinc.com/api/Flow/updateFlow

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "tenantId": 0,
• "name": "string",
• "flowStatusId": 0,
• "isBroadcast": true,
• "isPublished": true,
• "isIPaaSSubscription": true,
• "connectorId": 0,
• "code": "string",
• "description": "string",
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z",
• "contactId": 0

}

Response samples

• 200
• 400
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new flow configuration

Requires flow create permissions to create new flow configurations. Request body must contain valid Flows model data.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Complete flow model with configuration settings for the new flow

id	integer <int32>
tenantId	integer <int32>
name	string or null
flowStatusId	integer <int32>
isBroadcast	boolean
isPublished	boolean
isIPaaSSubscription	boolean
connectorId	integer <int32>
code	string or null
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
contactId	integer or null <int32>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
tenantId	integer <int32>
name	string or null
flowStatusId	integer <int32>
isBroadcast	boolean
isPublished	boolean
isIPaaSSubscription	boolean
connectorId	integer <int32>
code	string or null
description	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>
contactId	integer or null <int32>

https://us.thruinc.com/api/Flow/createFlow

https://uk.thruinc.com/api/Flow/createFlow

https://eu.thruinc.com/api/Flow/createFlow

https://au.thruinc.com/api/Flow/createFlow

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "tenantId": 0,
• "name": "string",
• "flowStatusId": 0,
• "isBroadcast": true,
• "isPublished": true,
• "isIPaaSSubscription": true,
• "connectorId": 0,
• "code": "string",
• "description": "string",
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z",
• "contactId": 0

}

Response samples

• 200
• 400
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a flow configuration

Removes flow configuration and all associated flow endpoint relationships.

Authorizations:

ApiKeyBearer

query Parameters

id	integer <int32> The unique identifier of the flow to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/deleteFlow

https://uk.thruinc.com/api/Flow/deleteFlow

https://eu.thruinc.com/api/Flow/deleteFlow

https://au.thruinc.com/api/Flow/deleteFlow

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Applies and activates a flow configuration

Activates flow configuration changes by applying them to the runtime environment.

Authorizations:

ApiKeyBearer

query Parameters

flowId

integer <int32> The unique identifier of the flow to apply

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/applyFlow

https://uk.thruinc.com/api/Flow/applyFlow

https://eu.thruinc.com/api/Flow/applyFlow

https://au.thruinc.com/api/Flow/applyFlow

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Immediately executes a specific flow endpoint

Immediately triggers execution of a specific flow endpoint outside of scheduled times.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId	integer <int32> The unique identifier of the flow endpoint to execute
flowId	integer <int32> The unique identifier of the parent flow

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/runFlowEndpointNow

https://uk.thruinc.com/api/Flow/runFlowEndpointNow

https://eu.thruinc.com/api/Flow/runFlowEndpointNow

https://au.thruinc.com/api/Flow/runFlowEndpointNow

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Immediately executes a specific flow endpoint using request body

Immediately triggers execution of a specific flow endpoint using POST request body.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Flow endpoint execution request containing the endpoint identifier

flowEndpointId

integer <int32>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/runFlowEndpointNow

https://uk.thruinc.com/api/Flow/runFlowEndpointNow

https://eu.thruinc.com/api/Flow/runFlowEndpointNow

https://au.thruinc.com/api/Flow/runFlowEndpointNow

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "flowEndpointId": 0

}

Response samples

• 200
• 400
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves the current operational state of a flow

Returns current operational state information for a flow.

Authorizations:

ApiKeyBearer

query Parameters

flowId

integer <int32> The unique identifier of the flow

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/getFlowState

https://uk.thruinc.com/api/Flow/getFlowState

https://eu.thruinc.com/api/Flow/getFlowState

https://au.thruinc.com/api/Flow/getFlowState

Response samples

• 200
• 404

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves recent activity for flows

Returns recent flow activity including transfer counts and execution history.

Authorizations:

ApiKeyBearer

query Parameters

count

integer <int32> Number of recent activity records to retrieve

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/getRecentFlowActivity

https://uk.thruinc.com/api/Flow/getRecentFlowActivity

https://eu.thruinc.com/api/Flow/getRecentFlowActivity

https://au.thruinc.com/api/Flow/getRecentFlowActivity

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves FileZilla FTP client configuration for a flow

Returns FileZilla configuration XML for FTP/FTPS flow endpoint setup.

Authorizations:

ApiKeyBearer

query Parameters

flowId

integer <int32> The unique identifier of the flow

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/getFileZillaConfig

https://uk.thruinc.com/api/Flow/getFileZillaConfig

https://eu.thruinc.com/api/Flow/getFileZillaConfig

https://au.thruinc.com/api/Flow/getFileZillaConfig

Response samples

• 200
• 404

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves FileZilla FTP client configuration for multiple flows

Returns FileZilla configuration XML for multiple flows in a single response.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

List of flow identifiers to generate configuration for

Array

integer <int32>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/getFileZillaConfig

https://uk.thruinc.com/api/Flow/getFileZillaConfig

https://eu.thruinc.com/api/Flow/getFileZillaConfig

https://au.thruinc.com/api/Flow/getFileZillaConfig

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

[

• 0

]

Response samples

• 200
• 400

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Exports multiple flow configurations for backup or migration

Exports flow configurations as JSON for backup or migration to another environment.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

List of flow identifiers to export

Array

integer <int32>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/exportFlowsById

https://uk.thruinc.com/api/Flow/exportFlowsById

https://eu.thruinc.com/api/Flow/exportFlowsById

https://au.thruinc.com/api/Flow/exportFlowsById

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

[

• 0

]

Response samples

• 200
• 400
• 404

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Exports a single flow configuration by flow code

Exports single flow configuration identified by flow code as JSON.

Authorizations:

ApiKeyBearer

query Parameters

flowCode

string The unique code identifier of the flow to export

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/exportFlowByCode

https://uk.thruinc.com/api/Flow/exportFlowByCode

https://eu.thruinc.com/api/Flow/exportFlowByCode

https://au.thruinc.com/api/Flow/exportFlowByCode

Response samples

• 200
• 404

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Imports flow configurations from JSON data

Imports flow configurations from JSON data into the current environment.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

JSON string containing flow configuration data to import

any

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/importFlows

https://uk.thruinc.com/api/Flow/importFlows

https://eu.thruinc.com/api/Flow/importFlows

https://au.thruinc.com/api/Flow/importFlows

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

null

Response samples

• 200
• 400

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves transfer requests for a flow

Returns transfer request history for a flow with optional date filtering.

Authorizations:

ApiKeyBearer

query Parameters

flowId	integer <int32> The unique identifier of the flow
fromDate	string <date-time> Optional start date filter for transfer requests
toDate	string <date-time> Optional end date filter for transfer requests
	object Optional additional filters for transfer request search

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/getTransferRequests

https://uk.thruinc.com/api/Flow/getTransferRequests

https://eu.thruinc.com/api/Flow/getTransferRequests

https://au.thruinc.com/api/Flow/getTransferRequests

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves client responses for a specific transfer request

Returns client responses associated with a specific transfer request.

Authorizations:

ApiKeyBearer

query Parameters

requestId

integer <int64> The unique identifier of the transfer request

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/getClientResponses

https://uk.thruinc.com/api/Flow/getClientResponses

https://eu.thruinc.com/api/Flow/getClientResponses

https://au.thruinc.com/api/Flow/getClientResponses

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves active schedules for a flow

Returns list of currently active schedules configured for a flow.

Authorizations:

ApiKeyBearer

query Parameters

flowId

integer <int32> The unique identifier of the flow

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/getActiveSchedules

https://uk.thruinc.com/api/Flow/getActiveSchedules

https://eu.thruinc.com/api/Flow/getActiveSchedules

https://au.thruinc.com/api/Flow/getActiveSchedules

Response samples

• 200
• 400

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves available nodes for a flow

Returns list of nodes available for assignment to the specified flow.

Authorizations:

ApiKeyBearer

query Parameters

flowId

integer <int32> The unique identifier of the flow

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/getAvailableNodes

https://uk.thruinc.com/api/Flow/getAvailableNodes

https://eu.thruinc.com/api/Flow/getAvailableNodes

https://au.thruinc.com/api/Flow/getAvailableNodes

Response samples

• 200

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Initiates an asynchronous job to apply a flow configuration

Initiates asynchronous job to apply flow configuration changes to runtime environment.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Apply flow job request containing the flow identifier

flowId

integer <int32>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/applyFlowJob

https://uk.thruinc.com/api/Flow/applyFlowJob

https://eu.thruinc.com/api/Flow/applyFlowJob

https://au.thruinc.com/api/Flow/applyFlowJob

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "flowId": 0

}

Response samples

• 200
• 400

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves the status of a flow apply job

Returns current status and progress of an asynchronous flow apply job.

Authorizations:

ApiKeyBearer

path Parameters

jobId required

string The unique identifier of the apply flow job

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Flow/applyFlowJob/{jobId}

https://uk.thruinc.com/api/Flow/applyFlowJob/{jobId}

https://eu.thruinc.com/api/Flow/applyFlowJob/{jobId}

https://au.thruinc.com/api/Flow/applyFlowJob/{jobId}

Response samples

• 200
• 404

Content type

text/plainapplication/jsontext/jsontext/plain

No sample