URI

HTTP Method

POST

Description

Creates a new Agent File Monitor task.
 
To persist sysIds, use the retainSysIds property.

Example URI

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example

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

Properties

See 17235996 Agent File Monitor Task Properties.

Example Response

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

URI

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 Agent File Monitor Task properties without modifying related records, use the excludeRelated property.

Example

See Agent File Monitor Task: XML and JSON Examples.

Properties

See 17235996 Properties.

Example Response

• Status 200 /OK
  Successfully updated the <task type> task with sysId <sysId> to version <version>.

URI

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

Properties

See 17235996 Agent File Monitor Task Properties.