Get Job Execution Status List
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API is used to get status of all the jobs executed on a Semantic Model.
Method: GET
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/job-execution-status
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 status 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 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 | Folder ID in which the Semantic Model is located. | – |
Responses
200 Success
{
"data": {
"jobexecutionstatus": {
"upcomingjobs": "",
"history": [
{
"scheduledTime": "05/25/2026 12:02:19 IST",
"historyId": "807CF6D5-F567-4864-25A9-E7C968B2F4FE",
"buildType": "FULL",
"frequencyType": "NOW",
"runtime": "05/25/2026 12:03:00 IST",
"userName": "Admin",
"isIdealBuild": false,
"status": "CANCELED"
}
]
},
"inqueuejobs": ""
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |