Skip to content

Get Job by ID

Returns a job with a specified ID.

Request

HTTP Request

GET /node/api/jobs/:id

Permissions

objectPermissions

Path parameters

Parameter Type Description
id String
required		 The ID of a job to be retrieved.

Request body

The request body is empty.

Response

See the Job model.

Example

Request

login=<...>
password=<...>
saymon_hostname=<...>
job_id=<...>
url=http://$saymon_hostname/node/api/jobs/$job_id

curl -X GET $url -u $login:$password

let login = <...>
let password = <...>
let saymonHostname = <...>
let jobId = <...>
let path = "/node/api/jobs/" + jobId;
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Authorization", auth);

let requestOptions = {
    method: "GET",
    headers: headers
};

fetch(saymonHostname + path, requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log("error", error));

const http = require("http");

let login = <...>
let password = <...>
let saymonHostname = <...>
let jobId = <...>
let path = "/node/api/jobs/" + jobId;
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "GET",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth
    },
    "path": path
};

let req = http.request(options, function (res) {
    let chunks = [];

    res.on("data", function (chunk) {
        chunks.push(chunk);
    });

    res.on("end", function (chunk) {
        let body = Buffer.concat(chunks);
        console.log(body.toString());
    });

    res.on("error", function (error) {
        console.error(error);
    });
});

req.end();

import requests

login = <...>
password = <...>
saymon_hostname = <...>
job_id = <...>
url = "https://" + saymon_hostname + "/node/api/jobs/" + job_id

response = requests.request("GET", url, auth=(login, password))
print(response.text)

Response

{
    "id": "5f1150e0786952333e048898",
    "description": {
        "stdout": "Hello, world!",
        "exitCode": 0
    },
    "operation_id": "5ed0e3505a6afa192c2e711f",
    "owner_id": "5e9465cb10b1f754077cb061",
    "owner_type": 1,
    "user_id": "5e2184a1a51400778eadc945",
    "process_meta": null,
    "timestamp": 1594970336122,
    "results": []
}

See Also