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

Toggle Pane

• FlowEndpoint
  • getRetrieves a specific flow endpoint configuration
  • getRetrieves a list of flow endpoints with optional filtering
  • getRetrieves flow endpoints associated with a specific node
  • getRetrieves flow endpoints that are not yet assigned to a flow
  • postCreates a new flow endpoint configuration
  • putUpdates an existing flow endpoint configuration
  • delDeletes a flow endpoint configuration
  • getRetrieves file paths configured for flow endpoints
  • postTests connectivity to a flow endpoint

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.

FlowEndpoint

Retrieves a specific flow endpoint configuration

Returns complete flow endpoint configuration including processing options, schedules, and alerts.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

integer <int32> Unique identifier of the flow endpoint

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowId	integer <int32>
flowEndpointTypeId	integer <int32>
endpointId	integer <int32>
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>

https://us.thruinc.com/api/FlowEndpoint/getFlowEndpoint

https://uk.thruinc.com/api/FlowEndpoint/getFlowEndpoint

https://eu.thruinc.com/api/FlowEndpoint/getFlowEndpoint

https://au.thruinc.com/api/FlowEndpoint/getFlowEndpoint

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves a list of flow endpoints with optional filtering

Returns list of flow endpoints with optional filtering by flow, type, or organization.

Authorizations:

ApiKeyBearer

query Parameters

flowId	integer <int32> Optional flow identifier to filter endpoints
flowEndpointTypeId	integer <int32> Optional endpoint type identifier to filter by type: 1 = Source, 2 = Target, 0 = All/Undefined
orgIds	string Optional organization identifiers to filter by organizations

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
flowId	integer <int32>
flowEndpointTypeId	integer <int32>
endpointId	integer <int32>
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>

https://us.thruinc.com/api/FlowEndpoint/getFlowEndpointsList

https://uk.thruinc.com/api/FlowEndpoint/getFlowEndpointsList

https://eu.thruinc.com/api/FlowEndpoint/getFlowEndpointsList

https://au.thruinc.com/api/FlowEndpoint/getFlowEndpointsList

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves flow endpoints associated with a specific node

Returns list of flow endpoints configured to use a specific node.

Authorizations:

ApiKeyBearer

query Parameters

nodeId

integer <int32> Unique identifier of the node

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
flowId	integer <int32>
flowEndpointTypeId	integer <int32>
endpointId	integer <int32>
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>

https://us.thruinc.com/api/FlowEndpoint/getThruNodeFlowEndpoints

https://uk.thruinc.com/api/FlowEndpoint/getThruNodeFlowEndpoints

https://eu.thruinc.com/api/FlowEndpoint/getThruNodeFlowEndpoints

https://au.thruinc.com/api/FlowEndpoint/getThruNodeFlowEndpoints

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves flow endpoints that are not yet assigned to a flow

Returns list of flow endpoints not yet assigned to any flow configuration.

Authorizations:

ApiKeyBearer

query Parameters

flowId	integer <int32> Flow identifier to check for unassigned endpoints
organizationId	integer <int32> Organization identifier to filter endpoints
flowEndpointTypeId	integer <int32> Endpoint type identifier to filter by type: 1 = Source, 2 = Target, 0 = All/Undefined

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
flowId	integer <int32>
flowEndpointTypeId	integer <int32>
endpointId	integer <int32>
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>

https://us.thruinc.com/api/FlowEndpoint/getUnassignedFlowEndpointsList

https://uk.thruinc.com/api/FlowEndpoint/getUnassignedFlowEndpointsList

https://eu.thruinc.com/api/FlowEndpoint/getUnassignedFlowEndpointsList

https://au.thruinc.com/api/FlowEndpoint/getUnassignedFlowEndpointsList

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new flow endpoint configuration

Establishes new flow endpoint with specified endpoint reference and configuration.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Flow endpoint configuration details

id	integer <int32>
flowId	integer <int32>
flowEndpointTypeId	integer <int32>
endpointId	integer <int32>
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>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowId	integer <int32>
flowEndpointTypeId	integer <int32>
endpointId	integer <int32>
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>

https://us.thruinc.com/api/FlowEndpoint/createFlowEndpoint

https://uk.thruinc.com/api/FlowEndpoint/createFlowEndpoint

https://eu.thruinc.com/api/FlowEndpoint/createFlowEndpoint

https://au.thruinc.com/api/FlowEndpoint/createFlowEndpoint

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowId": 0,
• "flowEndpointTypeId": 0,
• "endpointId": 0,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing flow endpoint configuration

Modifies existing flow endpoint configuration including processing options and schedules.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated flow endpoint configuration details

id	integer <int32>
flowId	integer <int32>
flowEndpointTypeId	integer <int32>
endpointId	integer <int32>
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>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowId	integer <int32>
flowEndpointTypeId	integer <int32>
endpointId	integer <int32>
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>

https://us.thruinc.com/api/FlowEndpoint/updateFlowEndpoint

https://uk.thruinc.com/api/FlowEndpoint/updateFlowEndpoint

https://eu.thruinc.com/api/FlowEndpoint/updateFlowEndpoint

https://au.thruinc.com/api/FlowEndpoint/updateFlowEndpoint

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowId": 0,
• "flowEndpointTypeId": 0,
• "endpointId": 0,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z"

}

Response samples

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

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a flow endpoint configuration

Removes flow endpoint configuration and all associated settings.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

integer <int32> Unique identifier of the flow endpoint to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/FlowEndpoint/deleteFlowEndpoint

https://uk.thruinc.com/api/FlowEndpoint/deleteFlowEndpoint

https://eu.thruinc.com/api/FlowEndpoint/deleteFlowEndpoint

https://au.thruinc.com/api/FlowEndpoint/deleteFlowEndpoint

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves file paths configured for flow endpoints

Returns list of file paths configured for flow endpoint processing.

Authorizations:

ApiKeyBearer

query Parameters

flowId

integer <int32> Unique identifier of the flow

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

string

https://us.thruinc.com/api/FlowEndpoint/getFlowEndpointPaths

https://uk.thruinc.com/api/FlowEndpoint/getFlowEndpointPaths

https://eu.thruinc.com/api/FlowEndpoint/getFlowEndpointPaths

https://au.thruinc.com/api/FlowEndpoint/getFlowEndpointPaths

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Tests connectivity to a flow endpoint

Validates flow endpoint connectivity by attempting connection to configured endpoint.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId	integer <int32> Unique identifier of the flow endpoint to test
thruNodeId	string Optional node identifier for testing specific node connectivity
path	string Optional path to test specific directory access

Responses

https://us.thruinc.com/api/FlowEndpoint/testConnection

https://uk.thruinc.com/api/FlowEndpoint/testConnection

https://eu.thruinc.com/api/FlowEndpoint/testConnection

https://au.thruinc.com/api/FlowEndpoint/testConnection

Response samples

• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample