...

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

Agent File Monitor Task Web Services#Create Create an Agent File Monitor TaskAgent File Monitor Task Web Services#Modify
Modify an Agent File Monitor Task
Agent File Monitor Task Web Services#Read Read an Agent File Monitor Task

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

...

	Description
URI	http://host_name/uc/resources/task
HTTP Method	POST
Description	Creates a new Agent File Monitor task. To persist sysIds, use the retainSysIds property.
Example URI	http://localhost:8080/uc/resources/task
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example	See Agent File Monitor Task: XML and JSON Examples, below.
Properties	See Agent File Monitor Task Web Services#PropertiesProperties.
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. To modify Agent File Monitor Task properties without modifying related records, use the excludeRelated property.
Example	See Agent File Monitor Task: XML and JSON Examples.
Properties	See Agent File Monitor Task Web Services#Properties Properties.
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 Agent File Monitor Task: XML and JSON Examples.) Status 404 /Not Found A task with id "f87848b00a0001037f43e7c81c8ec969" does not exist.
Properties	See Agent File Monitor Task Web Services#PropertiesProperties.

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

...

Examples

XML

JSON

Example for Task

Expand

Code Block

title	XML

<taskFileMonitor exportReleaseLevel="7.2.0.0" exportTable="ops_task_file_monitor" retainSysIds="true" version="1">

<actions

<actions />

<variables

<variables />

<notes

<notes />

<virtualResources

<virtualResources />

<exclusiveTasks

<exclusiveTasks />

<agent

<agent />

<agentCluster>uc

<agentCluster>uc Demo Cluster</

agentCluster>

agentCluster>

<agentClusterVar

<agentClusterVar />

<agentVar

<agentVar />

<avgRunTime>3</avgRunTime>

<avgRunTimeDisplay>3

<avgRunTimeDisplay>3 Seconds</

avgRunTimeDisplay>

avgRunTimeDisplay>

<broadcastCluster

<broadcastCluster />

<broadcastClusterVar

<broadcastClusterVar />

<cpDuration

<cpDuration />

<cpDurationUnit>Minutes</cpDurationUnit>

<cpDurationUnit>Minutes</cpDurationUnit>

<credentials

<credentials />

<credentialsVar

<credentialsVar />

<customField1

<customField1 label="Domain">web.com</

customField1>

customField1>

<customField2

<customField2 />

<efDayConstraint>Nth</efDayConstraint>

<efDuration>00

<efDuration>00:00:00:00</

efDuration>

efDuration>

<efEnabled>false</efEnabled>

<efEnabled>false</efEnabled>

<efNthAmount>10</efNthAmount>

<efOffsetDuration

<efOffsetDuration/>

<efOffsetDurationUnit>Minutes</efOffsetDurationUnit>

<efOffsetDurationUnit>Minutes</efOffsetDurationUnit>

<efOffsetPercentage>0</efOffsetPercentage>

<efOffsetType>Percentage<\efOffsetType>

<efOffsetType>Percentage<\efOffsetType>

<efTime>00

<efTime>00:00</

efTime>

efTime>

<efType>Time</efType>

<executionRestriction>Run</executionRestriction>

<firstRun>2021

<firstRun>2021-03-15 13:59:37 -0400</

firstRun>

firstRun>

<holdResources>false</holdResources>

<holdResources>false</holdResources>

<lastRun>2021

<lastRun>2021-03-16 17:12:42 -0400</

lastRun>

lastRun>

<lastRunTime>9</lastRunTime>

<lastRunTimeDisplay>9

<lastRunTimeDisplay>9 seconds</

lastRunTimeDisplay>

lastRunTimeDisplay>

<lfDayConstraint>Nth</lfDayConstraint>

<lfDuration>00

<lfDuration>00:00:00:00</

lfDuration>

lfDuration>

<lfEnabled>false</lfEnabled>

<lfEnabled>false</lfEnabled>

<lfNthAmount>1</lfNthAmount>

<lfOffsetDuration

<lfOffsetDuration/>

<lfOffsetDurationUnit>Minutes</lfOffsetDurationUnit>

<lfOffsetDurationUnit>Minutes</lfOffsetDurationUnit>

<lfOffsetPercentage>0</lfOffsetPercentage>

