Getting Started with Cloud Data Profiling REST API

Back Next

Explore profile definition

View the profile definition information such as general asset information, source details, formatting options, sampling options, profileable fields, and drilldown type.

GET request: Use the GET method to fetch profile definition information based on the profile ID.; The following table lists the parameters that you need to specify to explore profile definition:

Property
Value

URL
Enter a URL to fetch the profile definition. Use the following format: https://usw3-dqprofile.dm-ap.informaticacloud.com/profiling-service/api/v1/profile/<ID>
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 fetch the profile definition. Use the following format: https://usw3-dqprofile.dm-ap.informaticacloud.com/profiling-service/api/v1/profile/<ID>

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: { "id":"ee99c41e-779b-4846-92a0-6047e26e5823" "profileKey":2676 "version":0 "name":"ALL_COLUMN" "orgId":"bk5LnFlx32ZjYMsTbXYN6z" "description":"Creating profile using Automation." "frsId":"c1xEOUmYfwwgFzu8CCNmU2" "connectionId":"5abzn0m1erWcY4LBDPHXer" "createdBy":"3vC7otmqf3weY98g8jzuG2" "createdByName":"USER4" "createTime":1596601754485 "updatedBy":"3vC7otmqf3weY98g8jzuG2" "updatedByName":"USER4" "updateTime":1596601754488 "lastRunKey":1 "isFilterEnabled":NULL "runtimeOptions":{ "id":"4b4d8cbc-c0fe-4686-b300-e5a7b8d3e206" "scheduleId":NULL "runtimeEnvironmentId":NULL "defaultEmailNotification":true } "source":{ "id":"3a054fc3-12b3-42ed-94f1-558cfb66b200" "name":"SUPPORTED_DATATYPE" "fields":[...] "dataSourceType":"UNSET" "sourceType":"DATASOURCE" } "profileableFields":[ 0:{ "id":"cfa05374-c70e-4d97-b895-a67a15e0040e" "isDeleted":false "columnKey":10008 "sourceName":"SUPPORTED_DATATYPE" "fieldName":"CHARACTERVARYING_COL" "fieldType":"DATASOURCEFIELD" } 1:{...} 2:{...} 3:{...} 4:{...} ] "samplingOptions":{ "id":NULL "rows":-1 "samplingType":"ALL_ROWS" } "drillDownType":"ON" }

Profiling Tutorial

Download Guide

Watch

Comments

Cloud Data Profiling Homepage