Table of Contents


  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. Mass Ingestion Streaming REST API
  8. Model Serve REST API
  9. RunAJob utility
  10. ParamSetCli utility
  11. REST API codes
  12. REST API resource quick references

REST API Reference

REST API Reference



When you use the REST API to run a
dynamic mapping
task, use the REST API version 1 job resource to start or stop the job. You can also get details about the job.
Do not use the platform REST API version 2 job resource to get the status of a
dynamic mapping
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.

GET request

To get details of a
dynamic mapping
task run, use the following URI:

GET response

If successful, returns the job status.
If unsuccessful, the response includes a reason for the failure.
For example, you might get the following response when you request details of a completed
dynamic mapping
{ "taskId": "jUJNIX39Z6ZbR8KZCm2ieS", "taskFrsId": "k2AE77O06oYg6NvrOtKt6t", "taskName": "Dynamic Mapping Task2", "instanceId": 1, "startedBy": "", "startTime": "2021-08-26T16:28:11.000Z", "updateTime": "2021-08-26T16:28:35.000Z", "endTime": "2021-08-26T16:28:35.000Z", "runtimeEnvironment": "test1", "runtimeEnvironmentId": "01000025000000000002", "status": "COMPLETED", "successRows": 3, "errorRows": 0, "saasMappingId": "01000017000000000007", "mappingName": "dsst__copy_data_new_tgt_With_SortList", "mappingFrsId": "5A90bRPboO0dpMQ8F2nkgy", "mappingDocType": "MAPPING", "runContext": "API", "scheduleName": null, "jobs": [ { "jobName": "Job_1", "jobUUID": "78OZ7JlUNSCd09kwQWXbUf", "groupName": "Group_1", "saasJobRunId": 52, "saasLogId": "010000C100000000040H", "startTime": "2021-08-26T16:28:18.000Z", "updateTime": "2021-08-26T16:28:33.000Z", "endTime": "2021-08-26T16:28:33.000Z", "errorMessage": null, "status": "COMPLETED", "failedSourceRows": 0, "successSourceRows": 3, "failedTargetRows": 0, "successTargetRows": 3, "enabled": true, "sessionLogUrl": null } ] }

Start POST request

To run a
dynamic mapping
task, use the following URI:
Include the federated task ID in the request as in the following example:
{ "taskFrsId": "k2AE77O06oYg6NvrOtKt6t" }

Start POST response

Returns the run ID and the federated task ID.
For example, if you run a
dynamic mapping
task for the second time, you get the following response:
{ "runId": 2, "taskFrsId": "k2AE77O06oYg6NvrOtKt6t" }

Stop POST request

To stop a dynamic mapping task run, use the following URI
Include the task ID and the job run ID attributes in the job object as shown in the following example:
{ "taskFrsId": "gScmpuSzjSdcbNPFNYbbcg", "runId": 10 }

Stop POST response

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


We’d like to hear from you!