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:

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_CONNECTOR
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:

Filed

Type

Description

objects

Collection

Collection of object

id

String

path

String

type

String

description

String

createdBy

String

updateTime

String