Get Dataset Last Job Summary
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API retrieves the last job summary of the Dataset.
Method: GET
Request URL: {kyvos-url}/rest/v2/datasets/{name-or-id}/last-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 Dataset for which the last job summary 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. The default value is name. | – |
folderName | String | Name of the folder containing the Dataset for which the last job summary is to be retrieved. If the Dataset is present in the root directory, specify [Root]. 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 the last job summary is to be retrieved. | – |
Responses
200 Success
{
"allBuildStatus": {
"buildStatus": {
"instanceId": 0,
"historyId": "B3FF28B6-9A68-499E-7738-2F7BA3801116",
"buildType": "DATA_PROFILE",
"subType": "REGISTERED",
"currentBuildStatus": {
"completed": {
"size": "0.00 B",
"totalTime": 0,
"recordCount": 60669,
"sections": [
{
"messages": {
"message": {
"type": "INFO",
"content": "Record Count: 60669"
}
},
"type": "DETAILS"
}
],
"timestamp": "05/12/2026 08:17:36",
"elapsedTime": 0
}
},
"buildNo": 1,
"type": "QUERY",
"status": "COMPLETED"
}
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error. |