Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. Mass Ingestion Files REST API
  7. RunAJob utility
  8. REST API codes
  9. REST API resource quick references

REST API Reference

REST API Reference

job

job

Use this resource to start or stop a task based on ID or name. You can also retrieve job completion status.

Start POST Request

If your organization uses projects and folders, use the REST API version 3 lookup resource to retrieve the task ID. This ID is the federated task ID, which you must include in the POST request.
Alternatively, you can use the task resource to retrieve the task ID. However, the task resource returns a task ID that you can only use to run tasks located in the Default folder.
Do not use this resource for a
Mass Ingestion
file ingestion
task. Instead, use the
file ingestion
job resource. For more information, see Mass Ingestion Files REST API.
To start a task, use the following URI:
/api/v2/job
With this URI, use the following attributes in a job object:
Field
Type
Required
Description
taskId
String
Required if taskName or taskFederatedId is not 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 is not located in the Default folder.
Task ID that includes the folder path to the task.
taskName
String
Required if taskId or taskFederatedId is not 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
-
A valid, publicly available URL. The service posts the job status to the callbackURL.

Start POST Response

Returns the job object if the request is successful. Returns an error object if errors occur.
The job object includes the following attributes:
Field
Type
Description
taskId
String
Task or linear taskflow ID.
taskFederatedId
String
Task ID that 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.

Start POST Request Example

To start a linear taskflow with an ID of 0034J90000000M in JSON, 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 the ID of 0100000Z000009, you might use the following request. To run multiple instances of the task simultaneously, the request includes the runtime object.
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" } }

Stop POST Request

To stop a task or linear taskflow, use the following URI:
/api/v2/job/stop
With this URI, use the following attributes in a job object:
Field
Type
Required
Description
taskId
String
Required if taskName not included.
Task or linear taskflow ID. Use taskId or taskName in the URI.
taskFederatedId
String
Required if the task is not located in the Default folder.
Task ID that includes the folder path to the task.
taskName
String
Required if taskId not 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.

Stop POST Response

Returns the success object if the request is successful. Returns the error object if errors occur.

Stop POST Example

To stop a linear taskflow with an ID of 0034J90000000M in JSON, 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" }

Job Status

When you include the callbackURL in the job request, the service sends a request to the callback URL when the job completes. The service always uses a JSON request for callbacks.
A callback might be called multiple times because of a system failure or incorrect server response. When the service sends a request to the callback URL, the endpoint on your server must return a 200 HTTP code within 30 seconds. Otherwise, the URL connection breaks and the service counts the break as a failed attempt. The server will make a total of three attempts.
The service executes the POST request from the callback URL. The following text is a sample return:
{ @type:"callbackUrlResponse" endTime: "2013-02-27T18:57:52.000Z", objectId: "0034J90000000M", objectName: "taskName", runId: 5, status: "COMPLETED" // or “FAILED” }


Updated May 03, 2021