Getting Started with Cloud Data Profiling REST API

Back Next

Find the exact profile

Find the exact profile job if multiple profiles with the same name exist in different folders.

GET request: Use the GET method to fetch the exact profile.; The following table lists the parameter that you need to specify to find the exact profile:

Property
Value

URL
Enter a URL to fetch the right profile. Use the following format: https://usw3-dqprofile.dm-ap.informaticacloud.com/profiling-service/api/v1/profile

IDS-SESSION-ID
REST API session ID for the current session. Use in most REST API request headers. For example,
klCIHW6BvWmeFFwlQg7q84

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

frsFolderName
Name of the folder that contains the profiles.

name
Name of the profile.

exactMatch
Specify true if you want to search for a profile with its exact name.
API response code: 200 OK
Example: If Data Profiling contains profiles such as Profile1, Profile2, and Profile3 and you pass the
exactMatch
property as True to identify a profile named Profile1. The API fetches the exact profile name. If you pass the
exactMatch
property as False, the API fetches all the profiles that match the name partially.

Property	Value
URL	Enter a URL to fetch the right profile. Use the following format: https://usw3-dqprofile.dm-ap.informaticacloud.com/profiling-service/api/v1/profile
IDS-SESSION-ID	REST API session ID for the current session. Use in most REST API request headers. For example, klCIHW6BvWmeFFwlQg7q84
frsProjectName	Name of the project that contains the folders and profiles.
frsFolderName	Name of the folder that contains the profiles.
name	Name of the profile.
exactMatch	Specify true if you want to search for a profile with its exact name.

