Get the jobs schema
import requests
url = "https://{FUSION_HOST}/job-config/jobs/_schema"
response = requests.get(url)
print(response.text)HttpResponse<String> response = Unirest.get("https://{FUSION_HOST}/job-config/jobs/_schema")
.asString();const options = {method: 'GET'};
fetch('https://{FUSION_HOST}/job-config/jobs/_schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://{FUSION_HOST}/job-config/jobs/_schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{FUSION_HOST}/job-config/jobs/_schema"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{FUSION_HOST}/job-config/jobs/_schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}curl --request GET \
--url https://{FUSION_HOST}/job-config/jobs/_schema{
"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
}Get the jobs schema
Get JSON schema for jobs managed by this API.
GET
/
job-config
/
jobs
/
_schema
Get the jobs schema
import requests
url = "https://{FUSION_HOST}/job-config/jobs/_schema"
response = requests.get(url)
print(response.text)HttpResponse<String> response = Unirest.get("https://{FUSION_HOST}/job-config/jobs/_schema")
.asString();const options = {method: 'GET'};
fetch('https://{FUSION_HOST}/job-config/jobs/_schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));require 'uri'
require 'net/http'
url = URI("https://{FUSION_HOST}/job-config/jobs/_schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{FUSION_HOST}/job-config/jobs/_schema"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{FUSION_HOST}/job-config/jobs/_schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}curl --request GET \
--url https://{FUSION_HOST}/job-config/jobs/_schema{
"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
Available options:
string, number, integer, boolean, object, array, null, ref Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I