...

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

Task Monitor Task Web Services#Create Create a Task Monitor TaskTask Monitor Task Web Services#Modify
Modify a Task Monitor Task
Task Monitor Task Web Services#Read Read a Task Monitor Task

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

...

Anchor

	Create a Task Monitor Task
	Create a Task Monitor Task

Create a Task Monitor Task

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

Anchor

	Modify a Task Monitor Task
	Modify a Task Monitor Task

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

Anchor

	Read a Task Monitor Task
	Read a Task Monitor Task

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

Anchor

	Task Monitor Task XML and JSON Examples
	Task Monitor Task XML and JSON Examples

Task Monitor Task: XML and JSON Examples

The retainSysIds and version properties are specified as attributes in XML.

The exportReleaseLevel and /wiki/spaces/UC71x/pages/5179227 properties are specified as attributes in XML.

Examples

XML

JSON

Example for Task

Expand

title	XML

Code Block

language	text

<taskMonitor exportReleaseLevel="7.2.0.0" exportTable="ops_task_monitor" retainSysIds="true" version="1">

<actions

<actions />

<variables

<variables />

<notes

<notes />

<virtualResources

<virtualResources />

<exclusiveTasks

<exclusiveTasks />

<avgRunTime>3</avgRunTime>

<avgRunTimeDisplay>3

<avgRunTimeDisplay>3 Seconds</

avgRunTimeDisplay>

avgRunTimeDisplay>

<cpDuration

<cpDuration />

<cpDurationUnit>Minutes</cpDurationUnit>

<cpDurationUnit>Minutes</cpDurationUnit>

<credentials

<credentials />

<credentialsVar

<credentialsVar />

<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 />
       <efOffsetDurationUnit>Minutes</efOffsetDurationUnit>
       <efOffsetPercentage>0</efOffsetPercentage>
       <efOffsetType>Percentage</efOffsetType>
       <efTime>00:00</efTime>

<efNthAmount>10</efNthAmount>
       <efOffsetDuration />
       <efOffsetDurationUnit>Minutes</efOffsetDurationUnit>

     <efOffsetPercentage>0</efOffsetPercentage>

<efOffsetType>Percentage</efOffsetType>

 <efTime>00:00</efTime>

<holdResources>false</holdResources>

<efType>Time</efType>
       <executionRestriction>Run</executionRestriction>

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

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

lastRun>

firstRun>

<holdResources>false</holdResources>

<lastRunTimeDisplay>9 seconds</lastRunTimeDisplay>

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

<lastRunTime>9</lastRunTime>

<lfDuration>00

<lastRunTimeDisplay>9 seconds</lastRunTimeDisplay>
       <lfDayConstraint>Nth</lfDayConstraint>
       <lfDuration>00:00:00:00</

lfDuration>

lfDuration>

<lfEnabled>false</lfEnabled>

<lfEnabled>false</lfEnabled>

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

<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>

<lsDuration>00:00:00

<lsTime>00:00</

lsDuration>

lsTime>

<lsEnabled>false</lsEnabled>

<lsType>Time</lsType>

<maxRunTime>9</maxRunTime>
       <maxRunTimeDisplay>9

Seconds</maxRunTimeDisplay>

<minRunTime>3</minRunTime>
       <minRunTimeDisplay>3

Seconds</minRunTimeDisplay>

<maxRunTimeDisplay>9

Seconds</maxRunTimeDisplay>

<monitorEarlyFinish>false</monitorEarlyFinish>

<monitorLateFinish>false</monitorLateFinish>

<minRunTimeDisplay>3

Seconds<

<monitorLateStart>false</

minRunTimeDisplay>

monitorLateStart>

<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>

<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 />

<expirationAction>Finished</expirationAction>

<expirationAction>Finished</expirationAction>

<monType>General</monType>

<monType>General</monType>

<relativeTimeFrom>00

<relativeTimeFrom>00:00</

relativeTimeFrom>

relativeTimeFrom>

<relativeTimeTo

<relativeTimeTo />

<statusText>Defined