API response when you run the exactMatch property as True: [ { "id": "bd65f226-5c26-4348-88bd-dfc6be65ac4a", "profileKey": 24428, "version": 1, "name": "Profile1", "orgId": "d2axWRuaa6zffjGfvwWWQf", "description": "Creating profile using Automation.", "frsId": "310N0zDWccJkY40yGhwOIR", "frsProjectId": "7v6XDfrInjqlP4KO0AUlo3", "frsFolderId": "4rYOVAakQPtfg716rzlpeS", "connectionId": "fMxoRXfkpcGl47mi76z4uk", "createdBy": "1vcXL5Kw7jNgTUNO7sS9gF", "createdByName": "User4", "createTime": 1610906983086, "updatedBy": "1vcXL5Kw7jNgTUNO7sS9gF", "updatedByName": "User4", "updateTime": 1610906983305, "isFilterEnabled": null, "runtimeOptions": { "id": "5ecafc1b-7cad-4a1c-9d74-62ac8e096a19", "scheduleId": null, "runtimeEnvironmentId": null, "defaultEmailNotification": true }, "source": { "id": "510df11b-e4fc-4a73-8259-ca8d739f6667", "name": "Oracle_source", "fields": [ { "id": "e93b787a-49e2-47ba-8ad4-95dd1c94bb1f", "name": "LONG_COL", "dataType": "decimal", "precision": 38, "scale": 0, "pcType": "HIPRECDECIMAL", "order": 19, "isDeleted": false, "isMetadataUpdated": false }, ], "dataSourceType": "UNSET", "sourceType": "DATASOURCE" }, "profileableFields": [ { "id": "3c8c9108-3143-4a27-9609-cff24e93cdb4", "isDeleted": false, "columnKey": 10011, "sourceName": "Oracle_Source", "fieldName": "TIMESTAMP_COL", "fieldType": "DATASOURCEFIELD" }, { "id": "9c205cc3-8e17-408a-99bf-4385d3bb83cf", "isDeleted": false, "columnKey": 10032, "sourceName": "Oracle_Source", "fieldName": "DEC_COL", "fieldType": "DATASOURCEFIELD" }, { "id": "bc3030eb-3a2f-4163-910a-e5e32dc081f4", "isDeleted": false, "columnKey": 10010, "sourceName": "Oracle_Source", "fieldName": "DATE_COL", "fieldType": "DATASOURCEFIELD" }, ], "samplingOptions": { "id": null, "rows": -1, "samplingType": "ALL_ROWS" }, "drillDownType": "ON" } ]
API response when you run the exactMatch property as False: { "id": "bd65f226-5c26-4348-88bd-dfc6be65ac4a", "profileKey": 24428, "version": 1, "name": "Profile_1", "orgId": "d2axWRuaa6zffjGfvwWWQf", "description": "Creating profile using Automation.", "frsId": "310N0zDWccJkY40yGhwOIR", "frsProjectId": "7v6XDfrInjqlP4KO0AUlo3", "frsFolderId": "4rYOVAakQPtfg716rzlpeS", "connectionId": "fMxoRXfkpcGl47mi76z4uk", "createdBy": "1vcXL5Kw7jNgTUNO7sS9gF", "createdByName": "User4", "createTime": 1610906983086, "updatedBy": "1vcXL5Kw7jNgTUNO7sS9gF", "updatedByName": "User4", "updateTime": 1610906983305, "isFilterEnabled": null, "runtimeOptions": { "id": "5ecafc1b-7cad-4a1c-9d74-62ac8e096a19", "scheduleId": null, "runtimeEnvironmentId": null, "defaultEmailNotification": true }, "source": { "id": "510df11b-e4fc-4a73-8259-ca8d739f6667", "name": "Oracle_source", "fields": [ { "id": "e93b787a-49e2-47ba-8ad4-95dd1c94bb1f", "name": "LONG_COL", "dataType": "decimal", "precision": 38, "scale": 0, "pcType": "HIPRECDECIMAL", "order": 19, "isDeleted": false, "isMetadataUpdated": false }, ], "dataSourceType": "UNSET", "sourceType": "DATASOURCE" }, "profileableFields": [ { "id": "3c8c9108-3143-4a27-9609-cff24e93cdb4", "isDeleted": false, "columnKey": 10011, "sourceName": "Oracle_Source", "fieldName": "TIMESTAMP_COL", "fieldType": "DATASOURCEFIELD" }, { "id": "9c205cc3-8e17-408a-99bf-4385d3bb83cf", "isDeleted": false, "columnKey": 10032, "sourceName": "Oracle_Source", "fieldName": "DEC_COL", "fieldType": "DATASOURCEFIELD" }, { "id": "bc3030eb-3a2f-4163-910a-e5e32dc081f4", "isDeleted": false, "columnKey": 10010, "sourceName": "Oracle_Source", "fieldName": "DATE_COL", "fieldType": "DATASOURCEFIELD" }, ], "samplingOptions": { "id": null, "rows": -1, "samplingType": "ALL_ROWS" }, "drillDownType": "ON" }, "profileKey": 24429, "version": 2, "name": "Profile_2", "orgId": "d2axWRuaa6zffjGfvwWWQf", "description": "Creating profile using Automation.", "frsId": "310N0zDWccJkY40yGhwOIR", "frsProjectId": "7v6XDfrInjqlP4KO0AUlo3", "frsFolderId": "4rYOVAakQPtfg716rzlpeS", "connectionId": "fMxoRXfkpcGl47mi76z4uk", "createdBy": "1vcXL5Kw7jNgTUNO7sS9gF", "createdByName": "User4", "createTime": 1610906983086, "updatedBy": "1vcXL5Kw7jNgTUNO7sS9gF", "updatedByName": "User4", "updateTime": 1610906983305, "isFilterEnabled": null, "runtimeOptions": { "id": "5ecafc1b-7cad-4a1c-9d74-62ac8e096a19", "scheduleId": null, "runtimeEnvironmentId": null, "defaultEmailNotification": true }, "source": { "id": "510df11b-e4fc-4a73-8259-ca8d739f6667", "name": "Oracle_source", "fields": [ { "id": "e93b787a-49e2-47ba-8ad4-95dd1c94bb1f", "name": "LONG_COL", "dataType": "decimal", "precision": 38, "scale": 0, "pcType": "HIPRECDECIMAL", "order": 19, "isDeleted": false, "isMetadataUpdated": false }, ], "dataSourceType": "UNSET", "sourceType": "DATASOURCE" }, "profileableFields": [ { "id": "3c8c9108-3143-4a27-9609-cff24e93cdb4", "isDeleted": false, "columnKey": 10011, "sourceName": "Oracle_Source", "fieldName": "TIMESTAMP_COL", "fieldType": "DATASOURCEFIELD" }, { "id": "9c205cc3-8e17-408a-99bf-4385d3bb83cf", "isDeleted": false, "columnKey": 10032, "sourceName": "Oracle_Source", "fieldName": "DEC_COL", "fieldType": "DATASOURCEFIELD" }, { "id": "bc3030eb-3a2f-4163-910a-e5e32dc081f4", "isDeleted": false, "columnKey": 10010, "sourceName": "Oracle_Source", "fieldName": "DATE_COL", "fieldType": "DATASOURCEFIELD" }, ], "samplingOptions": { "id": null, "rows": -1, "samplingType": "ALL_ROWS" }, "drillDownType": "ON" }, "profileKey": 24430, "version": 3, "name": "Profile_3", "orgId": "d2axWRuaa6zffjGfvwWWQf", "description": "Creating profile using Automation.", "frsId": "310N0zDWccJkY40yGhwOIR", "frsProjectId": "7v6XDfrInjqlP4KO0AUlo3", "frsFolderId": "4rYOVAakQPtfg716rzlpeS", "connectionId": "fMxoRXfkpcGl47mi76z4uk", "createdBy": "1vcXL5Kw7jNgTUNO7sS9gF", "createdByName": "User4", "createTime": 1610906983086, "updatedBy": "1vcXL5Kw7jNgTUNO7sS9gF", "updatedByName": "User4", "updateTime": 1610906983305, "isFilterEnabled": null, "runtimeOptions": { "id": "5ecafc1b-7cad-4a1c-9d74-62ac8e096a19", "scheduleId": null, "runtimeEnvironmentId": null, "defaultEmailNotification": true }, "source": { "id": "510df11b-e4fc-4a73-8259-ca8d739f6667", "name": "Oracle_source", "fields": [ { "id": "e93b787a-49e2-47ba-8ad4-95dd1c94bb1f", "name": "LONG_COL", "dataType": "decimal", "precision": 38, "scale": 0, "pcType": "HIPRECDECIMAL", "order": 19, "isDeleted": false, "isMetadataUpdated": false }, ], "dataSourceType": "UNSET", "sourceType": "DATASOURCE" }, "profileableFields": [ { "id": "3c8c9108-3143-4a27-9609-cff24e93cdb4", "isDeleted": false, "columnKey": 10011, "sourceName": "Oracle_Source", "fieldName": "TIMESTAMP_COL", "fieldType": "DATASOURCEFIELD" }, { "id": "9c205cc3-8e17-408a-99bf-4385d3bb83cf", "isDeleted": false, "columnKey": 10032, "sourceName": "Oracle_Source", "fieldName": "DEC_COL", "fieldType": "DATASOURCEFIELD" }, { "id": "bc3030eb-3a2f-4163-910a-e5e32dc081f4", "isDeleted": false, "columnKey": 10010, "sourceName": "Oracle_Source", "fieldName": "DATE_COL", "fieldType": "DATASOURCEFIELD" }, ], "samplingOptions": { "id": null, "rows": -1, "samplingType": "ALL_ROWS" }, "drillDownType": "ON" } ]