Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version 2

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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 File Transfer task.

Example URI

http://localhost:8080/uc/resources/task

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example

See File Transfer Task: XML and JSON Examples, below.

Properties

See File Transfer Task Web Services#Properties 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, below.
 
To modify File Transfer Task properties without modifying related records, use the excludeRelated property.

Example

See File Transfer Task: XML and JSON Examples.

Properties

See File Transfer Task Web Services#Properties 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

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

Properties

See File Transfer Task Web Services#Properties Properties.

Anchor
File Transfer Task XML and JSON Examples
File Transfer Task XML and JSON Examples
File Transfer Task: XML and JSON Examples

...

Examples

XML

JSON

Anchor
Example for Task
Example for Task
Example for Task

Expand
titleXML
<taskFtp retainSysIds="true" version="1">
       <actions />
       <variables />
       <notes />
       <virtualResources />
       <exclusiveTasks />
       <agent />
       <agentCluster>uc Demo Cluster</agentCluster>
       <agentClusterVar />
       <agentVar />
       <avgRunTime>3</avgRunTime>
       <avgRunTimeDisplay>3 Seconds</avgRunTimeDisplay>
       <broadcastCluster />
       <broadcastClusterVar />
       <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>false</startHeld>
       <startHeldReason /> 
       <summary>Test Email</summary>
       <sysId>fb59a227517a421a92c15ff5aefe3b66</sysId>
       <timeZonePref>-- System Default --</timeZonePref>
       <twDelayAmount />
       <twDelayDuration>00:00:00:00</twDelayDuration>
       <twDelayType>None</twDelayType>
       <twWaitAmount />
       <twWaitDayConstraint>NONE</twWaitDayConstraint>
       <twWaitDuration>00:00:00:00</twWaitDuration>
       <twWaitTime>00:00</twWaitTime>
       <twWaitType>None</twWaitType>
       <twWorkflowOnly>-- System Default --</twWorkflowOnly>
       <userEstimatedDuration />
       <authenticatePeer>true</authenticatePeer>
       <codepage>-- None --</codepage>
       <command>GET</command>
       <compress>NO</compress>
       <createop>-- None --</createop>
       <encrypt>NO</encrypt>
       <exitCodeOutput />
       <exitCodeProcessing>Success Exitcode Range</exitCodeProcessing>
       <exitCodeText />
       <exitCodes>0</exitCodes>
       <formOrScript>Form</formOrScript>
       <format>ASCII</format>
       <ftpSubcommands />
       <jobcard />
       <localFilename>${demo_ops_download_dir}/welcome.msg</localFilename>
       <move>false</move>
       <nft>false</nft>
       <outputType>STDOUT</outputType>
       <primaryBroker />
       <primaryBrokerChoice>Agent Cluster</primaryBrokerChoice>
       <primaryBrokerRef>sbus43 - AGNT0001</primaryBrokerRef>
       <primaryCluster>${cluster}</primaryCluster>
       <primaryClusterRef />
       <primaryCredVar />
       <primaryCredentials />
       <primaryFilesys>-- None --</primaryFilesys>
       <primaryOpenOptions />
       <remoteCredVar />
       <remoteCredentials>uc - Anonymous</remoteCredentials>
       <remoteFilename>welcome.msg</remoteFilename>
       <remoteServer>ftp.winzip.com</remoteServer>
       <retryExitCodes />
       <retryIndefinitely>false</retryIndefinitely>
       <retryInterval>60</retryInterval>
       <retryMaximum>0</retryMaximum>
       <retrySuppressFailure>false</retrySuppressFailure>
       <runtimeDir />
       <script />
       <secondaryBroker>${agent}</secondaryBroker>
       <secondaryBrokerChoice>Agent Cluster</secondaryBrokerChoice>
       <secondaryBrokerRef />
       <secondaryCluster />
       <secondaryClusterRef>Opswise - Default Windows Cluster</secondaryClusterRef>
       <secondaryCredVar />
       <secondaryCredentials />
       <secondaryFilesys>-- None --</secondaryFilesys>
       <secondaryOpenOptions />
       <serverType>UDM</serverType>
       <showProgress>false</showProgress>
       <transferDirection>GET</transferDirection>
       <transferMode>Passive</transferMode>
       <trimSpace>false</trimSpace>
       <udmOperation>1</udmOperation>
       <udmOptions />
       <useRegex>false</useRegex>
</taskFtp>
Expand
titleJSON
{
  "type": "taskFtp",
  "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,
  "codepage" : "-- None --",
  "command": "GET",
  "compress": "NO",
  "cpDuration": null,
  "cpDurationUnit": "Minutes",
  "createop": "-- None --",
  "credentials": null,
  "credentialsVar": null,
  "customField1": {
    "label": "Domain",
    "value": "http://qa-cntlr-mssql:8080/uc/"
  },
  "customField2": {
    "label": null,
    "value": null
  },
  "encrypt": "NO",
  "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",
  "exitCodeOutput": null,
  "exitCodeProcessing": "Success Exitcode Range",
  "exitCodeText": null,
  "exitCodes": 0,
  "firstRun": "2021-03-15 13:59:37 -0400",
  "formOrScript": "Form",
  "format": "ASCII",
  "ftpSubcommands": null,
  "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",
  "localFilename": "${demo_ops_download_dir}/welcome.msg",
  "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",
  "move": false,
  "name": "uc - Test Email",
  "nft": false,
  "notes": [],
  "opswiseGroups": null, 
  "outputType": "STDOUT",
  "primaryBrokerChoice": "Agent Cluster",
  "primaryBrokerRef": "sbus43 - AGNT0001",
  "primaryCluster": "${cluster}",
  "primaryClusterRef": null,
  "primaryCredVar": null,
  "primaryCredentials": null,
  "primaryFilesys": "-- None --",
  "primaryOpenOptions": null,
  "remoteCredVar": null,
  "remoteCredentials": "uc - Anonymous",
  "remoteFilename": "welcome.msg",
  "remoteServer": "ftp.winzip.com",
  "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,
  "secondaryBroker": "${agent}",
  "secondaryBrokerChoice": "Agent Cluster",
  "secondaryBrokerRef": null,
  "secondaryCluster": null,
  "secondaryClusterRef": "Opswise - Default Windows Cluster",
  "secondaryCredVar": null,
  "secondaryCredentials": null,
  "secondaryFilesys": "-- None --",
  "secondaryOpenOptions": null,
  "serverType": "UDM",
  "showProgress": false,
  "startHeld": false,
  "startHeldReason": null,  
  "summary": "Test Email",
  "sysId": "fb59a227517a421a92c15ff5aefe3b66",
  "timeZonePref": "-- System Default --",
  "transferDirection": "GET",
  "transferMode": "Passive",
  "trimSpace": false,
  "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 --",
  "udmOperation": 1,
  "udmOptions": null,
  "useRegex": false,
  "userEstimatedDuration": null,
  "variables": [],
  "version": 1,
  "virtualResources": []
}

...