Waiting for engine...
Skip to main content

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

Toggle Pane
API docs by Redocly

Download OpenAPI Specification: Download

Report

Initiates a file activity export job for audit data

Authorizations:
ApiKeyBearer
Request Body schema:

Export configuration including filters, date range, and output format for activity data

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:
reportId
integer <int64>
message
string or null

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 the status and progress of a file activity export job

Authorizations:
ApiKeyBearer
query Parameters
guid
string

Unique identifier of the export job to check

Responses

Response Schema:
id
integer <int64>
tenantId
integer <int32>
contentType
string or null
reportRequestedBy
string or null
reportRequestedDate
string <date-time>
status
string or null
scheduledRetention
string or null <date-time>
dateRetentioned
string or null <date-time>
assignedTo
string or null
lastHeartbeat
string or null <date-time>
errorMessage
string or null
reportProcessedDate
string or null <date-time>
filePath
string or null
filters
string or null

Response samples

Content type
No sample

Retrieves a list of all available reports for the current organization

Authorizations:
ApiKeyBearer

Responses

Response Schema:
Array
id
integer <int64>
tenantId
integer <int32>
contentType
string or null
reportRequestedBy
string or null
reportRequestedDate
string <date-time>
status
string or null
scheduledRetention
string or null <date-time>
dateRetentioned
string or null <date-time>
assignedTo
string or null
lastHeartbeat
string or null <date-time>
errorMessage
string or null
reportProcessedDate
string or null <date-time>
filePath
string or null
filters
string or null

Response samples

Content type
No sample

Downloads a generated report file

Authorizations:
ApiKeyBearer
path Parameters
reportId
required
string

Unique identifier of the report to download

Responses