Getting Started with Cloud Data Profiling REST API

Back Next

Identify the unique rule id

You can use the

getRuleIds

API call to identify the unique ID of the rule that is associated with a profile.

POST request: Use the POST method to return the unique ID of a rule that is associated with a profile.; The following table lists the parameters to specify:

Property
Description

URL
Enter a URL to return the unique ID of a rule that is associated with a profile. Use the following format: https://[HostName]/profiling-service/api/v1/profile/getRuleIds

IDS-SESSION-ID
REST API session ID for the current session. For example,
klCIHW6BvWmeFFwlQg7q84

PROFILEID
The unique identifier of the Data Profiling asset. For example, 908ed64e-cfd0-4544-bb69-5f5414e2f18b
API parameters: The following table lists the important query parameters exposed for this API:

Property
Description

profileName
Name of the profile.

frsProjectName
Name of the project that contains the folders and profiles.

frsFolderName
Name of the folder that contains the profiles.

ruleName
Name of the rule.

columnId
The unique identifier of the column.

columnName
Name of the column.

ruleProject
Name of the project that contains the saved rule.

ruleFolder
Name of the folder that contains the profile and rule.

frsRuleId
The unique identifier of the rule.
API response code: 200 OK

Property	Description
URL	Enter a URL to return the unique ID of a rule that is associated with a profile. Use the following format: https://[HostName]/profiling-service/api/v1/profile/getRuleIds
IDS-SESSION-ID	REST API session ID for the current session. For example, klCIHW6BvWmeFFwlQg7q84
PROFILEID	The unique identifier of the Data Profiling asset. For example, 908ed64e-cfd0-4544-bb69-5f5414e2f18b

Property	Description
profileName	Name of the profile.
frsProjectName	Name of the project that contains the folders and profiles.
frsFolderName	Name of the folder that contains the profiles.
ruleName	Name of the rule.
columnId	The unique identifier of the column.
columnName	Name of the column.
ruleProject	Name of the project that contains the saved rule.
ruleFolder	Name of the folder that contains the profile and rule.
frsRuleId	The unique identifier of the rule.