Page Comparison

Panel

Table of Contents

maxlevel	2

...

	Description
URI	http://host_name/uc/resources/task
HTTP Method	POST
Description	Creates a new IBM i task.
Example URI	http://localhost:8080/uc/resources/task
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example	See Linux/Unix IBM i Task: XML and JSON Examples, below.
Properties	See Properties.
Example Response	Status 200 /OK Successfully created the <task type> task with sysId <sysId>.

...

	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 IBM i Task properties without modifying related records, use the excludeRelated property.
Example	See IBM i 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>.

...

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

...

Examples

XML

JSON

Example for Task

Expand

title	XML

<?xmlversion="1.0"encoding="UTF-8"standalone="yes"?>

<taskIbmiexportReleaseLevel="7.7.0.0"exportTable="ops_task_ibmi"retainSysIds="true"version="1">

<agentCluster>Opswise - Default IBM i Cluster</agentCluster>

<cpDurationUnit>Minutes</cpDurationUnit>

<efEnabled>false</efEnabled>

<efOffsetDurationUnit>Minutes</efOffsetDurationUnit>

<efOffsetType>Percentage</efOffsetType>

<enforceVariables>false</enforceVariables>

<exclusiveWithSelf>false</exclusiveWithSelf>

<holdResources>false</holdResources>

<lfEnabled>false</lfEnabled>

<lfOffsetDurationUnit>Minutes</lfOffsetDurationUnit>

<lfOffsetType>Percentage</lfOffsetType>

<lockVariables>false</lockVariables>

<logLevel>Inherited</logLevel>

<lsEnabled>false</lsEnabled>

<name>stonebranch-ibmi-00</name>

<resolveNameImmediately>false</resolveNameImmediately>

<retryIndefinitely>false</retryIndefinitely>

<retrySuppressFailure>false</retrySuppressFailure>

<simulation>false</simulation>

<startHeld>false</startHeld>

<timeZonePref>-- System Default --</timeZonePref>

<twWorkflowOnly>-- System Default --</twWorkflowOnly>

<command>${command}</command>

<commandOrScript>Command</commandOrScript>

<exitCodeProcessing>Success Exitcode Range</exitCodeProcessing>

<outputFailureOnly>false</outputFailureOnly>

<outputType>STDOUT</outputType>

<runAsSudo>false</runAsSudo>

<waitForOutput>false</waitForOutput>

</taskIbmi>

Expand

title	JSON

{

"type": "taskIbmi",

"actions": {

"abortActions": [],

"emailNotifications": [],

"setVariableActions": [],

"snmpNotifications": [],

"systemOperations": []

},

"agent": null,

"agentCluster": "Opswise - Default IBM i Cluster",

"agentClusterVar": null,

"agentVar": null,

"broadcastCluster": null,

"broadcastClusterVar": null,

"command": "${command}",

"commandOrScript": "Command",

"commandType": "CL",

"cpDuration": null,

"cpDurationUnit": "Minutes",

"credentials": null,

"credentialsVar": null,

"customField1": {

"label": null,

"value": null

},

"customField2": {

"label": null,

"value": null

},

"efDayConstraint": "None",

"efDuration": "00:00:00:00",

"efEnabled": false,

"efNthAmount": 5,

"efOffsetDuration": null,

"efOffsetDurationUnit": "Minutes",

"efOffsetPercentage": 0,

"efOffsetType": "Percentage",

"efTime": "00:00",

"efType": "Time",

"enforceVariables": false,

"environment": [],

"exclusiveTasks": [],

"exclusiveWithSelf": false,

"executionRestriction": "None",

"exitCodeOutput": null,

"exitCodeProcessing": "Success Exitcode Range",

"exitCodeText": null,

"exitCodes": "0",

"exportReleaseLevel": "7.7.0.0",

"exportTable": "ops_task_ibmi",

"firstRun": "",

"holdResources": false,

"lastRun": "",

"lfDayConstraint": "None",

"lfDuration": "00:00:00:00",

"lfEnabled": false,

"lfNthAmount": 5,

"lfOffsetDuration": null,

"lfOffsetDurationUnit": "Minutes",

"lfOffsetPercentage": 0,

"lfOffsetType": "Percentage",

"lfTime": "00:00",

"lfType": "Time",

"lockVariables": false,

"logLevel": "Inherited",

"lsDayConstraint": "None",

"lsDuration": "00:00:00:00",

"lsEnabled": false,

"lsNthAmount": 5,

"lsTime": "00:00",

"lsType": "Time",

"name": "stonebranch-ibmi-00",

"notes": [],

"opswiseGroups": [],

"outputFailureOnly": false,

"outputReturnFile": null,

"outputReturnNline": "100",

"outputReturnSline": "1",

"outputReturnText": null,

"outputReturnType": "NONE",

"outputType": "STDOUT",

"overrideInstanceWait": "No",

"parameters": null,

"resPriority": 10,

"resolveNameImmediately": false,

"restrictionPeriod": "None",

"restrictionPeriodAfterDate": null,

"restrictionPeriodAfterTime": null,

"restrictionPeriodBeforeDate": null,

"restrictionPeriodBeforeTime": null,

"restrictionPeriodDateList": [],

"retainSysIds": true,

"retryExitCodes": null,

"retryIndefinitely": false,

"retryInterval": 60,

"retryMaximum": 0,

"retrySuppressFailure": false,

"runAsSudo": false,

"runCount": 0,

"runTime": 0,

"runtimeDir": null,

"script": null,

"simulation": false,

"startHeld": false,

"startHeldReason": null,

"summary": null,

"sysId": "6e7386cfac5f4c36b758e9d46e23f4f2",

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

...

Versions Compared

Old Version 4

New Version Current

Key