<statusText>Defined, Waiting, Time Wait, Held, Exclusive Requested,
              Exclusive Wait, Resource Requested, Resource Wait, Execution Wait,
              Undeliverable, Queued, Submitted, Action Required, Started, Running,
              Running/Problems, Cancel Pending, In Doubt, Start Failure,
              Confirmation Required, Cancelled, Failed, Skipped, Finished, Success
       </

statusText>

statusText>

<taskNameLookup>Contains</taskNameLookup>

<taskNameLookup>Contains</taskNameLookup>

<timeScope>Relative</timeScope>

<timeScope>Relative</timeScope>

<typeText>Workflow

<typeText>Workflow, Timer, Windows, Linux/Unix, z/OS, File Monitor,
          Manual, Email, File Transfer, SQL, FTP File Monitor, Task Monitor, 
          Variable Monitor, Stored Procedure, Universal Command, System Monitor, 
          Application Control, SAP, Email Monitor, Web Service, 
          Universal</

typeText>

typeText>

<wfConditionType>Starts

<wfConditionType>Starts With</

wfConditionType>

wfConditionType>

<wfConditionValue>test</wfConditionValue>
</taskMonitor>

Expand

title	JSON

Code Block

language	text

{
  "type": "taskMonitor",
  "actions": {
    "abortActions": [],
    "emailNotifications": [],
    "setVariableActions": [],
    "snmpNotifications": [],
    "systemOperations": []
  },


  "avgRunTime": 3,


  "avgRunTimeDisplay": "3 Seconds",
  "cpDuration": null,
  "cpDurationUnit": "Minutes",
  "credentials": null,
  "credentialsVar": null,
   "customField1": {
    "label

": "Domain"

": null,
    "value":

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

null
  },
  "customField2": {
    "label": null,
    "value": null
  },
  "efDayConstraint": "Nth Day",
  "efDuration": "00:00:00:00",
  "efEnabled": false,
  "efNthAmount": 10,

 "efOffsetDuration": null,

 "efOffsetDurationUnit": "Minutes",


  "efOffsetPercentage": 0,


  "efOffsetType": "Percentage",


  "efTime": "00:00",
  "efType": "Time",
  "excludeRelated": false,
  "exclusiveTasks": [],
  "executionRestriction": "Run",


  "expirationAction": "Finished",


  "exportReleaseLevel": "7.2.0.0",


  "exportTable": "ops_task_monitor",


  "firstRun": "2021-03-15 13:59:37 -0400",
  "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",


  "maxRunTime": 9,


  "maxRunTimeDisplay": "9 Seconds",


  "minRunTime": 3,


  "minRunTimeDisplay": "3 Seconds",
  "monitorEarlyFinish": false,
  "monitorLateFinish": false,
  "monitorLateStart": false,
  "monType": "General",
  "name": "uc - Test Email",
  "notes": [],
  "opswiseGroups": null, 
  "relativeTimeFrom": "00:00",
  "relativeTimeTo": null,
  "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,
  "startHeld": false,
  "startHeldReason": null,
  "statusText": "Success",
  "summary": "Test Email",
  "sysId": "fb59a227517a421a92c15ff5aefe3b66",


  "taskNameLookup": "Contains",


  "timeScope": "Relative",
  "timeZonePref": "-- System Default --",
  "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 --",
  "typeText": "Workflow, Timer, Windows, Linux/Unix, z/OS, File Monitor,
     Manual, Email, File Transfer, SQL, FTP File Monitor, Task Monitor, 
     Variable Monitor, Stored Procedure, Universal Command, System Monitor, 
     Application Control, SAP, Email Monitor, Web Service, Universal",
  "userEstimatedDuration": null,
  "variables": [],
  "version": 1,
  "virtualResources": [],
  "wfConditionType": "Starts With",
  "wfConditionValue": "test"
}

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.

Anchor

	Properties
	Properties

Properties

See All Tasks Properties
See Task Monitor Task Properties

Versions Compared

Old Version 1

New Version Current

Key

Create a Task Monitor Task

Modify a Task Monitor Task

Read a Task Monitor Task

Task Monitor Task: XML and JSON Examples

Properties

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Create a Task Monitor Task

Modify a Task Monitor Task

Read a Task Monitor Task

Task Monitor Task: XML and JSON Examples

Properties