REST API Reference

Back Next

Starting a job

Use the job resource to start a job.

POST request

Use the following URI:

/api/v2/job

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

Field	Type	Required	Description
taskId	String	Required if taskName or taskFederatedId 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 or taskFederatedId 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.
callbackURL	String	No	A valid, publicly available URL. The service posts the job status to the callbackURL.
runtime		No	Attribute that defines runtime properties.
parameterFileName	String	No	Parameter file name.
parameterFileDir	String	No	Parameter file directory on the Secure Agent machine.

POST response

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

The following table describes the attributes in the job object:

Field	Type	Description
taskId	String	Task or linear taskflow ID.
taskFederatedId	String	Global unique identifier for the task, which includes the folder path to the task.
taskName	String	Task or linear taskflow name.
taskType	String	The type of task. Returns one of the following codes for Data Integration : DMASK. Masking task. DRS. Replication task. DSS. Synchronization task. MTT. Mapping task. PCS. PowerCenter task. WORKFLOW. Linear taskflow.
runId	Long	ID of the job.
callbackURL	String	Status of the job.

POST request examples

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

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

{
"taskId": "0034J90000000M",
"taskType": "Workflow",
"callbackURL": "https://MyIICSJobStatus.com",
}

To start a

mapping

task with ID 0100000Z000009, you might use the following request:

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

{
    "@type": "job",
    "taskId": "0100000Z000009",
    "taskType": "MTT",
    "runtime": {
        "@type": "mtTaskRuntime"
    }
}

Because the request includes a runtime object, you can make additional requests to run the task simultaneously in other runtime environments.

To start a

mapping

task using a parameter file, you might use the following request:

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

{
  "@type": "job",
  "taskId": "0116Q70Z0000000000N4",
  "taskType": "MTT",
  "runtime": {
    "@type": "mtTaskRuntime",
    "parameterFileName": "EmployeeDept.param",
    "parameterFileDir": "/root/dev/FlatFiles"
  }
}

You might get the following response:

{
  "@type": "job",
  "taskId": "0116Q70Z0000000000N4",
  "taskType": "MTT",
  "runId": 59,
  "taskName": "mct_03126935_Oracle_FF_Parameter",
  "runInParallel": false
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Starting a job

Starting a job

POST request

POST response

POST request examples