Versions Compared

Key

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

...

Anchor
Create a Remote File Monitor Task
Create a Remote File Monitor Task

Create a Remote File Monitor Task


Description

URI

http://host_name/uc/resources/task

HTTP Method

POST

Description

Creates a new Remote File Monitor task.

Example URI

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

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example

See Remote File Monitor Task: XML and JSON Examples, below.

Properties

See Properties.

Example Response

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

Anchor
Modify a Remote File Monitor Task
Modify a Remote File Monitor Task

Modify a Remote File Monitor 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, below.
 
To modify Remote File Monitor Task properties without modifying related records, use the excludeRelated property.

Example

See Remote File Monitor 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>.

Anchor
Read a Remote File Monitor Task
Read a Remote File Monitor Task

Read a Remote File Monitor 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.

Anchor
Remote File Monitor Task XML and JSON Examples
Remote File Monitor Task XML and JSON Examples

Remote File Monitor Task: XML and JSON Examples

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

...

See Task Web Services - Task-Related Records for XML and JSON examples of task-related records.

Anchor
Properties
Properties

Properties