Get Reference by ID

Returns a reference with the specified ID.

Request

HTTP Request

GET /node/api/refs/:id

Permissions

referencePermissions

Path parameters

Parameter Type Description

id

String
required

The ID of a reference to be retrieved.

Request body

The request body is empty.

Response

Returns the requested reference. See the Reference model for more information.

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

login=<...>
password=<...>
saymon_hostname=<...>
ref_id=<...>
url=https://$saymon_hostname/node/api/refs/$ref_id

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let refId = <...>
let path = "/node/api/refs/" + refId;
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 refId = <...>
let path = "/node/api/refs/" + refId;
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 = <...>
ref_id = <...>
url = "https://" + saymon_hostname + "/node/api/refs/" + ref_id

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

Response

{
    "id": "5e60fb67630502472925ffbf",
    "target": "5e21b85b308c3c66d64e07c8",
    "owner": 1,
    "client_data": "..."
}

See Also