Get Dataset Job Execution Status
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API retrieves job execution status and related details of a Dataset job.
Method: GET
Request URL: {kyvos-url}/rest/v2/datasets/{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 Dataset whose job execution status needs to be retrieved. Note: If the Dataset 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 Dataset name or a Dataset ID. If by=name, provide the Dataset name in the name-or-id parameter. If by=id, provide the Dataset ID in the name-or-id parameter. Default value is name. | – |
folderName | String | Name of the folder containing the Dataset for which job execution status details are to be retrieved. Note: If neither folderName nor folderId is provided, the Dataset will be treated as a root-level entity by default. | – |
folderId | String | ID of the folder containing the Dataset for which job execution status details are to be retrieved. | – |
Responses
200 Success
{
"data": {
"jobexecutionstatus": {
"upcomingjobs": "",
"history": [
{
"scheduledTime": "05/12/2026 08:16:31 IST",
"historyId": "7897EF85-9600-9943-2FA5-A3E2D9EB058C",
"buildType": "DATA_PROFILE",
"frequencyType": "ONCE",
"runtime": "05/12/2026 08:17:36 IST",
"userName": "admin",
"isIdealBuild": false,
"status": "SUCCESSFUL"
}
]
},
"inqueuejobs": ""
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |