ForgeRock · Schema

SchedulerJob

A scheduled job configuration

Access ManagementAuthenticationAuthorizationIdentity GovernanceIdentity ManagementOAuthOpenID Connect

Properties

Name Type Description
_id string
enabled boolean Whether the job is enabled
type string Job type
schedule string Cron expression for cron-type jobs
misfirePolicy string Policy for handling missed executions
invokeService string The service to invoke
invokeContext object Context for the service invocation
invokeLogLevel string
View JSON Schema on GitHub

JSON Schema

forgerock-schedulerjob-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SchedulerJob",
  "title": "SchedulerJob",
  "type": "object",
  "description": "A scheduled job configuration",
  "properties": {
    "_id": {
      "type": "string",
      "readOnly": true
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the job is enabled"
    },
    "type": {
      "type": "string",
      "description": "Job type",
      "enum": [
        "cron",
        "simple"
      ]
    },
    "schedule": {
      "type": "string",
      "description": "Cron expression for cron-type jobs"
    },
    "misfirePolicy": {
      "type": "string",
      "description": "Policy for handling missed executions",
      "enum": [
        "fireAndProceed",
        "doNothing"
      ]
    },
    "invokeService": {
      "type": "string",
      "description": "The service to invoke"
    },
    "invokeContext": {
      "type": "object",
      "description": "Context for the service invocation",
      "properties": {
        "action": {
          "type": "string"
        },
        "mapping": {
          "type": "string"
        }
      }
    },
    "invokeLogLevel": {
      "type": "string",
      "enum": [
        "info",
        "debug",
        "trace"
      ]
    }
  }
}