...

Universal Controller supports the following RESTful-based web services for Remote File Monitor Task operations, which are listed alphabetically on this page.

Remote File Monitor Task Web Services#Create Create a Remote File Monitor TaskRemote File Monitor Task Web Services#Modify
Modify a Remote File Monitor Task
Remote File Monitor Task Web Services#Read Read a Remote File Monitor Task

Formatting specifications for each web service, including details about parameter requirements, are provided.

Links to detailed information about the properties used in these web services also is located on this page.

...

	Description
URI	http://host_name/uc/resources/task
HTTP Method	POST
Description	Creates a new Remote File Monitor task.
Example URI	http://localhost:8080/uc/resources/task
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example	See Remote File Monitor Task: XML and JSON Examples, below.
Properties	See Remote File Monitor Task Web Services#Properties 63547265.
Example Response	Status 200 /OK Successfully created the <task type> task with sysId <sysId>.

...

	Description
URI	http://host_name/uc/resources/task
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
HTTP Method	PUT
Description	Modifies the task specified by the sysId in the request, below. To modify Remote File Monitor Task properties without modifying related records, use the excludeRelated property.
Example	See Remote File Monitor Task: XML and JSON Examples.
Properties	See Remote File Monitor Task Web Services#Properties 63547265.
Example Response	Status 200 /OK Successfully updated the <task type> task with sysId <sysId> to version <version>.

...

	Description
URI	http://host_name/uc/resources/task
HTTP Method	GET
Description	Retrieves information on the specified task.
Request Parameters	`taskid` or `taskname`
Mutually Exclusive Parameters	`taskid` and `taskname`
Example URI	http://localhost:8080/uc/resources/task?taskname=testTask http://localhost:8080/uc/resources/task?taskid=d26265a2c4f345359d9b356f18a462c1
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Response	Status 200 /OK (See Remote File Monitor Task: XML and JSON Examples.) Status 404 /Not Found A task with id "f87848b00a0001037f43e7c81c8ec969" does not exist.
Properties	See Remote File Monitor Task Web Services#Properties 63547265.

Anchor
Remote File Monitor Task XML and JSON Examples
Remote File Monitor Task XML and JSON Examples
Remote File Monitor Task: XML and JSON Examples

...

Examples

XML

JSON

Anchor

	Example for Task
	Example for Task

Example for Task

<taskFtpFileMonitor exportReleaseLevel="7.2.0.0"

Expand

title	XML

Code Block

language	text

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<taskFtpFileMonitor exportReleaseLevel="7.4.0.0" exportTable="ops_task_ftp_file_monitor" retainSysIds="true"

>

 version="

1

8">
    <variables/>

<actions

 <notes/>
    <agent>SBUS30 - AGNT0005</agent>

<variables

/>

  <agentCluster />

<notes

<agentClusterVar />
    <agentVar />

<virtualResources

   <avgRunTime>2</

>

avgRunTime>
    <avgRunTimeDisplay>2 Seconds</avgRunTimeDisplay>

<exclusiveTasks

/>

  <broadcastCluster />

<agent

<broadcastClusterVar />
    <cpDuration />

<agentCluster

/>

  <cpDurationUnit>Minutes</cpDurationUnit>

<agentClusterVar

<credentials />

<credentialsVar

<agentVar>agentVar<

agentVar

<avgRunTime>3<

<customField1/

avgRunTime

<avgRunTimeDisplay>3 Seconds</avgRunTimeDisplay

<customField2/>
    <efDayConstraint>None</efDayConstraint>

 <efDuration>00:00:00:00</efDuration>
    <efEnabled>false</efEnabled>

<broadcastClusterVar

 <efNthAmount>5</

>

efNthAmount>

<efOffsetDuration

<cpDuration

/>
    <efOffsetDurationUnit>Minutes</efOffsetDurationUnit>

<cpDurationUnit>Minutes</cpDurationUnit>

  <efOffsetPercentage>0</efOffsetPercentage>

<efOffsetType>Percentage</efOffsetType>
    <efTime>00:00</efTime>

<credentialsVar

 <efType>Time</

>

efType>
    <exclusiveWithSelf>false</exclusiveWithSelf>

 <executionRestriction>None</executionRestriction>
    <firstRun>2023-01-17 14:37:25 -0500</firstRun>

<customField2

/>

   <holdResources>false</holdResources>

<lastRun>2023-01-18 13:13:35 -0500</lastRun>

<efDuration>00

<lastRunTime>1</lastRunTime>
    <lastRunTimeDisplay>1 Seconds</lastRunTimeDisplay>
    <lfDayConstraint>None</lfDayConstraint>
    <lfDuration>00:00:00:00</

efDuration>

lfDuration>
    <lfEnabled>false</lfEnabled>

<efEnabled>false</efEnabled>

  <lfNthAmount>5</lfNthAmount>
    <lfOffsetDuration

<efNthAmount>10<

efNthAmount

<efOffsetDuration

 <lfOffsetDurationUnit>Minutes</

>
       <efOffsetDurationUnit>Minutes</efOffsetDurationUnit>
       <efOffsetPercentage>0</efOffsetPercentage>
       <efOffsetType>Percentage</efOffsetType>
       <efTime>00:00</efTime>

lfOffsetDurationUnit>
    <lfOffsetPercentage>0</lfOffsetPercentage>
    <lfOffsetType>Percentage</lfOffsetType>
    <lfTime>00:00</lfTime>
    <lfType>Time</lfType>

<logLevel>Inherited</logLevel>
    <lsDayConstraint>None</lsDayConstraint>

  <lsDuration>00:00:00:00</lsDuration>
    <lsEnabled>false</lsEnabled>

<firstRun>2021-03-15

13:59:37 -0400</firstRun>

 <lsNthAmount>5</lsNthAmount>
    <lsTime>00:00</lsTime>

<holdResources>false</holdResources>

  <lsType>Time</lsType>
    <maxRunTime>2</maxRunTime>

<maxRunTimeDisplay>2 Seconds</maxRunTimeDisplay>
    <minRunTime>1</minRunTime>

  <minRunTimeDisplay>1 Seconds</minRunTimeDisplay>

<lastRunTimeDisplay>9 seconds</lastRunTimeDisplay>

 <name>ftp-mon-1</name>
    <actions/>

<lfDayConstraint>Nth<

<opswiseGroups/

lfDayConstraint

>
    <resPriority>10</resPriority>

  <resolveNameImmediately>false</resolveNameImmediately>
    <restrictionPeriod>None</restrictionPeriod>
    <restrictionPeriodAfterDate

<lfEnabled>false<

lfEnabled

>
    <restrictionPeriodAfterTime />
    <restrictionPeriodBeforeDate

<lfNthAmount>1<

lfNthAmount

<lfOffsetDuration

<restrictionPeriodBeforeTime />

       <lfOffsetDurationUnit>Minutes</lfOffsetDurationUnit>
       <lfOffsetPercentage>0</lfOffsetPercentage>
       <lfOffsetType>Percentage</lfOffsetType>
       <lfTime>00:00</lfTime>


    <restrictionPeriodDateList/>
    <runCount>9</runCount>
    <runTime>14</runTime>

<startHeld>false</startHeld>

<startHeldReason

<lsDayConstraint>Nth<

lsDayConstraint

<lsDuration>00:00:00:00</lsDuration

<summary />
    <sysId>b0b026ac3a5747d3961d10a0e956f24a</sysId>

<lsEnabled>false</lsEnabled

  <exclusiveTasks/>

<lsNthAmount>7</lsNthAmount

<virtualResources/>
    <timeZonePref>-- System Default --<

lsTime>00:00</lsTime>

/timeZonePref>

<twDelayAmount

<lsType>Time<

lsType


    <twDelayDuration>00:00:00:00</twDelayDuration>

  <twDelayType>None</twDelayType>

<maxRunTimeDisplay>9

<twWaitAmount

Seconds<

maxRunTimeDisplay


    <twWaitDayConstraint>None</twWaitDayConstraint>

   <twWaitDuration>00:00:00:00</twWaitDuration>

<minRunTimeDisplay>3 Seconds</minRunTimeDisplay>

 <twWaitTime>00:00</twWaitTime>
    <twWaitType>None</twWaitType>

<name>uc

 <twWorkflowOnly>-- System

Test

Default

Email</name>

--</twWorkflowOnly>
    <userEstimatedDuration

<opswiseGroups

/>
    <authenticatePeer>false</authenticatePeer>

<resolveNameImmediately>false</resolveNameImmediately>

 <ftpFmtype>Exist</ftpFmtype>
    <jobcard />
    <listOptions

<resPriority>10<

resPriority

>
    <minFileScale>KB</minFileScale>

  <minFileSize />
    <outputFailureOnly>false</outputFailureOnly>

<outputReturnNline>90</outputReturnNline>
    <outputReturnSline>1</outputReturnSline>

<restrictionPeriodAfterTime>10:30</restrictionPeriodAfterTime

<outputReturnText />
    <outputReturnType>OUTERR</outputReturnType>

  <pollInterval>30</pollInterval>
    <pollMaximum

<restrictionPeriodBeforeTime>15:00<

restrictionPeriodBeforeTime

>
    <remoteCredVar />

<restrictionPeriodDateList

/>

  <remoteCredentials>ftp-cred-1</remoteCredentials>

<remoteFilename>/home/qatest/shammi_testing/test.txt</remoteFilename>

<remoteServer>qa-sage</remoteServer>

<startHeld>false</startHeld>

<servertype>FTP</servertype>

<stableSeconds

<startHeldReason

/>
    <transferMode>Passive</transferMode>

<summary

  <useRegex>false</

>

useRegex>

<verifyHostName>false</verifyHostName>
    <wait>false</wait>

<timeZonePref>--

System

Default

<waitForOutput>true</waitForOutput>

--

</

timeZonePref>

taskFtpFileMonitor>

Expand

title	JSON

Code Block

language	text

{
    "type": "taskFtpFileMonitor",

<twDelayAmount

/>

  "actions":

     "abortActions": [],

"emailNotifications": [],

"setVariableActions": [],

"snmpNotifications": [],

"systemOperations": []
    },

"agent": "SBUS30 - AGNT0005",

<twWorkflowOnly>-- System Default --</twWorkflowOnly>

"agentCluster": null,
    "agentClusterVar": null,

<userEstimatedDuration

/>

 "agentVar": null,

"authenticatePeer": false,
    "avgRunTime":

<ftpFmtype>Exist</ftpFmtype>

2,
    "avgRunTimeDisplay":

<jobcard /> <listOptions /> <minFileScale>KB</minFileScale> <minFileSize>10</minFileSize> <pollInterval>30</pollInterval> <pollMaximum>2</pollMaximum> <remoteCredentials /> <remoteCredVar>credVar</remoteCredVar> <remoteFilename>${demo_ops_download_dir}/ftpfile.txt</remoteFilename> <remoteServer>test.com</remoteServer> <servertype>FTP</servertype> <stableSeconds /> <transferMode>Passive</transferMode> <useRegex>false</useRegex>
<veridyHostName>true</veridyHostName> <wait>true</wait> </taskFtpFileMonitor>

Expand

title	JSON

