Waiting for engine...
Skip to main content

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

Toggle Pane
API docs by Redocly

Download OpenAPI Specification: Download

Activity

Retrieves file activity based on the provided filters.

viewType:= SourceAndTargetStructured, Source, Target

transferStatusID:= Scheduled (1), Queued (2), Started (3), Progress (4), Completed (5), Cancelled (6), Error (7)

Example requests:

POST /api/Activity/getFileActivity - Example using the minimum set of filer fields { "showPurged": false, "viewType": "SourceAndTargetStructured", "flowCode": "", "flowId": 0, "organizationCode": "", "endpointCode": "", "filename": "", "fromDate": "2022-08-09", "transferStatusId": [], "processingStatus": [], "paging": { "pageNumber": 1, "totalCount": 0, "pageSize": 30, "orderBy": "", "orderDirection": "desc" } }

POST /api/Activity/getFileActivity - Example filtering target files, purged, and with a timestamp { "showPurged": true, "viewType": "Target", "flowCode": "", "flowId": 0, "organizationCode": "", "endpointCode": "", "filename": "", "fromDate": "2022-10-25T20:40:55.260Z", "transferStatusId": [], "processingStatus": [], "paging": { "pageNumber": 1, "totalCount": 0, "pageSize": 50, "orderBy": "", "orderDirection": "desc" } }

POST /api/Activity/getFileActivity - Example filtering for Errors, Cancelled, and Queued files { "viewType":"SourceAndTargetStructured", "showPurged":false, "flowCode":"", "organizationCode":"", "endpointCode":"", "fromDate":"2022-11-01T05:00:00.000Z", "filename":"", "transferStatusId":["7","6","2"], "processingStatus":[], "paging":{ "pageNumber":1, "totalCount":0, "pageSize":50, "orderBy":"TransferStateDateTimeConvert", "orderDirection":"desc" } }

Authorizations:
ApiKeyBearer
Request Body schema:
showPurged
boolean
viewType
string or null
flowCode
string or null
flowId
integer <int32>
organizationCode
string or null
organizationId
integer <int32>
endpointCode
string or null
endpointId
integer <int32>
flowEndpointCode
string or null
flowEndpointId
integer <int32>
filename
string or null
fromDate
string or null <date-time>
toDate
string or null <date-time>
transferStatusId
Array of integers or null <int32> [ items <int32 > ]
processingStatus
Array of strings or null
Array of objects or null (FileActivitiesListItem)
object (PagingModel)

Responses

Response Schema:
showPurged
boolean
viewType
string or null
flowCode
string or null
flowId
integer <int32>
organizationCode
string or null
organizationId
integer <int32>
endpointCode
string or null
endpointId
integer <int32>
flowEndpointCode
string or null
flowEndpointId
integer <int32>
filename
string or null
fromDate
string or null <date-time>
toDate
string or null <date-time>
transferStatusId
Array of integers or null <int32> [ items <int32 > ]
processingStatus
Array of strings or null
Array of objects or null (FileActivitiesListItem)
object (PagingModel)

Request samples

Content type
{
  • "showPurged": true,
  • "viewType": "string",
  • "flowCode": "string",
  • "flowId": 0,
  • "organizationCode": "string",
  • "organizationId": 0,
  • "endpointCode": "string",
  • "endpointId": 0,
  • "flowEndpointCode": "string",
  • "flowEndpointId": 0,
  • "filename": "string",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z",
  • "transferStatusId": [
    • 0
    ],
  • "processingStatus": [
    • "string"
    ],
  • "items": [
    • {
      }
    ],
  • "paging": {
    • "pageNumber": 0,
    • "totalCount": 0,
    • "pageSize": 0,
    • "skip": 0,
    • "orderBy": "string",
    • "orderDirection": "string",
    • "lastReportId": "string",
    • "lastSortValue": "string"
    }
}

Response samples

Content type
No sample

Retrieves download history for a specific file

Authorizations:
ApiKeyBearer
query Parameters
reportId
string

Unique identifier for the file report (must be a valid 24-digit hex string)

flowEndpointType
integer <int32>

Type of flow endpoint: 1 = Source, 2 = Target, 0 = All/Undefined

Responses

Response Schema:
Array
downloadStartedDateTime
string or null <date-time>
downloadStateId
integer <int32>
firstName
string or null
lastName
string or null
lastStateDateTime
string or null <date-time>
userId
integer <int32>

Response samples

Content type
No sample

Gets organization endpoints associated with a specific flow

Authorizations:
ApiKeyBearer
query Parameters
flowId
integer <int32>

Unique identifier for the flow

Responses

Response Schema:
Array
endpointId
integer <int32>
endpointCode
string or null
endpointName
string or null
organizationId
integer <int32>
organizationCode
string or null
organizationName
string or null

Response samples

Content type
No sample

Retrieves available filter options for activity searches

Authorizations:
ApiKeyBearer
Request Body schema:

Filter criteria to determine available options

flowId
integer <int32>
organizationId
integer <int32>
endpointId
integer <int32>
flowEndpointId
integer <int32>
Array of objects or null (FilterOption)
Array of objects or null (FilterOption)
Array of objects or null (FilterOption)
Array of objects or null (FilterOption)

Responses

Response Schema:
flowId
integer <int32>
organizationId
integer <int32>
endpointId
integer <int32>
flowEndpointId
integer <int32>
Array of objects or null (FilterOption)
Array of objects or null (FilterOption)
Array of objects or null (FilterOption)
Array of objects or null (FilterOption)

Request samples

Content type
{
  • "flowId": 0,
  • "organizationId": 0,
  • "endpointId": 0,
  • "flowEndpointId": 0,
  • "flowList": [
    • {
      }
    ],
  • "organizationList": [
    • {
      }
    ],
  • "endpointList": [
    • {
      }
    ],
  • "flowEndpointList": [
    • {
      }
    ]
}

Response samples

Content type
No sample

Retrieves complete transfer history for a specific file

Authorizations:
ApiKeyBearer
query Parameters
reportId
string

Unique identifier for the file report (must be a valid 24-digit hex string)

flowEndpointId
integer <int32>

Identifier for the flow endpoint

Responses

Response Schema:
Array
type
string or null
id
string or null
flowEndpointId
integer <int32>
stateId
integer <int32>
stateName
string or null
stateMessage
string or null
reportId
string or null
flowCode
string or null
endpointCode
string or null
organizationCode
string or null
dateTime
string <date-time>
progress
integer or null <int32>
bytesCompleted
integer <int64>
thruNodeId
string or null

Response samples

Content type
No sample

Resends target files for processing

Authorizations:
ApiKeyBearer
Request Body schema:

List of report identifiers for files to be resent (each must be a valid 24-digit hex string)

Array
string

Responses

Response Schema:
totalFiles
integer <int32>
successfulResends
integer <int32>
failedResends
integer <int32>
Array of objects or null (ResendFileResult)

Request samples

Content type
[
  • "string"
]

Response samples

Content type
No sample

Deletes files with optional associated file cleanup

Authorizations:
ApiKeyBearer
query Parameters
deleteAssociatedFiles
boolean
Default: false

Whether to delete associated files (default: false)

Request Body schema:

List of report identifiers for files to be deleted (each must be a valid 24-digit hex string)

Array
string

Responses

Request samples

Content type
[
  • "string"
]

Response samples

Content type
No sample

Retrieves comprehensive transfer history for audit and reporting

Authorizations:
ApiKeyBearer
Request Body schema:

Filter criteria for transfer history search

fileId
string or null
flowEndpointId
integer or null <int32>
pageNumber
integer <int32>
pageSize
integer <int32>
startDateTimeUtc
string or null <date-time>
endDateTimeUtc
string or null <date-time>
includeTransferErrors
boolean

Responses

Response Schema:
fileId
string or null
flowEndpointId
integer or null <int32>
pageNumber
integer <int32>
pageSize
integer <int32>
startDateTimeUtc
string or null <date-time>
endDateTimeUtc
string or null <date-time>
includeTransferErrors
boolean
total
integer <int64>
Array of objects or null (TransferHistoryItemViewModel)

Request samples

Content type
{
  • "fileId": "string",
  • "flowEndpointId": 0,
  • "pageNumber": 0,
  • "pageSize": 0,
  • "startDateTimeUtc": "2019-08-24T14:15:22Z",
  • "endDateTimeUtc": "2019-08-24T14:15:22Z",
  • "includeTransferErrors": true
}

Response samples

Content type
No sample