Waiting for engine...
Skip to main content

Boomi MFT - File Sharing API Reference (1.16) - Audit

Toggle Pane
API docs by Redocly

Download OpenAPI Specification: Download

Audit Service

The Audit REST Web Services provide endpoints for retrieving audit records across system components. These services provide programmatic access to audit data, enabling monitoring, compliance, and integration with external analytics or security tools.

Retrieve User Audit

Returns the records of the User audit.

Invocation Scenarios

Search MFT User Audit records for the current authenticated user. All query parameters are optional.

Remarks

REST version: 1.0
order=-1 : from latest by date to older
order=1 : from earliest by date to newer
DateTime should be in Unix epoch format, in milliseconds, example: /Date(1706922061000)/ , slashed included
Sample URL with datetime filtering:
https://sitename.domain.ext/REST/1.0/Audit/Users?start=/Date(1704070861000)/&end=/Date(1706922061000)/
Search value for userSearchString should not include the quotes, e.g. userSearchString=email@domain.com

Authorizations:
SessionAuth
query Parameters
operation
integer <int32>
applicationId
integer <int32>
userId
string
userSearchString
string
start
integer <int64>

Unix epoch time in milliseconds.

end
integer <int64>

Unix epoch time in milliseconds.

skip
integer <int32>
take
integer <int32>
order
string

Responses

Response Schema: application/json
ApplicationID
required
string
ApplicationName
required
string
AuthStatus
required
string
DateCreated
required
string <date-time>

Log Operation’s date create (UTC) in Unix epoch format including slashes

IsApproved
required
boolean
OperationId
required
string

Operation Id

OperationName
required
string

Operation Name

PerformedByUserEmail
required
string

User’s email who performed the operation

PerformedByUserFullName
required
string

User’s full name who performed the operation

PerformedByUserID
required
string

Identifier of User who performed the operation

SSOFlag
required
boolean
UserEmail
required
string

User’s last name

UserFullName
required
string

User’s full name

UserID
required
string

Identifier of User

UserLogID
required
string

Identifier of Log Operation

ClientIPAddress
string

User’s client IP address

ClientVersion
string
DeviceUID
string
AgreementID
string
Note
string

Operation Note

Response samples

Content type
application/json
{
  • "UserLogID": "1Q1OBQWVHTROE",
  • "UserID": "1Q1TUBQWVHJGD",
  • "UserFullName": "A B",
  • "UserEmail": "Test",
  • "OperationId": "1",
  • "OperationName": "Authenticate User",
  • "ClientIPAddress": "string",
  • "ClientVersion": "string",
  • "DeviceUID": "string",
  • "ApplicationID": "1",
  • "ApplicationName": "Web Edition",
  • "SSOFlag": true,
  • "IsApproved": true,
  • "AgreementID": "string",
  • "AuthStatus": "Approved",
  • "DateCreated": "/Date(1337174868567)/",
  • "PerformedByUserID": "1Q1TUBQWVHJGD",
  • "PerformedByUserFullName": "T C",
  • "PerformedByUserEmail": "TC@abc.com",
  • "Note": "string"
}

Retrieve UserGroup Audit

Returns the records of User Group audit.

Invocation Scenarios

Search MFT UserGroup Audit records for the current authenticated user. All query parameters are optional.

Remarks

REST version: 1.0
order=-1 : from latest by date to older
order=1 : from earliest by date to newer
DateTime should be in Unix epoch format, in milliseconds, example: /Date(1706922061000)/
Sample URL with datetime filtering:
https://sitename.domain.ext/REST/1.0/Audit/ UserGroups?start=/Date(1704070861000)/&end=/Date(1706922061000)/
Search value for userSearchString should not include the quotes, e.g. userSearchString=email@domain.com
Search value for userGroupSearchString should not include the quotes, e.g. userGroupSearchString=Test UserGroup API v1.

