Get All Job Schedules
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
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}/schedules
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":{
"incrementalBuildType":{
"200E6FCF-E64C-FE61-4693-ED4672178ACC":{
"scheduleInfo":{
"endDate":"02/08/2030",
"everyWeek":"1",
"name":"FB030660-D930-3123-E820-3254BB9A3950",
"timeZone":"",
"startTime":"",
"id":"FB030660-D930-3123-E820-3254BB9A3950",
"endTime":"",
"recurringTime":"17:44",
"startDate":"05/19/2026",
"buildOnDay":"1,2",
"frequency":"WEEKLY"
},
"batchDetails":{
"attachmentFormat":"NONE",
"userParams":{
},
"deliveryOperations":{
}
},
"jobDetails":{
"onceDate":"",
"onceEndDate":"",
"onceEndTime":"",
"name":"F0074B97-73D9-F5E9-376E-793CF2F51196",
"onceTime":"",
"timeZone":"",
"partitionReplacement":{
"excludeCurrPartition":true,
"replacePartition":false
},
"id":"200E6FCF-E64C-FE61-4693-ED4672178ACC",
"jobType":"RECUR",
"batchId":"F0074B97-73D9-F5E9-376E-793CF2F51196",
"ownerId":"338711994",
"scheduleId":"FB030660-D930-3123-E820-3254BB9A3950"
}
}
}
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |