Skip to main content

Windows Task Web Services

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

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 a Windows Task​

Description

URI

http://host_name/uc/resources/task

HTTP Method

POST

Description

Creates a new Windows 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 Windows Task: XML and JSON Examples, below.

Properties

See Properties.

Example Response

  • Status 200 /OK
    Successfully created the <task type> task with sysId <sysId>.

Modify a Windows 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 Windows Task properties without modifying related records, use the excludeRelated property.

Example

See Windows 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 a Windows 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

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

Properties

See Properties.

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

JSON
JSON
{
  "type": "taskWindows",
  "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,
  "command": "${demo_ops_snooze}",
  "commandOrScript": "Command",
  "cpDuration": null,
  "cpDurationUnit": "Minutes",
  "createConsole": false,
  "credentials": null,
  "credentialsVar": null,
  "customField1": {
    "label": "Domain",
    "value": "http://qa-cntlr-mssql:8080/uc/"
  },
  "customField2": {
    "label": null,
    "value": null
  },
  "desktopInteract": false,
  "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",
  "elevateUser": false,
  "environment": null,
  "excludeRelated": false,
  "exclusiveTasks": [],
  "executionRestriction": "Run",
  "exitCodeOutput": null,
  "exitCodeProcessing": "Success Exitcode Range",
  "exitCodes": 0,
  "exitCodeText": null,  
  "exportReleaseLevel": "7.2.0.0",  
  "exportTable": "ops_task_windows",  
  "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",
  "name": "uc - Test Email",
  "notes": [],
  "opswiseGroups": null, 
  "outputFailureOnly": true,
  "outputReturnFile": null,
  "outputReturnNline": 100,
  "outputReturnSline": 1,
  "outputReturnText": null,
  "outputReturnType": "NONE",
  "outputType": "STDOUT",
  "parameters": "${_random(30,10)} 0",
  "resolveNameImmediately": false,
  "resPriority": 10,
  "restrictionPeriod": "Span",
  "restrictionPeriodAfterDate": "2017-11-10",
  "restrictionPeriodAfterTime": "10:30",
  "restrictionPeriodBeforeDate": "2017-11-20",
  "restrictionPeriodBeforeTime": "15:00",
  "restrictionPeriodDateList": [],
  "retainSysIds": true,
  "retryExitCodes": null,
  "retryIndefinitely": false,
  "retryInterval": 60,
  "retryMaximum": 0,
  "retrySuppressFailure": false,  
  "runCount": 32,  
  "runTime": 108,
  "runtimeDir": null,
  "script": null,
  "startHeld": false,
  "startHeldReason": null,  
  "summary": "Test Email",
  "sysId": "fb59a227517a421a92c15ff5aefe3b66",
  "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 --",
  "userEstimatedDuration": null,
  "variables": [],
  "version": 1,
  "virtualResources": [],
  "waitForOutput": false
}

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​