Execute Entity Operation

Executes an operation with a given ID on a given Entity.

Request

HTTP Request

POST /node/api/entities/:entity_id/operations/:op_id/execute

Permissions

entityPermissions & execute-operations

Path parameters

Parameter Type Description

entity_id

String
required

The ID of an entity whose operation should be executed.

op_id

String
required

The ID of an operation to be executed.

Request body

Request body contains operation input arguments.

Use the arguments with the {{args.<argument_name>}} macro in the operation script:

#!/bin/bash

ping {{args.host}} -c {{args.count}}

Pass the arguments in the request body like so:

{
  "host": "example.com",
  "count": 4
}

Response

Returns the ID of the job, that executed this operation.

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

login=<...>
password=<...>
saymon_hostname=<...>
entity_id=<...>
operation_id=<...>
url=https://$saymon_hostname/node/api/links/$entity_id/operations/$operation_id/execute

curl -X POST $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let entityId = <...>
let operationId = <...>
let path = "/node/api/objects/" + entityId + "/operations/" +
    operationId + "/execute";
let auth = "Basic " + btoa(login + ":" + password);

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

let requestOptions = {
    method: "POST",
    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 entityId = <...>
let operationId = <...>
let path = "/node/api/links/" + entityId + "/operations/" +
    operationId + "/execute";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "POST",
    "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 = <...>
entity_id = <...>
operation_id = <...>
url = "https://" + saymon_hostname + "/node/api/links/" + \
    entity_id + "/operations/" + operation_id + "/execute"

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

Response

"62de902eb238aa0131bd3b8b"

See Also