Get Schedule

Returns a single schedule, including its most recent run.

Options

ID

Stringified ObjectId (hexadecimal string with 24 characters). See ObjectId

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

• ID: Stringified ObjectId (hexadecimal string with 24 characters). See ObjectId
• Kind: Identifies this object as a schedule.
• Environment: A reusable execution setup a schedule runs against: a KNIME workflow, a shell script, or a Docker container.
• Type: Which kind of workload this schedule runs: a KNIME workflow, a shell script, or a Docker container.
• Description: The schedule's name, shown throughout the app.
• Cron: A cron expression controlling when this schedule fires, in the instance's configured time zone.
• Active: Whether this schedule fires automatically according to cron. When false, it can still be triggered manually, but never on its own.
• Notes: Markdown-formatted notes about the schedule.
• Cleanup Run After Minutes: The time in minutes since execution, when the run data will be removed.
• Notify on Run Canceled: Whether to send a notification email when a run of this schedule is canceled.
• Notify on Run Failed: Whether to send a notification email when a run of this schedule fails.
• Notify on Run Passed: Whether to send a notification email when a run of this schedule passes.
• Deletable: Whether this schedule can be deleted.
• Runnable: Whether you're allowed to trigger this schedule manually right now.
• Latest Run: The most recent run of this schedule, or null if it's never been run.
• Next Run: When this schedule will next fire on its own, or null if it's not active.
• Additional Files: Extra files made available to every run of this schedule, alongside its workflow/script.
• Created At: When the schedule was created.
• Updated At: When the schedule was last changed.
• Created By: A NodePit Runner user account.
• Updated By: A NodePit Runner user account.
• Project: Stringified ObjectId (hexadecimal string with 24 characters). See ObjectId
• Tags: Free-form labels for filtering and matching against executor tags.
• Cancel Running Run After Minutes: The time in minutes after which a running run will be canceled.
• Cancel Running Run After Minutes Enabled: Whether cancelRunningRunAfterMinutes is enforced.
• Concurrency Strategy: What happens when this schedule is triggered while a previous run of it is still active: allow runs them in parallel, skip ignores the new trigger, queue waits for the active run to finish first, and cancelAndReplace cancels the active run and starts the new one immediately.
• Has Active Run: Whether this schedule currently has a run that is pending, running, or being canceled.
• Workflow: A file belonging to a project — either manually uploaded, or produced automatically as a run's output.
• Flow Variables: Flow variables passed into the workflow for every run.
• Credentials: Credentials made available to the workflow for every run.
• Reset Workflow: Whether the workflow is reset (discarding node execution results) before each run.
• Xvfb: Whether the workflow runs inside a virtual display (Xvfb). Enable this if the workflow uses nodes that require a graphical display to run, even though no one is watching.
• Script: A file belonging to a project — either manually uploaded, or produced automatically as a run's output.
• Variables: Environment variables passed into the container for every run.
• Command: Command to run in the environment’s Docker image, overriding its entrypoint. Leave unset to run the image’s own default command.

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers