Hi, I'm Ask INFA!
What would you like to know?
ASK INFAPreview
Please to access Ask INFA.
Success
Manage your Success Plans and Engagements, gain key insights into your implementation journey, and collaborate with your CSMs
Customer Experience Accelerators
Accelerate your Purchase to Value by engaging with Informatica for Customer Success
My Engagements
All your Engagements at one place
 Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
 Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Experience Lounge
Self-guided, intuitive experience platform for outcome-focused product capabilities and use cases
 Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
SupportFlash
Monthly support newsletter
Product Availability Matrix
Product Availability Matrix statements of Informatica products
Product Lifecycle
End of Life statements of Informatica products
Pulse
Monitor the status of your Informatica services across regions
Events
Change Request Tracking
Marketplace
Trust Platform
English
  • Administrator
  • All Products

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. RunAJob utility
  10. ParamSetCli utility
  11. REST API codes

REST API Reference

REST API Reference

Back Next

Data Integration resource quick reference

Data Integration
 resource quick reference

The following list describes the operations that you can perform on
Data Integration
 resources:
Code tasks (version 1 resource)
Create, start, and cancel a
code task
 job. You can also access session logs, view job details and job status of a
code task
.
The following table lists the operations:
Operation
Method
URI
Get the configuration parameters for a
code task
.
GET
GET <server URL>/disnext/api/v1/CodeTask/<Code task ID>
Get the job status for a
code task
.
GET
GET <server URL>/disnext/api/v1/CodeTask/JobStatus/<Code task job ID>
Get the session logs for a
code task
.
GET

GET <server URL>/logservice/api/v1/jobs/<Code task job ID>/logs
Get the Spark task results for a
code task
.
GET

GET <server URL>/logservice/api/v1/jobs/<Code task job ID>/callback
Create a
code task
.
POST
POST <server URL>/disnext/api/v1/CodeTask
Start a
code task
.
POST
POST <server URL>/disnext/api/v1/CodeTask/Start
Cancel a
code task
.
PUT
PUT <server URL>/disnext/api/v1/CodeTask/Cancel
Connections (version 2 resource)
Get connection details for an organization. You can also use this resource to create, update, test, and delete a connection.
The following table lists the operations:
Operation
Method
URI
Get details of all connections in the organization.
GET
/api/v2/connection
Get a list of connections by Secure Agent ID and connection type.
GET
/api/v2/connection/search?agentId=<agentId>&uiType=<uiType>
Get a list of connections by runtime environment ID and connection type.
GET
/api/v2/connection/search?runtimeEnvironmentId=<runtimeEnvironmentId>&uiType=<uiType>
Get connection details by connection ID.
GET
/api/v2/connection/<id>
Get connection details by connection name.
GET
/api/v2/connection/name/<name>
Get source metadata details for a connection.
GET
/api/v2/connection/source/<connection ID>/metadata
Get target metadata details for a connection.
GET
/api/v2/connection/target/<connection ID>/metadata
Get the objects that you can use as a source by connection ID.
GET
/api/v2/connection/source/<id>
Get the objects that you can use as a source by connection name.
GET
/api/v2/connection/source/name/<name>
Get the objects that you can use as a target by connection ID.
GET
/api/v2/connection/target/<id>
Get the objects that you can use as a target by connection name.
GET
/api/v2/connection/target/name/<name>
Test a connection.
GET
/api/v2/connection/test/<id>
Create a connection.
POST
/api/v2/connection
Update a connection.
POST
/api/v2/connection/<id>
Delete a connection.
DELETE
/api/v2/connection/<id>
Connection migration (version 2 resource)
Migrate an old version of a connection in referenced assets to the latest version in the organization.
The following table lists the operations:
Operation
Method
URI
Start a migration job for a connection.
POST
saas/api/v2/connectionMigration/migrate
Connectors (version 2 resource)
Get a list of connectors that are available to an organization along with connector details and their attributes.
The following table lists the operations:
Operation
Method
URI
Get available connectors for an organization.
GET
/api/v2/connector
Get metadata for a connector type.
GET
/api/v2/connector/metadata?connectorName=<connectorName>
Data preview (version 2 resource)
Preview data in a mapping.
The following table lists the operations:
Operation
Method
URI
Preview source data by connection ID.
GET
/api/v2/connection/source/<id>/datapreview/<objectName>
Preview source data by connection name.
GET
/api/v2/connection/source/name/<name>/datapreview/<objectName>
Preview target data by connection ID.
GET
/api/v2/connection/target/<id>/datapreview/<objectName>
Preview target data by connection name.
GET
/api/v2/connection/target/name/<name>/datapreview/<objectName>
Data services (version 1 resource)
Run data services from the data services repository.
The following table lists the operations:
Operation
Method
URI
Run a data service.
POST
/DSRepo/rest/api/v1/services/run/<service name>
Dynamic mapping
 tasks (version 1 resource)
Create a
dynamic mapping
 task to batch jobs together that are based on the same mapping. You can also run the task and get details about the job.
