Overview

Universal Controller supports the following RESTful-based web services for PeopleSoft 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 PeopleSoft Task

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

PeopleSoft Task: XML and JSON Examples

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

Examples

XML

JSON

Example for Task

XML

<taskPeopleSoft retainSysIds="true" version="1">
       <actions />
       <variables />
       <notes />
       <runtimeParameters />
       <virtualResources />
       <exclusiveTasks />
       <agent>AGNT0001</agent>
       <agentCluster />
       <agentClusterVar />
       <agentVar />
       <avgRunTime>3</avgRunTime>
       <avgRunTimeDisplay>3 Seconds</avgRunTimeDisplay>
       <broadcastCluster />
       <cpDuration />
       <cpDurationUnit>Minutes</cpDurationUnit>
       <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>true</startHeld>
       <startHeldReason>hold reason</startHeldReason> 
       <summary />
       <sysId>f87848b00a0001037f43e7c81c8ec969</sysId>
       <timeZonePref>-- System Default --</timeZonePref>
       <twDelayAmount />
       <twDelayDuration>00:00:01:00</twDelayDuration>
       <twDelayType>Duration</twDelayType>
       <twWaitAmount />
       <twWaitDayConstraint />
       <twWaitDuration>00:00:00:00</twWaitDuration>
       <twWaitTime>00:00</twWaitTime>
       <twWaitType>Time</twWaitType>
       <twWorkflowOnly>Yes</twWorkflowOnly>
       <userEstimatedDuration>00:00:00:02</userEstimatedDuration>
       <command>Schedule Job</command>
       <connection>PS_Connection 1</connection>
       <connectionVar />
       <contentFilter />
       <distributionOptions>
            <distributionOption>
                  <distributionIdType>User</distributionIdType>
                  <distributionId>PS_User_1</distributionId>
            </distributionOption>
            <distributionOption>
                  <distributionIdType>Role</distributionIdType>
                  <distributionId>PS_Role_1</distributionId>
            </distributionOption>
       </distributionOptions>
       <emailAddresses>"stone@qa.stone.branch</emailAddresses>
       <emailAttachLog>false</emailAttachLog>
       <emailSubject>Test Subject for ${ops_task_name}</emailSubject>
       <emailText>Test Body for ${ops_task_name} with id ${ops_task_id}.</emailText>
       <emailWebReport>false</emailWebReport>
       <exitCodeOutput />
       <exitCodeProcessing>Success Exitcode Range</exitCodeProcessing>
       <exitCodes>0</exitCodes>
       <exitCodeText />
       <mainJobName /> 
       <mainSchedName /> 
       <outputDestFormat>0</outputDestFormat>
       <outputDestString />
       <outputDestType>0</outputDestType>
       <outputFailureOnly>true</outputFailureOnly>
       <outputReturnFile />
       <outputReturnNline>100</outputReturnNline>
       <outputReturnSline>1</outputReturnSline>
       <outputReturnText />
       <outputReturnType>OUTERR</outputReturnType>
       <outputType>STDOUT</outputType>
       <printAppMessage>false</printAppMessage>
       <printDistList>false</printDistList>
       <printJobTree>false</printJobTree>
       <printParamList>false</printParamList>
       <printSystemMessage>false</printSystemMessage>
       <processFileName />
       <processName>TREEMOVER</processName>
       <processType>PSJob</processType>
       <psCredentials>PeopleSoft</psCredentials>
       <psCredentialsVar />
       <report>false</report>
       <reportFolderName />
       <retentionDays />
       <runControlId>ESS1A</runControlId       <serverName />
       <waitForOutput>false</waitForOutput>
</taskPeopleSoft>

JSON

{
  "type": "taskPeoplesoft",
  "actions": {
    "abortActions": [],
    "emailNotifications": [],
    "setVariableActions": [],
    "snmpNotifications": [],
    "systemOperations": []
  },
  "agent": null,  
  "agentCluster": "uc Demo Cluster",
  "agentClusterVar": null,
  "agentVar": null,
  "avgRunTime": 3,
  "avgRunTimeDisplay": "3 Seconds",
  "broadcastCluster": null,
  "command": "Schedule Job",
  "connection": "PS_Connnection 1",
  "connectionVar": null,
  "contentFilter": null,
  "cpDuration": null,
  "cpDurationUnit": "Minutes",
  "credentials": null,
  "credentialsVar": null,
  "customField1": {
    "label": "Domain",
    "value": "http://qa-cntlr-mssql:8080/uc/"
  },
  "customField2": {
    "label": null,
    "value": null
  },
  "distributionOptions": [
        {
            "distributionId": "PS_User_1",
            "distributionIdType": "User"
        },
        {
            "distributionId": "PS_Role_1",
            "distributionIdType": "Role"
        }
    ],
  "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",
  "emailAddresses": "stone@qa.stone.branch",
  "emailAttachLog": false,
  "emailSubject": "Test Subject for $\{ops_task_name}",
  "emailText": "Test Body for $\{ops_task_name} with id $\{ops_task_id}.",
  "emailWebReport": false,
  "excludeRelated": false,
  "exclusiveTasks": [],
  "executionRestriction": "Run",
  "exitCodeOutput": null,
  "exitCodeProcessing": "Success Exitcode Range",
  "exitCodes": 0,
  "exitCodeText": null,
  "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",
  "mainJobName": null,
  "mainSchedName": null,
  "maxRunTime": 9,
  "maxRunTimeDisplay": "9 Seconds",
  "minRunTime": 3,
  "minRunTimeDisplay": "3 Seconds",
  "name": "uc - Test Email",
  "notes": [],
  "opswiseGroups": null, 
  "outputDestFormat": 0, 
  "outputDestString": null, 
  "outputDestType": 0, 
  "outputFailureOnly": true,
  "outputReturnFile": null, 
  "outputReturnNline": 100, 
  "outputReturnSline": 1, 
  "outputReturnText": null, 
  "outputReturnType": "OUTERR", 
  "outputType": "STDOUT", 
  "printAppMessage": false, 
  "printDistList": false, 
  "printJobTree": false, 
  "printParamList": false, 
  "printSystemMessage": false, 
  "processFileName": null, 
  "processName": "TREEMOVER", 
  "processType": PSJob,
  "psCredentials": "PeopleSoft",
  "report": false,
  "reportFolderName": null,
  "resolveNameImmediately": false,
  "resPriority": 10,
  "restrictionPeriod": "Span",
  "restrictionPeriodAfterDate": "2017-11-10",
  "restrictionPeriodAfterTime": "10:30",
  "restrictionPeriodBeforeDate": "2017-11-20",
  "restrictionPeriodBeforeTime": "15:00",
  "restrictionPeriodDateList": [],
  "retainSysIds": true,
  "retentionDays": null,
  "runControlId": ESS1A,
  "runCount": 32,
  "runTime": 108,
  "runtimeParameters": [],
  "serverName": 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

See All Tasks Properties
See PeopleSoft Task Properties

PeopleSoft Task Web Services