Metadata Mapping for API Jobs

Important:On the Add API Job page, you need to test your API connection in the Request Info phase before completing this section.

The second phase of the Add API Job page is Metadata Mapping. Complete the following steps to map fields between the selected task fields in the FSM Data Ingestion Utility and the field headers in the input API that was uploaded in Adding a New API Job. After this task is successfully complete, you can import your organization’s SaaS data using the SaaS vendor’s API as detailed in Importing an API Job.

To map between FSM Data Ingestion Utility and the field headers in the input API:

1. Go to the API Jobs page (API Jobs > API Jobs).
2. Select the Metadata Mapping phase to display the Metadata Mapping table. The following table describes the Metadata Mapping fields.

Field

Description

Application

Displays the selected SaaS application name for the associated API job.

Mapped Fields

Displays the input API header fields to be mapped.

Action

Click the Map link in the Action field to map between FSM Data Ingestion Utility and the field headers in the input API.
Click the Clear link in the Action field to clear the mapping of the respective API headers.
3. For the Date Format dropdown list, select the appropriate date format that is represented in your API job. FSM Data Ingestion Utility supports the following date formats.

Date Format

Example

yyyy-MM-dd

(2024-02-05)

Note:This is the default date format.

dd/MM/yyyy

(05/02/2024)

dd-MM-yyyy

(05-02-2024)

dd-MMM-yyyy

(05-Feb-2024)

dd-Month-yyyy

(05-February-2024)

dd/yyyy/MM

(05/2024/02)

MM/dd/yyyy

(05/02/2024)

MMM/dd/yyyy

(Feb/05/2024)

Month/dd/yyyy

(February/05/2024)

MM/yyyy/dd

(02/2024/05)

yyyy/MM/dd

(2024/02/05)

yyyy/MMM/dd

(2024/Feb/05)

yyyy/Month/dd

(2024/February/05)

4. In the Actions column, click Map. The Select Mapping Field dialog box opens. The field mapping between the FSM Data Ingestion Utility task fields and the input API fields is configured.

Important:When Name values appear in the Mapped Fields column, the user’s name is automatically mapped to firstName, middleName, and lastName in FSM Data Ingestion Utility. No manual formatting is necessary. For example, the Name value dennis g abbas would be mapped as:

firstName is dennis 
middleName is g 
lastName is abbas.
5. Select the required Test Connection Response for the task field.
6. Click Save. The API field is mapped and is listed in the Mapped Fields column.

Note:If you click Save without mapping the mandatory fields, an error message displays with the names of the missing field names. Example: The following fields are mandatory and cannot be empty: ssoAppName, ssoAppDisplayName, appInstanceID

The following table lists the mandatory fields for the integration tasks in the FSM Data Ingestion Utility.

Task

Mandatory Field

Application Roster

Unique ID

Email

First Name

Last Name

Application Usage

Unique ID

Occurred At

Application Discovery

SSO App Name

SSO App Display Name

App Instance ID

SSO Application Roster

Unique ID

Email

First Name

Last Name

App Instance ID

SSO Application Usage

Unique ID

Occurred At

App Instance ID

Product Consumption

ID

Occurred At

Usage Group

Continue to Previewing a Scheduled API Job.

Previewing a Scheduled API Job

Before you import your API job into the FSM Data Ingestion Utility, you can preview your SaaS vendor data. This preview workflow ensures correct data mapping and successful data importing. Completing the following steps.

To preview a scheduled API job:

1. Go to the API Jobs page (API Jobs > API Jobs).
2. Go to the Jobs Scheduled tab.
3. Go to the appropriate Job ID table row.
4. In the Actions column, click Preview. The Data Preview dialog box opens.
If SaaS vendor data is available in the API job, you will see a maximum of 10 records with mapped job data.
If you wish to make changes to the mapped data, refer to Metadata Mapping for API Jobs.
If the SaaS vendor data is mapped correctly, continue to Importing an API Job.
If no SaaS vendor data is available in the API job, you will see the following message: There is no data available to preview: [JOB NAME]. If you mapped the SaaS vendor data incorrectly and need to change the API job’s data mapping fields, refer to Metadata Mapping for API Jobs.