Получить документ потока

Возвращает документ потока с заданным ID как свойство.

Пример скачивания загруженного документа можно найти в статье Скачать документ.

Запрос

HTTP Запрос

GET /node/api/flows/:flow_id/docs/:doc_id

Параметры пути

Параметр	Тип	Описание
doc_id	String

обязательный | ID получаемого документа. | | flow_id | String

обязательный | ID потока. |

Тело запроса

Тело запроса пустое.

Ответ

Возвращает информацию об указанном документе в формате JSON.

Ответ содержит следующие параметры:

Параметр	Тип	Описание
id	String	ID документа.
type_id	Integer	Тип загруженного документа. 6 для ссылок, 7 для загруженных файлов.
name	String	Имя документа.
value	String	Внутренняя ссылка на документ. Хранит адреса для веб страниц и upload_<...> для загруженных файлов.

Пример

Запрос

• Bash
• JavaScript
• NodeJS
• Python

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

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

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

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

Ответ

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

Смотрите также

• Удалить документ потока
• Добавить документ к потоку