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

lookup

lookup

Use the lookup resource to look up an object's ID, name, path, or type attributes.

POST request

This resource is usually used to obtain an object's ID to use in an export request or job request. When you use this resource to obtain an object's ID, include the object path and type in the lookup request.
For a job request, use the value of the id field for the taskFederatedId field in the request.
To request lookup information, use the following URI:
/public/core/v3/lookup
You can use the following fields in the objects object:
Field
Type
Required
Description
id
String
Required if object path and type not included.
Global identifier of the object.
path
String
Required with type if object ID not included.
Full path of the object including project, folder, and object name.
type
String
Required with path if object ID not included.
Type of object.
For
Data Integration
, the object can be one of the following types:
  • DTEMPLATE. Mapping.
  • MTT. Mapping task.
  • DSS. Synchronization task.
  • DMASK. Masking task.
  • DRS. Replication task.
  • CONNECTION.
  • AGENT. Secure Agent.
  • AGENTGROUP. Runtime environment.
  • MAPPLET.
  • BSERVICE. Business service definition.
  • HSCHEMA. Hierarchical schema.
  • PCS. PowerCenter task.
  • FWCONFIG. Fixed width configuration.
  • CUSTOMSOURCE. Saved query.
  • MI_TASK. Mass ingestion task.
  • WORKFLOW. Linear taskflow.
  • VISIOTEMPLATE
  • SCHEDULE
  • SCHEDULE_JOB
  • SCHEDULE_BLACKOUT. Schedule blackout period.
  • TASKFLOW
For
Application Integration
, the object can be one of the following types:
  • PROCESS
  • GUIDE
  • AI_CONNECTION
  • AI_SERVICE_CONNECTOR
  • PROCESS_OBJECT
For B2B Gateway, the object can be one of the following types:
  • B2BGW_MONITOR
  • B2BGW_CUSTOMER
  • B2BGW_SUPPLIER
Object types are not case sensitive.

POST response

Returns object information if successful or an error object if errors occur.
If successful, returns the following lookup information for each object:
Field
Type
Description
objects
Collection
Collection of objects for which lookup is requested.
id
String
Global identifier of the object. Use the value of this field as the value for taskFederatedId when you submit a job request.
path
String
Full path of the object including project, folder, and object name.
type
String
Type of object.
description
String
Description of the object.
createdBy
String
User who created the object.
updateTime
String
Last time the object was modified.

POST example

The following example shows a lookup request for eight objects:
POST <baseApiUrl>/public/core/v3/lookup Content-Type: application/json Accept: application/json INFA-SESSION-ID: 9KA11tLGqxVcGeul8SQBK3 { "objects": [{ "id" : "2iXOKghGpySlgv6ifQImyl" }, { "path" : "Default/Synchronization Task1", "type" : "DSS" }, { "id" : "hTrrjm1kawScIm1BGEj6UV" }, { "path" : "My Project", "type" : "Project" }, { "path" : "My Project/DSS Tasks Folder", "type" : "Folder" }, { "path": "USW1R90FPZXD", "type": "Agent" }, { "path": "USW1R90FPZXD", "type": "AgentGroup" }, { "path": "FF_Conn_1", "type": "Connection" }] }
The response includes lookup information for each object as shown in the following example:
{ "objects": [ { "id": "2iXOKghGpySlgv6ifQImyl", "path": "Default/Mapping1", "type": "DTEMPLATE", "description": "My Mapping 1", "updateTime": "2018-04-13T20:44:37Z" }, { "id": "1fOqrwpFvLkimAkFFvIiwl", "path": "Default/Synchronization Task1", "type": "DSS", "description": "Sync Data Task", "updateTime": "2018-04-13T20:45:44Z" }, { "id": "hTrrjm1kawScIm1BGEj6UV", "path": "My Project/Linear Taskflow1", "type": "WORKFLOW", "description": null, "updateTime": "2018-04-13T20:50:31Z" }, { "id": "0EzsUXQ1RnkbKD6VyOukCb", "path": "My Project", "type": "Project", "description": "", "updateTime": "2018-04-13T20:40:07Z" }, { "id": "dRNcMcUVou5lh5kihmEAWl", "path": "My Project/DSS Tasks Folder", "type": "Folder", "description": "DSS Tasks", "updateTime": "2018-04-13T20:49:17Z" }, { "id": "1a8moeCNtm4fh5vGcUhxOj", "path": "USW1R90FPZXD", "type": "AGENT", "description": null, "updateTime": "2018-04-12T19:01:16Z" }, { "id": "9iJP8TdBOMujA7eH2CTm8l", "path": "USW1R90FPZXD", "type": "AgentGroup", "description": null, "updateTime": "2018-04-12T19:01:17Z" }, { "id": "5VkwOw6Jd8RglXEkxDu0ya", "path": "FF_Conn_1", "type": "Connection", "description": null, "updateTime": "2018-04-12T21:34:11Z" } ] }


Updated May 03, 2021