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

Toggle Pane

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

FlowEndpointSchedules

Retrieves a specific flow endpoint schedule configuration by ID

Returns schedule configuration including type, frequency, and timing settings.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointScheduleId required

integer <int32> Unique identifier of the flow endpoint schedule

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
flowScheduleTypeId	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>
	object (FlowEndpointOnArrivalSchedules)
	object (FlowEndpointContinuousSchedules)
	object (FlowEndpointDailySchedules)
	object (FlowEndpointWeeklySchedules)
	object (FlowEndpointMonthlySchedules)

https://us.thruinc.com/api/FlowEndpointSchedules/{flowEndpointScheduleId}

https://uk.thruinc.com/api/FlowEndpointSchedules/{flowEndpointScheduleId}

https://eu.thruinc.com/api/FlowEndpointSchedules/{flowEndpointScheduleId}

https://au.thruinc.com/api/FlowEndpointSchedules/{flowEndpointScheduleId}

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes a specific flow endpoint schedule configuration

Removes schedule configuration from flow endpoint.

Authorizations:

ApiKeyBearer

path Parameters

flowEndpointScheduleId required

integer <int32> Unique identifier of the flow endpoint schedule to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/FlowEndpointSchedules/{flowEndpointScheduleId}

https://uk.thruinc.com/api/FlowEndpointSchedules/{flowEndpointScheduleId}

https://eu.thruinc.com/api/FlowEndpointSchedules/{flowEndpointScheduleId}

https://au.thruinc.com/api/FlowEndpointSchedules/{flowEndpointScheduleId}

Response samples

• 200
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves flow endpoint schedule configuration for a specific flow endpoint

Returns schedule 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>
flowScheduleTypeId	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>
	object (FlowEndpointOnArrivalSchedules)
	object (FlowEndpointContinuousSchedules)
	object (FlowEndpointDailySchedules)
	object (FlowEndpointWeeklySchedules)
	object (FlowEndpointMonthlySchedules)

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

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

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

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

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new flow endpoint schedule configuration

Establishes new schedule with specified timing, frequency, and execution settings.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Flow endpoint schedule configuration details including timing, frequency, and execution settings

id	integer <int32>
flowEndpointId	integer <int32>
flowScheduleTypeId	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>
	object (FlowEndpointOnArrivalSchedules)
	object (FlowEndpointContinuousSchedules)
	object (FlowEndpointDailySchedules)
	object (FlowEndpointWeeklySchedules)
	object (FlowEndpointMonthlySchedules)

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
flowScheduleTypeId	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>
	object (FlowEndpointOnArrivalSchedules)
	object (FlowEndpointContinuousSchedules)
	object (FlowEndpointDailySchedules)
	object (FlowEndpointWeeklySchedules)
	object (FlowEndpointMonthlySchedules)

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "flowScheduleTypeId": 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",
• "flowEndpointOnArrivalSchedule": {

  • "id": 0,
  • "flowEndpointId": 0,
  • "attempts": 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"

  },
• "flowEndpointContinuousSchedule": {

  • "id": 0,
  • "flowEndpointId": 0,
  • "period": "string",
  • "units": 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"

  },
• "flowEndpointDailySchedule": {

  • "id": 0,
  • "flowEndpointId": 0,
  • "isSunday": true,
  • "isMonday": true,
  • "isTuesday": true,
  • "isWednesday": true,
  • "isThursday": true,
  • "isFriday": true,
  • "isSaturday": true,
  • "period": "string",
  • "units": 0,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z"

  },
• "flowEndpointWeeklySchedule": {

  • "period": "string",
  • "units": 0,
  • "id": 0,
  • "flowEndpointId": 0,
  • "repeatDay": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z"

  },
