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

REST API Reference

REST API Reference

Data Integration resource quick reference

Data Integration
resource quick reference

The following list contains the syntax and a brief description of the
Data Integration
resources:
CodeTask POST
disnext version 1 resource.
Creates or starts a
code task
.
Use the server URL from the login response as the base URL for one of the following URIs:
  • To create a
    code task
    , use the following URI:
    /disnext/api/v1/CodeTask
  • To start a
    code task
    , use the following URI:
    /disnext/api/v1/CodeTask/Start
CodeTask GET
disnext version 1 resource.
Gets the details or the status of a
code task
.
Use the server URL from the login response as the base URL for one of the following URIs:
  • To get the details of a
    code task
    , use the following URI:
    /disnext/api/v1/CodeTask/<codeTaskId>
  • To get the status of a
    code task
    , use the following URI:
    /disnext/api/v1/CodeTask/JobStatus/<jobId>
CodeTask PUT
disnext version 1 resource.
Cancels a
code task
job.
Use the server URL from the login response as the base URL for the following URI:
/disnext/api/v1/CodeTask/Cancel
connection GET
Version 2 resource.
Returns information related to connections in the organization.
Use the serverUrl from the login response as the base URL.
You can request the following information:
  • Connection details. To request the details of a connection or of all connections in the organization, use one of the following URIs:
    /api/v2/connection /api/v2/connection/<id> /api/v2/connection/name/<name>
  • Connection objects. To request a list of objects that you can use as a source or target for the specified connection, use one of the following URIs:
    /api/v2/connection/source/<id> /api/v2/connection/target/<id>
  • Connection details by runtime environment. To request a list of all connections in the organization that use a particular runtime environment, use the following URI:
    /api/v2/connection/<runtimeEnvironmentId>
  • Connections by Secure Agent and connection type. To request a list of connections by Secure Agent ID and connection type, use the following URI:
    /api/v2/connection/search?agentId=<id>&uiType=<uiType>
  • Metadata details. To request metadata details for a connection, use the following URI:
    /api/v2/connection/<source or target>/<id>/metadata
  • Test connection. To test a connection, use the following URI:
    /api/v2/connection/test/<id>
