Returns a list of jobs
curl --request GET \
--url http://10.2.4.166:8080/composer/api/jobs \
--header 'Authorization: Basic <encoded-value>'import requests
url = "http://10.2.4.166:8080/composer/api/jobs"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('http://10.2.4.166:8080/composer/api/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://10.2.4.166:8080/composer/api/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://10.2.4.166:8080/composer/api/jobs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://10.2.4.166:8080/composer/api/jobs")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/jobs")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"content": [
{
"job": {
"id": "<string>",
"name": "<string>",
"category": "<string>",
"callbackData": "<string>",
"options": {
"frequency": {
"cronExpression": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"interval": {
"unit": "NANOSECONDS",
"value": 123
}
},
"timeout": {
"unit": "NANOSECONDS",
"value": 123
},
"locality": "EVERYWHERE",
"executeImmediately": true
},
"nextExecutionTime": "2023-11-07T05:31:56Z",
"lastExecutionStartTime": "2023-11-07T05:31:56Z",
"lastExecutionEndTime": "2023-11-07T05:31:56Z",
"state": "IN_PROGRESS",
"tags": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"currentExecution": {
"id": "<string>",
"jobName": "<string>",
"clientId": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"state": "IN_PROGRESS"
},
"lastCompletedExecution": {
"id": "<string>",
"jobName": "<string>",
"clientId": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"state": "IN_PROGRESS"
},
"nextExecutionDate": "2023-11-07T05:31:56Z"
}
]
}Returns a list of jobs
Returns a list of jobs
curl --request GET \
--url http://10.2.4.166:8080/composer/api/jobs \
--header 'Authorization: Basic <encoded-value>'import requests
url = "http://10.2.4.166:8080/composer/api/jobs"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('http://10.2.4.166:8080/composer/api/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://10.2.4.166:8080/composer/api/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://10.2.4.166:8080/composer/api/jobs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://10.2.4.166:8080/composer/api/jobs")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/jobs")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"content": [
{
"job": {
"id": "<string>",
"name": "<string>",
"category": "<string>",
"callbackData": "<string>",
"options": {
"frequency": {
"cronExpression": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"interval": {
"unit": "NANOSECONDS",
"value": 123
}
},
"timeout": {
"unit": "NANOSECONDS",
"value": 123
},
"locality": "EVERYWHERE",
"executeImmediately": true
},
"nextExecutionTime": "2023-11-07T05:31:56Z",
"lastExecutionStartTime": "2023-11-07T05:31:56Z",
"lastExecutionEndTime": "2023-11-07T05:31:56Z",
"state": "IN_PROGRESS",
"tags": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"currentExecution": {
"id": "<string>",
"jobName": "<string>",
"clientId": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"state": "IN_PROGRESS"
},
"lastCompletedExecution": {
"id": "<string>",
"jobName": "<string>",
"clientId": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"state": "IN_PROGRESS"
},
"nextExecutionDate": "2023-11-07T05:31:56Z"
}
]
}Authorizations
HTTP Basic authentication using global administrator credentials (username and password).
Query Parameters
Job Category Name
GMT Formatted date/time with offset, e.g.: 2011-12-03T10:15:30+01:00'
GMT Formatted date/time with offset, e.g.: 2011-12-03T10:15:30+01:00'
GMT Formatted date/time with offset, e.g.: 2011-12-03T10:15:30+01:00'
GMT Formatted date/time with offset, e.g.: 2011-12-03T10:15:30+01:00'
GMT Formatted date/time with offset, e.g.: 2011-12-03T10:15:30+01:00'
GMT Formatted date/time with offset, e.g.: 2011-12-03T10:15:30+01:00'
Field name to sort by. Should be prefixed with - for descending or + for ascending. Available field names are: category state, nextExecutionTime, lastExecutionEndTime, lastExecutionStartTime, tags.name
Response
200 - application/vnd.composer.v3+json
OK
Show child attributes
Show child attributes
Was this page helpful?