Skip to content

Commit ecab2ee

Browse files
committed
Update from SAP DITA CMS (squashed):
commit 0fa630d46faf80638e0849dbecf3c79bd2ac72f0 Author: REDACTED Date: Tue Jan 7 09:57:53 2025 +0000 Update from SAP DITA CMS 2025-01-07 09:57:53 Project: dita-all/jjq1673438782153 Project map: c2f780f61c744155b0bd42b6f38fb70c.ditamap Output: loio4b3e16d4e4d14242bdc2ab48d2aec6be Language: en-US Builddable map: 0d59fbec11074faf8cb91d44023c1659.ditamap commit cd1983ae466e47832df52184e5db4a0f7477b324 Author: REDACTED Date: Tue Jan 7 09:22:13 2025 +0000 Update from SAP DITA CMS 2025-01-07 09:22:13 Project: dita-all/jjq1673438782153 Project map: c2f780f61c744155b0bd42b6f38fb70c.ditamap Output: loio4b3e16d4e4d14242bdc2ab48d2aec6be Language: en-US Builddable map: 0d59fbec11074faf8cb91d44023c1659.ditamap commit 8557920e536db9ecdf791d2f6acfb4c1e9cb0474 Author: REDACTED Date: Mon Jan 6 10:48:50 2025 +0000 Update from SAP DITA CMS 2025-01-06 10:48:50 Project: dita-all/jjq1673438782153 Project map: c2f780f61c744155b0bd42b6f38fb70c.ditamap ################################################## [Remaining squash message was removed before commit...]
1 parent 97435b5 commit ecab2ee

22 files changed

+216
-72
lines changed

docs/10---What-s-New/2023-what-s-new-for-sap-job-scheduling-service-archive-8ff6481.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ Filter the list of available jobs.
163163

164164
You can now benefit from an improved user experience for the list of available jobs. Filter the entries by job name, subdomain or by tenant ID. This way you can locate specific jobs more easily.
165165

166-
For more information, see [Manage Jobs, Tasks, and Schedules with Service Dashboard](../40---Using-JOB-SCHDULR-TITLE/manage-jobs-tasks-and-schedules-with-service-dashboard-132fd06.md) and [Retrieve Jobs](../40---Using-JOB-SCHDULR-TITLE/retrieve-jobs-b4d3719.md).
166+
For more information, see [Manage Jobs, Tasks, and Schedules with Service Dashboard](../40---Using-JOB-SCHDULR-TITLE/manage-jobs-tasks-and-schedules-with-service-dashboard-132fd06.md) and [Retrieve All Jobs](../40---Using-JOB-SCHDULR-TITLE/retrieve-all-jobs-b4d3719.md).
167167

168168
</td>
169169
<td valign="top">

docs/20---Concepts/schedule-formats-54615f0.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -888,12 +888,20 @@ These dates and ranges are applicable for the parameters time, repeatAt, and rep
888888
889889
> ### Example:
890890
> - "10 hours from now"
891+
>
891892
> - "20 minutes from now"
893+
>
892894
> - "in 2 hours"
895+
>
893896
> - "tomorrow at 4pm"
897+
>
894898
> - "next week monday at 5am"
899+
>
895900
> - "9pm tonight"
901+
>
896902
> - "3.30pm"
903+
>
904+
> - "now"
897905
898906
- RepeatAt
899907

@@ -904,8 +912,11 @@ These dates and ranges are applicable for the parameters time, repeatAt, and rep
904912
905913
> ### Example:
906914
> - "4.40pm"
915+
>
907916
> - "18.40"
917+
>
908918
> - "6.20am"
919+
>
909920
> - "17.20:30"
910921
>
911922
> > ### Caution:
@@ -925,7 +936,9 @@ These dates and ranges are applicable for the parameters time, repeatAt, and rep
925936

926937
> ### Example:
927938
> - "10 hours"
939+
>
928940
> - "2 days"
941+
>
929942
> - "5 minutes"
930943
931944

docs/40---Using-JOB-SCHDULR-TITLE/activate-or-deactivate-all-job-schedules-fe9650b.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -165,14 +165,16 @@ The API call was successful and the activation status of all the schedules were
165165

166166
[Delete Job](delete-job-cd8feb7.md "This API deletes a job and all its runtime information such as schedules and logs.")
167167

168-
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
169-
170168
[Retrieve Job Details](retrieve-job-details-815605d.md "This API retrieves the saved configuration settings of a specified job.")
171169

170+
[Retrieve All Jobs](retrieve-all-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
171+
172172
[Retrieve Job Run Logs](retrieve-job-run-logs-13d38f3.md "This API retrieves the run logs for a specified job schedule.")
173173

174174
[Retrieve Job Run Log Details](retrieve-job-run-log-details-e49a4b2.md "This API retrieves the details for a specified job run log.")
175175

176+
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
177+
176178
[Create Job Schedule](create-job-schedule-66ab3c1.md "This API creates a job schedule for a specified job.")
177179

178180
[Configure Job Schedule](configure-job-schedule-0a4d939.md "This API configures/updates the runtime information of a job schedule for a specified job.")
@@ -185,5 +187,3 @@ The API call was successful and the activation status of all the schedules were
185187

186188
[Retrieve Job Schedules](retrieve-job-schedules-251658d.md "This API retrieves all schedules for a specified job.")
187189

188-
[Retrieve Jobs](retrieve-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
189-

docs/40---Using-JOB-SCHDULR-TITLE/configure-job-schedule-0a4d939.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,16 @@ object
127127
</td>
128128
<td valign="top">
129129

130-
Data value is passed to the job action endpoint when invoked by Job Scheduler. For the HTTP method “PUT” or “POST”, the data parameters are sent in the request body while invoking the endpoint. For the HTTP method “GET” or “DELETE”, the data parameters are sent as query strings
130+
Data value is passed to the job action endpoint when invoked by Job Scheduler. For the HTTP method “PUT” or “POST”, the data parameters are sent in the request body while invoking the endpoint. For the HTTP method “GET” or “DELETE”, the data parameters are sent as query strings.
131+
132+
For Cloud Foundry \(CF\) tasks, you can configure all parameters listed at [https://v3-apidocs.cloudfoundry.org/version/3.182.0/\#tasks](https://v3-apidocs.cloudfoundry.org/version/3.182.0/#tasks). For example:
133+
134+
```
135+
{"memory_in_mb": 2048,
136+
"disk_in_mb": 256}
137+
```
138+
139+
131140

132141
</td>
133142
</tr>
@@ -347,14 +356,16 @@ The API call was successful and returns the updated schedule information.
347356

348357
[Delete Job](delete-job-cd8feb7.md "This API deletes a job and all its runtime information such as schedules and logs.")
349358

350-
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
351-
352359
[Retrieve Job Details](retrieve-job-details-815605d.md "This API retrieves the saved configuration settings of a specified job.")
353360

361+
[Retrieve All Jobs](retrieve-all-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
362+
354363
[Retrieve Job Run Logs](retrieve-job-run-logs-13d38f3.md "This API retrieves the run logs for a specified job schedule.")
355364

356365
[Retrieve Job Run Log Details](retrieve-job-run-log-details-e49a4b2.md "This API retrieves the details for a specified job run log.")
357366

367+
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
368+
358369
[Create Job Schedule](create-job-schedule-66ab3c1.md "This API creates a job schedule for a specified job.")
359370

360371
[Delete Job Schedule](delete-job-schedule-3066b6d.md "This API deletes the specified job schedule.")
@@ -367,5 +378,3 @@ The API call was successful and returns the updated schedule information.
367378

368379
[Retrieve Job Schedules](retrieve-job-schedules-251658d.md "This API retrieves all schedules for a specified job.")
369380

370-
[Retrieve Jobs](retrieve-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
371-

docs/40---Using-JOB-SCHDULR-TITLE/configure-job-using-id-514f2f6.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -276,14 +276,16 @@ The API was unable to process the request because of invalid data provided.
276276

277277
[Delete Job](delete-job-cd8feb7.md "This API deletes a job and all its runtime information such as schedules and logs.")
278278

279-
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
280-
281279
[Retrieve Job Details](retrieve-job-details-815605d.md "This API retrieves the saved configuration settings of a specified job.")
282280

281+
[Retrieve All Jobs](retrieve-all-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
282+
283283
[Retrieve Job Run Logs](retrieve-job-run-logs-13d38f3.md "This API retrieves the run logs for a specified job schedule.")
284284

285285
[Retrieve Job Run Log Details](retrieve-job-run-log-details-e49a4b2.md "This API retrieves the details for a specified job run log.")
286286

287+
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
288+
287289
[Create Job Schedule](create-job-schedule-66ab3c1.md "This API creates a job schedule for a specified job.")
288290

289291
[Configure Job Schedule](configure-job-schedule-0a4d939.md "This API configures/updates the runtime information of a job schedule for a specified job.")
@@ -298,7 +300,5 @@ The API was unable to process the request because of invalid data provided.
298300

299301
[Retrieve Job Schedules](retrieve-job-schedules-251658d.md "This API retrieves all schedules for a specified job.")
300302

301-
[Retrieve Jobs](retrieve-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
302-
303303
[SAP Alert Notification service for SAP BTP](https://help.sap.com/docs/ALERT_NOTIFICATION?version=Cloud)
304304

docs/40---Using-JOB-SCHDULR-TITLE/configure-job-using-name-5790b8a.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -178,14 +178,16 @@ The API was unable to process the request due to invalid data provided.
178178

179179
[Delete Job](delete-job-cd8feb7.md "This API deletes a job and all its runtime information such as schedules and logs.")
180180

181-
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
182-
183181
[Retrieve Job Details](retrieve-job-details-815605d.md "This API retrieves the saved configuration settings of a specified job.")
184182

183+
[Retrieve All Jobs](retrieve-all-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
184+
185185
[Retrieve Job Run Logs](retrieve-job-run-logs-13d38f3.md "This API retrieves the run logs for a specified job schedule.")
186186

187187
[Retrieve Job Run Log Details](retrieve-job-run-log-details-e49a4b2.md "This API retrieves the details for a specified job run log.")
188188

189+
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
190+
189191
[Create Job Schedule](create-job-schedule-66ab3c1.md "This API creates a job schedule for a specified job.")
190192

191193
[Configure Job Schedule](configure-job-schedule-0a4d939.md "This API configures/updates the runtime information of a job schedule for a specified job.")
@@ -200,7 +202,5 @@ The API was unable to process the request due to invalid data provided.
200202

201203
[Retrieve Job Schedules](retrieve-job-schedules-251658d.md "This API retrieves all schedules for a specified job.")
202204

203-
[Retrieve Jobs](retrieve-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
204-
205205
[SAP Alert Notification service for SAP BTP](https://help.sap.com/docs/ALERT_NOTIFICATION?version=Cloud)
206206

docs/40---Using-JOB-SCHDULR-TITLE/create-job-2c1ecb6.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ This API creates a job by accepting one or more job schedules to be created.
66

77

88

9+
> ### Note:
10+
> You cannot create CF tasks using the REST API because they are bound to a specific application. For more information, see [Can I create a CF task using the REST API?](https://help.sap.com/docs/job-scheduling/sap-job-scheduling-service/frequently-asked-questions?version=Cloud#rest-api).
11+
12+
13+
914
## Routes
1015

1116
*POST /scheduler/jobs*
@@ -570,14 +575,16 @@ The API was unable to process the request due to invalid data provided.
570575

571576
[Delete Job](delete-job-cd8feb7.md "This API deletes a job and all its runtime information such as schedules and logs.")
572577

573-
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
574-
575578
[Retrieve Job Details](retrieve-job-details-815605d.md "This API retrieves the saved configuration settings of a specified job.")
576579

580+
[Retrieve All Jobs](retrieve-all-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
581+
577582
[Retrieve Job Run Logs](retrieve-job-run-logs-13d38f3.md "This API retrieves the run logs for a specified job schedule.")
578583

579584
[Retrieve Job Run Log Details](retrieve-job-run-log-details-e49a4b2.md "This API retrieves the details for a specified job run log.")
580585

586+
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
587+
581588
[Create Job Schedule](create-job-schedule-66ab3c1.md "This API creates a job schedule for a specified job.")
582589

583590
[Configure Job Schedule](configure-job-schedule-0a4d939.md "This API configures/updates the runtime information of a job schedule for a specified job.")
@@ -592,7 +599,5 @@ The API was unable to process the request due to invalid data provided.
592599

593600
[Retrieve Job Schedules](retrieve-job-schedules-251658d.md "This API retrieves all schedules for a specified job.")
594601

595-
[Retrieve Jobs](retrieve-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
596-
597602
[SAP Alert Notification service for SAP BTP](https://help.sap.com/docs/ALERT_NOTIFICATION?version=Cloud)
598603

docs/40---Using-JOB-SCHDULR-TITLE/create-job-schedule-66ab3c1.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ string
253253
</td>
254254
<td valign="top">
255255

256-
For one-time schedules, this denotes the task execution time. You can use human-readable text to denote a specific time. Example: "3.30pm", "tomorrow at 2am". For information about human readable dates and the supported readable strings, see [Date and Time Format](../20---Concepts/schedule-formats-54615f0.md#loio333e7ce070c245d0bb8493cff2e3027b).
256+
For one-time schedules, this denotes the task execution time. You can use human-readable text to denote a specific time. Example: "3.30pm", "tomorrow at 2am", "now". For information about human-readable dates and the supported readable strings, see [Date and Time Format](../20---Concepts/schedule-formats-54615f0.md#loio333e7ce070c245d0bb8493cff2e3027b).
257257

258258
If an object is used, you must specify the date and time formats as strings. For information about the supported formats, see [Date and Time Format](../20---Concepts/schedule-formats-54615f0.md#loio333e7ce070c245d0bb8493cff2e3027b).
259259

@@ -277,7 +277,7 @@ string
277277
</td>
278278
<td valign="top">
279279

280-
Used to run schedules repeatedly at some interval. Human-readable texts must comply with the rules outlined for human readable dates. For information about the supported formats, see [Human-Readable Date Formats](../20---Concepts/schedule-formats-54615f0.md#loioa323f2d365904499a83a1b60f473bb78).
280+
Used to run schedules repeatedly at some interval. Human-readable texts must comply with the rules outlined for human-readable dates. For information about the supported formats, see [Human-Readable Date Formats](../20---Concepts/schedule-formats-54615f0.md#loioa323f2d365904499a83a1b60f473bb78).
281281

282282
</td>
283283
</tr>
@@ -299,15 +299,24 @@ string
299299
</td>
300300
<td valign="top">
301301

302-
For recurring schedules, this denotes the exact time when the job schedule must run. The human readable strings must comply with the rules outlined in the section Human Readable Dates. For information about human readable dates and the supported readable strings, see [Human-Readable Date Formats](../20---Concepts/schedule-formats-54615f0.md#loioa323f2d365904499a83a1b60f473bb78).
302+
For recurring schedules, this denotes the exact time when the job schedule must run. The human-readable strings must comply with the rules outlined in the section Human-Readable Dates. For information about human-readable dates and the supported readable strings, see [Human-Readable Date Formats](../20---Concepts/schedule-formats-54615f0.md#loioa323f2d365904499a83a1b60f473bb78).
303303

304304
</td>
305305
</tr>
306306
</table>
307307

308308

309309

310-
### Example
310+
### Examples
311+
312+
```
313+
POST /scheduler/jobs/3/schedules
314+
{
315+
    "active":"true",
316+
    "description":"One-time schedule that will be executed immediately",
317+
    "time": "now"
318+
}
319+
```
311320

312321
```
313322
PUT /scheduler/jobs/3/schedules
@@ -368,14 +377,16 @@ The API responds with a Location header representing the relative resource URI f
368377

369378
[Delete Job](delete-job-cd8feb7.md "This API deletes a job and all its runtime information such as schedules and logs.")
370379

371-
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
372-
373380
[Retrieve Job Details](retrieve-job-details-815605d.md "This API retrieves the saved configuration settings of a specified job.")
374381

382+
[Retrieve All Jobs](retrieve-all-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
383+
375384
[Retrieve Job Run Logs](retrieve-job-run-logs-13d38f3.md "This API retrieves the run logs for a specified job schedule.")
376385

377386
[Retrieve Job Run Log Details](retrieve-job-run-log-details-e49a4b2.md "This API retrieves the details for a specified job run log.")
378387

388+
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
389+
379390
[Configure Job Schedule](configure-job-schedule-0a4d939.md "This API configures/updates the runtime information of a job schedule for a specified job.")
380391

381392
[Delete Job Schedule](delete-job-schedule-3066b6d.md "This API deletes the specified job schedule.")
@@ -388,5 +399,3 @@ The API responds with a Location header representing the relative resource URI f
388399

389400
[Retrieve Job Schedules](retrieve-job-schedules-251658d.md "This API retrieves all schedules for a specified job.")
390401

391-
[Retrieve Jobs](retrieve-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
392-

docs/40---Using-JOB-SCHDULR-TITLE/delete-all-job-schedules-0aab1ab.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,14 +105,16 @@ The API call was successful and the schedules were deleted.
105105

106106
[Delete Job](delete-job-cd8feb7.md "This API deletes a job and all its runtime information such as schedules and logs.")
107107

108-
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
109-
110108
[Retrieve Job Details](retrieve-job-details-815605d.md "This API retrieves the saved configuration settings of a specified job.")
111109

110+
[Retrieve All Jobs](retrieve-all-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
111+
112112
[Retrieve Job Run Logs](retrieve-job-run-logs-13d38f3.md "This API retrieves the run logs for a specified job schedule.")
113113

114114
[Retrieve Job Run Log Details](retrieve-job-run-log-details-e49a4b2.md "This API retrieves the details for a specified job run log.")
115115

116+
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
117+
116118
[Create Job Schedule](create-job-schedule-66ab3c1.md "This API creates a job schedule for a specified job.")
117119

118120
[Configure Job Schedule](configure-job-schedule-0a4d939.md "This API configures/updates the runtime information of a job schedule for a specified job.")
@@ -125,5 +127,3 @@ The API call was successful and the schedules were deleted.
125127

126128
[Retrieve Job Schedules](retrieve-job-schedules-251658d.md "This API retrieves all schedules for a specified job.")
127129

128-
[Retrieve Jobs](retrieve-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
129-

docs/40---Using-JOB-SCHDULR-TITLE/delete-job-cd8feb7.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,14 +113,16 @@ Passing invalid Job ID.
113113

114114
[Configure Job \(Using Name\)](configure-job-using-name-5790b8a.md "This API configures a job with the updated runtime information using job name.")
115115

116-
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
117-
118116
[Retrieve Job Details](retrieve-job-details-815605d.md "This API retrieves the saved configuration settings of a specified job.")
119117

118+
[Retrieve All Jobs](retrieve-all-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
119+
120120
[Retrieve Job Run Logs](retrieve-job-run-logs-13d38f3.md "This API retrieves the run logs for a specified job schedule.")
121121

122122
[Retrieve Job Run Log Details](retrieve-job-run-log-details-e49a4b2.md "This API retrieves the details for a specified job run log.")
123123

124+
[Update Job Run Log](update-job-run-log-e85da40.md "This API is used by the application to inform the Job Scheduler about the status of an asynchronous, long-running job.")
125+
124126
[Create Job Schedule](create-job-schedule-66ab3c1.md "This API creates a job schedule for a specified job.")
125127

126128
[Configure Job Schedule](configure-job-schedule-0a4d939.md "This API configures/updates the runtime information of a job schedule for a specified job.")
@@ -135,5 +137,3 @@ Passing invalid Job ID.
135137

136138
[Retrieve Job Schedules](retrieve-job-schedules-251658d.md "This API retrieves all schedules for a specified job.")
137139

138-
[Retrieve Jobs](retrieve-jobs-b4d3719.md "This API retrieves all jobs in a service instance.")
139-

0 commit comments

Comments
 (0)