Search Results interface_api_id

Overview

IGS_AD_API_INT is an Oracle E-Business Suite view owned by the APPS schema. It exposes the working contents of the IGS_AD_API_INT_ALL interface table, which is used by the Oracle Student System (formerly Oracle iLearning / Oracle Student Systems) module for the address and third-party API inbound interface. In Oracle EBS 12.1.1 and 12.2.2, the view functions as a reporting and diagnostics layer for staged address API records prior to validation and transfer into the production address tables (HZ_LOCATIONS, HZ_PARTIES, and related TCA entities).

The view is principally used by concurrent programs, interfaces, and support analysts. It carries the standard Oracle interface-table conventions: a STATUS column, a MATCH_IND column, an ERROR_CODE column, and WHO/audit columns (CREATED_BY, CREATION_DATE, LAST_UPDATED_BY, LAST_UPDATE_DATE, LAST_UPDATE_LOGIN) plus request and program context columns. These let operators identify which records are pending, processed, or rejected and trace their origin back to a concurrent request.

The user's search term, interface_api_id, is the primary identifier exposed by this view. It is the unique key that ties each interface row to a specific API invocation, and it is the column most often referenced when troubleshooting address API failures.

Underlying Base Objects

The view is defined solely over the table IGS_AD_API_INT_ALL. No other documented base objects contribute to the definition. The view text projects the ROWID of the base row as ROW_ID, exposing all operational, audit, and descriptive columns without filtering or joining. Because IGS_AD_API_INT_ALL is an _ALL suffix table, it is multi-org enabled and includes the ORG_ID column, which the view faithfully surfaces.

The absence of joins means the view is a flat, direct projection of the underlying interface table. Consequently, performance characteristics mirror the base table: full scans are common, and the absence of documented indexes on the view itself means indexing is inherited from IGS_AD_API_INT_ALL.

Key Columns

• INTERFACE_API_ID — Primary identifier for the API interface row, linking the record to its originating API call. The central search target for this view.
• INTERFACE_ID — The parent interface identifier grouping related address API records.
• STATUS — Processing state of the row (for example pending, successfully processed, or error).
• ERROR_CODE — Populated when the row fails validation or transfer.
• MATCH_IND — Match flag indicating whether an existing party or location was matched during processing.
• PERSON_ID_TYPE / ALTERNATE_ID — Party identification and cross-reference data.
• START_DT / END_DT / MATCH_IND — Date-effectivity controls for the address record.
• REGION_CD — Region code for the address being interfaced.
• ORG_ID — Operating unit context, reflecting the multi-org nature of the _ALL table.
• REQUEST_ID, PROGRAM_ID, PROGRAM_APPLICATION_ID, PROGRAM_UPDATE_DATE — Concurrent request and program execution context.
• ATTRIBUTE_CATEGORY and ATTRIBUTE1 through ATTRIBUTE20 — Descriptive flexfield columns available for custom data.

Common Use Cases and Queries

Typical usage includes monitoring interface load health, identifying rows in error, and reconciling concurrent request outputs. A query targeting the user's search term:

SELECT interface_api_id,
       interface_id,
       status,
       error_code,
       person_id_type,
       alternate_id,
       match_ind,
       org_id
FROM   apps.igs_ad_api_int
WHERE  interface_api_id = :interface_api_id;

Listing all errored rows for a run:

SELECT interface_api_id, interface_id, status, error_code,
       created_by, creation_date, request_id
FROM   apps.igs_ad_api_int
WHERE  status = 'ERROR'
ORDER  BY creation_date DESC;

Because the view reduces to a single base table, standard tuning applies: filter on INTERFACE_API_ID or STATUS when indexed on IGS_AD_API_INT_ALL, and restrict by ORG_ID in a multi-org environment. The view is read-mostly; corrections are made against the base table, after which the record is resubmitted for processing.