The following table lists the operations:
Operation
Method
URI
Get details for a
dynamic mapping
 task.
GET
/batch-mapping/api/v1/dynamictask/<id>
Get details for a job that runs a
dynamic mapping
 task.
GET
/batch-mapping/api/v1/Job/monitor/task/<Id>/run/<runId>
Create a
dynamic mapping
 task.
POST
/batch-mapping/api/v1/dynamictask
Run a
dynamic mapping
 task.
POST
/batch-mapping/api/v1/Job
Stop a job that runs a
dynamic mapping
 task.
POST
/batch-mapping/api/v1/Job/stop
Update a
dynamic mapping
 task.
PUT
/batch-mapping/api/v1/dynamictask/<Id>
Delete a
dynamic mapping
 task.
DELETE
/batch-mapping/api/v1/dynamictask/<id>
Expressions (version 2 resource)
Validate expressions.
The following table lists the operations:
Operation
Method
URI
Validate an expression.
POST
/saas/api/v2/expression/validate
Fields (version 2 resource)
Get and update field details for a source or target object.
The following table lists the operations:
Operation
Method
URI
Get fields for a source object by connection ID.
GET
/api/v2/connection/source/<id>/field/<object name>
Get fields for a source object by connection name.
GET
/api/v2/connection/source/name/<name>/field/<object name>
Get fields for a target object by connection ID.
GET
/api/v2/connection/target/<id>/field/<object name>
Get fields for a target object by connection name.
GET
/api/v2/connection/target/name/<name>/field/<object name>
Update fields in a source flat file by connection ID.
POST
/api/v2/connection/source/<id>/field/<objectName>
Update fields in a target flat file by connection ID.
POST
/api/v2/connection/target/<id>/field/<objectName>
Update fields in a source object that's not a flat file by connection ID.
POST
/api/v2/connection/source/<id>/fields?objectName=<object name>
Update fields in a target object that's not a flat file by connection ID.
POST
/api/v2/connection/target/<id>/fields?objectName=<object name>
File listeners (version 1 resource)
Create, update, delete, run a file listener, and change the owner of a file listener association from one user to another.
The following table lists the operations:
Operation
Method
URI
Get file listener details.
GET
mftsaas/api/v1/filelisteners/<filelistener ID>
Get the status of a file listener.
GET
mftsaas/api/v1/filelisteners/job/<Job ID>/status
Get file listener job details.
GET
mftsaas/api/v1/filelisteners/<Run ID>/activityLog
Create a file listener and event listener.
POST
mftsaas/api/v1/filelisteners
Change the owner of a file listener association.
POST
mftsaas/api/v1/ChangeCallbackOwnership
Start a file listener.
POST
mftsaas/api/v1/filelisteners/<file listener ID>/start
Stop a file listener.
POST
mftsaas/api/v1/filelisteners/<file listener ID>/stop
Update a file listener.
PUT
mftsaas/api/v1/filelisteners/<filelistener ID>
Delete a file listener.
DELETE
mftsaas/api/v1/filelisteners/<file listener ID>
File transfer (version 1 resource)
Send files to a remote server or receive files from a remote server.
The following table lists the operations:
Operation
Method
URI
Get the status of a file transfer job.
GET
mftsaas/api/v1/job/<runID>/status
Transfer files.
POST
mftsaas/api/v1/sendfiles/<connection ID>
Receive files.
POST
mftsaas/api/v1/receivefiles/<connection ID>
Compress and transfer files for a file transfer task using a hosted server.
POST
mftsaas/api/v1/filetransferTask/execute/1003
Decompress and transfer files for a file transfer task using a hosted server.
POST
mftsaas/api/v1/filetransferTask/execute/1004
Encrypt and transfer files for a file transfer task using a hosted server.
POST
mftsaas/api/v1/filetransferTask/execute/1001
Decrypt and transfer files for a file transfer task using a hosted server.
POST
mftsaas/api/v1/filetransferTask/execute/1002
Compress and transfer files for a file transfer task using a remote server.
POST
mftsaas/api/v1/filetransferTask/execute/1003
Decompress and transfer files for a file transfer task using a remote server.
POST
mftsaas/api/v1/filetransferTask/execute/1004
Encrypt and transfer files for a file transfer task using a remote server.
POST
mftsaas/api/v1/filetransferTask/execute/1001
Decrypt and transfer files for a file transfer task using a remote server.
POST
mftsaas/api/v1/filetransferTask/execute/1002
Fixed-width configuration (version 2 resource)
Get, create, update, and delete fixed-width formats for flat file sources, targets, and lookups.
The following table lists the operations:
Operation
Method
URI
Get all fixed-width formats.
GET
/api/v2/fwConfig
Get a fixed-width format by format ID.
GET
/api/v2/fwConfig/<id>
Get a fixed-width format by federated ID.
GET
/api/v2/fwConfig/frs/<id>
Get a fixed-width format by format name.
GET
/api/v2/fwConfig/name/<name>
Create a fixed-width format.
POST
/api/v2/fwConfig
Update a fixed-width format.
POST
/api/v2/fwConfig/<id>
Delete a fixed-width format.
DELETE
/api/v2/fwConfig/<id>
Hierarchical mappers (version 1 resource)
Create or run a hierarchical mapper that converts hierarchical data to a different hierarchical structure. You can also get metadata about a hierarchical mapper.
The following table lists the operations:
Operation
Method
URI
Get metadata about a hierarchical mapper.
GET
/h2h/api/v1/idsm/metadata/<hierarchical mapper ID>
Create a hierarchical mapper.
POST
/h2h/api/v1/create/<hierarchical mapper ID>
Run a hierarchical mapper.
POST
/h2h/api/v1/service/run/<hierarchical mapper ID>
Job log files (version 1 resource)
Get log information for completed
Data Integration
 jobs from
