Overview

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

Create an Email Monitor Task
Modify an Email Monitor Task
Read an Email 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.

For information on Task web services that are applicable to all task types, see:

Create an Email Monitor Task

	Description
URI	http://host_name/uc/resources/task
HTTP Method	POST
Description	Creates a new Email 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 Email Monitor Task: XML and JSON Examples, below.
Properties	See Properties.
Example Response	Status 200 /OK Successfully created the <task type> task with sysId <sysId>.

Modify an Email Monitor Task

	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 Email Monitor Task properties without modifying related records, use the excludeRelated property.
Example	See Email Monitor Task: XML and JSON Examples.
Properties	See Properties.
Example Response	Status 200 /OK Successfully updated the <task type> task with sysId <sysId> to version <version>.

Read an Email Monitor Task

	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 Email Monitor Task: XML and JSON Examples.) Status 404 /Not Found A task with id "f87848b00a0001037f43e7c81c8ec969" does not exist.
Properties	See Properties.

Email Monitor Task: XML and JSON Examples

The retainSysIdsand versionproperties are specified as attributes in XML.

The exportReleaseLevel and exportTable properties are specified as attributes in XML.

Examples

XML

JSON

Example for Task

XML

<taskEmailMonitor exportReleaseLevel="7.2.0.0" exportTable="ops_task_email_monitor" retainSysIds="true" version="1">
       <actions />
       <variables />
       <notes />
       <virtualResources />
       <exclusiveTasks />
       <avgRunTime>3</avgRunTime>
       <avgRunTimeDisplay>3 Seconds</avgRunTimeDisplay>
       <cpDuration />
       <cpDurationUnit>Minutes</cpDurationUnit>
       <credentials>outlook</credentials>
       <credentialsVar />
       <customField1 label="Domain">web.com</customField1>
       <customField2 />
       <efDayConstraint>Nth</efDayConstraint>
       <efDuration>00:00:00:00</efDuration>
       <efEnabled>false</efEnabled>
       <efNthAmount>10</efNthAmount>
       <efOffsetDuration />
       <efOffsetDurationUnit>Minutes</efOffsetDurationUnit>
       <efOffsetPercentage>0</efOffsetPercentage>
       <efOffsetType>Percentage</efOffsetType>
       <efTime>00:00</efTime>
       <efType>Time</efType>
       <executionRestriction>Run</executionRestriction>
       <firstRun>2021-03-15 13:59:37 -0400</firstRun>
       <holdResources>false</holdResources>
       <lastRun>2021-03-16 17:12:42 -0400</lastRun>
       <lastRunTime>9</lastRunTime>
       <lastRunTimeDisplay>9 seconds</lastRunTimeDisplay>
       <lfDayConstraint>Nth</lfDayConstraint>
       <lfDuration>00:00:00:00</lfDuration>
       <lfEnabled>false</lfEnabled>
       <lfNthAmount>1</lfNthAmount>
       <lfOffsetDuration />
       <lfOffsetDurationUnit>Minutes</lfOffsetDurationUnit>
       <lfOffsetPercentage>0</lfOffsetPercentage>
       <lfOffsetType>Percentage</lfOffsetType>
       <lfTime>00:00</lfTime>
       <lfType>Time</lfType>
       <lsDayConstraint>Nth</lsDayConstraint>
       <lsDuration>00:00:00:00</lsDuration>
       <lsEnabled>false</lsEnabled>
       <lsNthAmount>7</lsNthAmount>
       <lsTime>00:00</lsTime>
       <lsType>Time</lsType>
       <maxRunTime>9</maxRunTime>
       <maxRunTimeDisplay>9 Seconds</maxRunTimeDisplay>
       <minRunTime>3</minRunTime>
       <minRunTimeDisplay>3 Seconds</minRunTimeDisplay>
       <name>uc - Test Email</name>
       <opswiseGroups /> 
       <resolveNameImmediately>false</resolveNameImmediately>
       <resPriority>10</resPriority>
       <restrictionPeriod>Span</restrictionPeriod>
       <restrictionPeriodAfterDate>2017-11-10</restrictionPeriodAfterDate>
       <restrictionPeriodAfterTime>10:30</restrictionPeriodAfterTime>
       <restrictionPeriodBeforeDate>2017-11-20</restrictionPeriodBeforeDate>
       <restrictionPeriodBeforeTime>15:00</restrictionPeriodBeforeTime>
       <restrictionPeriodDateList />
       <runCount>32</runCount>
       <runTime>108</runTime>
       <startHeld>false</startHeld>
       <startHeldReason /> 
       <summary>Test Email</summary>
       <sysId>fb59a227517a421a92c15ff5aefe3b66</sysId>
       <timeZonePref>-- System Default --</timeZonePref>
       <twDelayAmount />
       <twDelayDuration>00:00:00:00</twDelayDuration>
       <twDelayType>None</twDelayType>
       <twWaitAmount />
       <twWaitDayConstraint>NONE</twWaitDayConstraint>
       <twWaitDuration>00:00:00:00</twWaitDuration>
       <twWaitTime>00:00</twWaitTime>
       <twWaitType>None</twWaitType>
       <twWorkflowOnly>-- System Default --</twWorkflowOnly>
       <userEstimatedDuration />
       <action>Mark As Read</action>
       <body />
       <bodyBeginMarker>TBD</bodyBeginMarker>
       <bodyEndMarker>TBD</bodyEndMarker>
       <bodyFilter>None</bodyFilter>
       <bodyVariables>None</bodyVariables>
       <caseSensitive>false</caseSensitive>
       <cc />
       <ccFilter>None</ccFilter>
       <connection>Test Email Connection</connection>
       <connectionVar />
       <contentProcessingType>None</contentProcessingType>
       <contentValue />
       <csContentProcessing>false</csContentProcessing>
       <expirationAction>failed</expirationAction>
       <filterLogic>And</filterLogic>
       <from />
       <fromFilter>None</fromFilter>
       <includeReadEmail>true</includeReadEmail>
       <mailboxFolder>true</mailboxFolder>
       <mailboxFolderDestination />
       <moveToTrash>true</moveToTrash>
       <receivedAfter>Date</receivedAfter>
       <receivedAfterDate />
       <receivedAfterOffset>00:00</receivedAfterOffset>
       <receivedBefore>Date</receivedBefore>
       <receivedBeforeDate />
       <receivedBeforeOffset>00:00</receivedBeforeOffset>
       <receivedOn>Date</receivedOn>
       <receivedOnDate />
       <receivedRestriction>None</receivedRestriction>
       <sentAfter>Date</sentAfter>
       <sentAfterDate />
       <sentAfterOffset>00:00</sentAfterOffset>
       <sentBefore>Date</sentBefore>
       <sentBeforeDate />
       <sentBeforeOffset>00:00</sentBeforeOffset>
       <sentOn>Date</sentOn>
       <sentOnDate />
       <sentRestriction>None</sentRestriction>
       <subject />
       <subjectFilter>None</subjectFilter>
       <timeLimit>12</timeLimit>
       <timeLimitUnit>Hours</timeLimitUnit>
       <to />
       <toFilter>None</toFilter>
       <useAdvancedCriteria>false</useAdvancedCriteria>
</taskEmailMonitor>

JSON

{
  "type": "taskEmailMonitor",
  "actions": {
    "abortActions": [],
    "emailNotifications": [],
    "setVariableActions": [],
    "snmpNotifications": [],
    "systemOperations": []
  },
  "action": "Mark As Read",
  "avgRunTime": 3,
  "avgRunTimeDisplay": "3 Seconds",
  "body": null,
  "bodyBeginMarker": "TBD",
  "bodyEndMarker": "TBD",
  "bodyFilter": "None",
  "bodyVariables": "None",
  "caseSensitive": false,
  "cc": null,
  "ccFilter": "None",
  "connection": "Test Email Connection",
  "connectionVar": null,
  "contentProcessingType": "None",
  "contentValue": null,
  "csContentProcessing": false,
  "cpDuration": null,
  "cpDurationUnit": "Minutes",
  "credentials": "outlook",
  "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": 0,
  "efOffsetType": "Persentage",
  "efTime": "00:00",
  "efType": "Time",
  "excludeRelated": false,
  "exclusiveTasks": [],
  "executionRestriction": "Run",
  "expirationAction": "failed",
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_task_email_monitor",
  "filterLogic": "And",
  "firstRun": "2021-03-15 13:59:37 -0400",
  "from": null,
  "fromFilter": "None",
  "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",
  "mailboxFolder": true,
  "mailboxFolderDestination": null,
  "maxRunTime": 9,
  "maxRunTimeDisplay": "9 Seconds",
  "minRunTime": 3,
  "minRunTimeDisplay": "3 Seconds",
  "moveToTrash": true,
  "name": "uc - Test Email",
  "notes": [],
  "opswiseGroups": null,
  "receivedAfter": "Date",
  "receivedAfterDate": null,
  "receivedAfterOffset": "00:00",
  "receivedBefore": "Date",
  "receivedBeforeDate": null,
  "receivedBeforeOffset": "00:00",
  "receivedOn": "Date",
  "receivedOnDate": null,
  "receivedRestriction": "None",
  "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,
  "sentAfter": "Date",
  "sentAfterDate": null,
  "sentAfterOffset": "00:00",
  "sentBefore": "Date",
  "sentBeforeDate": null,
  "sentBeforeOffset": "00:00",
  "sentOn": "Date",
  "sentOnDate": null,
  "sentRestriction": "None",
  "startHeld": false,
  "startHeldReason": null,  
  "subject": null,
  "subjectFilter": "None",
  "summary": "Test Email",
  "sysId": "fb59a227517a421a92c15ff5aefe3b66",
  "timeLimit": 12,
  "timeLimitUnit": "Hours",
  "timeZonePref": "-- System Default --",
  "to": null,
  "toFilter": "None",
  "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 --",
  "useAdvancedCriteria": false,
  "userEstimatedDuration": null,
  "variables": [],
  "version": 1,
  "virtualResources": []
}

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

See Task Web Services - Task-Related Records for XML and JSON examples of task-related records.

Properties

See All Tasks Properties
See Email Monitor Task Properties

Browser not supported