Authorizations:
SessionAuth
query Parameters
operation
integer <int32>
userId
string
userGroupId
string
userSearchString
string
userGroupSearchString
string
start
integer <int64>

Unix epoch time in milliseconds.

end
integer <int64>

Unix epoch time in milliseconds.

skip
integer <int32>
take
integer <int32>
order
string

Responses

Response Schema: application/json
DateCreated
required
string <date-time>

Log Operation’s date create (UTC)

GroupModifierRole
required
string

User’s role who can modify the group

GroupName
required
string

Group name

Operation
required
string

Operation Id

OperationName
required
string

Operation Name

PerformedByUserEmail
required
string

User’s email who performed the operation

PerformedByUserFullName
required
string

User’s full name who performed the operation

PerformedByUserID
required
string

Identifier of User who performed the operation

PreviousGroupModifierRole
required
string

Previous user’s role who can modify the group

PreviousGroupName
required
string

Group name before rename

UserEmail
required
string

User’s last name

UserFullName
required
string

User’s full name

UserGroupID
required
string

Identifier of User Group

UserGroupLogID
required
string

Identifier of Log Operation

UserID
required
string

Identifier of User

ClientIPAddress
string

User’s client IP address

Response samples

Content type
application/json
{
  • "UserGroupLogID": "1Q1OBQWVHTROE",
  • "UserID": "1Q1TUBQWVHJGD",
  • "UserGroupID": "1Q1TUBQWVHJGD",
  • "UserFullName": "A B",
  • "UserEmail": "Test",
  • "Operation": "int",
  • "OperationName": "Internal Upload",
  • "ClientIPAddress": "string",
  • "DateCreated": "/Date(1337174868567)/",
  • "PerformedByUserID": "1Q1TUBQWVHJGD",
  • "PerformedByUserFullName": "T C",
  • "PerformedByUserEmail": "TC@abc.com",
  • "PreviousGroupName": "Group1",
  • "GroupModifierRole": "Administrator",
  • "GroupName": "Group2",
  • "PreviousGroupModifierRole": "Test.jpg"
}

Retrieve FileSystem Audit

Get list of the FileSystem audit.

Invocation Scenarios

Search MFT FileSystem Audit records for the current authenticated user. All query parameters are optional.

Remarks

REST version: 1.0
order=-1 : from latest by date to older
order=1 : from earliest by date to newer
DateTime should be in Unix epoch format, in milliseconds, example: /Date(1706922061000)/
Sample URL with datetime filtering:
https://sitename.domain.ext/REST/1.0/Audit/ FileSystem?start=/Date(1704070861000)/&end=/Date(1706922061000)/

Authorizations:
SessionAuth
query Parameters
operation
integer <int32>
applicationId
integer <int32>
userId
string
start
string <date-time>
end
string <date-time>
skip
integer <int32>
take
integer <int32>
order
string

Responses

Response Schema: application/json
AgreementID
required
string

Only for Secure Message Reference to Agreement Id used for the message

ApplicationName
required
string

Application name for the log operation

ApplicationShortName
required
string

Application short name for the log operation

DateDeleted
required
string <date-time>

Only for Secure Message Message delete date in Unix epoch format including slashes

DateExpire
required
string <date-time>

Only for Secure Message Message expire date in Unix epoch format including slashes

DateSent
required
string <date-time>

Only for Secure Message Message sent date in Unix epoch format including slashes

Description
required
string

Item’s description

ExternalUserEmail
required
string

Email of external user which belong to the operation

FileId
required
string

File ID

FileSystemLogId
required
string

Identifier of Log Item

FileSystemLogOpId
required
string

Identifier of Log Operation

FolderId
required
string

Folder ID

FolderPermission
required
string

None = 0x00, // 0 Show = 0x01, // 1 Read = 0x02, // 2 Create = 0x04, // 4 Download = 0x08, // 8 Distribute = 0x010, // 16 Manage = 0x020, // 32 Modify = 0x040, // 64 Delete = 0x080, // 128 FullControl = Read \

