...
Universal Controller supports the following RESTful-based web services for Manual Task operations, which are listed alphabetically on this page.
- Manual Task Web Services#Create Create a Manual TaskManual Task Web Services#Modify
- Modify a Manual Task
- Manual Task Web Services#Read Read a Manual 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 Manual task. |
Example URI | http://localhost:8080/uc/resources/task |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example | See Manual Task: XML and JSON Examples, below. |
Properties | |
Example Response |
|
...
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. |
Example | |
Properties | |
Example Response |
|
...
Examples | XML | JSON | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Example for Task |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | SNMP Notification | SNMP Notification | SNMP Notification
Anchor | System Operation | System Operation | System Operation
Expand |
Anchor | Abort | Abort | Abort
Anchor | Email Notification | Email Notification | Email Notification
Anchor | Set Variable | Set Variable | Set Variable
Anchor | SNMP Notification | SNMP Notification | SNMP Notification
Anchor | System Operation | System Operation | System Operation
Anchor | Examples for Task-Related Records | Examples for Task-Related Records | Examples for Task-Related Records
Anchor | Notes | Notes | Notes
Anchor | Variables in Tasks | Variables in Tasks | Variables
<emailNotification> <description /> <exitCodes /> <notifyOnEarlyFinish>false</notifyOnEarlyFinish> <notifyOnLateFinish>false</notifyOnLateFinish> <notifyOnLateStart>false</notifyOnLateStart> <status>Success</status> <sysId>2b72cdaaf3a145e4bbae5a7ddd24baff</sysId> <attachFile>false</attachFile> <attachJobLog>false</attachJobLog> <attachStdError>false</attachStdError> <attachStdOut>true</attachStdOut> <bcc /> <body>test body</body> <cc /> <emailConnection>uc - Gmail Account</emailConnection> <emailTemplate /> <emailTemplateVar /> <fileName /> <fileNumLines>100</fileNumLines> <fileScanText /> <fileStartLine>1</fileStartLine> <joblogNumLines>100</joblogNumLines> <joblogScanText /> <joblogStartLine>1</joblogStartLine> <replyTo>replyTo@test.com</replyTo> <report> <groupName /> <title>report1</title> <userName>ops.admin</userName> </report> <stderrNumLines>100</stderrNumLines> <stderrScanText /> <stderrStartLine>1</stderrStartLine> <stdoutNumLines>100</stdoutNumLines> <stdoutScanText /> <stdoutStartLine>1</stdoutStartLine> <subject /> <to>test@test.com</to> </emailNotification>
<setVariableAction>
<description />
<exitCodes />
<notificationOption>Operation Failure</notificationOption>
<notifyOnEarlyFinish>false</notifyOnEarlyFinish>
<notifyOnLateFinish>false</notifyOnLateFinish>
<notifyOnLateStart>false</notifyOnLateStart>
<status>Waiting</status>
<sysId>f7824e38add745c2bf41017b07697bdf</sysId>
<variableName>name</variableName>
<variableScope>Self</variableScope>
<variableValue />
</setVariableAction>
<snmpNotification> <description /> <exitCodes /> <notifyOnEarlyFinish>false</notifyOnEarlyFinish> <notifyOnLateFinish>false</notifyOnLateFinish> <notifyOnLateStart>false</notifyOnLateStart> <status>Resource Requested</status> <sysId>1a1ddf2fa7f7466db8b5fc7863fc4ea3</sysId> <severity>Normal</severity> <snmpManager>test manager</snmpManager> </snmpNotification>
<systemOperation> <description /> <exitCodes /> <notifyOnEarlyFinish>false</notifyOnEarlyFinish> <notifyOnLateFinish>false</notifyOnLateFinish> <notifyOnLateStart>false</notifyOnLateStart> <status>Held</status> <sysId>742beaf652834054b1edc37e6423700d</sysId> <agent /> <agentCluster /> <agentClusterVar /> <agentVar /> <execCommand>Cancel</execCommand> <execCriteria>Oldest Active Instance</execCriteria> <execId /> <execLookupOption>Task</execLookupOption> <execName /> <execWorkflowNameCond /> <execWorkflowName /> <limit /> <notificationOption>Operation Failure</notificationOption> <operation>Run Task Instance Command</operation> <task>uc - B=${B}</task> <taskLimitType>Unlimited</taskLimitType> <taskVar /> <trigger /> <triggerVar /> <variables> <variable> <name>var1</name> <value>val1</value> </variable> <variable> <name>var2</name> <value>val2</value> </variable> </variables> <variablesUnresolved>false</variablesUnresolved> <variablesUnresolved /> <virtualResource /> <virtualResourceVar /> </systemOperation> |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|
Anchor | ||||
---|---|---|---|---|
|
...