• "flowEndpointMonthlySchedule": {

  • "period": "string",
  • "units": 0,
  • "id": 0,
  • "flowEndpointId": 0,
  • "repeatDay": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "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 flow endpoint schedule configuration

Modifies existing schedule configuration including timing and recurrence settings.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Updated flow endpoint schedule configuration details

id	integer <int32>
flowEndpointId	integer <int32>
flowScheduleTypeId	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>
	object (FlowEndpointOnArrivalSchedules)
	object (FlowEndpointContinuousSchedules)
	object (FlowEndpointDailySchedules)
	object (FlowEndpointWeeklySchedules)
	object (FlowEndpointMonthlySchedules)

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
flowScheduleTypeId	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>
	object (FlowEndpointOnArrivalSchedules)
	object (FlowEndpointContinuousSchedules)
	object (FlowEndpointDailySchedules)
	object (FlowEndpointWeeklySchedules)
	object (FlowEndpointMonthlySchedules)

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "flowScheduleTypeId": 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",
• "flowEndpointOnArrivalSchedule": {

  • "id": 0,
  • "flowEndpointId": 0,
  • "attempts": 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"

  },
• "flowEndpointContinuousSchedule": {

  • "id": 0,
  • "flowEndpointId": 0,
  • "period": "string",
  • "units": 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"

  },
• "flowEndpointDailySchedule": {

  • "id": 0,
  • "flowEndpointId": 0,
  • "isSunday": true,
  • "isMonday": true,
  • "isTuesday": true,
  • "isWednesday": true,
  • "isThursday": true,
  • "isFriday": true,
  • "isSaturday": true,
  • "period": "string",
  • "units": 0,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z"

  },
• "flowEndpointWeeklySchedule": {

  • "period": "string",
  • "units": 0,
  • "id": 0,
  • "flowEndpointId": 0,
  • "repeatDay": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z"

  },
• "flowEndpointMonthlySchedule": {

  • "period": "string",
  • "units": 0,
  • "id": 0,
  • "flowEndpointId": 0,
  • "repeatDay": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "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 flow endpoint schedule configuration (creates new or updates existing based on ID)

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

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Flow endpoint schedule configuration to save (performs upsert based on record ID)

id	integer <int32>
flowEndpointId	integer <int32>
flowScheduleTypeId	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>
	object (FlowEndpointOnArrivalSchedules)
	object (FlowEndpointContinuousSchedules)
	object (FlowEndpointDailySchedules)
	object (FlowEndpointWeeklySchedules)
	object (FlowEndpointMonthlySchedules)

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
flowEndpointId	integer <int32>
flowScheduleTypeId	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>
	object (FlowEndpointOnArrivalSchedules)
	object (FlowEndpointContinuousSchedules)
	object (FlowEndpointDailySchedules)
	object (FlowEndpointWeeklySchedules)
	object (FlowEndpointMonthlySchedules)

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

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

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

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

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "flowEndpointId": 0,
• "flowScheduleTypeId": 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",
• "flowEndpointOnArrivalSchedule": {

  • "id": 0,
  • "flowEndpointId": 0,
  • "attempts": 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"

  },
• "flowEndpointContinuousSchedule": {

  • "id": 0,
  • "flowEndpointId": 0,
  • "period": "string",
  • "units": 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"

  },
• "flowEndpointDailySchedule": {

  • "id": 0,
  • "flowEndpointId": 0,
  • "isSunday": true,
  • "isMonday": true,
  • "isTuesday": true,
  • "isWednesday": true,
  • "isThursday": true,
  • "isFriday": true,
  • "isSaturday": true,
  • "period": "string",
  • "units": 0,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z"

  },
• "flowEndpointWeeklySchedule": {

  • "period": "string",
  • "units": 0,
  • "id": 0,
  • "flowEndpointId": 0,
  • "repeatDay": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedBy": "string",
  • "deletedDate": "2019-08-24T14:15:22Z"

  },
• "flowEndpointMonthlySchedule": {

  • "period": "string",
  • "units": 0,
  • "id": 0,
  • "flowEndpointId": 0,
  • "repeatDay": 0,
  • "startDate": "2019-08-24T14:15:22Z",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "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 flow endpoint schedule configurations for a specific flow endpoint

Removes all schedule configurations from a flow endpoint.

Authorizations:

ApiKeyBearer

query Parameters

flowEndpointId

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

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

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

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

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

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

Response samples

• 200
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample