| Note |
|---|
Доступно начиная с версии ExeMES 2.4 |
| Comboversions | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Excerpt | |
|---|---|
|
...
|
...
|
...
ExeMES Media Service |
...
предоставляет следующие возможности:
|
...
|
ExeMES Media Service используется
...
| Note |
|---|
Вызов web API возможен при наличии у пользователя, под которым производится вызов функции, соответствующего доступа |
Вызов web API ExeMedia Service
Вызов web API ExeMedia Service можно реализовывать различными способами в зависимости от способов и методов реализации на стороне клиентских приложений.
Пример вызова web API функции Files, возвращающей список всех файлов в ExeMES:
| Code Block | ||||
|---|---|---|---|---|
| ||||
var myHeaders = new Headers();
var accessToken = "token"; // здесь необходимо задать Access Token, полученный от KeyCloak
myHeaders.append("Authorization", `Bearer ${accessToken}`);
var requestOptions = {
method: 'GET',
headers: myHeaders
};
fetch("https://exemedia.[домен]/api/Files", requestOptions)
.then(response => response.json())
.then(result => console.log(result))
.catch(error => console.log('error', error)); |
| Code Block | ||||
|---|---|---|---|---|
| ||||
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://exemedia.[домен]/api/Files");
var accessToken = "token"; // здесь необходимо задать Access Token, полученный от KeyCloak
request.Headers.Add("Authorization", $"Bearer {accessToken}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync()); |
Документация по web API ExeMedia Service
ExeMedia Service использует бесплатные инструменты Swagger в качестве встроенного инструмента документирования web API.
| Info |
|---|
Swagger — это набор инструментов, который позволяет автоматически описывать API на основе его кода. На основе кода Swagger автоматически генерирует документацию в формате JSON-файла. Ее можно встроить на страницу сайта или в приложение, чтобы пользователи могли интерактивно знакомиться с документацией. |
Документация по web API ExeMedia Service доступна в Swagger по адресу https://exemedia.[домен]/swagger/index.html. В интерфейсе swagger представлен список всех доступных web API функций ExeMedia Service с описанием.
...
| title | Работа со Swagger |
|---|
Для получения информации о параметрах функции необходимо выбрать функцию в списке после чего откроется выпадающая область, в которой представлены все параметры функции. Также в выпадающей области можно вызвать функцию с заданными параметрами. Для этого сначала необходимо пройти процесс авторизации.
Для авторизации в Swagger необходимо нажать на кнопку «Authorize», размещенную в правом верхнем углу основной страницы, после чего в открывшемся окне нажать на кнопку «Authorize».
Далее вы будете перенаправлены на страницу входа и после успешного прохождения авторизации API функции будут доступны для вызова из Swagger. Swagger предоставляет информацию о назначении каждой функции и каждого параметра функции.
Для вызова функции необходимо нажать на кнопку «Try it out» в выпадающей области, после чего задать необходимые параметры функции и нажать на кнопку «Execute». В случае успешного выполнения функции, возвращаемые функцией данные станут доступны в поле «Response body»:
При неуспешном выполнении функции в Server response будет предоставлена информация об ошибке:
Для хранения файлов ExeMES Media Service использует БД MinIO.
ExeMES Media Service работает с любыми типами файлов. Файлы связываются со следующими сущностям производственной модели ExeMES:
- материалы;
- объекты из объектной модели;
- процессы;
- операции;
- стандартные операции;
- производственные заказы;
- производственные задания.
| Tip |
|---|
Просмотр в web-интерфейсе ExeMES Client и ExeMES RuntimeClient возможен для файлов следующих типов:
|
| Note |
|---|
Когда файл отвязывают от сущности производственной модели ExeMES удаляется только сама связь, файл из БД ExeMES Media Service не удаляется, поэтому необходимо периодически проводить регламентную очистку неиспользуемых файлов. |
Очистка неиспользуемых файлов
| Note |
|---|
Функционал очистки неиспользуемых файлов доступен при наличии у пользователя роли Admin (см. инструкцию по управлению доступом к ExeMES). |
Возможность очистки неиспользуемых файлов доступна на любой странице ExeMES Client, где доступно окно управления файлами.
На странице в контекстном меню необходимо развернуть окно работы с файлами (появляется по нажатию на кнопку "Привязанные файлы") и нажать на кнопку
:
После чего откроется всплывающее окно со списком неиспользуемых файлов:
Для каждого файла из списка представлена следующая информацией:
- имя файла;
- идентификатор файла в БД ExeMES Media Service;
- размер файла в байтах;
- тип файла;
- дата и время создания файла - соответствует дате и времени загрузки первой версии файла;
- дата и время последнего изменения файла.
| Tip |
|---|
Индикатор |
Для удаления неиспользуемого файла необходимо выбрать его в списке (отметить 
) и нажать кнопку «Удалить выбранные файлы»:
| Tip |
|---|
Индикатор |
Для удаления всех неиспользуемых файлов необходимо поставить флажок «Выбрать все» и нажать кнопку «Удалить выбранные файлы»:
...