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

Toggle Pane

• FlowEndpointConfigurations
  • getRetrieves a specific flow endpoint configuration by ID
  • delDeletes a specific flow endpoint configuration
  • getRetrieves flow endpoint configuration for a specific flow endpoint
  • postCreates a new flow endpoint configuration
  • putUpdates an existing flow endpoint configuration
  • putSaves flow endpoint configuration (creates new or updates existing based on ID)
  • delDeletes all flow endpoint configurations for a specific flow endpoint

API docs by Redocly

Download OpenAPI Specification: Download

FlowEndpointConfigurations

Retrieves a specific flow endpoint configuration by ID

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointConfigurationId required

integer <int32> Unique identifier of the flow endpoint configuration

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isOverwriteExistingFiles	boolean
isDeleteDeliveredFiles	boolean
isCustomerArchive	boolean
alertHour	integer <int32>
isSubfolders	boolean
flowEndpointName	string or null
serverPath	string or null
thruPath	string or null
filenameFilters	string or null
excludeFilenameFilters	string or null
bucketName	string or null
sourceServerArchivePath	string or null
archiveSourceEndpointCode	string or null
note	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>
dateFilters	string or null
associatedThruNodeId	string or null
numConcurrentFiles	integer <int32>
nodeRootPath	string or null
	Array of objects or null (FlowEndpointServerPaths)

https://us.thruinc.com/api/FlowEndpointConfigurations/{flowEndpointConfigurationId}

https://uk.thruinc.com/api/FlowEndpointConfigurations/{flowEndpointConfigurationId}

https://eu.thruinc.com/api/FlowEndpointConfigurations/{flowEndpointConfigurationId}

https://au.thruinc.com/api/FlowEndpointConfigurations/{flowEndpointConfigurationId}

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a specific flow endpoint configuration

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointConfigurationId required

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

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/FlowEndpointConfigurations/{flowEndpointConfigurationId}

https://uk.thruinc.com/api/FlowEndpointConfigurations/{flowEndpointConfigurationId}

https://eu.thruinc.com/api/FlowEndpointConfigurations/{flowEndpointConfigurationId}

https://au.thruinc.com/api/FlowEndpointConfigurations/{flowEndpointConfigurationId}

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves flow endpoint configuration for a specific flow endpoint

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

integer <int32> Unique identifier of the flow endpoint

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isOverwriteExistingFiles	boolean
isDeleteDeliveredFiles	boolean
isCustomerArchive	boolean
alertHour	integer <int32>
isSubfolders	boolean
flowEndpointName	string or null
serverPath	string or null
thruPath	string or null
filenameFilters	string or null
excludeFilenameFilters	string or null
bucketName	string or null
sourceServerArchivePath	string or null
archiveSourceEndpointCode	string or null
note	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>
dateFilters	string or null
associatedThruNodeId	string or null
numConcurrentFiles	integer <int32>
nodeRootPath	string or null
	Array of objects or null (FlowEndpointServerPaths)

https://us.thruinc.com/api/FlowEndpointConfigurations/getByFlowEndpointId

https://uk.thruinc.com/api/FlowEndpointConfigurations/getByFlowEndpointId

https://eu.thruinc.com/api/FlowEndpointConfigurations/getByFlowEndpointId

https://au.thruinc.com/api/FlowEndpointConfigurations/getByFlowEndpointId

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new flow endpoint configuration

Example dateFilters:

[ { "condition": "BETWEEN", "date": "2022-11-01T05:00:00.000Z", "secondaryDate": "2022-11-30T06:00:00.000Z" }, { "condition": "AFTER", "date": "2023-01-01T06:00:00.000Z", "secondaryDate": "2023-01-26T21:15:38.367Z" }, { "condition": "BEFORE", "date": "2022-09-30T05:00:00.000Z", "secondaryDate": "2023-01-26T19:56:32.830Z" } ]

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Flow endpoint configuration details including paths, filters, and processing settings

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isOverwriteExistingFiles	boolean
isDeleteDeliveredFiles	boolean
isCustomerArchive	boolean
alertHour	integer <int32>
isSubfolders	boolean
flowEndpointName	string or null
serverPath	string or null
thruPath	string or null
filenameFilters	string or null
excludeFilenameFilters	string or null
bucketName	string or null
sourceServerArchivePath	string or null
archiveSourceEndpointCode	string or null
note	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>
dateFilters	string or null
associatedThruNodeId	string or null
numConcurrentFiles	integer <int32>
nodeRootPath	string or null
	Array of objects or null (FlowEndpointServerPaths)

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isOverwriteExistingFiles	boolean
isDeleteDeliveredFiles	boolean
isCustomerArchive	boolean
alertHour	integer <int32>
isSubfolders	boolean
flowEndpointName	string or null
serverPath	string or null
thruPath	string or null
filenameFilters	string or null
excludeFilenameFilters	string or null
bucketName	string or null
sourceServerArchivePath	string or null
archiveSourceEndpointCode	string or null
note	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>
dateFilters	string or null
associatedThruNodeId	string or null
numConcurrentFiles	integer <int32>
nodeRootPath	string or null
	Array of objects or null (FlowEndpointServerPaths)

https://us.thruinc.com/api/FlowEndpointConfigurations

https://uk.thruinc.com/api/FlowEndpointConfigurations

https://eu.thruinc.com/api/FlowEndpointConfigurations

https://au.thruinc.com/api/FlowEndpointConfigurations

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "isEnabled": true,
• "isOverwriteExistingFiles": true,
• "isDeleteDeliveredFiles": true,
• "isCustomerArchive": true,
• "alertHour": 0,
• "isSubfolders": true,
• "flowEndpointName": "string",
• "serverPath": "string",
• "thruPath": "string",
• "filenameFilters": "string",
• "excludeFilenameFilters": "string",
• "bucketName": "string",
• "sourceServerArchivePath": "string",
• "archiveSourceEndpointCode": "string",
• "note": "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",
• "dateFilters": "string",
• "associatedThruNodeId": "string",
• "numConcurrentFiles": 0,
• "nodeRootPath": "string",
• "serverPathList": [

  • {

    • "id": 0,
    • "flowEndpointId": 0,
    • "path": "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"

    }

  ]

}

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing flow endpoint configuration

Example dateFilters:

[ { "condition": "BETWEEN", "date": "2022-11-01T05:00:00.000Z", "secondaryDate": "2022-11-30T06:00:00.000Z" }, { "condition": "AFTER", "date": "2023-01-01T06:00:00.000Z", "secondaryDate": "2023-01-26T21:15:38.367Z" }, { "condition": "BEFORE", "date": "2022-09-30T05:00:00.000Z", "secondaryDate": "2023-01-26T19:56:32.830Z" } ]

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated flow endpoint configuration details

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isOverwriteExistingFiles	boolean
isDeleteDeliveredFiles	boolean
isCustomerArchive	boolean
alertHour	integer <int32>
isSubfolders	boolean
flowEndpointName	string or null
serverPath	string or null
thruPath	string or null
filenameFilters	string or null
excludeFilenameFilters	string or null
bucketName	string or null
sourceServerArchivePath	string or null
archiveSourceEndpointCode	string or null
note	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>
dateFilters	string or null
associatedThruNodeId	string or null
numConcurrentFiles	integer <int32>
nodeRootPath	string or null
	Array of objects or null (FlowEndpointServerPaths)

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isOverwriteExistingFiles	boolean
isDeleteDeliveredFiles	boolean
isCustomerArchive	boolean
alertHour	integer <int32>
isSubfolders	boolean
flowEndpointName	string or null
serverPath	string or null
thruPath	string or null
filenameFilters	string or null
excludeFilenameFilters	string or null
bucketName	string or null
sourceServerArchivePath	string or null
archiveSourceEndpointCode	string or null
note	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>
dateFilters	string or null
associatedThruNodeId	string or null
numConcurrentFiles	integer <int32>
nodeRootPath	string or null
	Array of objects or null (FlowEndpointServerPaths)

https://us.thruinc.com/api/FlowEndpointConfigurations

https://uk.thruinc.com/api/FlowEndpointConfigurations

https://eu.thruinc.com/api/FlowEndpointConfigurations

https://au.thruinc.com/api/FlowEndpointConfigurations

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "isEnabled": true,
• "isOverwriteExistingFiles": true,
• "isDeleteDeliveredFiles": true,
• "isCustomerArchive": true,
• "alertHour": 0,
• "isSubfolders": true,
• "flowEndpointName": "string",
• "serverPath": "string",
• "thruPath": "string",
• "filenameFilters": "string",
• "excludeFilenameFilters": "string",
• "bucketName": "string",
• "sourceServerArchivePath": "string",
• "archiveSourceEndpointCode": "string",
• "note": "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",
• "dateFilters": "string",
• "associatedThruNodeId": "string",
• "numConcurrentFiles": 0,
• "nodeRootPath": "string",
• "serverPathList": [

  • {

    • "id": 0,
    • "flowEndpointId": 0,
    • "path": "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"

    }

  ]

}

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Saves flow endpoint configuration (creates new or updates existing based on ID)

Performs upsert operation: creates new configuration if ID is 0, otherwise updates existing configuration

Example dateFilters:

[ { "condition": "BETWEEN", "date": "2022-11-01T05:00:00.000Z", "secondaryDate": "2022-11-30T06:00:00.000Z" }, { "condition": "AFTER", "date": "2023-01-01T06:00:00.000Z", "secondaryDate": "2023-01-26T21:15:38.367Z" }, { "condition": "BEFORE", "date": "2022-09-30T05:00:00.000Z", "secondaryDate": "2023-01-26T19:56:32.830Z" } ]

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Flow endpoint configuration to save (performs upsert based on record ID)

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isOverwriteExistingFiles	boolean
isDeleteDeliveredFiles	boolean
isCustomerArchive	boolean
alertHour	integer <int32>
isSubfolders	boolean
flowEndpointName	string or null
serverPath	string or null
thruPath	string or null
filenameFilters	string or null
excludeFilenameFilters	string or null
bucketName	string or null
sourceServerArchivePath	string or null
archiveSourceEndpointCode	string or null
note	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>
dateFilters	string or null
associatedThruNodeId	string or null
numConcurrentFiles	integer <int32>
nodeRootPath	string or null
	Array of objects or null (FlowEndpointServerPaths)

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isOverwriteExistingFiles	boolean
isDeleteDeliveredFiles	boolean
isCustomerArchive	boolean
alertHour	integer <int32>
isSubfolders	boolean
flowEndpointName	string or null
serverPath	string or null
thruPath	string or null
filenameFilters	string or null
excludeFilenameFilters	string or null
bucketName	string or null
sourceServerArchivePath	string or null
archiveSourceEndpointCode	string or null
note	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>
dateFilters	string or null
associatedThruNodeId	string or null
numConcurrentFiles	integer <int32>
nodeRootPath	string or null
	Array of objects or null (FlowEndpointServerPaths)

https://us.thruinc.com/api/FlowEndpointConfigurations/save

https://uk.thruinc.com/api/FlowEndpointConfigurations/save

https://eu.thruinc.com/api/FlowEndpointConfigurations/save

https://au.thruinc.com/api/FlowEndpointConfigurations/save

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "isEnabled": true,
• "isOverwriteExistingFiles": true,
• "isDeleteDeliveredFiles": true,
• "isCustomerArchive": true,
• "alertHour": 0,
• "isSubfolders": true,
• "flowEndpointName": "string",
• "serverPath": "string",
• "thruPath": "string",
• "filenameFilters": "string",
• "excludeFilenameFilters": "string",
• "bucketName": "string",
• "sourceServerArchivePath": "string",
• "archiveSourceEndpointCode": "string",
• "note": "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",
• "dateFilters": "string",
• "associatedThruNodeId": "string",
• "numConcurrentFiles": 0,
• "nodeRootPath": "string",
• "serverPathList": [

  • {

    • "id": 0,
    • "flowEndpointId": 0,
    • "path": "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"

    }

  ]

}

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes all flow endpoint configurations for a specific flow endpoint

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

integer <int32> Unique identifier of the flow endpoint to remove all configurations for

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/FlowEndpointConfigurations/deleteByFlowEndpointId

https://uk.thruinc.com/api/FlowEndpointConfigurations/deleteByFlowEndpointId

https://eu.thruinc.com/api/FlowEndpointConfigurations/deleteByFlowEndpointId

https://au.thruinc.com/api/FlowEndpointConfigurations/deleteByFlowEndpointId

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample