Connect to the Jet Analytics API with the REST Data Source

Jobs deprecated: This article references the Jet Analytics Jobs API, which has been deprecated. Schedule Jet Analytics Data Integration execution packages via Jet Analytics Orchestration rather than using Jobs.

The article is retained as a reference for configuring REST endpoints that use dynamic values drawn from another endpoint — this technique applies to any REST API, not just the Jobs API.

This article shows how to connect to the Jet Analytics API endpoints using the Jet Analytics REST data source. It demonstrates how to configure a dynamic endpoint whose path is populated with values drawn from another endpoint — for example, retrieving job logs for each job ID returned by the jobs endpoint.

Prerequisites

Generate an API key in the Jet Analytics Portal under Admin > Security and permissions. See API Key Management for instructions.
Note the API domain: apim-txportal-prod.azure-api.net. This can also be found in the Jet Analytics API Postman collection.

Configure the data source

Add a new Jet Analytics REST data source, enter a name, and set the Base URL to:

https://apim-txportal-prod.azure-api.net/public

In the Header section, click Add and add the API key header:

Name:APIKey
Value: the generated API key
Enable Is sensitive to mask the value in previews.

Note:

The header name must be APIKey exactly — not the name you gave the key when generating it in the Portal. The value is the generated key string.

Add static endpoints

All Jobs

Set Path = jobs, Name = All jobs, and click Add endpoint. No additional settings are required.

All Statuses

Set Path = jobs/status, Name = All statuses, and click Add endpoint.

Note:

If using Azure Data Lake as Ingest storage and the transfer of the All Statuses endpoint fails with a data type error, add a data type override to convert all fields to NVarChar(50).

Add the dynamic endpoint (All Job Logs)

Before adding this endpoint, the data source must already be added to an Ingest instance and the transfer task for the All Jobs endpoint must have been run at least once. This ensures the endpoint has data to draw values from when the dynamic endpoint is configured.

The All Job Logs endpoint uses the following path structure, where {jobId} is replaced dynamically with each job ID from the All Jobs endpoint:

https://apim-txportal-prod.azure-api.net/public/jobs/{jobId}/logs

In the All Jobs table, the job ID field is called Id. The path uses curly brackets to reference the field name.

Configure the endpoint:

Set Path = jobs/{Id}/logs and Name = All job logs. Click Add endpoint.
Expand Advanced and click Enable in the Dynamic values section. Change Dynamic values source from Query to From endpoint table.
Set Select endpoint to All Jobs and Select table to the table that contains the Id field.
Click Save, synchronise the data source in Jet Analytics Data Integration, and run the transfer task.

Use the result in Jet Analytics Data Integration

The All Job Logs endpoint generates two tables: All job logs_TX_Root and JobExecutionLogs. To join them, relate the Id field from All job logs_TX_Root to the JobExecutionId field in JobExecutionLogs, and also relate the two TX_Autogenerated_Element_Id fields.