This is the main class of an extension and is the entry point from which configurations, connection providers, operations and sources are going to be declared.
Configurations
Config
Default configuration
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
The connection types that can be provided to this configuration. |
x |
||
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit. |
|
Connection Types
Connection
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Base path |
String |
The base URL pointing to the MOVEit Transfer server, e.g. "https://my_moveit.mydomain.com" |
x |
|
Username |
String |
The username used for logging into MOVEit Transfer. |
|
|
Password |
String |
The password used for logging into MOVEit Transfer. |
|
|
Org ID |
String |
The organization ID to log into in a multi-org MOVEit Transfer deployment. |
|
|
Verify SSL certificate |
Boolean |
Whether to verify the SSL certificate used by MOVEit Transfer server. Strongly recommend to set it to "true" for production environment. |
true |
|
Time unit for the connection timeout |
Enumeration, one of:
|
Time unit for the connection timeout |
SECONDS |
|
Connection Timeout |
Number |
Connection Timeout |
60 |
|
Time unit for the read timeout |
Enumeration, one of:
|
Time unit for the read timeout |
SECONDS |
|
Read Timeout |
Number |
Read Timeout |
60 |
|
Time unit for the write timeout |
Enumeration, one of:
|
Time unit for the write timeout |
SECONDS |
|
Write Timeout |
Number |
Write Timeout |
60 |
|
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn't pass after exhausting the associated reconnection strategy |
|
||
Pooling Profile |
Characteristics of the connection pool |
|
Associated Operations
Operations
Copy File To Folder
<ipswitch-mit-mule4:copy-file-to-folder>
Copy a file to a folder.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
File ID |
x |
|
Copy File Input |
Input that contains the destination folder ID |
x |
||
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Create Subfolder
<ipswitch-mit-mule4:create-subfolder>
Create new subfolder in folder
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
ID of the folder where new folder should be added |
x |
|
Create Folder Input |
Input values for creating new subfolder |
x |
||
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Create User
<ipswitch-mit-mule4:create-user>
Create new user. If sourceUserId is specified in user model clone operation will be executed.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Create User Input |
Input values for creating new user |
x |
||
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Delete File
<ipswitch-mit-mule4:delete-file>
Delete a file.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
File ID |
x |
|
Access Token |
String |
Access token |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Delete Folder
<ipswitch-mit-mule4:delete-folder>
Delete a folder.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
Folder ID |
x |
|
Access Token |
String |
Access token |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Delete User
<ipswitch-mit-mule4:delete-user>
Delete user.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
User ID |
x |
|
Access Token |
String |
Access token |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Download File
<ipswitch-mit-mule4:download-file>
Download a file.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
File ID |
x |
|
Access Token |
String |
Access token |
|
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
|
|
Output Encoding |
String |
The encoding of the payload that this operation outputs. |
|
|
Streaming Strategy |
Configure if repeatable streams should be used and their behaviour |
|
||
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
Binary |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Get Current User Details
<ipswitch-mit-mule4:get-current-user-details>
Get current user details
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Get File Details
<ipswitch-mit-mule4:get-file-details>
Get detail information of a file.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
File ID |
x |
|
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Get Files In Folder
<ipswitch-mit-mule4:get-files-in-folder>
List files in a folder.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
Parent folder ID |
x |
|
Page |
Number |
Page number (1 based) |
|
|
Per Page |
Number |
Items per page in result collection; Default is 25 |
|
|
Sort Field |
String |
Field to sort by; Default is name. |
|
|
Sort Direction |
String |
Sort direction; Default is ascending. |
|
|
Name Mask |
String |
Name mask to search by |
|
|
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Get Folder Access Controls
<ipswitch-mit-mule4:get-folder-access-controls>
List folder access controls.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
Folder ID |
x |
|
Page |
Number |
Page number (1 based) |
|
|
Per Page |
Number |
Items per page in result collection; Default is 25 |
|
|
Sort Field |
String |
Name of field to sort the results by. (Name, Type or Path); Default is Path. |
|
|
Sort Direction |
String |
Sort direction; Default is ascending. |
|
|
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Get Folder Content
<ipswitch-mit-mule4:get-folder-content>
List content of the folder.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
Parent folder ID |
x |
|
Page |
Number |
Page number (1 based) |
|
|
Per Page |
Number |
Items per page in result collection; Default is 25 |
|
|
Sort Field |
String |
Field to sort by; (type, time, size or name); Sorting order starts with type and ends with name. |
|
|
Sort Direction |
String |
Sort direction; Default is ascending. |
|
|
Name Mask |
String |
Name mask to search by |
|
|
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Get Folder Details
<ipswitch-mit-mule4:get-folder-details>
Get detail information of a folder.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
Folder ID |
x |
|
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Get Groups Of User
<ipswitch-mit-mule4:get-groups-of-user>
List user groups a user is member of.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
User ID |
x |
|
Page |
Number |
Page number (1 based) |
|
|
Per Page |
Number |
Items per page in result collection; Default is 25 |
|
|
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Get Subfolders In Folder
<ipswitch-mit-mule4:get-subfolders-in-folder>
List subfolders in a folder.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
Parent folder ID |
x |
|
Page |
Number |
Page number (1 based) |
|
|
Per Page |
Number |
Items per page in result collection; Default is 25 |
|
|
Sort Field |
String |
Field to sort by; Default is name. |
|
|
Sort Direction |
String |
Sort direction; Default is ascending. |
|
|
Name Mask |
String |
Name mask to search by |
|
|
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Get Token
<ipswitch-mit-mule4:get-token>
Request API token.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Grant Type |
String |
Type of authentication, "password" or "refresh_token" |
x |
|
Username |
String |
Username. Use with "password" grant type |
|
|
Password |
String |
User password. Use with "password" grant type |
|
|
Language |
String |
Language to use. Optional. Use with "password" grant type |
|
|
Org Id |
String |
Organization ID to authenticate against for a multi-org MOVEit Transfer server. Optional. Use with "password" grant type |
|
|
Refresh Token |
String |
Refresh token. Use with "refresh_token" grant type |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Get User Details
<ipswitch-mit-mule4:get-user-details>
Get detail information of a user.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
User ID |
x |
|
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Get User Group Members
<ipswitch-mit-mule4:get-user-group-members>
List members of a user group.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
Group ID |
x |
|
Page |
Number |
Page number (1 based) |
|
|
Per Page |
Number |
Items per page in result collection; Default is 25 |
|
|
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
List Files
<ipswitch-mit-mule4:list-files>
List files the current user can view.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Page |
Number |
Page number (1 based) |
|
|
Per Page |
Number |
Items per page in result collection; Default is 25 |
|
|
Sort Field |
String |
Name of field to sort the results by. (Name, Type or Path); Default is Path. |
|
|
Sort Direction |
String |
Sort direction; Default is ascending. |
|
|
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
List Folders
<ipswitch-mit-mule4:list-folders>
List folders the current user can view.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Name Mask |
String |
Name mask to search by |
|
|
Path Mask |
String |
Path mask to search by |
|
|
Page |
Number |
Page number (1 based) |
|
|
Per Page |
Number |
Items per page in result collection; Default is 25 |
|
|
Sort Field |
String |
Name of field to sort the results by. (Name, Type or Path); Default is Path. |
|
|
Sort Direction |
String |
Sort direction; Default is ascending. |
|
|
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
List User Groups
<ipswitch-mit-mule4:list-user-groups>
List user groups current user can view.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Page |
Number |
Page number (1 based) |
|
|
Per Page |
Number |
Items per page in result collection; Default is 25 |
|
|
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
List Users
<ipswitch-mit-mule4:list-users>
List users the current user can view.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Page |
Number |
Page number (1 based) |
|
|
Per Page |
Number |
Items per page in result collection; Default is 25 |
|
|
Sort Field |
String |
Name of field to sort the results by. (username, fullName, lastLoginStamp or email); Default is username. |
|
|
Sort Direction |
String |
Sort direction; Default is ascending. |
|
|
Filter Input |
Filter input. |
|
||
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Revoke Token
<ipswitch-mit-mule4:revoke-token>
Revoke API token
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Token |
String |
Access token or refresh token to revoke. |
x |
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Update File
<ipswitch-mit-mule4:update-file>
Update file property.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
File ID |
x |
|
Update File Input |
File property to update |
x |
||
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Update Folder
<ipswitch-mit-mule4:update-folder>
Update folder property.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
Folder ID |
x |
|
Update Folder Input |
Folder property to update |
x |
||
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Update User
<ipswitch-mit-mule4:update-user>
Update user property.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id |
String |
User ID |
x |
|
Update User Input |
User property to update, limited to one at a time. |
x |
||
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Upload File To Folder
<ipswitch-mit-mule4:upload-file-to-folder>
Upload a file to a folder from InputStream. The content type of the request must be \"multipart/form-data\".
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Folder Id |
String |
Folder ID |
x |
|
File Content |
Binary |
File content |
#[payload] |
|
Filename |
String |
Filename |
x |
|
Hash Type |
String |
Type of hash provided (sha-1, sha-256, sha-384, sha-512) |
|
|
Hash |
String |
Hash of file |
|
|
Comments |
String |
File upload comments |
|
|
Access Token |
String |
Access token |
|
|
Target Variable |
String |
The name of a variable on which the operation's output will be placed |
|
|
Target Value |
String |
An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
|
Output
Type |
For Configurations.
Throws
-
IPSWITCH-MIT-MULE4:INVOCATION_ERROR
-
IPSWITCH-MIT-MULE4:CONNECTIVITY
-
IPSWITCH-MIT-MULE4:RETRY_EXHAUSTED
-
IPSWITCH-MIT-MULE4:API_ERROR
Types
Reconnection
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Fails Deployment |
Boolean |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy |
||
Reconnection Strategy |
The reconnection strategy to use |
Reconnect
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often (in ms) to reconnect |
||
Count |
Number |
How many reconnection attempts to make |
Reconnect Forever
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often (in ms) to reconnect |
Pooling Profile
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Active |
Number |
Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted. |
||
Max Idle |
Number |
Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that may be idle at one time. |
||
Max Wait |
Number |
Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_WAIT. |
||
Min Eviction Millis |
Number |
Determines the minimum amount of time an object may sit idle in the pool before it is eligible for eviction. When non-positive, no objects will be evicted from the pool due to idle time alone. |
||
Eviction Check Interval Millis |
Number |
Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed. |
||
Exhausted Action |
Enumeration, one of:
|
Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are: "WHEN_EXHAUSTED_FAIL", which will throw a NoSuchElementException, "WHEN_EXHAUSTED_WAIT", which will block by invoking Object.wait(long) until a new or idle object is available, or WHEN_EXHAUSTED_GROW, which will create a new Mule instance and return it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it will block for at most that many milliseconds, after which a NoSuchElementException will be thrown. If maxThreadWait is a negative value, it will block indefinitely. |
||
Initialisation Policy |
Enumeration, one of:
|
Determines how components in a pool should be initialized. The possible values are: INITIALISE_NONE (will not load any components into the pool on startup), INITIALISE_ONE (will load one initial component into the pool on startup), or INITIALISE_ALL (will load all components in the pool on startup) |
||
Disabled |
Boolean |
Whether pooling should be disabled |
Expiration Policy
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Idle Time |
Number |
A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the maxIdleTime attribute |
File Details
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Current File Type |
Enumeration, one of:
|
|||
Download Count |
Number |
|||
Folder ID |
String |
|||
Hash |
String |
|||
Id |
String |
|||
Name |
String |
|||
Org ID |
String |
|||
Original File Type |
Enumeration, one of:
|
|||
Original Filename |
String |
|||
Path |
String |
|||
Size |
Number |
|||
Upload Agent Brand |
String |
|||
Upload Agent Version |
String |
|||
Upload Comment |
String |
|||
Upload IP |
String |
|||
Upload Integrity |
Number |
|||
Upload Stamp |
String |
|||
Upload User Full Name |
String |
|||
Upload Username |
String |
Copy File Input
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Destination Folder Id |
String |
Folder Details Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Allow File Overwrite |
Boolean |
|||
Clean Time Days |
Number |
|||
Clean Type |
Enumeration, one of:
|
|||
Delivery Recepient Notification Type |
Enumeration, one of:
|
|||
Description |
String |
|||
Enforce Unique Filenames |
Boolean |
|||
File Mask Rule |
Enumeration, one of:
|
|||
File Masks |
String |
|||
Folder Type |
Enumeration, one of:
|
|||
Id |
String |
|||
Is Shared |
Boolean |
|||
Last Content Change Time |
String |
|||
Name |
String |
|||
New File Notification Time |
Number |
|||
New File Notification Type |
Enumeration, one of:
|
|||
New Time |
Number |
|||
Org Id |
Number |
|||
Owner |
String |
|||
Parent Id |
String |
|||
Parent Inherit Rights |
Number |
|||
Path |
String |
|||
Permission |
||||
Quota |
Number |
|||
Response Text |
String |
|||
Response Time |
Number |
|||
Response Type |
Enumeration, one of:
|
|||
Subfolder Clean Time |
Number |
|||
System Type |
Enumeration, one of:
|
|||
Upload Notification Confirmation Time |
Number |
|||
Upload Notification Confirmation Type |
Enumeration, one of:
|
I Folder Permission
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Can Add Subfolders |
Boolean |
|||
Can Change Settings |
Boolean |
|||
Can Delete |
Boolean |
|||
Can Delete Files |
Boolean |
|||
Can List Files |
Boolean |
|||
Can List Subfolders |
Boolean |
|||
Can Read Files |
Boolean |
|||
Can Write Files |
Boolean |
Create Folder Input
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Folder Name |
String |
|||
Inherit Permissions |
Enumeration, one of:
|
User Details
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Auth Method |
Enumeration, one of:
|
|||
Default Folder ID |
Number |
|||
Display Settings |
||||
String |
||||
Email Format |
Enumeration, one of:
|
|||
Expiration Policy ID |
Number |
|||
Folder Quota |
Number |
|||
Force Change Password |
Boolean |
|||
Full Name |
String |
|||
Home Folder ID |
Number |
|||
Id |
String |
|||
Language |
String |
|||
Last Login Stamp |
String |
|||
Notes |
String |
|||
Org ID |
Number |
|||
Password Change Stamp |
String |
|||
Permission |
Enumeration, one of:
|
|||
Receives Notification |
Enumeration, one of:
|
|||
Status |
Enumeration, one of:
|
|||
Status Note |
String |
|||
Username |
String |
Display Settings Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
File List Page Size |
Number |
|||
Live View Page Size |
Number |
|||
User List Page Size |
Number |
Create User Input
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
String |
||||
Force Change Password |
Boolean |
|||
Full Name |
String |
|||
Home Folder In Use Option |
Enumeration, one of:
|
|||
Home Folder Path |
String |
|||
Notes |
String |
|||
Org ID |
Number |
|||
Password |
String |
|||
Permission |
Enumeration, one of:
|
|||
Source User Id |
String |
|||
Username |
String |
Repeatable In Memory Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. |
||
Max Buffer Size |
Number |
This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which all these attributes are expressed |
Repeatable File Store Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max In Memory Size |
Number |
Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |
Paged Model Simple File Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Items |
Array of Simple File Model |
|||
Paging |
||||
Sorting |
Array of Sort Field Dto |
Simple File Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Id |
String |
|||
Name |
String |
|||
Path |
String |
|||
Size |
Number |
|||
Upload Stamp |
String |
Paging Info Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Page |
Number |
|||
Per Page |
Number |
|||
Total Items |
Number |
|||
Total Pages |
Number |
Sort Field Dto
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Sort Direction |
Enumeration, one of:
|
|||
Sort Field |
String |
Paged Model Folder Acl Entry Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Items |
Array of Folder Acl Entry Model |
|||
Paging |
||||
Sorting |
Array of Sort Field Dto |
Folder Acl Entry Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Id |
String |
|||
Name |
String |
|||
Permissions |
||||
Type |
Enumeration, one of:
|
Folder Acl Permissions Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Add Delete Subfolders |
Boolean |
|||
Admin |
Boolean |
|||
Delete Files |
Boolean |
|||
List Files |
Boolean |
|||
List Users |
Boolean |
|||
Notify |
Boolean |
|||
Read Files |
Boolean |
|||
Share |
Boolean |
|||
Write Files |
Boolean |
Paged Model Folder Content Item Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Items |
Array of Folder Content Item Model |
|||
Paging |
||||
Sorting |
Array of Sort Field Dto |
Folder Content Item Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Folder Type |
Enumeration, one of:
|
|||
Id |
String |
|||
Is Shared |
Boolean |
|||
Last Update Time |
String |
|||
Name |
String |
|||
Parent Id |
String |
|||
Path |
String |
|||
Size |
Number |
|||
Type |
Enumeration, one of:
|
Paged Model User Group Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Items |
Array of User Group Model |
|||
Paging |
||||
Sorting |
Array of Sort Field Dto |
User Group Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Description |
String |
|||
Id |
Number |
|||
Name |
String |
|||
Relationship |
Enumeration, one of:
|
Paged Model Simple Folder Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Items |
Array of Simple Folder Model |
|||
Paging |
||||
Sorting |
Array of Sort Field Dto |
Simple Folder Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Folder Type |
Enumeration, one of:
|
|||
Id |
String |
|||
Is Shared |
Boolean |
|||
Last Content Change Time |
String |
|||
Name |
String |
|||
Parent Id |
String |
|||
Path |
String |
Token Acquired Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Access Token |
String |
|||
Expires In |
Number |
|||
Refresh Token |
String |
|||
Token Type |
String |
Paged Model Simple User
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Items |
Array of Simple User |
|||
Paging |
||||
Sorting |
Array of Sort Field Dto |
Simple User
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
String |
||||
Full Name |
String |
|||
Id |
String |
|||
Last Login Stamp |
String |
|||
Org ID |
Number |
|||
Permission |
Enumeration, one of:
|
|||
Status |
Enumeration, one of:
|
|||
Username |
String |
Paged Model File Details
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Items |
Array of File Details |
|||
Paging |
||||
Sorting |
Array of Sort Field Dto |
Paged Model Group Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Items |
Array of Group Model |
|||
Paging |
||||
Sorting |
Array of Sort Field Dto |
Group Model
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Description |
String |
|||
Id |
Number |
|||
Members Count |
Number |
|||
Name |
String |
List Users Filter Input
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
String |
||||
Full Name |
String |
|||
Permission |
String |
|||
Status |
String |
|||
Username |
String |
Revoke Token Response
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Message |
String |
Update File Input
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
File Name |
String |
Update Folder Input
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Folder Name |
String |
Update User Input
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Auth Method |
Enumeration, one of:
|
|||
Default Folder Id |
Number |
|||
String |
||||
Email Format |
Enumeration, one of:
|
|||
Folder Quota |
Number |
|||
Force Change Password |
Boolean |
|||
Full Name |
String |
|||
Language |
String |
|||
Notes |
String |
|||
Password |
String |
|||
Permission |
Enumeration, one of:
|
|||
Receives Notification |
Enumeration, one of:
|
|||
Status |
Enumeration, one of:
|
|||
Status Note |
String |