Cron

A scheduled job that executes a Bot on a recurring schedule.

Schema

Elements

Name	Required	Type	Description
identifier		Identifier[]	An identifier for this cron job Details An identifier for this cron job.
active	✓	boolean	Whether the job is registered with the scheduler Details Whether the scheduled job runs. Setting this to false unregisters the job while leaving the schedule itself intact, so the job can be turned back on without redefining it.
onBehalfOf	✓	Reference<ProjectMembership>	The membership on whose behalf the job runs Details The project membership whose identity and access policy the scheduled job assumes when it runs.
parameter		CronParameter[]	Input passed to the target Details Input passed to the target each time the scheduled job runs, with the same structure as Parameters.parameter. The target is always invoked with the whole Cron resource, so these parameters arrive alongside the schedule that produced them.
name	✓	string	Name from the definition Details The name of the parameter (reference to the operation definition).
value[x]		boolean, dateTime, decimal, integer, string, Reference<>	If parameter is a data type Details If the parameter is a data type.
resource		Resource	If parameter is a whole resource Details If the parameter is a whole resource. When resolving references in resources, the operation definition may specify how references may be resolved between parameters. If a reference cannot be resolved between the parameters, the application should fall back to it's general resource resolution methods.
cronString	✓	string	The schedule on which the job runs Details A schedule for the job to be executed, as a cron expression. An expression that is not a valid five-field cron expression is rejected on write.
endTime		dateTime	The point after which the job stops running Details The point in time after which the job no longer runs. A job whose end time has already passed is never scheduled, and a running one is removed once the time passes. When absent, the job runs until it is disabled or deleted.
targetReference	✓	Reference<Bot>	The target invoked by the scheduled job Details The target invoked each time the scheduled job runs.

Search Parameters

Name	Type	Description	Expression
identifier	token	The identifier of the cron job	Cron.identifier
on-behalf-of	reference	The project membership on whose behalf the cron job runs	Cron.onBehalfOf
target	reference	The Bot invoked by the cron job	Cron.targetReference

Inherited Elements

Name	Required	Type	Description
id		string	Logical id of this artifact Details The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta		Meta	Details The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules		uri	Details A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language		code	Details The base language in which the resource is written.
text		Narrative	Text summary of the resource, for human interpretation Details A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained		Resource[]	Contained, inline Resources Details These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension		Extension[]	Extensions that cannot be ignored Details May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).