{ "type": "taskFtpFileMonitor", "actions": {

"2 Seconds",
    "broadcastCluster": null,
    "broadcastClusterVar": null,
    "cpDuration": null,
    "

abortActions

cpDurationUnit":

[]

"Minutes",
    "

emailNotifications

credentials":

[]

null,
    "

setVariableActions

credentialsVar":

[],

null,
    "customField1": {
        "

snmpNotifications

label":

[],

 null,
        "

systemOperations

value": null

[]

    },
    "

agent

customField2":

null,

"agentCluster":

"uc

Demo

Cluster",

agentClusterVar

label": null,

"agentVar":

null,

"authenticatePeer":

true,

avgRunTime

value": null

3,

"avgRunTimeDisplay":

"3

Seconds"

},
    "

broadcastCluster

efDayConstraint":

null

"None",
    "

broadcastClusterVar

efDuration":

null

"00:00:00:00",
    "

cpDuration

efEnabled":

null

false,
    "

cpDurationUnit

efNthAmount":

"Minutes"

5,
    "

credentials

efOffsetDuration": null,
    "

credentialsVar

efOffsetDurationUnit":

null

"Minutes",
    "

customField1

efOffsetPercentage":

{

0,
    "

label

efOffsetType": "

Domain

Percentage",
    "

value

efTime": "

http://qa-cntlr-mssql:8080/uc/" },

00:00",
    "

customField2

efType":

{

"Time",
    "

label

exclusiveTasks":

null

[],
    "

value

exclusiveWithSelf":

null

false,

},

efDayConstraint

executionRestriction": "

Nth Day

None",
    "

efDuration

exportReleaseLevel": "

00:00:00:00

7.4.0.0",
    "

efEnabled

exportTable":

false,

"ops_task_ftp_file_monitor",
    "

efNthAmount": 10, "efOffsetDuration": null,
"efOffsetDurationUnit

firstRun": "2023-01-17 14:37:25 -0500",
    "ftpFmtype": "

Minutes

Exist",

efOffsetPercentage

holdResources":

0,

false,
    "

efOffsetType

jobcard":

"Percentage",

null,
    "

efTime

lastRun": "

00:00

2023-01-18 13:13:35 -0500",
    "

efType

lastRunTime":

"Time"

1,
    "

excludeRelated

lastRunTimeDisplay":

false,

"1 Seconds",
    "

exclusiveTasks

lfDayConstraint":

[]

"None",
    "

executionRestriction

lfDuration": "

Run

00:00:00:00",

exportReleaseLevel

lfEnabled":

"7.2.0.0",

false,
    "

exportTable

lfNthAmount":

"ops_task_manual",
"firstRun": "2021-03-15 13:59:37 -0400"

5,
    "lfOffsetDuration": null,
    "

ftpFmtype

lfOffsetDurationUnit": "

Exist

Minutes",
    "

holdResources

lfOffsetPercentage":

false

0,

lastRun

lfOffsetType": "

2021-03-16 17:12:42 -0400

Percentage",

"lastRunTime":

9,

lastRunTimeDisplay

lfTime": "

9 Seconds

00:00",
    "

lfDayConstraint

lfType": "

Nth Day

Time",
    "

lfDuration

listOptions":

"00:00:00:00"

null,
    "

lfEnabled

logLevel":

false

"Inherited",
    "

lfNthAmount

lsDayConstraint":

1

"None",

"lfOffsetDuration":

null,

lfOffsetDurationUnit

lsDuration":

"Minutes",
"lfOffsetPercentage

"00:00:00:00",
    "lsEnabled":

0,

false,
    "

lfOffsetType

lsNthAmount":

"Percentage",

5,
    "

lfTime

lsTime": "00:00",
    "

lfType

lsType": "Time",
    "

lsDayConstraint

maxRunTime":

"Nth Day",

2,
    "

lsDuration

maxRunTimeDisplay": "

00:00:00:00

2 Seconds",
    "

lsEnabled

minFileScale":

false

"KB",
    "

lsNthAmount

minFileSize":

7

null,
    "

lsTime

minRunTime":

"00:00",

1,
    "

lsType

minRunTimeDisplay": "

Time

1 Seconds",

"maxRunTime":

9,

maxRunTimeDisplay

name": "

9 Seconds

ftp-mon-1",
    "

minFileScale

notes":

"KB"

[],
    "

minFileSize

opswiseGroups":

10

[],

minRunTime

outputFailureOnly":

3

false,

minRunTimeDisplay

outputReturnNline": "

3 Seconds

90",
    "

name

outputReturnSline": "

uc - Test Email",

1",
    "

notes

outputReturnText":

[]

null,
    "

opswiseGroups

outputReturnType":

null

"OUTERR",
    "pollInterval": 30,
    "pollMaximum":

2

null,
    "

remoteCredentials

remoteCredVar": null,
    "

remoteCredVar

remoteCredentials": "

credVar

ftp-cred-1",
    "remoteFilename": "

${demo_ops_download_dir}/ftpfile

/home/qatest/shammi_testing/test.txt",
    "remoteServer": "

test.com

qa-sage",
    "

resolveNameImmediately

resPriority":

false

10,
    "

resPriority

resolveNameImmediately":

10

false,
    "restrictionPeriod": "

Span

None",
    "restrictionPeriodAfterDate":

"2017-11-10",

null,
    "restrictionPeriodAfterTime":

"10:30"

null,
    "restrictionPeriodBeforeDate":

"2017-11-20",

null,
    "restrictionPeriodBeforeTime":

"15:00",

null,
    "restrictionPeriodDateList": [],
    "retainSysIds": true,


    "runCount":

32

9,


    "runTime":

108

14,
    "servertype": "FTP",
    "stableSeconds": null,
    "startHeld": false,
    "startHeldReason": null,
    "summary":

"Test Email",

null,
    "sysId": "

fb59a227517a421a92c15ff5aefe3b66

b0b026ac3a5747d3961d10a0e956f24a",
    "timeZonePref": "-- System Default --",
    "transferMode": "Passive",
    "twDelayAmount": null,
    "twDelayDuration": "00:00:00:00",
    "twDelayType": "None",
    "twWaitAmount": null,
    "twWaitDayConstraint": "

NONE

None",
    "twWaitDuration": "00:00:00:00",
    "twWaitTime": "00:00",
    "twWaitType": "None",
    "twWorkflowOnly": "-- System Default --",
    "useRegex": false,
    "userEstimatedDuration": null,
    "variables": [],


    "verifyHostName":

true

false,
    "version":

1

8,


    "virtualResources": [],
    "wait": false,
    "waitForOutput": true
}

See Task Web Services - Task Actions for XML and JSON examples of task actions.

...

Versions Compared

Old Version 1

New Version 2

Key

Anchor
Remote File Monitor Task XML and JSON Examples
Remote File Monitor Task XML and JSON Examples
Remote File Monitor Task: XML and JSON Examples

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

AnchorRemote File Monitor Task XML and JSON ExamplesRemote File Monitor Task XML and JSON ExamplesRemote File Monitor Task: XML and JSON Examples

Anchor
Remote File Monitor Task XML and JSON Examples
Remote File Monitor Task XML and JSON Examples
Remote File Monitor Task: XML and JSON Examples