Getting Started with Cloud Data Profiling REST API

Getting Started with Cloud Data Profiling REST API

Monitor a profile

Monitor a profile

You can monitor the jobs for the data profiling tasks that you run. Monitor to learn how to view and monitor jobs that are running or have run in Data Profiling.

Get Job by ID

Gets the Data Profiling job details based on the job ID.
GET request
Use the GET method to monitor a profile.
The following table lists the parameters that you need to specify to monitor a profile:
Property
Value
URL
Enter a URL to monitor a profile. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/profiling-service/api/v1/job/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 job Id. For example, 67f6b06a-a830-4b46-a137-e047c8087176
Copy the Job ID from the run profile API response.
API response code
200 OK
API response
{ "id": "67f6b06a-a830-4b46-a137-e047c8087176" "name": "Simple profile - run - 1" "type": "PROFILING_PC" "orgId": "7zmpu0DNPKAklXvmGgxSEI" "createTime": 1604475123078 "startTime": 1604475123200 "endTime": 1604475192442 "status": "COMPLETED" "createdBy": "8qPaKBgSQV2jN2V9O08DO4" "errorMessage": "No errors encountered." "jobSteps":[ 0:{ "id": "e624dcd7-ea69-41e7-903c-869a5e169149" "name": "Generating data profiling mappings." "jobStepType": "GENERATE_PROFILING_WORKFLOW" "orgId": "7zmpu0DNPKAklXvmGgxSEI" "sequence": 1 "createTime": 1604475123519 "startTime": 1604475132503 "endTime": 1604475134035 "errorMessage": "No errors encountered." "status": "COMPLETED" "dtmStats": NULL } 1:{ "id": "90b4fad1-ceaf-413b-aa06-e8537ee0bf23" "name": "s_profiling_562_1_1" "jobStepType": "PROFILING_MAPPING" "orgId": "7zmpu0DNPKAklXvmGgxSEI" "sequence": 2 "createTime": 1604475134013 "startTime": 1604475139509 "endTime": 1604475186399 "errorMessage": "No errors encountered." "status": "COMPLETED" "dtmStats": "{"firstError":"No errors encountered.","targetSuccessRows":961,"transformationStats":[{"rejectedRows..." } 2:{ "id": "a6f5bfa4-7462-4687-a436-ca25c5db2563" "name": "Loading data from staging area to metric store" "jobStepType": "STAGING_TO_STORE" "orgId": "7zmpu0DNPKAklXvmGgxSEI" "sequence": 3 "createTime": 1604475134012 "startTime": 1604475189114 "endTime": 1604475190646 "errorMessage": "No errors encountered." "status": "COMPLETED" "dtmStats": NULL } 3:{ "id": "30c2ffd1-f707-4bdc-8391-243edc236d20" "name": "Fetching the source row count" "jobStepType": "ROWCOUNT_FETCH" "orgId": "7zmpu0DNPKAklXvmGgxSEI" "sequence": 0 "createTime": 1604475123517 "startTime": 1604475127637 "endTime": 1604475130592 "errorMessage": "No errors encountered." "status": "COMPLETED" "dtmStats": "{"firstError":"TT_11132 Transformation [ROW_COUNT_EXPRESSION] had an error evaluating output column ..." } ] }

0 COMMENTS

We’d like to hear from you!