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

Toggle Pane

• FlowEndpointServerPathMappings
  • getRetrieves a specific server path mapping configuration by ID
  • delDeletes a specific server path mapping configuration
  • getRetrieves all server path mappings for a specific flow endpoint
  • postCreates a new server path mapping configuration for a flow endpoint
  • putUpdates an existing server path mapping configuration for a flow endpoint
  • putSaves server path mapping configuration (creates new or updates existing based on ID)
  • delDeletes all server path mapping 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.

FlowEndpointServerPathMappings

Retrieves a specific server path mapping configuration by ID

Returns server path mapping configuration including source and target path relationships.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointServerPathMappingId required

integer <int32> Unique identifier of the server path mapping

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
sourceFlowEndpointId	integer <int32>
sourceServerPathId	integer <int32>
targetServerPathId	integer <int32>
isIncludeSubfolders	boolean
createdBy	string or null
createdDate	string <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/FlowEndpointServerPathMappings/{flowEndpointServerPathMappingId}

https://uk.thruinc.com/api/FlowEndpointServerPathMappings/{flowEndpointServerPathMappingId}

https://eu.thruinc.com/api/FlowEndpointServerPathMappings/{flowEndpointServerPathMappingId}

https://au.thruinc.com/api/FlowEndpointServerPathMappings/{flowEndpointServerPathMappingId}

Response samples

• 200
• 403

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a specific server path mapping configuration

Removes server path mapping configuration from flow endpoint.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointServerPathMappingId required

integer <int32> Unique identifier of the server path mapping to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/FlowEndpointServerPathMappings/{flowEndpointServerPathMappingId}

https://uk.thruinc.com/api/FlowEndpointServerPathMappings/{flowEndpointServerPathMappingId}

https://eu.thruinc.com/api/FlowEndpointServerPathMappings/{flowEndpointServerPathMappingId}

https://au.thruinc.com/api/FlowEndpointServerPathMappings/{flowEndpointServerPathMappingId}

Response samples

• 200
• 403

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves all server path mappings for a specific flow endpoint

Returns list of server path mappings 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>
sourceFlowEndpointId	integer <int32>
sourceServerPathId	integer <int32>
targetServerPathId	integer <int32>
isIncludeSubfolders	boolean
createdBy	string or null
createdDate	string <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/FlowEndpointServerPathMappings/getByFlowEndpointId

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

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

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

Response samples

• 200
• 403

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new server path mapping configuration for a flow endpoint

Establishes new path mapping between source and target server paths.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Server path mapping configuration details including source and destination path mappings

id	integer <int32>
flowEndpointId	integer <int32>
sourceFlowEndpointId	integer <int32>
sourceServerPathId	integer <int32>
targetServerPathId	integer <int32>
isIncludeSubfolders	boolean
createdBy	string or null
createdDate	string <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>
sourceFlowEndpointId	integer <int32>
sourceServerPathId	integer <int32>
targetServerPathId	integer <int32>
isIncludeSubfolders	boolean
createdBy	string or null
createdDate	string <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/FlowEndpointServerPathMappings

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "sourceFlowEndpointId": 0,
• "sourceServerPathId": 0,
• "targetServerPathId": 0,
• "isIncludeSubfolders": 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

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing server path mapping configuration for a flow endpoint

Modifies existing path mapping configuration including subfolder inclusion.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated server path mapping configuration details

id	integer <int32>
flowEndpointId	integer <int32>
sourceFlowEndpointId	integer <int32>
sourceServerPathId	integer <int32>
targetServerPathId	integer <int32>
isIncludeSubfolders	boolean
createdBy	string or null
createdDate	string <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>
sourceFlowEndpointId	integer <int32>
sourceServerPathId	integer <int32>
targetServerPathId	integer <int32>
isIncludeSubfolders	boolean
createdBy	string or null
createdDate	string <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/FlowEndpointServerPathMappings

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "sourceFlowEndpointId": 0,
• "sourceServerPathId": 0,
• "targetServerPathId": 0,
• "isIncludeSubfolders": 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

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Saves server path mapping configuration (creates new or updates existing based on ID)

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

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Server path mapping configuration to save (performs upsert based on record ID)

id	integer <int32>
flowEndpointId	integer <int32>
sourceFlowEndpointId	integer <int32>
sourceServerPathId	integer <int32>
targetServerPathId	integer <int32>
isIncludeSubfolders	boolean
createdBy	string or null
createdDate	string <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>
sourceFlowEndpointId	integer <int32>
sourceServerPathId	integer <int32>
targetServerPathId	integer <int32>
isIncludeSubfolders	boolean
createdBy	string or null
createdDate	string <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/FlowEndpointServerPathMappings/save

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "sourceFlowEndpointId": 0,
• "sourceServerPathId": 0,
• "targetServerPathId": 0,
• "isIncludeSubfolders": 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

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes all server path mapping configurations for a specific flow endpoint

Removes all server path mappings from a flow endpoint.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

integer <int32> Unique identifier of the flow endpoint to remove all server path mappings for

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

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

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

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

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

Response samples

• 200
• 403

Content type

text/plainapplication/jsontext/jsontext/plain

No sample