connection POST
Version 2 resource.
Creates or updates a connection.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/connection/<id>
Use a connection object to define attributes.
connection DELETE
Version 2 resource.
Deletes a connection.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/connection/<id>
connector GET
Version 2 resource.
Returns a list of connectors available to the organization or attribute values for a specified connector type.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/connector /api/v2/connector/metadata?connectorType=<type>
customFunc GET
Version 2 resource.
Returns the details of a PowerCenter mapplet or of all PowerCenter mapplets in the organization.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/customFunc /api/v2/customFunc/<id> /api/v2/customFunc/name/<name>
customFunc POST
Version 2 resource.
Uploads a PowerCenter mapplet.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/customFunc/<id>
Define attributes in the request body and encode the request body as multipart/form-data. Include the following required attributes: file, name.
customFunc DELETE
Version 2 resource.
Deletes a PowerCenter mapplet.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/customFunc/<id>
dataPreview GET
Version 2 resource.
Use to preview data during mapping design. Specify the number of rows to return of source or target data for a specified object.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/connection/<source or target>/<connection ID>/datapreview/<object name> /api/v2/connection/<source or target>/name/<name>/datapreview/<object name>
dynamictask GET
Batch-mapping version 1 resource.
Returns the details of a
dynamic mapping
task.
Use the serverUrl from the login response as the base URL for the following URI:
/batch-mapping/api/v1/dynamictask/<id>
dynamictask POST
Batch-mapping version 1 resource.
Creates a
dynamic mapping
task.
Use the serverUrl from the login response as the base URL for the following URI:
/batch-mapping/api/v1/dynamictask
dynamictask PUT
Batch-mapping version 1 resource.
Updates a
dynamic mapping
task.
Use the serverUrl from the login response as the base URL for the following URI:
/batch-mapping/api/v1/dynamictask/<id>
dynamictask DELETE
Batch-mapping version 1 resource.
Deletes a
dynamic mapping
task.
Use the serverUrl from the login response as the base URL for the following URI:
/batch-mapping/api/v1/dynamictask/<id>
expressionValidation POST
Version 2 resource.
Validates expressions and returns a success or error response.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/expression/validate
field GET
Version 2 resource.
Returns the field details for a source or target object.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/connection/<source or target>/<id>/field/<name> /api/v2/connection/<source or target>/name/<name>/field/<name> /api/v2/connection/<source or target>/<id>/fields?objectName=<name>
field POST
Version 2 resource.
Updates the flat file attributes for a source or target object.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/connection/<source or target>/<id>/field/<name>
The flat file attributes provided in the request override the default attributes specified in the connection object.
filelisteners GET
mftsaas version 1 resource.
Gets file listener details and job status.
To get file listener details, use the serverUrl from the login response as the base URL for the following URI:
api/v1/filelisteners/<id>
To get the status of a file listener job, use the serverUrl from the login response as the base URL for the following URI:
mftsaas/api/v1/filelisteners/job/<id>/status
filelisteners POST
mftsaas version 1 resource.
Creates a file listener.
To create a file listener, use the serverUrl from the login response as the base URL for the following URI:
api/v1/filelisteners
To start a file listener, use the serverUrl from the login response as the base URL for the following URI:
mftsaas/api/v1/filelisteners/<id>/start
To stop a file listener , use the serverUrl from the login response as the base URL for the following URI:
mftsaas/api/v1/filelisteners/<id>/stop
filelisteners PUT
mftsaas version 1 resource.
Updates an existing file listener.
Use the serverUrl from the login response as the base URL for the following URI:
mftsaas/api/v1/filelisteners/<id>
filelisteners DELETE
mftsaas version 1 resource.
Deletes an existing file listener.
Use the serverUrl from the login response as the base URL for the following URI:
mftsaas/api/v1/filelisteners/<id>
fileRecord POST
Version 2 resource.
Upload a Visio template XML file or image file.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/fileRecord
Define attributes in the request body and encode the request body as multipart/form-data. Include the following required attributes: file, name.
fileRecord DELETE
Version 2 resource.
Delete a Visio template file or image file.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/fileRecord/<id>
fwConfig GET
Version 2 resource.
Returns the details of a fixed-width format.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/fwConfig/<id> /api/v2/fwConfig/name/<name>
fwConfig POST
Version 2 resource.
Uploads a fixed-width format.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/fwConfig/<id>
fwConfig DELETE
Version 2 resource.
Delete a fixed-width format.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/fwConfig/<id>
mapping GET
Version 2 resource.
Returns the details of a mapping or of all mappings in the organization. Can also return an image of a mapping.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/mapping/<id> /api/v2/mapping/name/<name> /api/v2/mapping/search?name=<name> /api/v2/mapping/<id>/image?deployed=<true|false>
masterTemplate GET
Version 2 resource.
Returns information about Visio templates. You can request the following information:
  • Visio templates. You can request the details of a Visio template or of all Visio templates in the organization. Use the serverUrl from the login response as the base URL for one of the following URIs:
    /api/v2/masterTemplate/<id> /api/v2/masterTemplate/name/<name>
  • Mapping
    tasks. You can request a list of
    mapping
    tasks that use a Visio template. Use the serverUrl from the login response as the base URL for the following URI:
    /api/v2/masterTemplate/<id>/tasks
masterTemplate POST
Version 2 resource.
Creates or updates a Visio template.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/masterTemplate/<id>
Use a masterTemplate object to define attributes.
masterTemplate DELETE
Version 2 resource.
Deletes a Visio template.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/masterTemplate/<id>
mttask GET
Version 2 resource.
Returns the details of a
mapping
task.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/mttask/<id> /api/v2/mttask/frs/<federated task ID> /api/v2/mttask/name/<name>
mttask POST
Version 2 resource.
Creates or updates a
mapping
task.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/mttask/<id> /api/v2/mttask/frs/<federated task ID>
Use an mttask object to define attributes.
mttask DELETE
Version 2 resource.
Deletes a
mapping
task.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/mttask/<id>
sendfiles POST
AS2 file transfer version 1 API.
Uses an AS2 connection to transfer files to a remote AS2 server.
Use the serverUrl from the login response as the base URL for the following URI:
mftsaas/api/v1/sendfiles/<connection name>
workflow GET
Version 2 resource.
Returns the details of a linear taskflow or of all linear taskflows in the organization.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/workflow/<id> /api/v2/workflow/name/<name> /api/v2/workflow/?simpleMode=true
workflow POST
Version 2 resource.
Creates or updates a linear taskflow.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/workflow/<id>
Use a workflow object to define attributes.
workflow DELETE
Version 2 resource.
Deletes a linear taskflow.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/workflow/<id>

0 COMMENTS

We’d like to hear from you!