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

Toggle Pane

• FlowEndpointCompressionOptions
  • getRetrieves all active compression types available for flow endpoints
  • getRetrieves a specific compression configuration by ID
  • delDeletes a specific compression configuration
  • getRetrieves compression configuration for a specific flow endpoint
  • postCreates a new compression configuration for a flow endpoint
  • putUpdates an existing compression configuration for a flow endpoint
  • putSaves compression configuration (creates new or updates existing based on ID)
  • delDeletes all compression configurations for a specific flow endpoint

API docs by Redocly

Download OpenAPI Specification: Download

FlowEndpointCompressionOptions

Retrieves all active compression types available for flow endpoints

Authorizations:

ApiKeyBearer

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
name	string or null
isEnabled	boolean
description	string or null

https://us.thruinc.com/api/FlowEndpointCompressionOptions/getActiveCompressionTypes

https://uk.thruinc.com/api/FlowEndpointCompressionOptions/getActiveCompressionTypes

https://eu.thruinc.com/api/FlowEndpointCompressionOptions/getActiveCompressionTypes

https://au.thruinc.com/api/FlowEndpointCompressionOptions/getActiveCompressionTypes

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves a specific compression configuration by ID

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointCompressionOptionId required

integer <int32> Unique identifier of the compression configuration

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
compressionTypeId	integer <int32>
compressionPassword	string or null
compressBatch	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>

https://us.thruinc.com/api/FlowEndpointCompressionOptions/{flowEndpointCompressionOptionId}

https://uk.thruinc.com/api/FlowEndpointCompressionOptions/{flowEndpointCompressionOptionId}

https://eu.thruinc.com/api/FlowEndpointCompressionOptions/{flowEndpointCompressionOptionId}

https://au.thruinc.com/api/FlowEndpointCompressionOptions/{flowEndpointCompressionOptionId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a specific compression configuration

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointCompressionOptionId required

integer <int32> Unique identifier of the compression configuration to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/FlowEndpointCompressionOptions/{flowEndpointCompressionOptionId}

https://uk.thruinc.com/api/FlowEndpointCompressionOptions/{flowEndpointCompressionOptionId}

https://eu.thruinc.com/api/FlowEndpointCompressionOptions/{flowEndpointCompressionOptionId}

https://au.thruinc.com/api/FlowEndpointCompressionOptions/{flowEndpointCompressionOptionId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves compression 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>
compressionTypeId	integer <int32>
compressionPassword	string or null
compressBatch	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>

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

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

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

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

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new compression configuration for a flow endpoint

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Compression configuration details including algorithm and settings

id	integer <int32>
flowEndpointId	integer <int32>
compressionTypeId	integer <int32>
compressionPassword	string or null
compressBatch	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>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
compressionTypeId	integer <int32>
compressionPassword	string or null
compressBatch	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>

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "compressionTypeId": 0,
• "compressionPassword": "string",
• "compressBatch": 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"

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing compression configuration for a flow endpoint

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated compression configuration details

id	integer <int32>
flowEndpointId	integer <int32>
compressionTypeId	integer <int32>
compressionPassword	string or null
compressBatch	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>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
compressionTypeId	integer <int32>
compressionPassword	string or null
compressBatch	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>

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "compressionTypeId": 0,
• "compressionPassword": "string",
• "compressBatch": 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"

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Saves compression 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

Compression configuration to save (performs upsert based on record ID)

id	integer <int32>
flowEndpointId	integer <int32>
compressionTypeId	integer <int32>
compressionPassword	string or null
compressBatch	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>

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
compressionTypeId	integer <int32>
compressionPassword	string or null
compressBatch	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>

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "compressionTypeId": 0,
• "compressionPassword": "string",
• "compressBatch": 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"

}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes all compression configurations for a specific flow endpoint

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

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

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

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

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

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

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

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample