Get Number Of Pages in Flow's Document

GET /node/api/flow/:id/docs/:doc_id/:format/pages
Returns the number of pages in a flow's document.
Request parameters
Path parameters
Parameter
Type
Description
doc_id
string
required
The ID of a document to be retrieved.
format
string
required
Either .pdf or .png. For the first option, the actual number of pages is returned. For the second one, the result is always equal to one.
id
string
required
The ID of a flow whose document should be processed.
Response description
Field
Type
Description
count
integer
required
The number of pages in the specified flow's document.
Examples
Request examples
Bash
JavaScript
NodeJS
Python
Bash
login=<...>
password=<...>
saymon_hostname=<...>
flow_id=<...>
document_id=<...>
format=png
url=https://$saymon_hostname/node/api/flows/$flow_id/docs/$document_id/$format/pages
​
curl -X GET $url -u $login:$password
JavaScript
let login = <...>
let password = <...>
let saymonHostname = <...>
let flowId = <...>
let documentId = <...>
let format = "png";
let path = "/node/api/flows/" + flowId + "/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));
NodeJS
const http = require("http");
​
let login = <...>
let password = <...>
let saymonHostname = <...>
let flowId = <...>
let documentId = <...>
let format = "png";
let path = "/node/api/flows/" + flowId + "/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();
Python
import requests
​
login = <...>
password = <...>
saymon_hostname = <...>
flow_id = <...>
document_id = <...>
_format = "png"
url = "https://" + saymon_hostname + "/node/api/flows/" + \
    flow_id + "/docs/" + document_id + "/" + _format + "/pages"
​
response = requests.request("GET", url, auth=(login, password))
print(response.text)
Response example
{
    "count": 10
}

Get Flow's Document

Delete Flow

Last updated 4 months ago

Parameter	Type	Description
doc_id	string `required`	The ID of a document to be retrieved.
format	string `required`	Either `.pdf` or `.png`. For the first option, the actual number of pages is returned. For the second one, the result is always equal to one.
id	string `required`	The ID of a flow whose document should be processed.