1Get All Job Schedules
Overview
This API is used to retrieves all scheduled jobs associated with a given Semantic Model.
Method: GET
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/schedule-jobs
💡 API Update
Starting with Release 2026.8, a new endpoint is introduced for this API, as provided above. The previously used endpoint, {kyvos-url}/rest/v2/semantic-models/{name-or-id}/schedules, is now deprecated. For details about the deprecated endpoint, refer to the 2026.7 Documentation.
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 job schedule details need 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, then Semantic Model will be treated as a root-level entity by default. | – |
folderId | String | ID of the folder containing the Semantic Model. | – |
Responses
200 Success
{
"scheduleInfos": {
"fullBuildType": {
"57003768e22cc3558078dc47e92e2d0f": {
"aggregationStrategy": 0,
"buildSourceDatasets": "IFNEEDED",
"batchDetails": {
"attachmentFormat": "NONE",
"segmentCapacity": "1",
"userParams": {},
"deliveryOperations": {}
},
"jobDetails": {
"onceDate": "09/01/2026",
"onceEndDate": "",
"runType": "ONCE",
"timeZone": "",
"partitionReplacement": {
"excludeCurrPartition": true,
"replacePartition": false
},
"batchId": "8939d5a35862bda855c94a512d643b37",
"ownerId": "397039469",
"onceEndTime": "",
"name": "8939d5a35862bda855c94a512d643b37",
"onceTime": "14:34",
"id": "57003768e22cc3558078dc47e92e2d0f",
"scheduleId": ""
}
}
}
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |