Skip to content

Get Bulk Operation Status

Returns the status of a bulk operation.

Request

HTTP Request

GET /node/api/bulk/:id/status

Path parameters

Parameter Type Description
id String
required
The ID of an operation whose status should be checked.

Request body

The request body is empty.

Response

Field Type Description
finished

boolean

required

The status of an operation. Equals true if the operation is finished and false otherwise.

Examples

Request examples

login=<...>
password=<...>
saymon_hostname=<...>
bulk_op_id=<...>
url=https://$saymon_hostname/node/api/bulk/$bulk_op_id/status

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let bulkOpId = <...>
let path = "/node/api/bulks/" + bulkOpId + "/status";
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 bulkOpId = <...>
let path = "/node/api/bulk/" + bulkOpId + "/status";
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 = <...>
bulk_op_id = <...>
url = "https://" + saymon_hostname + "/node/api/bulk/" + \
    bulk_op_id + "/status"

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

Response example

{
    "finished": true
}