REST API Reference

Back Next

Tasks

Use this resource to request a list of tasks of a specified type. You can use this resource to retrieve the name and ID for a task.

Do not use this resource to obtain a task ID to run a job. Instead, use the lookup resource. The lookup resource returns the federated task ID which is required to run a task that is not located in the Default folder.

Do not use this resource for a

file ingestion and replication

task. Instead, use the

file ingestion and replication

job resource. For more information see, tasks resource.

GET Request

To request a list of tasks of a specified type, use the task type code in the following URI.

/api/v2/task?type=<type>

Use the following attribute in the URI:

Field	Required	Description
type	Yes	For Data Integration , use one of the following codes: DMASK. Masking task. DRS. Replication task. DSS. Synchronization task. MTT. Mapping task. PCS. PowerCenter task.

GET Response

If the request is successful, returns the task object for every task of the requested type. Returns the error object if errors occur.

The task object includes the following attributes:

Field	Type	Description
id	String	Task ID.
orgId	String	Organization ID.
name	String	Task name.
description	String	Description.
createTime	String	Time the task was created.
updateTime	String	Last time the task was updated.
createdBy	String	User who created the task.
updatedBy	String	User who last updated the task.