Getting Started with Cloud Data Profiling REST API

Back Next

Manage profile jobs

Data Profiling creates a job when you run a data profiling task. You can view the Data Profiling job details, stop a job, resume a stopped job, and download session logs for the steps executed on the agent.

Get Job by Id

Gets the Data Profiling job details based on the job ID.

GET request: Use the GET method to view the Data Profiling job details based on the job ID.; The following table lists the parameters that you need to specify to view the Data Profiling job details based on the job ID:

Property
Value

URL
Enter a URL to view the Data Profiling job details based on the job ID. 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
Enter the unique identifier of the Data Profiling job.
API response code: 200 OK

Property	Value
URL	Enter a URL to view the Data Profiling job details based on the job ID. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/profiling-service/api/v1/job/{id}

Property	Value
ID	Enter the unique identifier of the Data Profiling job.

Get Running Jobs by Profile Id

Gets the details of a Data Profiling job based on the Profile ID.

GET request: Use the GET method to view the details of a Data Profiling job based on the Profile ID.; The following table lists the parameters that you need to specify to view the details of a Data Profiling job based on the Profile ID:

Property
Value

URL
Enter a URL to view the details of a Data Profiling job based on the Profile ID. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/profiling-service/api/v1/job/runningJobs/{profileId}
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 the details of a Data Profiling job based on the Profile ID. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/profiling-service/api/v1/job/runningJobs/{profileId}

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.

Stop Job

Stops the Data Profiling job.

GET request: Use the GET method to stop the Data Profiling job.; The following table lists the parameters that you need to specify to stop the Data Profiling job:

Property
Value

URL
Enter a URL to stop the Data Profiling job. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/profiling-service/api/v1/job/stop
API parameters: The following table lists the optional query parameters exposed for this API:

Property
Value

jobID
Enter the unique identifier of the Data Profiling job to be stopped.

jobStepID
Enter the unique identifier of the step executed on the Data Profiling job.

jobType
Choose the type of job to be stopped.
API response code: 200 OK

Property	Value
URL	Enter a URL to stop the Data Profiling job. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/profiling-service/api/v1/job/stop

Property	Value
jobID	Enter the unique identifier of the Data Profiling job to be stopped.
jobStepID	Enter the unique identifier of the step executed on the Data Profiling job.
jobType	Choose the type of job to be stopped.

Resumes Job

Resumes the Data Profiling job.

GET request: Use the GET method to resume the Data Profiling job.; The following table lists the parameters that you need to specify to resume the Data Profiling job:

Property
Value

URL
Enter a URL to resume the Data Profiling job. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/profiling-service/api/v1/job/resume
API parameters: The following table lists the optional query parameters exposed for this API:

Property
Value

jobID
Enter the unique identifier of the Data Profiling job to be resumed.

jobStepID
Enter the unique identifier of the step executed on the Data Profiling job.

jobType
Choose the type of job to be resumed.
API response code: 200 OK

Property	Value
URL	Enter a URL to resume the Data Profiling job. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/profiling-service/api/v1/job/resume

Property	Value
jobID	Enter the unique identifier of the Data Profiling job to be resumed.
jobStepID	Enter the unique identifier of the step executed on the Data Profiling job.
jobType	Choose the type of job to be resumed.

Get session logs

Downloads the session logs for the Data Profiling job steps executed on the agent.

GET request: Use the GET method to download the session logs for the Data Profiling job steps executed on the agent.; The following table lists the parameters that you need to specify to download the session logs for the Data Profiling job:

Property
Value

URL
Enter a URL to download the session logs for the Data Profiling job. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/profiling-service/api/v1/job/getSessionLogs/{jobStepId}
API parameters: The following table lists the important query parameters exposed for this API:

Property
Value

jobStepID
Enter the unique identifier of the step executed on the Data Profiling job.
API response code: 200 OK

Property	Value
URL	Enter a URL to download the session logs for the Data Profiling job. Use the following format: https://usw3-dqprofile.dm-us.informaticacloud.com/profiling-service/api/v1/job/getSessionLogs/{jobStepId}