Skip to content

Get Number of Pages in Object's Document

Returns the number of pages in object's document.

Request

HTTP Request

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

Path parameters

Parameter Type Description
doc_id

String
required

The ID of a document to be processed.
format

String
required

Either .png or .pdf. For the first option, the actual number of pages is returned. For the second one, the result is always equal to 1.
object_id

String
required

The ID or discovery ID of the object whose document must be processed.

Request body

The request body is empty.

Response

Field Type Description
count Integer The number of pages in object's document.

Examples

Request examples

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

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

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

Response description

{
    "count": 24
}