Describes a scheduled job to run. Expected ObjectLinks: Relation: RunAs - (link to the user that this report will run as) Relation: Runner - (link to the Job Runner to which this job will be dispatched Metadata on the Runner link will carry the parameters to be sent to the runner)
Overview of CronJobInfo goes here.
Item -> BaseInfo -> CronJobInfo
Field | Type | Inherited from | Description |
---|---|---|---|
Href | String | Item | Gets or sets the href. |
CommonName | String | BaseInfo | Common Name of the resource.The common name of the resource. |
ConcurrencyVersion | Nullable<Int64> | BaseInfo | Gets or Set the Version. |
InFolderHref | String | BaseInfo | relative path Href value for the containing folderAll objects exist within a folder. Even folders! |
InFolderKey | String | BaseInfo | Represents the internal ID of the containing folder |
IsGlobal | Boolean | BaseInfo | If set True, the object will be exposed to the entire instance scope in which it resides. Meaning this object will always pass scope wide permissions tests when being queried although other restrictions such as by type will still apply (You need at least Read on the object type to see it regardless where you are in the instance scope). This Attribute is intended for use with AccessLevelInfo objects only. Use with other model objects may cause unexpected behaviors. Particularly this should not be used with ScheduleInfos, HolidayInfos, HolidayDayInfos, or ElevatorAccessLevelInfos. In time more objects will be allowed for use with this attribute but for the time being please only use with AccessLevelInfo Objects. |
Key | String | BaseInfo | Represents the internal ID of the object. |
Links | List<Link> | BaseInfo | List of related resourcesIt is expected that a resource will have many related resources (i.e. person has many access levels) Consumers of the API are encouraged to iterate through the list of links requesting this additional information as required. |
Metadata | MetadataItem[] | BaseInfo | The set of metadata attached to this resourceMetadata is opaque to the server code. Key value pairs are saved as part of a client activity. Users of the Native windows client, are able to design custom forms to display and edit scalar values in the meta data. |
Monikers | MonikerItem[] | BaseInfo | the set of Monikers for this object |
Notes | NoteInfo[] | BaseInfo | The set of notes attached to this resourceNotes are free form text only that is stored in chronological order. All notes are retrieved as part of an OBJECT get. Notes may be added as one POST but not updated with a PUT of the primary resource. WHen the resource is deleted all the notes are also deleted. |
ObjectLinks | ObjectLinkItem[] | BaseInfo | The set of resources that are related to this resourceFrequently resources have a one to one, or one to many relationship with other resources in the system. Use this set of links to discover related resources. 2016/09/29 Href property of the related resource may be null. In which case it’s expected that a set of related objects has already been retrieved by the client and the Key value will be used to index into that set. |
Tags | String[] | BaseInfo | the set of tags for this objectTags are used to group objects together for the purposes of selection and assignment of operation rights |
CronSchedule | String | CronJobInfo | Gets or Sets the Schedule for this job, in UNIX Cron format |
CronScheduleDescription | String | CronJobInfo | Gets or Sets the description of the Cron ScheduleThe API server will generate a description from the CronSchedule if this property is left as a null or empty string |
IsEnabled | Boolean | CronJobInfo | Gets or sets the IsEnabled value. When set to true the Job will execute on the schedule |
IsPrivate | Boolean | CronJobInfo | Gets or sets the IsPrivate value. When set to true the Job will not be selected to run by the hosted job scheduler.If using a private scheduled job dispatcher, typically something that is run on site, then set the IsPrivate flag true. |
LastRunOn | Nullable<DateTime> | CronJobInfo | Gets the Date and Time (UTC) when the job last ran. |
NextRunOn | Nullable<DateTime> | CronJobInfo | Gets the next Date and Time (UTC) that the job is scheduled to run |
NotAfter | Nullable<DateTime> | CronJobInfo | Gets or sets the date that this CronJob ends (if null the cron job will run on schedule indefinitely) |
NotBefore | Nullable<DateTime> | CronJobInfo | Gets or sets the date that this CronJob starts (if null the cron will be eligible to start immediately) |
TimeZone | String | CronJobInfo | Gets or sets the POSIX timezone information for determining when this job should run.Please see TimeZone property for Mercury Controllers for more detailed discussion on POSIX timezone. |
{
"Href" : "String",
"CommonName" : "String",
"ConcurrencyVersion" : "Nullable\<Int64\>",
"InFolderHref" : "String",
"InFolderKey" : "String",
"IsGlobal" : "Boolean",
"Key" : "String",
"Links" : "List\<[Link](/object-model/link)\>",
"Metadata" : "[MetadataItem](/object-model/metadataitem)[]",
"Monikers" : "[MonikerItem](/object-model/monikeritem)[]",
"Notes" : "[NoteInfo](/object-model/noteinfo)[]",
"ObjectLinks" : "[ObjectLinkItem](/object-model/objectlinkitem)[]",
"Tags" : "String[]",
"CronSchedule" : "String",
"CronScheduleDescription" : "String",
"IsEnabled" : "Boolean",
"IsPrivate" : "Boolean",
"LastRunOn" : "Nullable\<DateTime\>",
"NextRunOn" : "Nullable\<DateTime\>",
"NotAfter" : "Nullable\<DateTime\>",
"NotBefore" : "Nullable\<DateTime\>",
"TimeZone" : "String"
}
Example in C#
// Returns: CronJobInfo
var cronJobInfo = await client.AddCronJobAsync(InstanceInfo instance, CronJobInfo cronJob);
Example in C#
// Returns: nothing
await client.DeleteCronJobAsync(CronJobInfo cronJob);
Example in C#
// Returns: IEnumerable<CronJobInfo>
var cronJobInfo = await client.GetCronJobsAsync(InstanceInfo instance);
Example in C#
// Returns: IEnumerable<CronJobInfo>
var cronJobInfo = await client.GetCurrentCronJobsAsync(InstanceInfo instance, Boolean isPrivate);
Example in C#
// Returns: nothing
await client.UpdateCronJobAsync(CronJobInfo cronJob);