GetBin

Синтаксис

<адрес веб-сервиса>/GetBin?<параметры операции>

Описание

Операция GetBin предназначена для извлечения бинарных данных с сервера с помощью GET-запроса.

Комментарии

В параметрах операции передаётся моникёр и различные дополнительные параметры. В зависимости от того объекта, для которого выполняется операция, в качестве моникёра указывается моникёр соединения с репозиторием или моникёр какого-либо открытого экземпляра объекта. Необходимые моникёры возвращают различные операции Open*.

Параметр и его значение в строке адреса разделяются символом «=», различные параметры разделяются между собой символом «&».

Допустимые параметры операции GetBin:

Параметр Описание
mon Моникёр объекта, для которого выполняется операция.
Допустимые виды моникёров:
  • <моникёр соединения с репозиторием>!$Sys! + <идентификатор_документа_репозитория>. Для извлечения содержимого документа, сохраненного в репозитории.
  • <моникёр соединения с репозиторием>!Preview! + <ключ_объекта>. Для извлечения миниатюры объекта репозитория в формате PNG.
  • <моникёр аналитической панели>!BinItem! + <id/key>. Для извлечения из аналитической панели изображения с указанными идентификатором/ключом.

Также могут использоваться моникёры, которые являются результатом выполнения операции PutBin.
attach Указание необходимости загрузить документ.
Допустимые значения параметра:
  • 1. Загрузка документа, при этом в заголовок формируемой ссылки будет добавлен параметр attachment. Пример: &attach=1.
  • 2. Открытие документа внутренним представлением браузера, при этом в заголовок формируемой ссылки будет добавлен параметр inline. Пример: &attach=2.
fileName Наименование файла, с которым осуществляется загрузка. Используется вместе с параметром attach. Пример: &attach=1&fileName=report.xls.

Важно. Наименования параметров являются регистрозависимыми.

Пример

Ниже приведён пример кода html-страницы, которая используется для получения бинарных данных с помощью операции GetBin. При открытии страницы осуществляется подключение к репозиторию и выполняются два действия:

Результаты выполнения операций будут открыты в новых вкладках браузера.

Для уменьшения примера из кода исключен скрипт функции PostRequest, которая используется для выполнения операций в JSON формате. Код данной функции можно посмотреть в статье «Подключение к репозиторию».

<!DOCTYPE html <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>Использование операции GetBin</title>
</head>
<body>
    <script language="javascript" type="text/javascript">
        var svc = "http://localhost:9090/axis2/services/PP.SOM.Som";
        OpenMetabase = { "OpenMetabase": { "tDef": { "id": "PPREPOSITORY" }, "tCreds": { "user": { "id": "pprepository" }, "pass": "pprepository" } } }
        OpenMetabaseResult = PostRequest(svc, OpenMetabase);
        /*
            Скрипт для PostRequest
        */
        //Выполнение GetBin
        url = svc + "/GetBin?mon=" + OpenMetabaseResult.OpenMetabaseResult.id + "!$Sys!LOGO";
        window.open(url);
        url = svc + "/GetBin?mon=" + OpenMetabaseResult.OpenMetabaseResult.id + "!Preview!12345";
        window.open(url);
    </script>
</body>
</html>

См. также:

Дополнительные операции