Get the jobs schema

Get JSON schema for jobs managed by this API.

GET /job-config/jobs/_schema

Get the jobs schema

Python

import requests

url = "https://{FUSION_HOST}/job-config/jobs/_schema"

response = requests.get(url)

print(response.text)

200

{
  "type": "object",
  "title": "Job Runtime Configuration",
  "description": "Configuration of when and how this job will run.",
  "properties": {
    "jobResource": {
      "type": "object",
      "title": "Job Resource",
      "properties": {}
    },
    "enabled": {
      "type": "boolean",
      "title": "Enabled",
      "description": "Enable or disable this jobs set of triggers.",
      "default": true
    },
    "triggers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {},
        "oneOf": [
          {
            "type": "object",
            "title": "Start + Interval",
            "description": "Schedule a job with a specific interval.",
            "required": [
              "interval",
              "type"
            ],
            "properties": {
              "enabled": {
                "type": "boolean",
                "title": "Enabled",
                "default": true
              },
              "interval": {
                "type": "integer",
                "title": "Interval",
                "minimum": 1,
                "exclusiveMinimum": false
              },
              "timeUnit": {
                "type": "string",
                "title": "Time Unit",
                "enum": [
                  "second",
                  "minute",
                  "hour",
                  "day",
                  "week",
                  "month"
                ],
                "default": "hour"
              },
              "startTime": {
                "type": "string",
                "title": "Start Time",
                "format": "date-time"
              },
              "type": {
                "type": "string",
                "enum": [
                  "interval"
                ],
                "default": "interval",
                "hints": [
                  "readonly"
                ]
              }
            },
            "additionalProperties": false,
            "category": "Other",
            "categoryPriority": 1,
            "unsafe": false
          },
          {
            "type": "object",
            "title": "Cron String",
            "description": "Schedule a job in crontab format.",
            "required": [
              "expression",
              "type"
            ],
            "properties": {
              "enabled": {
                "type": "boolean",
                "title": "Enabled",
                "default": true
              },
              "expression": {
                "type": "string",
                "title": "Crontab expression",
                "description": "See Cron Trigger documentation on www.quartz-scheduler.org for more info",
                "default": "0 15 10 ? * MON-FRI"
              },
              "type": {
                "type": "string",
                "enum": [
                  "cron"
                ],
                "default": "cron",
                "hints": [
                  "readonly"
                ]
              }
            },
            "additionalProperties": false,
            "category": "Other",
            "categoryPriority": 1,
            "unsafe": false
          },
          {
            "type": "object",
            "title": "After Another Job Completes",
            "description": "Run this job on the completion of another job.",
            "required": [
              "otherJob",
              "triggerType",
              "type"
            ],
            "properties": {
              "enabled": {
                "type": "boolean",
                "title": "Enabled",
                "default": true
              },
              "otherJob": {
                "type": "string",
                "title": "Another Job",
                "description": "Another job to watch for"
              },
              "triggerType": {
                "type": "string",
                "title": "Another Job Status",
                "description": "When to start this job - on successful completion of another job, on failure or in both cases.",
                "enum": [
                  "on_success",
                  "on_failure",
                  "on_success_or_failure"
                ],
                "default": "on_success"
              },
              "type": {
                "type": "string",
                "enum": [
                  "job_completion"
                ],
                "default": "job_completion",
                "hints": [
                  "readonly"
                ]
              }
            },
            "additionalProperties": false,
            "category": "Other",
            "categoryPriority": 1,
            "unsafe": false
          }
        ]
      }
    },
    "default": {
      "type": "boolean",
      "title": "Default",
      "description": "Internal flag for checking if this is a default schedule.",
      "default": false,
      "hints": [
        "hidden",
        "readonly"
      ]
    }
  },
  "category": "Other",
  "categoryPriority": 1,
  "unsafe": false
}

Response

200 - */*

OK

type · enum<string>

Available options: string, number, integer, boolean, object, array, null, ref

title · string

description · string

required · string[]

properties · object

Show child attributes

additionalProperties · object

minProperties · integer<int32>

maxProperties · integer<int32>

definitions · object

Show child attributes

category · string

categoryPriority · integer<int32>

enum · object[]

hints · string[]

unsafe · boolean

default · object

anyOf · object[]

Show child attributes

propertyGroups · object[]

Show child attributes