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

Toggle Pane

• FlowEndpointProcessingOptions
  • getRetrieves a specific processing option configuration by ID
  • delDeletes a specific processing option configuration
  • getRetrieves all processing option configurations for a specific flow endpoint
  • putSaves processing option configuration (creates new or updates existing based on service logic)
  • delDeletes all processing option configurations for a specific flow endpoint

API docs by Redocly

Download OpenAPI Specification: Download

FlowEndpointProcessingOptions

Retrieves a specific processing option configuration by ID

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointProcessingOptionId required

integer <int32> Unique identifier of the processing option configuration

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEncryption	boolean
isDecryption	boolean
isCompression	boolean
isDecompression	boolean
isNotifications	boolean
isTransferIfFileSizeChanged	boolean
isTransferIfCreateDateNewer	boolean
isTransferIfModifiedDateNewer	boolean
isTransferAllBatches	boolean
isTransferLatestBatchOnly	boolean
errorActionId	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>
pgpKeyId	integer <int32>
compressionTypeId	integer <int32>
compressionPassword	string or null
compressBatch	boolean
isVerify	boolean
verifyPgpKeyId	integer or null <int32>
isSign	boolean
signPgpKeyId	integer or null <int32>
isAsciiArmor	boolean
isEncryptionOrDecryption	boolean
isCompressionOrDecompression	boolean

https://us.thruinc.com/api/FlowEndpointProcessingOptions/{flowEndpointProcessingOptionId}

https://uk.thruinc.com/api/FlowEndpointProcessingOptions/{flowEndpointProcessingOptionId}

https://eu.thruinc.com/api/FlowEndpointProcessingOptions/{flowEndpointProcessingOptionId}

https://au.thruinc.com/api/FlowEndpointProcessingOptions/{flowEndpointProcessingOptionId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a specific processing option configuration

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointProcessingOptionId required

integer <int32> Unique identifier of the processing option configuration to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

isDeleted

boolean

https://us.thruinc.com/api/FlowEndpointProcessingOptions/{flowEndpointProcessingOptionId}

https://uk.thruinc.com/api/FlowEndpointProcessingOptions/{flowEndpointProcessingOptionId}

https://eu.thruinc.com/api/FlowEndpointProcessingOptions/{flowEndpointProcessingOptionId}

https://au.thruinc.com/api/FlowEndpointProcessingOptions/{flowEndpointProcessingOptionId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves all processing option configurations 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

Array

id	integer <int32>
flowEndpointId	integer <int32>
isEncryption	boolean
isDecryption	boolean
isCompression	boolean
isDecompression	boolean
isNotifications	boolean
isTransferIfFileSizeChanged	boolean
isTransferIfCreateDateNewer	boolean
isTransferIfModifiedDateNewer	boolean
isTransferAllBatches	boolean
isTransferLatestBatchOnly	boolean
errorActionId	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>
pgpKeyId	integer <int32>
compressionTypeId	integer <int32>
compressionPassword	string or null
compressBatch	boolean
isVerify	boolean
verifyPgpKeyId	integer or null <int32>
isSign	boolean
signPgpKeyId	integer or null <int32>
isAsciiArmor	boolean
isEncryptionOrDecryption	boolean
isCompressionOrDecompression	boolean

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

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

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

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

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Saves processing option configuration (creates new or updates existing based on service logic)

Uses service-level upsert logic to determine whether to create or update the configuration

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Processing option configuration to save

id	integer <int32>
flowEndpointId	integer <int32>
isEncryption	boolean
isDecryption	boolean
isCompression	boolean
isDecompression	boolean
isNotifications	boolean
isTransferIfFileSizeChanged	boolean
isTransferIfCreateDateNewer	boolean
isTransferIfModifiedDateNewer	boolean
isTransferAllBatches	boolean
isTransferLatestBatchOnly	boolean
errorActionId	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>
pgpKeyId	integer <int32>
compressionTypeId	integer <int32>
compressionPassword	string or null
compressBatch	boolean
isVerify	boolean
verifyPgpKeyId	integer or null <int32>
isSign	boolean
signPgpKeyId	integer or null <int32>
isAsciiArmor	boolean

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
isEncryption	boolean
isDecryption	boolean
isCompression	boolean
isDecompression	boolean
isNotifications	boolean
isTransferIfFileSizeChanged	boolean
isTransferIfCreateDateNewer	boolean
isTransferIfModifiedDateNewer	boolean
isTransferAllBatches	boolean
isTransferLatestBatchOnly	boolean
errorActionId	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>
pgpKeyId	integer <int32>
compressionTypeId	integer <int32>
compressionPassword	string or null
compressBatch	boolean
isVerify	boolean
verifyPgpKeyId	integer or null <int32>
isSign	boolean
signPgpKeyId	integer or null <int32>
isAsciiArmor	boolean
isEncryptionOrDecryption	boolean
isCompressionOrDecompression	boolean

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "isEncryption": true,
• "isDecryption": true,
• "isCompression": true,
• "isDecompression": true,
• "isNotifications": true,
• "isTransferIfFileSizeChanged": true,
• "isTransferIfCreateDateNewer": true,
• "isTransferIfModifiedDateNewer": true,
• "isTransferAllBatches": true,
• "isTransferLatestBatchOnly": true,
• "errorActionId": 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",
• "pgpKeyId": 0,
• "compressionTypeId": 0,
• "compressionPassword": "string",
• "compressBatch": true,
• "isVerify": true,
• "verifyPgpKeyId": 0,
• "isSign": true,
• "signPgpKeyId": 0,
• "isAsciiArmor": true

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes all processing option configurations for a specific flow endpoint

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

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

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

isDeleted

boolean

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

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

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

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

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample