Get Object’s Document

Returns an object’s document with the specified ID as a property.

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

Request

HTTP Request

GET /node/api/objects/:object_id/docs/:doc_id

Path parameters

Parameter Type Description

doc_id

String
required

The ID of a document to be retrieved.

object_id

String
required

The ID or discovery ID of the object whose document must 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 uploaded files.

name

String

Name of the document.

value

String

An internal link to the document. Stores URLs for web pages and upload_<...> for uploaded files.

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let objectId = <...>
let documentId = <...>
let path = "/node/api/objects/" + objectId + "/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 objectId = <...>
let documentId = <...>
let path = "/node/api/objects/" + objectId + "/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 = <...>
object_id = <...>
document_id = <...>
url = "https://" + saymon_hostname + "/node/api/objects/" + \
    object_id + "/docs/" + document_id

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

Response

{
    "name": "cpu.pdf",
    "value": "upload_8b8a8092b768c147b3916af112876925",
    "type_id": 7,
    "id": "5e79c5696ec5ea28e5105d55"
}

See Also