Get Job Summary
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API fetches the job summary of a Semantic Model.
Method: GET
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/job-summary
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 |
|---|---|---|---|
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 | Name or ID of the Semantic Model for which the job summary needs to be retrieved. 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 containing 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 containing the Semantic Model. | – |
historyId | String | Specifies the history ID of the job for which the summary is required. Note: This parameter is optional and should be provided only when a summary for a specific job is needed. If not provided, the job summary from the most recent process is retrieved. | – |
jobType | String | Provides the details of the job summary type. | FULL – Recreates the Semantic Model with all available data, including recalculation of all aggregates. INCREMENTAL – Updates the Semantic Model with the latest data. FULL_TEST – Recreates the Semantic Model using a limited number of rows for testing purposes. UPDATE_AGGREGATES – Updates Semantic Model aggregates based on the current aggregation strategy. CACHE_POPULATION – Clears cached query responses and repopulates the cache with the latest Semantic Model data. DROP_PARTITION – Creates rules to identify and drop selected partitions. DATA_PROFILE – Computes statistics from data such as distinct value count, invalid value count, or cardinality. |
Responses
200 Success
{
"allBuildStatus":{
"buildStatus":{
"buildFunction":"",
"instanceId":17832964984703240000,
"historyId":"2F02DED1-727A-6DE4-02A6-08778EF4CC8C",
"buildType":"CACHE_POPULATION",
"description":"",
"subType":"CUBE",
"currentBuildStatus":{
"completed":{
"cubebuildElapsedTime":0,
"isAggregateBuild":false,
"sections":[
{
"messages":"",
"type":"PHYSICAL_VIEW"
},
{
"messages":"",
"type":"PARTITION_STRATEGY"
},
{
"messages":"",
"type":"ADVANCED_PROPERTIES"
},
{
"messages":{
"message":{
"type":"INFO",
"content":"Aggregation Strategy :<B> Expert mode </B>"
}
},
"type":"AGGREGATION_STRATEGY"
},
{
"messages":{
"message":[
{
"type":"INFO",
"content":"Semantic Model Compatibility Version: <B>1</B>"
},
{
"type":"INFO",
"content":"Dimensions Metadata Version: <B>v1</B>"
}
]
},
"type":"MISCELLANEOUS"
},
{
"messages":"",
"type":"BUILD_INPUTS"
},
{
"messages":"",
"type":"TIME_INFO"
}
],
"timestamp":"07/06/2026 05:38:27",
"buildStatus":"SUCCESSFUL"
}
},
"buildNo":1,
"type":"ANALYTICAL",
"consolidatedBuildStatus":{
"completed":{
"cubebuildElapsedTime":0,
"isAggregateBuild":false,
"sections":[
{
"messages":"",
"type":"PHYSICAL_VIEW"
},
{
"messages":"",
"type":"PARTITION_STRATEGY"
},
{
"messages":"",
"type":"ADVANCED_PROPERTIES"
},
{
"messages":"",
"type":"AGGREGATION_STRATEGY"
},
{
"messages":{
"message":{
"type":"INFO",
"content":"Semantic Model Compatibility Version: <B>1</B>"
}
},
"type":"MISCELLANEOUS"
}
],
"timestamp":"07/06/2026 05:38:27"
}
},
"status":"COMPLETED",
"tags":""
}
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |