Skip to content

Update chap-scheduler-conf.adoc: Fix the URI for schedulers #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vharseko merged 2 commits into from
Apr 10, 2026
Merged

Update chap-scheduler-conf.adoc: Fix the URI for schedulers #156

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
842d9df
Update chap-scheduler-conf.adoc
vliefooghe-adeo Apr 9, 2026
099a51b
Apply suggestion from @maximthomas
maximthomas Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions openidm-doc/src/main/asciidoc/integrators-guide/chap-scheduler-conf.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024-2025 3A Systems LLC.
Portions Copyright 2024-2026 3A Systems LLC.
////

:figure-caption!:
Expand Down Expand Up @@ -353,7 +353,7 @@ $ curl \
}
}
}' \
"https://localhost:8443/openidm/scheduler/testlog-schedule"
"https://localhost:8443/openidm/scheduler/job/testlog-schedule"
{
"type": "cron",
"invokeService": "script",
Expand Down Expand Up @@ -394,7 +394,7 @@ $ curl \
}
}
}' \
"https://localhost:8443/openidm/scheduler?_action=create"
"https://localhost:8443/openidm/scheduler/job?_action=create"
{
"type": "cron",
"invokeService": "script",
Expand Down Expand Up @@ -426,7 +426,7 @@ $ curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request GET \
"https://localhost:8443/openidm/scheduler/d6d1b256-7e46-486e-af88-169b4b1ad57a"
"https://localhost:8443/openidm/scheduler/job/d6d1b256-7e46-486e-af88-169b4b1ad57a"
{
"_id": "d6d1b256-7e46-486e-af88-169b4b1ad57a",
"schedule": "0/1 * * * * ?",
Expand Down Expand Up @@ -479,15 +479,15 @@ $ curl \
}
}
}' \
"https://localhost:8443/openidm/scheduler/d6d1b256-7e46-486e-af88-169b4b1ad57a"
"https://localhost:8443/openidm/scheduler/job/d6d1b256-7e46-486e-af88-169b4b1ad57a"
null
----


[#listing-schedules]
==== Listing Configured Schedules

To display a list of all configured schedules, query the `openidm/scheduler` context path as shown in the following example:
To display a list of all configured schedules, query the `openidm/scheduler/job` context path as shown in the following example:
Copy link

Copilot AI Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section now documents schedule CRUD/actions under /openidm/scheduler/job, but the earlier intro/note in the same section still says the scheduler REST context path is /openidm/scheduler and advises managing schedules via that endpoint. Please update/clarify the introductory text (and the NOTE) to reflect that job operations are under /openidm/scheduler/job (or explain the /openidm/scheduler parent route vs the /job subresource) to avoid sending readers to the wrong endpoint.

Suggested change
To display a list of all configured schedules, query the `openidm/scheduler/job` context path as shown in the following example:
To display a list of all configured schedules, query the `/openidm/scheduler/job` context path (the scheduler job subresource) as shown in the following example:

Copilot uses AI. Check for mistakes.

[source, console]
----
Expand All @@ -496,7 +496,7 @@ $ curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request GET \
"https://localhost:8443/openidm/scheduler?_queryId=query-all-ids"
"https://localhost:8443/openidm/scheduler/job?_queryId=query-all-ids"
{
"remainingPagedResults": -1,
"pagedResultsCookie": null,
Expand Down Expand Up @@ -527,7 +527,7 @@ $ curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request DELETE \
"https://localhost:8443/openidm/scheduler/d6d1b256-7e46-486e-af88-169b4b1ad57a"
"https://localhost:8443/openidm/scheduler/job/d6d1b256-7e46-486e-af88-169b4b1ad57a"
null
----

Expand All @@ -546,7 +546,7 @@ $ curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request POST \
"http://localhost:8080/openidm/scheduler?_action=listCurrentlyExecutingJobs"
"http://localhost:8080/openidm/scheduler/job?_action=listCurrentlyExecutingJobs"
[
{
"concurrentExecution": false,
Expand Down Expand Up @@ -585,7 +585,7 @@ $ curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request POST \
"https://localhost:8443/openidm/scheduler?_action=pauseJobs"
"https://localhost:8443/openidm/scheduler/job?_action=pauseJobs"
{
"success": true
}
Expand All @@ -606,7 +606,7 @@ $ curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--request POST \
"https://localhost:8443/openidm/scheduler?_action=resumeJobs"
"https://localhost:8443/openidm/scheduler/job?_action=resumeJobs"
{
"success": true
}
Expand Down