Embedded API - Revision history

Craig: /* Enumerations */

2025-12-15T22:00:21Z

Enumerations

← Older revision		Revision as of 22:00, 15 December 2025
Line 205:		Line 205:
	* <code>PAUSE</code>		* <code>PAUSE</code>
	* <code>RESUME</code>		* <code>RESUME</code>


	'''Job Stats [[Job_Features#Execution_Statuses \| Status]]'''		'''Job Stats [[Job_Features#Execution_Statuses \| Status]]'''
Line 221:		Line 222:
	* <code>MINUTES</code>		* <code>MINUTES</code>
	* <code>HOURS</code>		* <code>HOURS</code>


	'''Job Stats Duration'''		'''Job Stats Duration'''

Craig: /* Enumerations */

2025-12-15T21:59:55Z

Enumerations

@@ Line 205: / Line 205: @@
 * <code>PAUSE</code>
 * <code>RESUME</code>
 = JobManager API =

Craig at 00:57, 14 December 2025

2025-12-14T00:57:52Z

← Older revision		Revision as of 00:57, 14 December 2025
Line 1,166:		Line 1,166:

	REST equivalent: [[REST_Endpoints#DELETE_a_schedule_alias\|DELETE a schedule alias]]		REST equivalent: [[REST_Endpoints#DELETE_a_schedule_alias\|DELETE a schedule alias]]


			= StatsManager API =

			''As of Obsidian 6.4.0''

			The [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/StatsManager.html StatsManager] allows for retrieving job execution statistics. Assumes the [[Built-in_Jobs#Obsidian_Execution_Statistics_Job\|Execution Statistics Job]] has run at least once successfully.

			== List Stats ==

			To list the job execution statistics, use [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/StatsManager.html#listStats(com.carfey.ops.api.bean.stats.StatsListingRequest) StatsManager.listStats()] which returns a [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/stats/StatsListing.html StatsListing].

			REST equivalent: [[REST_Endpoints#GET_a_list_of_job_execution_statistics\|GET a list of job execution statistics]]

Craig: /* HostManager API */

2024-10-16T18:03:35Z

HostManager API

← Older revision		Revision as of 18:03, 16 October 2024
Line 744:		Line 744:

	REST equivalent: [[REST_Endpoints#GET_event_hooks_on_host\|GET event hooks on host]]		REST equivalent: [[REST_Endpoints#GET_event_hooks_on_host\|GET event hooks on host]]



			== Event Hook Resume or Pause ==
			''As of Obsidian 5.5.0''

			To trigger a pause or resume of event hooks, use [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html#updateEventHook(com.carfey.ops.api.bean.host.UpdateEventHookRequest,java.lang.String) HostManager.updateEventHook(UpdateEventHookRequest,String)] which accepts an [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/host/UpdateEventHookRequest.html UpdateEventHookRequest].

			The method returns a [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/host/EventHookListing.html EventHookListing], or throws a [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/MissingEntityException.html MissingEntityException] if the specified host ID/name does not exist or the event hook does not exist on the specified host.

			REST equivalent: [[REST_Endpoints#POST_event_hook_pause_or_resume\|POST event hook pause/resume]]

	= CustomCalendarManager API =		= CustomCalendarManager API =

Craig: /* Enumerations */

2024-10-16T17:34:02Z

Enumerations

← Older revision		Revision as of 17:34, 16 October 2024
Line 200:		Line 200:
	* <code>ASC</code>		* <code>ASC</code>
	* <code>DESC</code>		* <code>DESC</code>


	'''Event Hook Action'''		'''Event Hook Action'''

Craig: /* Enumerations */

2024-10-16T17:33:46Z

Enumerations

← Older revision		Revision as of 17:33, 16 October 2024
Line 200:		Line 200:
	* <code>ASC</code>		* <code>ASC</code>
	* <code>DESC</code>		* <code>DESC</code>

			'''Event Hook Action'''
			* <code>PAUSE</code>
			* <code>RESUME</code>

	= JobManager API =		= JobManager API =

Craig: /* HostManager API */

2024-06-10T21:04:51Z

HostManager API

← Older revision		Revision as of 21:04, 10 June 2024
Line 724:		Line 724:

	== List Event Hooks ==		== List Event Hooks ==
	''As of Obsidian 5.3.0''		''As of Obsidian 5.4.0''

	To get a list of all event hooks against all hosts, use [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html#listEventHooksByHost() HostManager.listEventHooksByHost()], which returns a [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/host/EventHookListing.html EventHookListing].		To get a list of all event hooks against all hosts, use [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html#listEventHooksByHost() HostManager.listEventHooksByHost()], which returns a [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/host/EventHookListing.html EventHookListing].
Line 732:		Line 732:

	== Get Event Hooks on a specific Host ==		== Get Event Hooks on a specific Host ==
	''As of Obsidian 5.3.0''		''As of Obsidian 5.4.0''

	To get event hooks on a host by ID or name, use [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html#listEventHooksByHost(long) HostManager.listEventHooksByHost(id)] or [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html#listEventHooksByHost(java.lang.String) or HostManager.listEventHooksByHost(String)].		To get event hooks on a host by ID or name, use [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html#listEventHooksByHost(long) HostManager.listEventHooksByHost(id)] or [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html#listEventHooksByHost(java.lang.String) or HostManager.listEventHooksByHost(String)].

Craig: /* HostManager API */

2024-06-10T20:41:53Z

HostManager API

← Older revision		Revision as of 20:41, 10 June 2024
Line 732:		Line 732:

	== Get Event Hooks on a specific Host ==		== Get Event Hooks on a specific Host ==
			''As of Obsidian 5.3.0''

	To get event hooks on a host by ID or name, use [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html#listEventHooksByHost(long) HostManager.listEventHooksByHost(id)] or [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html#listEventHooksByHost(java.lang.String) or HostManager.listEventHooksByHost(String)].		To get event hooks on a host by ID or name, use [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html#listEventHooksByHost(long) HostManager.listEventHooksByHost(id)] or [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html#listEventHooksByHost(java.lang.String) or HostManager.listEventHooksByHost(String)].

Craig: /* HostManager API */

2024-06-10T20:41:35Z

HostManager API

← Older revision		Revision as of 20:41, 10 June 2024
Line 729:		Line 729:

	REST equivalent: [[REST_Endpoints#GET_event_hooks\|GET a list of event hooks]]		REST equivalent: [[REST_Endpoints#GET_event_hooks\|GET a list of event hooks]]


			== Get Event Hooks on a specific Host ==

			To get event hooks on a host by ID or name, use [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html#listEventHooksByHost(long) HostManager.listEventHooksByHost(id)] or [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html#listEventHooksByHost(java.lang.String) or HostManager.listEventHooksByHost(String)].

			The method returns a [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/host/EventHookListing.html EventHookListing], or throws a [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/MissingEntityException.html MissingEntityException] if the specified host ID or name does not exist.

			REST equivalent: [[REST_Endpoints#GET_event_hooks_on_host\|GET event hooks on host]]

	= CustomCalendarManager API =		= CustomCalendarManager API =

Craig: /* HostManager API */

2024-06-10T20:36:56Z

HostManager API

← Older revision		Revision as of 20:36, 10 June 2024
Line 680:		Line 680:
	= HostManager API =		= HostManager API =

	[https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html HostManager] is used to manage and view scheduling hosts.		[https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html HostManager] is used to manage and view scheduling hosts and see additional host details including event hooks.

	== List Scheduling Hosts ==		== List Scheduling Hosts ==
Line 721:		Line 721:

	REST equivalent: [[REST_Endpoints#PUT_updates_to_an_existing_scheduling_host\|PUT updates to an existing scheduling host]]		REST equivalent: [[REST_Endpoints#PUT_updates_to_an_existing_scheduling_host\|PUT updates to an existing scheduling host]]


			== List Event Hooks ==
			''As of Obsidian 5.3.0''

			To get a list of all event hooks against all hosts, use [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/embedded/HostManager.html#listEventHooksByHost() HostManager.listEventHooksByHost()], which returns a [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/api/bean/host/EventHookListing.html EventHookListing].

			REST equivalent: [[REST_Endpoints#GET_event_hooks\|GET a list of event hooks]]

	= CustomCalendarManager API =		= CustomCalendarManager API =