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

Toggle Pane

• FlowEndpointTriggerFiles
  • getRetrieves a specific trigger file configuration by ID
  • delDeletes a specific trigger file configuration
  • getRetrieves all trigger file configurations for a specific flow endpoint
  • postCreates a new trigger file configuration for a flow endpoint
  • putUpdates an existing trigger file configuration for a flow endpoint
  • putSaves trigger file configuration (creates new or updates existing based on ID)
  • delDeletes all trigger file configurations for a specific 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.

FlowEndpointTriggerFiles

Retrieves a specific trigger file configuration by ID

Returns trigger file configuration including semaphore and temporary file settings.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointTriggerFilesId required

integer <int32> Unique identifier of the trigger file configuration

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isTriggerSemaphoreFile	boolean
isTriggerTemporaryFilename	boolean
isTriggerBatchSemaphore	boolean
isAddExtension	boolean
isReplaceExtension	boolean
isTemporaryPrefix	boolean
isTemporaryExtension	boolean
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>
filePrefix	string or null
fileExtension	string or null
batchSemaphoreFilename	string or null

https://us.thruinc.com/api/FlowEndpointTriggerFiles/{flowEndpointTriggerFilesId}

https://uk.thruinc.com/api/FlowEndpointTriggerFiles/{flowEndpointTriggerFilesId}

https://eu.thruinc.com/api/FlowEndpointTriggerFiles/{flowEndpointTriggerFilesId}

https://au.thruinc.com/api/FlowEndpointTriggerFiles/{flowEndpointTriggerFilesId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a specific trigger file configuration

Removes trigger file configuration from flow endpoint.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointTriggerFilesId required

integer <int32> Unique identifier of the trigger file configuration to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

isDeleted

boolean

https://us.thruinc.com/api/FlowEndpointTriggerFiles/{flowEndpointTriggerFilesId}

https://uk.thruinc.com/api/FlowEndpointTriggerFiles/{flowEndpointTriggerFilesId}

https://eu.thruinc.com/api/FlowEndpointTriggerFiles/{flowEndpointTriggerFilesId}

https://au.thruinc.com/api/FlowEndpointTriggerFiles/{flowEndpointTriggerFilesId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves all trigger file configurations for a specific flow endpoint

Returns list of trigger file configurations for a flow endpoint.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

integer <int32> Unique identifier of the flow endpoint

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isTriggerSemaphoreFile	boolean
isTriggerTemporaryFilename	boolean
isTriggerBatchSemaphore	boolean
isAddExtension	boolean
isReplaceExtension	boolean
isTemporaryPrefix	boolean
isTemporaryExtension	boolean
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>
filePrefix	string or null
fileExtension	string or null
batchSemaphoreFilename	string or null

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

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

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

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

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new trigger file configuration for a flow endpoint

Establishes new trigger file configuration with semaphore and naming rules.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Trigger file configuration details including trigger conditions and file patterns

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isTriggerSemaphoreFile	boolean
isTriggerTemporaryFilename	boolean
isTriggerBatchSemaphore	boolean
isAddExtension	boolean
isReplaceExtension	boolean
isTemporaryPrefix	boolean
isTemporaryExtension	boolean
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>
filePrefix	string or null
fileExtension	string or null
batchSemaphoreFilename	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isTriggerSemaphoreFile	boolean
isTriggerTemporaryFilename	boolean
isTriggerBatchSemaphore	boolean
isAddExtension	boolean
isReplaceExtension	boolean
isTemporaryPrefix	boolean
isTemporaryExtension	boolean
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>
filePrefix	string or null
fileExtension	string or null
batchSemaphoreFilename	string or null

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "isEnabled": true,
• "isTriggerSemaphoreFile": true,
• "isTriggerTemporaryFilename": true,
• "isTriggerBatchSemaphore": true,
• "isAddExtension": true,
• "isReplaceExtension": true,
• "isTemporaryPrefix": true,
• "isTemporaryExtension": true,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z",
• "filePrefix": "string",
• "fileExtension": "string",
• "batchSemaphoreFilename": "string"

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing trigger file configuration for a flow endpoint

Modifies existing trigger file configuration including semaphore settings.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated trigger file configuration details

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isTriggerSemaphoreFile	boolean
isTriggerTemporaryFilename	boolean
isTriggerBatchSemaphore	boolean
isAddExtension	boolean
isReplaceExtension	boolean
isTemporaryPrefix	boolean
isTemporaryExtension	boolean
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>
filePrefix	string or null
fileExtension	string or null
batchSemaphoreFilename	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isTriggerSemaphoreFile	boolean
isTriggerTemporaryFilename	boolean
isTriggerBatchSemaphore	boolean
isAddExtension	boolean
isReplaceExtension	boolean
isTemporaryPrefix	boolean
isTemporaryExtension	boolean
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>
filePrefix	string or null
fileExtension	string or null
batchSemaphoreFilename	string or null

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "isEnabled": true,
• "isTriggerSemaphoreFile": true,
• "isTriggerTemporaryFilename": true,
• "isTriggerBatchSemaphore": true,
• "isAddExtension": true,
• "isReplaceExtension": true,
• "isTemporaryPrefix": true,
• "isTemporaryExtension": true,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z",
• "filePrefix": "string",
• "fileExtension": "string",
• "batchSemaphoreFilename": "string"

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Saves trigger file configuration (creates new or updates existing based on ID)

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

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Trigger file configuration to save (performs upsert based on record ID)

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isTriggerSemaphoreFile	boolean
isTriggerTemporaryFilename	boolean
isTriggerBatchSemaphore	boolean
isAddExtension	boolean
isReplaceExtension	boolean
isTemporaryPrefix	boolean
isTemporaryExtension	boolean
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>
filePrefix	string or null
fileExtension	string or null
batchSemaphoreFilename	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEnabled	boolean
isTriggerSemaphoreFile	boolean
isTriggerTemporaryFilename	boolean
isTriggerBatchSemaphore	boolean
isAddExtension	boolean
isReplaceExtension	boolean
isTemporaryPrefix	boolean
isTemporaryExtension	boolean
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>
filePrefix	string or null
fileExtension	string or null
batchSemaphoreFilename	string or null

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "isEnabled": true,
• "isTriggerSemaphoreFile": true,
• "isTriggerTemporaryFilename": true,
• "isTriggerBatchSemaphore": true,
• "isAddExtension": true,
• "isReplaceExtension": true,
• "isTemporaryPrefix": true,
• "isTemporaryExtension": true,
• "createdBy": "string",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedBy": "string",
• "updatedDate": "2019-08-24T14:15:22Z",
• "deletedBy": "string",
• "deletedDate": "2019-08-24T14:15:22Z",
• "filePrefix": "string",
• "fileExtension": "string",
• "batchSemaphoreFilename": "string"

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes all trigger file configurations for a specific flow endpoint

Removes all trigger file configurations from a flow endpoint.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

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

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

isDeleted

boolean

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

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

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

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

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample