SiteScheduledJobs.getJobDefinitions (Method)
Returns a list of jobs available to be scheduled.
Returns:
ScheduledJobs_GetJobDefinitions_Results (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| Component | PlainText_NonNull_100 | The component to be called. |
| Description | PlainText | The description of the job. |
| IsFactory | Boolean | Boolean flag which when true indicates that this is a CommonSpot-provided job definition and cannot be edited. |
| IsJobManagerJob | Boolean | A boolean flag which when set to true indicates that this job is called through the Job Manager. |
| JobDefinitionID | PositiveInteger | The ID of the job definition at the specified source scope. |
| JobDefinitionName | PlainText_NonNull_100 | The name of the job definition. |
| Method | PlainText_NonNull_100 | The method to be called. |
| SourceScope | PrimaryScope | The source scope of the job definition. |
| State | JobDefinitionState | The state of the job definition which can be 'Available', 'Hidden' or 'Suspended'. |
| TargetScope | PrimaryScope | The target scope of the job definition. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| availableOnly | Boolean | Required | A boolean flag which when set to true indicates that only available job definitions should be returned. |
Context:
| License Requirements | (none) |
| Permission Requirements | site:SiteAdmin |
| Deny Context | ClusterROPS |
| Require Context | (none) |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None