REST API Reference

Back Next

Stopping a job

Use the job resource to stop a job.

POST request

Use the following URI:

/api/v2/job/stop

The following table describes the attributes to use in a job object:

Field	Type	Required	Description
taskId	String	Required if taskName isn't included.	Task or linear taskflow ID. Use taskId or taskName in the URI. You can include this task ID when the task is located in the Default folder.
taskFederatedId	String	Required if the task isn't located in the Default folder.	Global unique identifier for the task, which includes the folder path to the task.
taskName	String	Required if taskId isn't included.	Task or linear taskflow name. Use taskId or taskName in the URI.
taskType	String	Yes	The type of task. For Data Integration , use one of the following codes: DMASK. Masking task. DRS. Replication task. DSS. Synchronization task. MTT. Mapping task. PCS. PowerCenter task. WORKFLOW. Linear taskflow.

POST response

The response returns the success object if the request is successful and an error object if an error occurs.

POST request example

To stop a linear taskflow with ID 0034J90000000M, you might use the following request:

POST <serverUrl>/api/v2/job/stop HTTP/1.0
Content-Type: application/json
Accept: application/json
icSessionId: <icSessionId>

{
"@type": "job",
"taskId": "0034J90000000M",
"taskType": "Workflow"
}

Jobs

Download Guide

Watch

Comments

Communities

Knowledge Base

Success Portal