IsExpired
required
boolean

Only for Secure Message Is message expired

IsProtected
required
boolean

Only for Secure Message Indicates if message protected or not

IsTop
required
boolean

Log item hierarchy placement.

LogDateCreated
required
string <date-time>

Log Item’s date create (UTC) in Unix epoch format including slashes

Name
required
string

Log Item name, e.g. file name or folder name

NextName
required
string

New name for the log item’s name

NextPath
required
string

New path to the item

NotifyFlag
required
boolean

Only for Secure Message Notification required flag

Operation
required
string

Operation Id

OperationDateCreated
required
string <date-time>

Log Operation’s date create (UTC) in Unix epoch format including slashes

OperationName
required
string

Operation Name

PartialUpload
required
boolean

Indicates incomplete upload for an item

Path
required
string

Path to the item

PreviousDescription
required
string

Item’s previous description

PreviousFolderPermission
required
string

Previous permission for the item

PreviousName
required
string

Previous name for the log item’s name

PreviousPath
required
string

Old path to the item

Priority
required
string

Only for Secure Message High Normal Low

RelatedUserEmail
required
string

Related user's email for the operation

RelatedUserId
required
string

Identifier of Related User

RelatedUserName
required
string

Related user's name for the operation

RequestRecipientLogin
required
boolean

Only for Secure Message Indicates if message requires recipient login

Size
required
integer <int64>

Item size in bites

Status
required
boolean

Indicates success/failure status of log item

Subject
required
string

Only for Secure Message Message Subject

TrackingNo
required
string

Only for Secure Message Message Tracking Id

UserEmail
required
string

User’s last name

UserFullName
required
string

User’s first name

UserID
required
string

Identifier of User

ClientIPAddress
string

User’s client IP address

Note
string

Operation’s note

Response samples

Content type
application/json
{
  • "FileSystemLogOpId": "1Q1OBQWVHTROE",
  • "FileSystemLogId": "1Q1OBQWVHTROM",
  • "UserID": "1Q1TUBQWVHJGD",
  • "UserFullName": "Ad",
  • "UserEmail": "Test",
  • "Operation": "int",
  • "OperationName": "Internal Upload",
  • "ClientIPAddress": "string",
  • "OperationDateCreated": "/Date(1337174868567)/",
  • "Note": "string",
  • "ApplicationName": "Web",
  • "ApplicationShortName": "Web",
  • "IsTop": true,
  • "LogDateCreated": "/Date(1343838136630)/",
  • "Status": true,
  • "Name": "Test.jpg",
  • "NextName": "NewTest.jpg",
  • "PreviousName": "Test.jpg",
  • "Path": "/FODLERS/COMMON/Test.jpg",
  • "NextPath": "/FODLERS/COMMON/New Folder/",
  • "PreviousPath": "/FODLERS/COMMON//Test.jpg",
  • "Description": "New description",
  • "PreviousDescription": "description",
  • "FolderPermission": "7",
  • "PreviousFolderPermission": "3",
  • "RelatedUserEmail": "Testuser@abc.com",
  • "RelatedUserName": "User A",
  • "RelatedUserId": "1Q1TUBQWVHJFF",
  • "Size": 100,
  • "FileId": "331TUBQWVHJFF",
  • "FolderId": "131TUBQWVHJFF",
  • "PartialUpload": false,
  • "ExternalUserEmail": "Extuser@abc.com",
  • "Priority": "High",
  • "DateDeleted": "/Date(1343838136630)/",
  • "DateExpire": "/Date(1343838136630)/",
  • "DateSent": "/Date(1343838136630)/",
  • "IsExpired": false,
  • "NotifyFlag": false,
  • "Subject": "Test",
  • "TrackingNo": "T478-014-93928-94469",
  • "AgreementID": "1214",
  • "IsProtected": true,
  • "RequestRecipientLogin": true
}