Execute Data Profiling on Semantic Model
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API executes a data profiling job for the Semantic Model.
Method: POST
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/data-profile
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
Content-Type (Required) | String | Specifies media type of request body. |
|
sessionid | String | The session ID is the token received from the login API. Note: Session ID is required for token-based authentication. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
name-or-id (Required) | String | Specifies the name or ID of the Semantic Model for which the data profiling job will be executed. Note: If the Semantic Model name is provided, either folderName or folderId must also be provided. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id parameter should be interpreted as a Semantic Model name or Semantic Model ID. If by=name, provide the Semantic Model name in the name-or-id parameter. If by=id, provide the Semantic Model ID in the name-or-id parameter. The default value is name. | – |
folderName | String | Name of the folder which contains the Semantic Model. If the Semantic Model is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the Semantic Model will be treated as a root-level entity by default. | – |
folderId | String | ID of the folder which contains the Semantic Model. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
runType | String | Specifies the execution schedule for the job. | Now: Immediately start the job. Once: Job will run at the specified time. Recurring: Job will run regularly at the specified time. Default: Now |
onceDateTime | String | Date time in format ( Required when runType is Once. | – |
dataProfileJson | String | Data profile settings in string-formatted JSON object. Note: An example JSON is provided under the Resources section below. | – |
userParams | String | Provides parameter details to be used during Semantic Model data profiling. The value must be passed as a JSON-formatted string. Note: An example JSON is provided under the Resources section below. | – |
jobConnectionName | String | Name of job connection. | – |
Responses
200 Success
{
"code": 0,
"message": "Data profile job added successfully."
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |
Resources
Below are examples of JSON structures which can be used as a reference for userParams and dataProfileJson parameters in the request body.
userParams:
[
{
"name":"parameterName",
"value":"parameterValue"
}
]dataProfileJson :
{
"samplingOptions":"SAMPLE/ALL",
"fieldsGroup":"COMPLETE/CUSTOM",
"fields":[
{
"fieldId":"id of element",
"displayName":"name of element"
}
]
}