Updating Monitored Directory Configuration

AdminStudio 2024 R2 | 28.0 | AdminStudio REST APIs

Edition:REST APIs are enabled with AdminStudio Enterprise Edition.

When you send this request, it updates the existing Monitored Directory using the Monitored Directory ID.

Updating Monitored Directory Configuration

Request Type

Description

API

http://localhost:8086/catalog/ASMonitoredDirectory

{

"MonitoredDirectoryId" : "9",

"MonitoredDirectoryName" : "MonitoredDirectory",

"MonitoredGroupPath" : "Applications",

"MonitoredDirectoryPath" : "C:\\Users\\administrator\\Desktop\\Test",

"MonitoredDirectoryWindowsAuthentication" : "false",

"MonitoredDirectoryUsername" : "XX\\XXXXXX",

"MonitoredDirectoryPassword":"XXXXXX",

"WorkflowId" :"2",

"AlternateDirectory":"2",

"MonitoredDirectoryAlternateDirectory": "C:\\Users\\administrator\\Desktop\\Test1",

"AlternateDirectoryWindowsAuthentication" : "false",

"AlternateDirectoryUsername" : "XX\\XXXXXX",

"AlternateDirectoryPassword" : "XXXXXX",

"IsAutomated" : "true"

}

Method

POST

Parameters
• MonitoredDirectoryId= Use to specify the existing Monitored Directory ID which needs to be updated.
• MonitoredDirectoryName = Use to specify the name of the Monitored Directory.
• MonitoredGroupPath = Use to specify the group path.
• MonitoredDirectoryPath = Use to specify the shared monitored directory path.
• MonitoredDirectoryWindowsAuthentication = Use to specify whether the Monitored Directory path connection should use Windows Authentication or a custom user name and password. Available options are:
• False = Do not use Windows Authentication
• True = Use Windows Authentication
• MonitoredDirectoryUsername = If not using Windows Authentication, use this parameter to specify the user name to use when connecting to the Monitored Directory.
• MonitoredDirectoryPassword = If not using Windows Authentication, use this parameter to specify the password to use when connecting to the Monitored Directory.
• WorkflowId = Use to specify the Workflow ID.
• AlternateDirectory = Use to specify if an alternate directory is to be used for package processing. It corresponds to the Alternate Location field in the Monitored Directory settings. Available options are:
• 0= Not Required
• 1= Copy to Alternate Location
• 2= Move to Alternate Location
• MonitoredDirectoryAlternateDirectory = Use to specify the path of the alternate directory where packages will be copied or moved based on the selected option in the Alternate Directory field.
• AlternateDirectoryWindowsAuthentication = Use to specify whether the connection to the alternate directory should use Windows Authentication or a custom username and password. Available options are:
• False = Do not use Windows Authentication
• True = Use Windows Authentication
• AlternateDirectoryUsername = If not using Windows Authentication, use this parameter to specify the username for connecting to the alternate directory.
• AlternateDirectoryPassword = If not using Windows Authentication, use this parameter to specify the password for connecting to the alternate directory.
• IsAutomated = Use to specify if the package handling process should be automated. Set to True for automated processing; otherwise, set to False.

Connection Info

Provides the connection information of the package as mentioned in Setting Up Connection to Run REST APIs 

Response

Example:

http://localhost:8086/catalog/ASMonitoredDirectory

Response:

<data>Monitored Directory Updated succesfully</data>