<lfOffsetType>Percentage<\lfOffsetType>

<lfOffsetType>Percentage<\lfOffsetType>

<lfTime>00

<lfTime>00:00</

lfTime>

lfTime>

<lfType>Time</lfType>

<lsDayConstraint>Nth</lsDayConstraint>

<lsDuration>00

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

lsDuration>

lsDuration>

<lsEnabled>false</lsEnabled>

<lsEnabled>false</lsEnabled>

<lsNthAmount>7</lsNthAmount>

<lsTime>00

<lsTime>00:00</

lsTime>

lsTime>

<lsType>Time</lsType>

<maxRunTime>9</maxRunTime>

<maxRunTimeDisplay>9

<maxRunTimeDisplay>9 Seconds</

maxRunTimeDisplay>

maxRunTimeDisplay>

<minRunTime>3</minRunTime>

<minRunTimeDisplay>3

<minRunTimeDisplay>3 Seconds</

minRunTimeDisplay>

minRunTimeDisplay>

<name>uc

<name>uc - Test Email</

name>

name>

<opswiseGroups

<opswiseGroups />

<resolveNameImmediately>false</resolveNameImmediately>

<resolveNameImmediately>false</resolveNameImmediately>

<resPriority>10</resPriority>

<restrictionPeriod>Span</restrictionPeriod>

<restrictionPeriodAfterDate>2017

<restrictionPeriodAfterDate>2017-11-10</

restrictionPeriodAfterDate>

restrictionPeriodAfterDate>

<restrictionPeriodAfterTime>10

<restrictionPeriodAfterTime>10:30</

restrictionPeriodAfterTime>

restrictionPeriodAfterTime>

<restrictionPeriodBeforeDate>2017

<restrictionPeriodBeforeDate>2017-11-20</

restrictionPeriodBeforeDate>

restrictionPeriodBeforeDate>

<restrictionPeriodBeforeTime>15

<restrictionPeriodBeforeTime>15:00</

restrictionPeriodBeforeTime>

restrictionPeriodBeforeTime>

<restrictionPeriodDateList

<restrictionPeriodDateList />

<runCount>32</runCount>

<runTime>108</runTime>

<startHeld>false</startHeld>

<startHeld>false</startHeld>

<startHeldReason

<startHeldReason />

<summary>Test

<summary>Test Email</

summary>

summary>

<sysId>fb59a227517a421a92c15ff5aefe3b66</sysId>

<timeZonePref>-- System Default --</

timeZonePref>

timeZonePref>

<twDelayAmount

<twDelayAmount />

<twDelayDuration>00

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

twDelayDuration>

twDelayDuration>

<twDelayType>None</twDelayType>

<twWaitAmount

<twWaitAmount />

<twWaitDayConstraint>NONE</twWaitDayConstraint>

<twWaitDuration>00

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

twWaitDuration>

twWaitDuration>

<twWaitTime>00

<twWaitTime>00:00</

twWaitTime>

twWaitTime>

<twWaitType>None</twWaitType>

<twWorkflowOnly>-- System Default --</

twWorkflowOnly>

twWorkflowOnly>

<userEstimatedDuration

<userEstimatedDuration />

<byPercentage

<byPercentage />

<byScale>1024</byScale>

<bySize

<bySize />

<fileName>$

<fileName>${demo_ops_download_dir}/</

fileName>

fileName>

<fileOwner>file

<fileOwner>file owner</

fileOwner>

fileOwner>

<fmtype>Exist</fmtype>

<fmtype>Exist</fmtype>

<maxFiles

<maxFiles />

<minFileScale>KB</minFileScale>

<minFileSize

<minFileSize />

<recursive>true</recursive>

<scanForward>false</scanForward>

<scanForward>false</scanForward>

<scanText

<scanText />

<stableSeconds

<stableSeconds />

<toScale>1024</toScale>

<toSize

<toSize />

<triggerOnExist>false</triggerOnExist>

<triggerOnExist>false</triggerOnExist>

<useRegex>true</useRegex>
</taskFileMonitor>

Expand

Code Block

title	JSON

{
  "type": "taskFileMonitor",
  "actions": {
    "abortActions": [],
    "emailNotifications": [],
    "setVariableActions": [],
    "snmpNotifications": [],
    "systemOperations": []
  },
  "agent": null,
  "agentCluster": "uc Demo Cluster",
  "agentClusterVar": null,
  "agentVar": null,


  "avgRunTime": 3,


  "avgRunTimeDisplay": "3 Seconds",
  "broadcastCluster": null,
  "broadcastClusterVar": null,
  "byPercentage": null,
  "byScale": "1024",
  "bySize": null, 
  "cpDuration": null,
  "cpDurationUnit": "Minutes",
  "credentials": null,
  "credentialsVar": null,
  "customField1": {
    "label": "Domain",
    "value": "http://qa-cntlr-mssql:8080/uc/"
  },
  "customField2": {
    "label": null,
    "value": null
  },
  "efDayConstraint": "Nth Day",
  "efDuration": "00:00:00:00",
  "efEnabled": false,
  "efNthAmount": 10,
  "efOffsetDuration": null,
  "efOffsetDurationUnit": "Minutes",
  "efOffsetPercentage": 1,
  "efOffsetType": "Percentage",
  "efTime": "00:00",
  "efType": "Time",
  "excludeRelated": false,
  "exclusiveTasks": [],
  "executionRestriction": "Run",


  "exportReleaseLevel": "7.2.0.0",


  "exportTable": "ops_task_file_monitor",


  "fileName": "${demo_ops_download_dir}",
  "fileOwner": "file owner",


  "firstRun": "2021-03-15 13:59:37 -0400",
  "fmtype": "Exist",
  "holdResources": false,


  "lastRun": "2021-03-16 17:12:42 -0400",


  "lastRunTime": 9,


  "lastRunTimeDisplay": "9 Seconds",
  "lfDayConstraint": "Nth Day",
  "lfDuration": "00:00:00:00",
  "lfEnabled": false,
  "lfNthAmount": 1,
  "lfOffsetDuration": null,
  "lfOffsetDurationUnit": "Minutes",
  "lfOffsetPercentage": 0,
  "lfOffsetType": "Percentage",
  "lfTime": "00:00",
  "lfType": "Time",
  "lsDayConstraint": "Nth Day",
  "lsDuration": "00:00:00:00",
  "lsEnabled": false,
  "lsNthAmount": 7,
  "lsTime": "00:00",
  "lsType": "Time",
  "maxFiles": null,

  "maxRunTime": 9,


  "maxRunTimeDisplay": "9 Seconds",
  "minFileScale": "KB", 
  "minFileSize": null,

  "minRunTime": 3,


  "minRunTimeDisplay": "3 Seconds",
  "name": "uc - Test Email",
  "notes": [],
  "opswiseGroups": null, 
  "recursive": true,
  "resolveNameImmediately": false,
  "resPriority": 10,
  "restrictionPeriod": "Span",
  "restrictionPeriodAfterDate": "2017-11-10",
  "restrictionPeriodAfterTime": "10:30",
  "restrictionPeriodBeforeDate": "2017-11-20",
  "restrictionPeriodBeforeTime": "15:00",
  "restrictionPeriodDateList": [],
  "retainSysIds": true,


  "runCount": 32,


  "runTime": 108,
  "scanForward": false,
  "scanText": null, 
  "stableSeconds": null,
  "startHeld": false,
  "startHeldReason": null,  
  "summary": "Test Email",
  "sysId": "fb59a227517a421a92c15ff5aefe3b66",
  "timeZonePref": "-- System Default --",
  "toScale": 1024,
  "toSize": null,
  "triggerOnExist": false,
  "twDelayAmount": null,
  "twDelayDuration": "00:00:00:00",
  "twDelayType": "None",
  "twWaitAmount": null,
  "twWaitDayConstraint": "NONE",
  "twWaitDuration": "00:00:00:00",
  "twWaitTime": "00:00",
  "twWaitType": "None",
  "twWorkflowOnly": "-- System Default --",
  "useRegex": true,
  "userEstimatedDuration": null,
  "variables": [],
  "version": 1
}

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

...

Versions Compared

Old Version 1

New Version Current

Key

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

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

AnchorAgent File Monitor Task XML and JSON ExamplesAgent File Monitor Task XML and JSON ExamplesAgent File Monitor Task: XML and JSON Examples

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