Skip to content

Get Link's Document

Returns a link's document with the specified ID as a property.

For an example on how to download the PDF documents see the Download PDF Document article in the cookbook.

Request

HTTP Request

GET /node/api/links/:link_id/docs/:doc_id

Path parameters

Parameter Type Description
doc_id String
required		 The ID of a document to be retrieved.
link_id String
required		 The ID of a link whose document should be retrieved.

Request body

The request body is empty.

Response

Returns a JSON representation of a specified document.

The response contains the following properties:

Name Type Description
id String ID of the document.
type_id Integer Type of an uploaded document — 6 for URLs, 7 for PDF files.
name String Name of the document.
value String An internal link to the document. Stores URLs for web pages and upload_<...> for PDF files.

Example

Request

login=<...>
password=<...>
saymon_hostname=<...>
link_id=<...>
document_id=<...>
url=https://$saymon_hostname/node/api/links/$link_id/docs/$document_id

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

let login = <...>
let password = <...>
let saymonHostname = <...>
let linkId = <...>
let documentId = <...>
let path = "/node/api/links/" + linkId + "/docs/" + documentId;
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 linkId = <...>
let documentId = <...>
let path = "/node/api/links/" + linkId + "/docs/" + documentId;
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 = <...>
link_id = <...>
document_id = <...>
url = "https://" + saymon_hostname + "/node/api/links/" + \
    link_id + "/docs/" + document_id

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

Response

{
    "name": "Bus_(computing).pdf",
    "value": "upload_a81d451eeebde3da52f7f83a6b83f78f",
    "type_id": 7,
    "id": "5e7a04dc6ec5ea28e5105f7e"
}