Getting Started with Cloud Data Profiling REST API

Back Next

Manage profile runs

You can list details of the profile runs, delete profile runs by profiling Id, and get profiling run details by profiling Id.

List all RunDetail

You can view all the profile runs for a profile.

GET request: Use the GET method to view profile runs.; The following table lists the parameters that you need to specify to view all columns in the profile run:

Property
Value

URL
Enter a URL to view all columns in the profile run. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/profiling-service/api/v1/runDetail
API parameters: The following table lists the important query parameters exposed for this API:

Property
Value

profileId

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 view all columns in the profile run. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/profiling-service/api/v1/runDetail

Property	Value
profileId	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: [ 0:{ ... } 1:{ "profileId": "20b84ac7-6dcb-4d30-a9f7-6c3c41549983" "jobId": "fd3ee432-90f4-4563-bc4a-5066bfaf32b7
" "id": "0fa855e9-664c-4a56-8997-b5f2c16a60b1
" "runKey": 11 "samplingType": "ALL_ROWS" "samplingRows": -1 "status": "COMPLETED" "runDetailStatus": NULL "startTime": 1610608118375 "endTime": 1610608154159 "executionTime": 35784 "createdTime": 1610608118364 "createdBy": "3vC7otmqf3weY98g8jzuG2" "createdByName": "USER4" "isFilterEnabled": false "filterName": NULL "rowsProcessed": 56 "numberOfDSColumns": 1 "numberOfRules": NULL "numberOfMappletColumns": NULL "numberOfColumns": 36 "runCostInMB": 0.01122761 "isDetectOutlier": false } 2:{ ... } 3:{ ... } ]

Delete runs by data profile asset

You can delete one or more profile runs for a profile. When you delete a profile run, Data Profiling deletes the profile results for the profile run from the profiling warehouse. You can delete a profile run to reclaim the storage space in the profiling warehouse.

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

Property
Value

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

Property
Value

ProfileID

The unique identifier of the Data Profiling asset. For example, 908ed64e-cfd0-4544-bb69-5f5414e2f18b

To retrieve the ProfileId, see the Prerequisites section.

runDetailIds
Profile run detail ID. Enter the ID of the profile run that you want to delete. For example, 31dc9585-b5e5-4191-8875-c3d49a249574. Copy the id
from the List all RunDetail API response.
API response code: 204 No content

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

Property	Value
ProfileID	The unique identifier of the Data Profiling asset. For example, 908ed64e-cfd0-4544-bb69-5f5414e2f18b To retrieve the ProfileId, see the Prerequisites section.
runDetailIds	Profile run detail ID. Enter the ID of the profile run that you want to delete. For example, 31dc9585-b5e5-4191-8875-c3d49a249574. Copy the id from the List all RunDetail API response.

API response: [ 0:{ "profileId": "20b84ac7-6dcb-4d30-a9f7-6c3c41549983" "jobId": "1781053e-7bae-4294-bdeb-0945e01252ce" "id": "31dad319-3887-4fbd-8250-341e8f41adcb" "runKey": NULL "samplingType": NULL "samplingRows": NULL "status": NULL "runDetailStatus": "DELETED" "startTime": NULL "endTime": NULL "executionTime": NULL "createdTime": NULL "createdBy": NULL "createdByName": NULL "isFilterEnabled": NULL "filterName": NULL "rowsProcessed": 0 "numberOfDSColumns": NULL "numberOfRules": NULL "numberOfMappletColumns": NULL "numberOfColumns": NULL "runCostInMB": NULL "isDetectOutlier": NULL } ]

Get Run Detail by ID

You can view run details of a profile run.

GET request: Use the GET method to view details of the profile run based on the profile run ID.; The following table lists the parameters that you need to specify to delete a profile:

Property
Value

URL
Enter a URL to view details of the profile run based on the profile run ID. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/profiling-service/api/v1/runDetail/id
API parameters: The following table lists the important query parameters exposed for this API:

Property
Value

ID

The unique identifier of the profiling run ID. For example, 0fa855e9-664c-4a56-8997-b5f2c16a60b1

Copy the jobid
from the List all RunDetail API response.
API response code: 200 OK

Property	Value
URL	Enter a URL to view details of the profile run based on the profile run ID. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/profiling-service/api/v1/runDetail/id

Property	Value
ID	The unique identifier of the profiling run ID. For example, 0fa855e9-664c-4a56-8997-b5f2c16a60b1 Copy the jobid from the List all RunDetail API response.

API response: { "profileId": "20b84ac7-6dcb-4d30-a9f7-6c3c41549983" "jobId": "fd3ee432-90f4-4563-bc4a-5066bfaf32b7" "id": "0fa855e9-664c-4a56-8997-b5f2c16a60b1" "runKey": 11 "samplingType": "ALL_ROWS" "samplingRows": -1 "status": "COMPLETED" "runDetailStatus": NULL "startTime": 1610608118375 "endTime": 1610608154159 "executionTime": 35784 "createdTime": 1610608118364 "createdBy": "3vC7otmqf3weY98g8jzuG2" "createdByName": "USER4" "isFilterEnabled": false "filterName": NULL "rowsProcessed": 56 "numberOfDSColumns": 1 "numberOfRules": NULL "numberOfMappletColumns": NULL "numberOfColumns": 36 "runCostInMB": 0.01122761 "profiledFields":[ ... ] "isDetectOutlier": false }

Profiling Tutorial

Download Guide

Watch

Comments

Cloud Data Profiling Homepage