Getting Started with Cloud Data Profiling REST API

Back Next

Run a profile

You can run the profile to extract column statistics, patterns, data types, value frequencies, and outliers for columns and rules.

POST request: Use the POST method to run a profile.; The following table lists the parameters that you need to specify to run a profile:

Property
Value

URL
Enter a URL to run a profile. Use the following format: https://usw3-dqprofile.dm-ap.informaticacloud.com/profiling-service/api/v1/profile/id/execute
API parameters: The following table lists the important query parameters exposed for this API:

Property
Value

ID

The unique identifier of the Data Profiling asset.

For example, 908ed64e-cfd0-4544-bb69-5f5414e2f18b

To retrieve the ProfileId, see the Prerequisites section.
API response code: 200 OK

Property	Value
URL	Enter a URL to run a profile. Use the following format: https://usw3-dqprofile.dm-ap.informaticacloud.com/profiling-service/api/v1/profile/id/execute

Property	Value
ID	The unique identifier of the Data Profiling asset. For example, 908ed64e-cfd0-4544-bb69-5f5414e2f18b To retrieve the ProfileId, see the Prerequisites section.

API response: { "profileRunId": "c47bf0ba-ff07-4235-85db-c82d17c5ad45" "profileJobId": "67f6b06a-a830-4b46-a137-e047c8087176" }

Profiling Tutorial

Download Guide

Watch

Comments

Cloud Data Profiling Homepage

0 COMMENTS

We’d like to hear from you! Log in to comment.

Robert Doan - December 23, 2024

This page should be updated to clarify that the ID input is actually a path parameter, for example: {$baseURL}/profiling-service/api/v1/profile/{$id}/execute

My initial impression from this document was that "ID" was supposed to be passed in the JSON body of the POST request, which is not correct.

Informatica Documentation Team - December 25, 2024

Hi Robert Doan,

We’re working to address your comments and we'll update the docs in an upcoming release.

Thanks,

Informatica Documentation team

Rename Saved Search

Table of Contents

Getting Started with Cloud Data Profiling REST API

Getting Started with Cloud Data Profiling REST API

Run a profile

Run a profile