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 returned in the lookup response for the federated task ID field in the job 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 unique identifier for 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.
Use one of the following values:
- PROJECT
- FOLDER
Or use one of the following asset types:
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_FILE_LISTENER. File listener.
- 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 unique identifier for 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