Operational Insights
.
The following table lists the operations:
Operation
Method
URI
Get all log information.
GET
/cdiinsights-service/api/v1/analytical/Orgs(<orgID>)/JobLogEntries
Linear taskflows (version 2 resource)
Get the details of a linear taskflow or the details of all linear taskflows in the organization. You can also create, update, and delete linear taskflows.
The following table lists the operations:
Operation
Method
URI
Get details of all linear taskflows.
GET
/api/v2/workflow
Get details for a linear taskflow by taskflow ID.
GET
/api/v2/workflow/<id>
Get details for a linear taskflow by taskflow name.
GET
/api/v2/workflow/name/<name>
Create a linear taskflow.
POST
/api/v2/workflow
Update a linear taskflow.
POST
/api/v2/workflow/<id>
Delete a linear taskflow.
DELETE
/api/v2/workflow/<id>
Mappings (version 2 resource)
Get details for a mapping or the details of all mappings in the organization.
The following table lists the operations:
Operation
Method
URI
Get details of all mappings.
GET
/api/v2/mapping
Get mapping details by mapping ID.
GET
/api/v2/mapping/<id>
Get mapping details by mapping name.
GET
/api/v2/mapping/name/<name>
Get details for all transformations in a mapping by mapping ID
GET
/api/v2/mapping/additionalTransformationInfo/<mapping ID>
Get details for transformations of a particular type in a mapping by mapping ID
GET
/api/v2/mapping/additionalTransformationInfo/<mapping ID>?txType=<transformation type>
Get details for all transformations in a mapping by mapping name
GET
/api/v2/mapping/additionalTransformationInfoByName/<mapping name>
Get details for transformations of a particular type in a mapping by mapping name
GET
/api/v2/mapping/additionalTransformationInfoByName/<mapping name>?txType=<transformation type>
Get a mapping image.
GET
/api/v2/mapping
/<id>
/image?deployed=<true|false>
Mapping
 tasks (version 2 resource)
Get details of a
mapping
 task. You can also create, update, and delete
mapping
 tasks.
The following table lists the operations:
Operation
Method
URI
Get
mapping
 task details by task ID.
GET
/api/v2/mttask/<id>
Get
mapping
 task details by federated ID.
GET
/api/v2/mttask/frs/<id>
Get
mapping
 task details by task name.
GET
/api/v2/mttask/name/<name>
Create a
mapping
 task.
POST
/api/v2/mttask/
Update a
mapping
 task by task ID.
POST
/api/v2/mttask/<id>
Update a
mapping
 task by federated ID.
POST
/api/v2/mttask/frs/<id>
Delete a
mapping
 task.
DELETE
/api/v2/mttask/<id>
PowerCenter mapplets (version 2 resource)
Get details of a PowerCenter mapplet or to request a list of all PowerCenter mapplets in the organization. You can also use this resource to upload and delete PowerCenter mapplets.
The following table lists the operations:
Operation
Method
URI
Get a list of all PowerCenter mapplets.
GET
/api/v2/customFunc
Get PowerCenter mapplet details by mapplet ID.
GET
/api/v2/customFunc/<id>
Get PowerCenter mapplet details by mapplet name.
GET
/api/v2/customFunc/name/<name>
Upload a new PowerCenter mapplet.
POST
/api/v2/customFunc
Update a PowerCenter mapplet.
POST
/api/v2/customFunc/<id>
Delete a PowerCenter mapplet.
DELETE
/api/v2/customFunc/<id>
Synchronization
 task conversion
Convert
synchronization
 tasks to
data transfer
 tasks.
The following table lists the operations:
Operation
Method
URI
Test compatibility between a
synchronization
 task and
data transfer
 task features.
GET
/dtt/dss/convert/test/<assetId>
Convert a
synchronization
 task to a
data transfer
 task.
POST
/dtt/dss/convert/<assetId>
Taskflows (version 1 resource)
Get the status of a taskflow, publish taskflows, and unpublish taskflows.
The following table lists the operations:
Operation
Method
URI
Get the status of a taskflow.
GET
/active-bpel/services/tf/status/<run ID>
Publish a taskflow.
POST
/active-bpel/asset/v1/publish
Unpublish a taskflow.
POST
/active-bpel/asset/v1/unpublish
0 COMMENTS
We’d like to hear from you!