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

Toggle Pane

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

FlowEndpointRenameOptions

Retrieves a specific file rename configuration by ID

Returns file rename configuration including regex patterns and path assignments.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointRenameOptionId required

integer <int32> Unique identifier of the file rename configuration

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
name	string or null
filter	string or null
regexString	string or null
testString	string or null
jsonString	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>
assignedPathIdList	Array of integers or null <int32> [ items <int32 > ]

https://us.thruinc.com/api/FlowEndpointRenameOptions/{flowEndpointRenameOptionId}

https://uk.thruinc.com/api/FlowEndpointRenameOptions/{flowEndpointRenameOptionId}

https://eu.thruinc.com/api/FlowEndpointRenameOptions/{flowEndpointRenameOptionId}

https://au.thruinc.com/api/FlowEndpointRenameOptions/{flowEndpointRenameOptionId}

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a specific file rename configuration

Removes file rename configuration from flow endpoint.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointRenameOptionId required

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

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/FlowEndpointRenameOptions/{flowEndpointRenameOptionId}

https://uk.thruinc.com/api/FlowEndpointRenameOptions/{flowEndpointRenameOptionId}

https://eu.thruinc.com/api/FlowEndpointRenameOptions/{flowEndpointRenameOptionId}

https://au.thruinc.com/api/FlowEndpointRenameOptions/{flowEndpointRenameOptionId}

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves all file rename configurations for a specific flow endpoint

Returns list of file rename configurations for a flow endpoint.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId required

integer <int32> Unique identifier of the flow endpoint (required)

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
flowEndpointId	integer <int32>
name	string or null
filter	string or null
regexString	string or null
testString	string or null
jsonString	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>
assignedPathIdList	Array of integers or null <int32> [ items <int32 > ]

https://us.thruinc.com/api/FlowEndpointRenameOptions/getFlowEndpointRenameOptionsList

https://uk.thruinc.com/api/FlowEndpointRenameOptions/getFlowEndpointRenameOptionsList

https://eu.thruinc.com/api/FlowEndpointRenameOptions/getFlowEndpointRenameOptionsList

https://au.thruinc.com/api/FlowEndpointRenameOptions/getFlowEndpointRenameOptionsList

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new file rename configuration for a flow endpoint

Establishes new file rename rule with regex pattern and replacement settings.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

File rename configuration details including patterns and replacement rules

id	integer <int32>
flowEndpointId	integer <int32>
name	string or null
filter	string or null
regexString	string or null
testString	string or null
jsonString	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>
assignedPathIdList	Array of integers or null <int32> [ items <int32 > ]

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
name	string or null
filter	string or null
regexString	string or null
testString	string or null
jsonString	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>
assignedPathIdList	Array of integers or null <int32> [ items <int32 > ]

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "name": "string",
• "filter": "string",
• "regexString": "string",
• "testString": "string",
• "jsonString": "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",
• "assignedPathIdList": [

  • 0

  ]

}

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing file rename configuration for a flow endpoint

Modifies existing file rename configuration including patterns and path assignments.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated file rename configuration details

id	integer <int32>
flowEndpointId	integer <int32>
name	string or null
filter	string or null
regexString	string or null
testString	string or null
jsonString	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>
assignedPathIdList	Array of integers or null <int32> [ items <int32 > ]

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
name	string or null
filter	string or null
regexString	string or null
testString	string or null
jsonString	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>
assignedPathIdList	Array of integers or null <int32> [ items <int32 > ]

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "name": "string",
• "filter": "string",
• "regexString": "string",
• "testString": "string",
• "jsonString": "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",
• "assignedPathIdList": [

  • 0

  ]

}

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Saves file rename 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

File rename configuration to save (performs upsert based on record ID)

id	integer <int32>
flowEndpointId	integer <int32>
name	string or null
filter	string or null
regexString	string or null
testString	string or null
jsonString	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>
assignedPathIdList	Array of integers or null <int32> [ items <int32 > ]

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
name	string or null
filter	string or null
regexString	string or null
testString	string or null
jsonString	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>
assignedPathIdList	Array of integers or null <int32> [ items <int32 > ]

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "name": "string",
• "filter": "string",
• "regexString": "string",
• "testString": "string",
• "jsonString": "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",
• "assignedPathIdList": [

  • 0

  ]

}

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes all file rename configurations for a specific flow endpoint

Removes all file rename configurations from a flow endpoint.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId required

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

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

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

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

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

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

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample