Hi, I'm Ask INFA!
What would you like to know?
ASK INFAPreview
Please to access Ask INFA.

Table of Contents

Search

  1. Preface
  2. IDMC REST API
  3. REST API resource quick references
  4. Platform REST API version 2 resources
  5. Platform REST API version 3 resources
  6. Data Integration REST API
  7. Cloud Data Integration for PowerCenter (CDI-PC) REST API
  8. Data Ingestion and Replication REST API
  9. Customer Managed REST API
  10. RunAJob utility
  11. ParamSetCli utility
  12. REST API codes

REST API Reference

REST API Reference

Data Ingestion and Replication resource quick reference

Data Ingestion and Replication
resource quick reference

The following list describes the operations that you can perform on
Data Ingestion and Replication
resources:
Database and application ingestion and replication tasks
Create and deploy
database ingestion and replication
tasks and
application ingestion and replication
tasks. Also manage and monitor the jobs associated with the tasks.
The following table lists the operations:
Operation
Method
URI
Create a task.
POST
/dbmi/public/api/v2/task/create
Deploy a task.
POST
/dbmi/public/api/v2/task/deploy/{taskId}
Run a job.
POST
/dbmi/public/api/v2/job/start
Stop a job.
POST
/dbmi/public/api/v2/job/stop
Resume a job.
POST
/dbmi/public/api/v2/job/resume
Undeploy a job.
POST
/dbmi/public/api/v2/job/undeploy
Get job status.
GET
/dbmi/public/api/v2/job/status
Get job metrics.
GET
/dbmi/public/api/v2/job/metrics
Get task details.
GET
/dbmi/public/api/v2/task/details?taskId={taskId}&projectId={projectId}&folderId={folderId}
File ingestion and replication
Create, manage, and monitor
file ingestion and replication
tasks.
The following table lists the operations:
Operation
Method
URI
Get job status.
GET
/mftsaas/api/v1/job/<runId>/status
Get job logs.
GET
/mftsaas/api/v1/job/<runId>/logs
Get details for a completed job using the task ID.
GET
/mftsaas/api/v1/mitasks/activityLog?taskId=<taskId>
Get details for an active or a completed job using the run ID.
GET
/mftsaas/api/v1/mitasks/activityLog?runId=<runId>
Get details for an active or a completed job using the run ID, including the number of rows to skip and a row limit.
GET
/mftsaas/api/v1/mitasks/activityLog?taskId={{taskID}}&<offset>
Get details for all jobs.
GET
/mftsaas/api/v2/mitasks/activityLog
Get details for all jobs using the task ID.
GET
/mftsaas/api/v2/mitasks/activityLog?taskId=<taskId>
Get details for all jobs using the run ID.
GET
/mftsaas/api/v2/mitasks/activityLog?runId=<runId>
Get details for all jobs including the rows to skip.
GET
/mftsaas/api/v2/mitasks/activityLog?taskId=<taskId>&offset=<offset>
Get details for all jobs and include a row limit.
GET
/mftsaas/api/v2/mitasks/activityLog?taskId=<taskId>&rowLimit<rowLimit>
Get details for all jobs based on the job type.
GET
/mftsaas/api/v2/mitasks/activityLog?jobType=<jobType>
Get the number of file events to display and include the file event limit.
GET
/mftsaas/api/v2/mitasks/activityLog?runId={{runID}}&fetchFileEvents=true&fileEventsLimit=10
View details of a particular task.
GET
/mftsaas/api/v1/mitasks/{{TASK-ID}}
View details for all tasks in the organization.
GET
/mftsaas/api/v1/mitasks
Create a task.
POST
/mftsaas/api/v1/mitasks
Update a task.
POST
/mftsaas/api/v1/mitasks/<taskID>
Get the location of a task.
GET
/mftsaas/api/v1/mitasks?resolveLocation=true
Delete a task.
DELETE
/mftsaas/api/v1/mitasks/<taskID>
Streaming ingestion and replication
Create, manage, and monitor
streaming ingestion and replication
jobs.
The following table lists the operations:
Operation
Method
URI
Create a task.
POST
/sisvc/restapi/v1/CreateEntity/Documents
Deploy a task.
POST
/sisvc/api/v1/Dataflows('<dataflow ID>')/OData.SI.Deploy
Undeploy a task.
POST
/sisvc/api/v1/Dataflows('<dataflow ID>')/OData.SI.Undeploy
Start a task.
POST
/sisvc/api/v1/Dataflows('<dataflow ID>')/OData.SI.Start
Stop a task.
POST
/sisvc/api/v1/Dataflows('<dataflowID>')/OData.SI.Stop
Copy a task.
POST
/sisvc/restapi/v1/CopyEntities
Update a task.
POST
/sisvc/restapi/v1/UpdateEntity/Documents('<document ID>')
Get task details.
GET
/sisvc/monitor/v1/jobs/<dataflow ID>/<run ID of the job>
Get the list of jobs.
GET
/mijobmonitor/api/v1/MIJobs
Get the job status.
GET
/sisvc/monitor/v1/status/dataflows/<dataflow ID>
Get the job statistics.
GET
/sisvc/monitor/v1/statistics/dataflows/<dataflow ID>
Get the job history.
GET
/sisvc/monitor/v1/history/dataflows/<dataflow ID>

0 COMMENTS

We’d like to hear from you!