Created
December 21, 2023 16:48
-
-
Save barbudour/fbba6fc0dd7ebe34ea41bddb3bef2786 to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "openapi": "3.0.1", | |
| "info": { | |
| "title": "TESSA REST API", | |
| "description": "ASP.NET Core Web API for Syntellect TESSA web application", | |
| "contact": { | |
| "name": "Syntellect support", | |
| "url": "https://mytessa.ru", | |
| "email": "tessa@syntellect.ru" | |
| }, | |
| "version": "v1" | |
| }, | |
| "servers": [ | |
| { | |
| "url": "/gossed/web" | |
| } | |
| ], | |
| "paths": { | |
| "/api/v1/applications": { | |
| "get": { | |
| "tags": [ | |
| "Applications" | |
| ], | |
| "summary": "Возвращает список всех приложений, доступных пользователю, в форме типизированного JSON.", | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/ApplicationPackage" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/applications/get-id": { | |
| "get": { | |
| "tags": [ | |
| "Applications" | |
| ], | |
| "summary": "Осуществляет попытку получения идентификатора приложения по его алиасу.\r\nВозвращает идентификатор приложения или 204 (No Content), если данные получить не удалось.", | |
| "parameters": [ | |
| { | |
| "name": "alias", | |
| "in": "query", | |
| "description": "Алиас приложения.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "64bit", | |
| "in": "query", | |
| "description": "Признак того, что приложение использует 64-битную архитектуру.", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/applications/get-attributes": { | |
| "get": { | |
| "tags": [ | |
| "Applications" | |
| ], | |
| "summary": "Возвращает дату изменения приложения и признак того, что приложение является 64-битным.\r\n \r\nВозвращает объект, содержащий дату изменения карточки приложения `Modified`\r\nи признак того, является ли приложение 64-битным `Client64Bit`,\r\nили 204 (No Content), если данные получить не удалось.", | |
| "parameters": [ | |
| { | |
| "name": "alias", | |
| "in": "query", | |
| "description": "Алиас приложения.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "64bit", | |
| "in": "query", | |
| "description": "Признак того, что приложение является 64-битным. Укажите `null`, чтобы не фильтровать приложения по разрядности,\r\nи скачивать те из них, разрядность которых соответствует разрядности ОС или настройкам в карточке сотрудника.", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ApplicationAttributesResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/applications/faulted-results/{id}": { | |
| "get": { | |
| "tags": [ | |
| "Applications" | |
| ], | |
| "summary": "Возвращает ошибки при скачивании приложения как объект Tessa.Platform.Validation.PlainValidationResult или 204 (No Content), если информация недоступна:\r\nошибок не было или пользователь не имеет доступа к этой записи в истории.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор записи в истории, которая возвращается в свойстве\r\nTessa.Applications.Package.ApplicationPackage.ActionHistoryRowID для загруженного пакета.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/applications/download": { | |
| "post": { | |
| "tags": [ | |
| "Applications" | |
| ], | |
| "summary": "Скачивает поток с бинарными данными приложения.", | |
| "requestBody": { | |
| "description": "Запрос на загрузку приложения.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ApplicationDownloadRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Stream" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/cards/new": { | |
| "post": { | |
| "tags": [ | |
| "Cards" | |
| ], | |
| "summary": "Создаёт пустой объект карточки. Физически карточка не создаётся в базе данных.", | |
| "requestBody": { | |
| "description": "Запрос на создание карточки.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardNewRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CardNewResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/cards/get": { | |
| "post": { | |
| "tags": [ | |
| "Cards" | |
| ], | |
| "summary": "Загружает карточку с указанными параметрами. Карточка должна существовать (или являться виртуальной).", | |
| "requestBody": { | |
| "description": "Запрос на загрузку карточки.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardGetRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CardGetResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/cards/get-file-versions": { | |
| "post": { | |
| "tags": [ | |
| "Cards" | |
| ], | |
| "summary": "Загружает список версий для файла с указанными параметрами.", | |
| "requestBody": { | |
| "description": "Запрос на загрузку списка версий.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardGetFileVersionsRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CardGetFileVersionsResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/cards/get-file-content": { | |
| "post": { | |
| "tags": [ | |
| "Cards" | |
| ], | |
| "summary": "Загружает содержимое файла с указанными параметрами в виде потока файла Microsoft.AspNetCore.Mvc.FileStreamResult.\r\nПредпочитаемое имя файла возвращается как заголовок `Content-Disposition` в `Response`.\r\n \r\nРезультат запроса API карточек Tessa.Cards.CardGetFileContentResponse не возвращается, но про наличии\r\nошибок будет возвращён Tessa.Platform.Validation.PlainValidationResult, сериализованный как typed json,\r\nс кодом ошибки System.Net.HttpStatusCode.BadRequest.", | |
| "requestBody": { | |
| "description": "Запрос на загрузку содержимого файла.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardGetFileContentRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/cards/get-file-content-stream": { | |
| "post": { | |
| "tags": [ | |
| "Cards" | |
| ], | |
| "summary": "Загружает содержимое файла с указанными параметрами в виде агрегированного потока System.IO.Stream,\r\nсодержащего результат запроса Tessa.Cards.CardGetFileContentResponse и бинарное содержимое файла.\r\nМетод рекомендуется для использования в desktop-клиенте.\r\n \r\nВозвращает объект, содержащий ответ на запрос и собственно бинарное содержимое файла.\r\nИспользуйте клиентское API карточек desktop-клиента, чтобы прочитать поток данных.", | |
| "requestBody": { | |
| "description": "Запрос на загрузку содержимого файла.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardGetFileContentRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Stream" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/cards/get-file-content-multipart": { | |
| "post": { | |
| "tags": [ | |
| "Cards" | |
| ], | |
| "summary": "Загружает содержимое файла с указанными параметрами в виде содержимого `multipart/form-data`,\r\nгде первый part с именем \"Response\" содержит Tessa.Cards.CardGetFileContentResponse в виде типизированного Json `application/json`,\r\nи второй part с именем \"Content\" (при его наличии) представляет бинарное содержимое файла `application/octet-stream`\r\n(также предоставляется рекомендуемое имя файла).\r\n \r\nЕсли в ответе на запрос указан Tessa.Cards.CardGetFileContentResponse.HasContent, равный `false`,\r\nто второй part с содержимым файла отсутствует.", | |
| "requestBody": { | |
| "description": "Запрос на загрузку содержимого файла.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardGetFileContentRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/HttpContent" | |
| } | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/HttpContent" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/cards/store": { | |
| "post": { | |
| "tags": [ | |
| "Cards" | |
| ], | |
| "summary": "Сохраняет карточку Tessa.Cards.CardStoreRequest.Card с заданными параметрами. Если у карточки указан режим сохранения\r\nTessa.Cards.CardStoreMode.Insert, то карточка считается новой и создаётся, в противном случае изменяется существующая карточка.", | |
| "requestBody": { | |
| "description": "Запрос на сохранение карточки.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardStoreRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CardStoreResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/cards/store-stream": { | |
| "post": { | |
| "tags": [ | |
| "Cards" | |
| ], | |
| "summary": "Сохраняет содержимое карточки вместе с файлами. Аналогичен запросу M:Tessa.Web.Controllers.CardsController.PostStore(Tessa.Cards.CardStoreRequest,System.Threading.CancellationToken), но позволяет передавать во входящем потоке\r\nсодержимое файлов, приложенных к карточке (добавление или замена файла), в виде агрегированного потока System.IO.Stream,\r\nсодержащего заголовок Tessa.Cards.ComponentModel.CardHeader, результат запроса Tessa.Cards.CardStoreResponse и бинарное содержимое сохраняемых файлов.\r\n \r\nМетод рекомендуется для использования в desktop-клиенте. Используйте клиентское API карточек desktop-клиента, чтобы сформировать поток данных.", | |
| "requestBody": { | |
| "description": "Запрос на сохранение карточки с файлами.", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/Stream" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CardStoreResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/cards/store-files": { | |
| "post": { | |
| "tags": [ | |
| "Cards" | |
| ], | |
| "summary": "Сохраняет содержимое карточки вместе с файлами. Аналогичен запросу M:Tessa.Web.Controllers.CardsController.PostStore(Tessa.Cards.CardStoreRequest,System.Threading.CancellationToken),\r\nно позволяет передавать в теле запроса `multipart/form-data` содержимое файлов, приложенных к карточке (добавление или замена файла).\r\n \r\nПервые part-ы содержат данные формы `form-data` в соответствии с именами свойств Tessa.Web.Services.CardStoreFilesRequest,\r\nв котором по ключу \"Header\" содержится заголовок Tessa.Cards.ComponentModel.CardHeader в форме типизированного json,\r\nа по ключу \"Request\" - запрос Tessa.Cards.CardStoreRequest в форме типизированного json.\r\n \r\nПоследующие part-ы представляют содержимое файлов в порядке, указанном в методе\r\nM:Tessa.Cards.ComponentModel.CardHeader.GetOrderedFiles для Tessa.Cards.ComponentModel.CardHeader.", | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CardStoreResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/cards": { | |
| "delete": { | |
| "tags": [ | |
| "Cards" | |
| ], | |
| "summary": "Удаляет карточку с заданными параметрами. Этот же метод используется при восстановлении карточки из корзины.", | |
| "requestBody": { | |
| "description": "Запрос на удаление карточки.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardDeleteRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CardDeleteResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/cards/request": { | |
| "post": { | |
| "tags": [ | |
| "Cards" | |
| ], | |
| "summary": "Выполняет универсальный запрос к API карточек с заданными параметрами. В пределах такого запроса выполняются любые операции,\r\nсоответствующие указанному типу запроса Tessa.Cards.CardRequest.RequestType, причём операция может быть связана\r\nс конкретной карточкой Tessa.Cards.CardRequest.CardID, или может быть не связана с карточками вовсе.", | |
| "requestBody": { | |
| "description": "Универсальный запрос к API карточек.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CardResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/types": { | |
| "get": { | |
| "tags": [ | |
| "CardTypes" | |
| ], | |
| "summary": "Загружает все типы карточек в системе.", | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardType" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/types/metadata": { | |
| "get": { | |
| "tags": [ | |
| "CardTypes" | |
| ], | |
| "summary": "Загружает объект метаинформации по карточкам Tessa.Cards.Metadata.CardMetadata.", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "Имя, по которому будет резолвиться Tessa.Cards.Metadata.ICardMetadataBuilder,\r\nесли не указано, то возвращается метаинформация по умолчанию.", | |
| "schema": { | |
| "type": "string", | |
| "default": "Default" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CardMetadata" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/types/{id}": { | |
| "get": { | |
| "tags": [ | |
| "CardTypes" | |
| ], | |
| "summary": "Загружает тип карточки с заданным идентификатором. Возвращает статус 204 (No Content), если тип не найден.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор типа карточки.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CardType" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/types/store": { | |
| "post": { | |
| "tags": [ | |
| "CardTypes" | |
| ], | |
| "summary": "Создаёт или изменяет заданные типы карточек, а также удаляет типы с указанными идентификаторами\r\nв рамках единственного изменения конфигурации. Метод доступен только администраторам.", | |
| "requestBody": { | |
| "description": "Запрос на сохранение и/или удаление типов карточек. Используется типизированный JSON.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardTypeStoreRequest" | |
| } | |
| ], | |
| "description": "Запрос на массовое сохранение типов карточек." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/check": { | |
| "get": { | |
| "tags": [ | |
| "Check" | |
| ], | |
| "summary": "Возвращает текстовое описание для конфигурации веб-сервиса с указанием версии серверной ОС и платформы .NET,\r\nа с перечислением загруженных расширений и дополнительных сборок с контроллерами.\r\nТакже выполняет проверку функционирования подсистем карточек и представлений, и возвращает результаты проверок.", | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/card/request": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Универсальный запрос к API карточек M:Tessa.Cards.ICardRepository.RequestAsync(Tessa.Cards.CardRequest,System.Threading.CancellationToken).", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос к API карточек, сериализованный в текстовый типизированный JSON.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/card/request/get": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на загрузку карточки M:Tessa.Cards.ICardRepository.GetAsync(Tessa.Cards.CardGetRequest,System.Threading.CancellationToken).", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос на загрузку карточки, сериализованный в текстовый типизированный JSON.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/card/request/new": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на создание карточки M:Tessa.Cards.ICardRepository.NewAsync(Tessa.Cards.CardNewRequest,System.Threading.CancellationToken).", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос на создание карточки, сериализованный в текстовый типизированный JSON.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/card/request/delete": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на удаление карточки M:Tessa.Cards.ICardRepository.DeleteAsync(Tessa.Cards.CardDeleteRequest,System.Threading.CancellationToken).", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос на удаление карточки, сериализованный в текстовый типизированный JSON.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/card/request/getFileContent": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на загрузку содержимого файла M:Tessa.Cards.ICardStreamServerRepository.GetFileContentAsync(Tessa.Cards.CardGetFileContentRequest,System.Threading.CancellationToken).", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос на загрузку содержимого файла, сериализованный в текстовый типизированный JSON.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/card/request/getFileVersions": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на загрузку списка версий файла M:Tessa.Cards.ICardRepository.GetFileVersionsAsync(Tessa.Cards.CardGetFileVersionsRequest,System.Threading.CancellationToken).", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос на загрузку списка версий файла, сериализованный в текстовый типизированный JSON.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/card/request/copy": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на создание копии карточки.", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос на создание копии карточки, сериализованный в текстовый типизированный JSON.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/card/request/createFromTemplate": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на создание карточки по шаблону.", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос на создание карточки по шаблону, сериализованный в текстовый типизированный JSON.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/card/request/repair": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на исправление структуры карточки.", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос на исправление структуры карточки, сериализованный в текстовый типизированный JSON.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/filelink": { | |
| "get": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Возвращает содержимое файла для его скачивания в браузере по ссылке.", | |
| "parameters": [ | |
| { | |
| "name": "cardID", | |
| "in": "query", | |
| "description": "Идентификатор карточки.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "fileID", | |
| "in": "query", | |
| "description": "Идентификатор файла.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "versionID", | |
| "in": "query", | |
| "description": "Идентификатор версии файла.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "cardTypeID", | |
| "in": "query", | |
| "description": "Идентификатор типа карточки.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "cardTypeName", | |
| "in": "query", | |
| "description": "Алиас типа карточки.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "fileName", | |
| "in": "query", | |
| "description": "Имя файла с расширением.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "fileTypeName", | |
| "in": "query", | |
| "description": "Имя типа файла.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "info", | |
| "in": "query", | |
| "description": "Сериализованные дополнительные параметры.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "asHtml", | |
| "in": "query", | |
| "description": "Контент файла возвращается как HTML страница.", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/view/request2": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на просмотр данных представления в web-клиенте.", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос на просмотр данных представления Tessa.Web.Client.Models.WebViewRequest,\r\nсериализованный в текстовый JSON. Типы объектов не передаются.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/view/request3": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на просмотр данных представления в web-клиенте.", | |
| "requestBody": { | |
| "description": "Запрос на просмотр данных представления Tessa.Web.Client.Models.WebViewRequest,\r\nсериализованный в текстовый JSON. Типы объектов не передаются.", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/WebViewRequest" | |
| } | |
| ], | |
| "description": "Запрос на загрузку данных представления." | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/WebViewRequest" | |
| } | |
| ], | |
| "description": "Запрос на загрузку данных представления." | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/WebViewRequest" | |
| } | |
| ], | |
| "description": "Запрос на загрузку данных представления." | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/WebViewRequest" | |
| } | |
| ], | |
| "description": "Запрос на загрузку данных представления." | |
| } | |
| }, | |
| "application/*+json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/WebViewRequest" | |
| } | |
| ], | |
| "description": "Запрос на загрузку данных представления." | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/WebViewRequest" | |
| } | |
| ], | |
| "description": "Запрос на загрузку данных представления." | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/WebViewRequest" | |
| } | |
| ], | |
| "description": "Запрос на загрузку данных представления." | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ITessaViewResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ITessaViewResult" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ITessaViewResult" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ITessaViewResult" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ITessaViewResult" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/view/searchQuery/save": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на сохранение поискового запроса в web-клиенте.", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос на сохранение поискового запроса Tessa.Views.SearchQueries.SearchQueryMetadata,\r\nсериализованный в текстовый JSON. Типы объектов не передаются.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/view/searchQuery/delete": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на удаление одного или нескольких поисковых запросов.", | |
| "requestBody": { | |
| "description": "Идентификаторы удаляемых поисковых запросов.", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| "application/octet-stream": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| "application/*+json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/view/addUserMetadata": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на добавление метаинформации пользователя в рабочем месте в web-клиенте.", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос на добавление метаинформации пользователя в рабочем месте Tessa.Views.Workplaces.IWorkplaceComponentMetadata,\r\nсериализованный в текстовый JSON. Типы объектов не передаются.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/view/changeUserMetadata": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на изменение метаинформации пользователя в рабочем месте в web-клиенте.", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос на изменение метаинформации пользователя в рабочем месте Tessa.Views.Workplaces.IWorkplaceComponentMetadata,\r\nсериализованный в текстовый JSON. Типы объектов не передаются.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/view/deleteUserMetadata": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на удаление метаинформации пользователя в рабочем месте в web-клиенте.", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос на удаление метаинформации пользователя в рабочем месте Tessa.Views.Workplaces.IWorkplaceComponentMetadata,\r\nсериализованный в текстовый JSON. Типы объектов не передаются.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/view/saveUserMetadataProperties": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запрос на сохранение объектов-свойств в рабочем месте в web-клиенте. Например, сохранение настроек колонок в представлении.", | |
| "parameters": [ | |
| { | |
| "name": "requestJSON", | |
| "in": "query", | |
| "description": "Запрос на сохранение объектов-свойств в рабочем месте в виде коллекции Tessa.Views.Workplaces.Properties.IItemProperties,\r\nсериализованной в текстовый JSON. Типы объектов не передаются.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/operations/create": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Создаёт активную операцию `IOperationRepository.Create` в web-клиенте.\r\nВозвращает уникальный идентификатор созданной операции.", | |
| "parameters": [ | |
| { | |
| "name": "typeId", | |
| "in": "query", | |
| "description": "Идентификатор типа операции.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "flags", | |
| "in": "query", | |
| "description": "Флаговое перечисление Tessa.Platform.Operations.OperationCreationFlags для настроек при создании операции.\r\n\r\n0 = None\r\n\r\n1 = CreateInProgress\r\n\r\n2 = ReportsProgress\r\n\r\n4 = FailWhenHasSameRequestHash", | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/OperationCreationFlags" | |
| } | |
| ], | |
| "default": 0, | |
| "x-enumNames": [ | |
| "None", | |
| "CreateInProgress", | |
| "ReportsProgress", | |
| "FailWhenHasSameRequestHash" | |
| ] | |
| }, | |
| "x-enumNames": [ | |
| "None", | |
| "CreateInProgress", | |
| "ReportsProgress", | |
| "FailWhenHasSameRequestHash" | |
| ] | |
| }, | |
| { | |
| "name": "digest", | |
| "in": "query", | |
| "description": "Digest с кратким текстовым описанием операции. Может быть `null`.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "request", | |
| "in": "query", | |
| "description": "Сериализованный в типизированный JSON запрос с дополнительной информацией по операции, зависимой от типа операции.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Идентификатор создаваемой операции или `null`, если идентификатор определяется сервером.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/operations/start": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запускает операцию с указанным идентификатором M:Tessa.Platform.Operations.IOperationRepository.StartAsync(System.Guid,System.Threading.CancellationToken).", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Идентификатор запускаемой операции.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/operations/startFirst": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Запускает первую незапущенную операцию с указанным идентификатором типа операции M:Tessa.Platform.Operations.IOperationRepository.StartFirstAsync(System.Guid,System.Threading.CancellationToken).\r\nВозвращает идентификатор запущенной операции или `null`, если подходящие операции отсутствуют.", | |
| "parameters": [ | |
| { | |
| "name": "typeId", | |
| "in": "query", | |
| "description": "Идентификатор типа запускаемой операции.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/operations/reportProgress": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Задаёт прогресс запущенной операции M:Tessa.Platform.Operations.IOperationRepository.ReportProgressAsync(System.Guid,System.Double,System.Threading.CancellationToken). Возвращает признак того, что операция существует,\r\nзапущена и поддерживает уведомление по прогрессу операции.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Идентификатор операции.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "progress", | |
| "in": "query", | |
| "description": "Прогресс операции в процентах как число от `0` до `100`. Администраторам обычно выводится два знака после запятой.", | |
| "schema": { | |
| "type": "number", | |
| "format": "double" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/operations/isAlive": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Возвращает признак того, что операция с указанным идентификатором существует в списке активных операций M:Tessa.Platform.Operations.IOperationRepository.IsAliveAsync(System.Guid,System.Threading.CancellationToken).", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Идентификатор проверяемой операции.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/operations/getState": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Возвращает состояние операции Tessa.Platform.Operations.OperationState по заданному идентификатору. Метод M:Tessa.Platform.Operations.IOperationRepository.GetStateAsync(System.Guid,System.Threading.CancellationToken).\r\n`0` - операция создана и не запущена;\r\n`1` - операция запущена и ещё не завершена;\r\n`2` - операция завершена, но не удалена;\r\n`null` - операция не найдена, т.е. не создана или уже удалена.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Идентификатор проверяемой операции.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OperationState" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OperationState" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OperationState" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OperationState" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OperationState" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/operations/getStateAndProgress": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Возвращает состояние операции Tessa.Platform.Operations.OperationState и прогресс по заданному идентификатору, сериализованный в типизированный JSON.\r\nМетод M:Tessa.Platform.Operations.IOperationRepository.GetStateAndProgressAsync(System.Guid,System.Threading.CancellationToken).", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Идентификатор проверяемой операции.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OperationStateAndProgress" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OperationStateAndProgress" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OperationStateAndProgress" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OperationStateAndProgress" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OperationStateAndProgress" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/operations/tryGet": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Возвращает сериализованный объект операции Tessa.Platform.Operations.IOperation или `null`, если операция не найдена.\r\nМетод M:Tessa.Platform.Operations.IOperationRepository.TryGetAsync(System.Guid,System.Boolean,System.Threading.CancellationToken).", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Идентификатор загружаемой операции.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "loadEverything", | |
| "in": "query", | |
| "description": "Признак того, что выполняется загрузка всех свойств объекта операции, в т.ч. запроса Tessa.Platform.Operations.IOperation.Request\r\nи ответа на запрос Tessa.Platform.Operations.IOperation.Response. Укажите `false`, если требуется только общая информация по операции.", | |
| "schema": { | |
| "type": "boolean", | |
| "default": true | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/operations/getAll": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Возвращает все активные операции M:Tessa.Platform.Operations.IOperationRepository.GetAllAsync(System.Guid,System.Boolean,System.Threading.CancellationToken)\r\nуказанного типа в виде списка сериализованных объектов Tessa.Platform.Operations.IOperation в типизированный JSON.", | |
| "parameters": [ | |
| { | |
| "name": "typeID", | |
| "in": "query", | |
| "description": "Тип операции, для которой требуется получить все доступные операции.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "loadEverything", | |
| "in": "query", | |
| "description": "Признак того, что выполняется загрузка всех свойств объекта операции, в т.ч. запроса Tessa.Platform.Operations.IOperation.Request\r\nи ответа на запрос Tessa.Platform.Operations.IOperation.Response. Укажите `false`, если требуется только общая информация по операции.", | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/operations/complete": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Отмечает операцию с указанным идентификатором как завершённую, при этом операция продолжает быть активной M:Tessa.Platform.Operations.IOperationRepository.CompleteAsync(System.Guid,Tessa.Platform.Operations.OperationResponse,System.Threading.CancellationToken).\r\nУказанная операция должна существовать.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Идентификатор завершаемой операции.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "response", | |
| "in": "query", | |
| "description": "Сериализованный в типизированный JSON ответ на запрос с дополнительной информацией по операции, зависимой от типа операции.\r\nМожет быть указан как пустая строка или `null`.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/operations/delete": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Удаляет активную операцию с указанным идентификатором M:Tessa.Platform.Operations.IOperationRepository.DeleteAsync(System.Guid,System.Threading.CancellationToken).", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Идентификатор удаляемой операции.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/operations/deleteOlderThan": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Удаляет все операции, которые созданы ранее, чем в указанный момент времени M:Tessa.Platform.Operations.IOperationRepository.DeleteOlderThanAsync(System.DateTime,System.Threading.CancellationToken).", | |
| "parameters": [ | |
| { | |
| "name": "dateTime", | |
| "in": "query", | |
| "description": "Дата/время операции в UTC.", | |
| "schema": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/sessions/close": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Закрывает текущую сессию. Возвращает признак того, что сессия существовала и была закрыта.", | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/sessions/closeAsAdmin": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Закрывает указанную сессию. Пользователь в текущей сессии должен быть администратором,\r\nиначе возвращается код ошибки Microsoft.AspNetCore.Http.StatusCodes.Status400BadRequest.\r\n \r\nВозвращает признак того, что сессия существовала и была закрыта.", | |
| "parameters": [ | |
| { | |
| "name": "sessionID", | |
| "in": "query", | |
| "description": "Идентификатор закрываемой сессии.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/meta": { | |
| "get": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Выполняет инициализацию данных по сессии и возвращает серверную метаинформацию при запуске web-клиента.\r\nВозвращает сериализованную в JSON строку с метаинформацией и настройками пользователя.\r\nНекоторые типы подобъектов внутри ответа отдельно сериализуются в типизированный JSON.", | |
| "parameters": [ | |
| { | |
| "name": "withoutCards", | |
| "in": "query", | |
| "description": "Не возвращать метаинформацию по карточкам.", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| { | |
| "name": "justCards", | |
| "in": "query", | |
| "description": "Возвращать только метаинформацию по карточкам и не возвращать никакую другую метаинформацию или настройки.", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| { | |
| "name": "cardId", | |
| "in": "query", | |
| "description": "Не используется.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "cachedVersion", | |
| "in": "query", | |
| "description": "Версия метаинформации, которая добавлена в кэш на клиенте. Если версия конфигурации на сервере равна версии на клиенте,\r\nто загружается ограниченный набор настроек, не связанных с серверной метаинформацией (например. настройки текущего пользователя).", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "userSettingsLastUpdate", | |
| "in": "query", | |
| "description": "Временная метка данных настроек пользовтеля.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/locos/{cultureCode}": { | |
| "get": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Возвращает строки локализации для указанного языка.", | |
| "parameters": [ | |
| { | |
| "name": "cultureCode", | |
| "in": "path", | |
| "description": "Код языка локализации. Обычно `en` или `ru`.", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/card/store": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Сохраняет карточку без содержимого файлов.", | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "cardStr": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "encoding": { | |
| "cardStr": { | |
| "style": "form" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/card/storeWithFiles": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Сохраняет карточку с содержимым файлов. Это multipart-запрос, содержащий запрос на сохранение Tessa.Cards.CardStoreRequest и содержимое добавляемых или заменяемых файлов.\r\nИмеет два параметра в форме: `CardStr` - cериализованный в типизированный JSON объект, содержащий карточку по ключу `Card` и дополнительную информацию\r\nдля запроса на сохранение Tessa.Cards.CardStoreRequest по ключу `Info`.\r\n`FileIdIndexRelation` - сериализованный объект в обычный JSON, представляющий собой словарь вида \"идентификатор файла - его индекс в массиве передаваемых файлов\".", | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/wallpapers": { | |
| "get": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Возвращает иконки с превью для фоновых изображений.", | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Закачивает файл фонового изображения, выбранный пользователем, в карточке сотрудника.", | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "image": { | |
| "type": "string", | |
| "format": "binary" | |
| } | |
| } | |
| }, | |
| "encoding": { | |
| "image": { | |
| "style": "form" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/wallpapers/{name}": { | |
| "get": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Возвращает файл фонового изображения по заданному имени.", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "description": "Имя файла с фоновым изображением. Если совпадает с именем файла, прикладываемого к карточке\r\n(настройка `WebWallpaper` в серверном app.json), то возвращается файл, приложенный к карточке сотрудника (нестандартное изображение, выбранное пользователем).", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "mode", | |
| "in": "query", | |
| "description": "Признак, определяющий как должен поменяться фон.\r\n\r\n0 = None (Стандартная смена фона.)\r\n\r\n1 = Init (Смена фона при инициализации.)\r\n\r\n2 = Default (Смена фона на корпоративный.)", | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/GetWallpaperMode" | |
| } | |
| ], | |
| "default": 0, | |
| "x-enumNames": [ | |
| "None", | |
| "Init", | |
| "Default" | |
| ], | |
| "x-enumDescriptions": [ | |
| "Стандартная смена фона.", | |
| "Смена фона при инициализации.", | |
| "Смена фона на корпоративный." | |
| ] | |
| }, | |
| "x-enumNames": [ | |
| "None", | |
| "Init", | |
| "Default" | |
| ], | |
| "x-enumDescriptions": [ | |
| "Стандартная смена фона.", | |
| "Смена фона при инициализации.", | |
| "Смена фона на корпоративный." | |
| ] | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/theme/set/{theme}": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Устанавливает текущую тему интерфейса, выбранную пользователем.", | |
| "parameters": [ | |
| { | |
| "name": "theme", | |
| "in": "path", | |
| "description": "Имя выбранной темы интерфейса. Для стандартных тем это строка `Cold` или `Warm`.", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/sequence/dereserve/{sequenceName}/{number}": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Дерезервирует указанный номер. Запрос вызывается из контрола карточки \"Нумератор\",\r\nили при закрытии несохранённой карточки, в которой был зарезервирован этот номер, или из клиентского API.", | |
| "parameters": [ | |
| { | |
| "name": "sequenceName", | |
| "in": "path", | |
| "description": "Последовательность, из которой дерезервируется номер.", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "number", | |
| "in": "path", | |
| "description": "Номер, который дерезервируется.", | |
| "required": true, | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/sequence/reserve/{sequenceName}": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Резервирует указанный номер. Запрос вызывается из контрола карточки \"Нумератор\" или из клиентского API.", | |
| "parameters": [ | |
| { | |
| "name": "sequenceName", | |
| "in": "path", | |
| "description": "Последовательность, из которой резервируется номер.", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "number", | |
| "in": "query", | |
| "description": "Номер, который резервируется.", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/error": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Записывает клиентское сообщение об ошибке в серверный лог.", | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "error": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "encoding": { | |
| "error": { | |
| "style": "form" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/tryGetErrorCard": { | |
| "post": { | |
| "tags": [ | |
| "Client" | |
| ], | |
| "summary": "Возвращает данные карточки ошибки по заданному идентификатору и сериализованные в типизированный JSON.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Идентификатор карточки ошибки.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/init/get": { | |
| "post": { | |
| "tags": [ | |
| "Initialization" | |
| ], | |
| "summary": "Возвращает информацию по инициализации приложения desktop-клиента, включая метаинформацию, информацию по правам доступа и др.", | |
| "requestBody": { | |
| "description": "Запрос на инициализацию приложения.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/InitializationRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/InitializationResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/localization": { | |
| "get": { | |
| "tags": [ | |
| "Localization" | |
| ], | |
| "summary": "Возвращает все существующие библиотеки локализации.", | |
| "parameters": [ | |
| { | |
| "name": "comments", | |
| "in": "query", | |
| "description": "Признак того, что должны возвращаться комментарии к строкам локализации. Если указано `false`, то возвращаются только сами строки\r\nи их перевод на доступные языки, но не комментарии, полезные при редактировании локализации в TessaAdmin.", | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainLocalizationLibrary" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Localization" | |
| ], | |
| "summary": "Удаляет заданную библиотеку локализации. Возвращает признак того, что библиотека существовала на момент удаления.\r\nМетод доступен только администраторам.", | |
| "requestBody": { | |
| "description": "Удаляемая библиотека локализации.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PlainLocalizationLibrary" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/localization/{id}": { | |
| "get": { | |
| "tags": [ | |
| "Localization" | |
| ], | |
| "summary": "Возвращает библиотеку локализации по указанному идентификатору. Возвращается 204 (No Content), если библиотека не найдена.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор возвращаемой библиотеки.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "comments", | |
| "in": "query", | |
| "description": "Признак того, что должны возвращаться комментарии к строкам локализации. Если указано `false`, то возвращаются только сами строки\r\nи их перевод на доступные языки, но не комментарии, полезные при редактировании локализации в TessaAdmin.", | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainLocalizationLibrary" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/localization/search": { | |
| "get": { | |
| "tags": [ | |
| "Localization" | |
| ], | |
| "summary": "Возвращает библиотеку локализации по указанному уникальному имени библиотеки. Возвращается 204 (No Content), если библиотека не найдена.", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "Уникальное имя возвращаемой библиотеки.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "comments", | |
| "in": "query", | |
| "description": "Признак того, что должны возвращаться комментарии к строкам локализации. Если указано `false`, то возвращаются только сами строки\r\nи их перевод на доступные языки, но не комментарии, полезные при редактировании локализации в TessaAdmin.", | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainLocalizationLibrary" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/localization/entries": { | |
| "get": { | |
| "tags": [ | |
| "Localization" | |
| ], | |
| "summary": "Возвращает строки локализации со всех библиотек для заданного языка.\r\nМетод учитывает переопределение строк с одинаковым названием в разных библиотеках.", | |
| "parameters": [ | |
| { | |
| "name": "culture", | |
| "in": "query", | |
| "description": "Язык локализации, строки в котором должны быть возвращены. Обычно, это \"ru\" для русского языка или \"en\" для английского языка.", | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| { | |
| "name": "comments", | |
| "in": "query", | |
| "description": "Признак того, что должны возвращаться комментарии к строкам локализации. Если указано `false`, то возвращаются только сами строки\r\nи их перевод на доступные языки, но не комментарии, полезные при редактировании локализации в TessaAdmin.", | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainLocalizationEntry" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/localization/store": { | |
| "post": { | |
| "tags": [ | |
| "Localization" | |
| ], | |
| "summary": "Создаёт или изменяет заданную библиотеку локализации.\r\nМетод доступен только администраторам.", | |
| "requestBody": { | |
| "description": "Сохраняемая библиотека локализации.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PlainLocalizationLibrary" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/onlyoffice/templates/{name}": { | |
| "get": { | |
| "tags": [ | |
| "OnlyOffice" | |
| ], | |
| "summary": "Возвращает содержимое документа-шаблона в папке `wwwroot/templates` по указанному имени.\r\nОбычно это шаблоны пустых документов: `empty.docx, empty.xlsx, empty.pptx`.\r\nВозвращает код ошибки `404`, если файл не найден.", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "description": "Имя файла шаблона.", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success" | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/onlyoffice/files/{id}/state": { | |
| "get": { | |
| "tags": [ | |
| "OnlyOffice" | |
| ], | |
| "summary": "Возвращает состояние указанного файла, который был открыт на редактирование.\r\nЕсли свойство `hasChangesAfterClose` в возвращаемом значении отлично от `null`,\r\nто посредством запроса к `files/{id}` можно получить актуальное содержимое файла;\r\nв противном случае используйте запрос к `files/{id}/editor` для актуального содержимого в процессе редактирования.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор редактируемого файла.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/onlyoffice/files/{id}/editor": { | |
| "get": { | |
| "tags": [ | |
| "OnlyOffice" | |
| ], | |
| "summary": "Возвращает содержимое редактируемого файла, используемое для сервера документов OnlyOffice.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор редактируемого файла.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "token", | |
| "in": "query", | |
| "description": "Токен прав доступа для текущей сессии.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/onlyoffice/files/{id}": { | |
| "get": { | |
| "tags": [ | |
| "OnlyOffice" | |
| ], | |
| "summary": "Возвращает содержимое файла, доступное после завершения редактирования на сервере документов OnlyOffice.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор редактируемого файла.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "original-format", | |
| "in": "query", | |
| "description": "Признак того, что следует произвести конвертацию в исходный формат файла.", | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/octet-stream": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "OnlyOffice" | |
| ], | |
| "summary": "Удаляет файл из кэша, используемого для взаимодействия с сервером документов OnlyOffice.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор редактируемого файла.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/onlyoffice/files/{id}/create": { | |
| "post": { | |
| "tags": [ | |
| "OnlyOffice" | |
| ], | |
| "summary": "Добавляет содержимое файла в кэш, используемый для сервера документов OnlyOffice.\r\nСодержимое файла должно находиться в теле запроса. Пустое тело соответствует пустому файлу.\r\nСвязывается с версией файла в карточке в параметре `versionId`.\r\nВызовите удаление документа запросом `DELETE files/{id}` по завершению работы с ним, в т.ч. при закрытии вкладки или приложения.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор редактируемого файла, по которому его содержимое будет доступно в методах этого API.\r\nУкажите здесь уникальный идентификатор для каждого вызова, связанного с открытием версии файла на редактирование.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "versionId", | |
| "in": "query", | |
| "description": "Идентификатор версии файла в карточке.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "name", | |
| "in": "query", | |
| "description": "Имя файла в карточке, включая его расширение.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/onlyoffice/files/{id}/callback": { | |
| "post": { | |
| "tags": [ | |
| "OnlyOffice" | |
| ], | |
| "summary": "Обрабатывает обратный вызов от сервера документов по запросам, связанным с сохранением файла и закрытием документа.\r\nВ свойстве `error` результата запроса содержится числовой код ошибки.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор редактируемого файла.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "token", | |
| "in": "query", | |
| "description": "Токен прав доступа для текущей сессии.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "description": "Объект с параметрами обратного вызова, определяемыми сервером документов OnlyOffice.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "object", | |
| "additionalProperties": { } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/onlyoffice/files/{id}/delete": { | |
| "post": { | |
| "tags": [ | |
| "OnlyOffice" | |
| ], | |
| "summary": "Удаляет файл из кэша, используемого для взаимодействия с сервером документов OnlyOffice.", | |
| "description": "POST-версия запроса на удаление, которая может быть использована для поддержки браузерного механизма `Navigator.sendBeacon`,\r\nкоторый поддерживает только POST, и с помощью которого можно гарантированно выполнить запрос перед закрытием страницы.\r\nВо всех остальных случаях используйте запрос `DELETE files/{id}`M:Tessa.Extensions.Default.Server.Web.Controllers.OnlyOfficeController.Delete(System.Guid,System.Threading.CancellationToken).", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор редактируемого файла.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/operations/create": { | |
| "post": { | |
| "tags": [ | |
| "Operations" | |
| ], | |
| "summary": "Создаёт операцию с заданными параметрами. Операция может быть создана сразу в состоянии \"Выполняется\", если это указано в флаге\r\nTessa.Platform.Operations.OperationCreationFlags.CreateInProgress. Возвращает идентификатор созданной операции.", | |
| "requestBody": { | |
| "description": "Запрос на создание операции.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CreateOperationRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "201": { | |
| "description": "Created", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/operations/{id}/start": { | |
| "post": { | |
| "tags": [ | |
| "Operations" | |
| ], | |
| "summary": "Запускает ранее созданную операцию, если она ещё не была запущена.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор запускаемой операции.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/operations/start-first": { | |
| "post": { | |
| "tags": [ | |
| "Operations" | |
| ], | |
| "summary": "Запускает первую доступную операции для заданного типа, и возвращает идентификатор этой операции\r\nили `null` (204 No Content), если доступных для запуска операций нет. Метод потокобезопасен. Гарантируется, что при параллельном обращении\r\nиз разных потоков или разных веб-серверов к серверу СУБД, только один поток или сервер получит запущенную операцию.", | |
| "parameters": [ | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "Идентификатор типа операции. Системные типы перечислены в Tessa.Platform.Operations.OperationTypes.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/operations/{id}/report-progress": { | |
| "post": { | |
| "tags": [ | |
| "Operations" | |
| ], | |
| "summary": "Устанавливает прогресс операции в процентах. Операция должна быть запущена с флагом Tessa.Platform.Operations.OperationCreationFlags.ReportsProgress.\r\nВозвращает признак того, что подходящая операция найдена, и её прогресс установлен.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор операции.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "value", | |
| "in": "query", | |
| "description": "Прогресс операции в процентах. Должен быть между `0` и `100`.", | |
| "schema": { | |
| "type": "number", | |
| "format": "double" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/operations/{id}/is-alive": { | |
| "get": { | |
| "tags": [ | |
| "Operations" | |
| ], | |
| "summary": "Проверяет, что заданная операция ещё существует как активная. При этом операция может быть не запущена,\r\nможет быть запущена и может быть завершена (если для операции установлено, что она должна завершаться без удаления методом M:Tessa.Web.Controllers.OperationsController.PostComplete(System.Guid,Tessa.Platform.Operations.OperationResponse,System.Boolean,System.Threading.CancellationToken)).", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор проверяемой операции.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/operations/get-id": { | |
| "get": { | |
| "tags": [ | |
| "Operations" | |
| ], | |
| "summary": "Возвращает идентификатор операции по хеш-значению запроса с параметрами операции\r\nили `null` (204 No Content), если соответствующей операции не было найдено.", | |
| "parameters": [ | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "Идентификатор типа операции. Системные типы перечислены в Tessa.Platform.Operations.OperationTypes.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "hash", | |
| "in": "query", | |
| "description": "Хеш-значение для параметров запроса операции.", | |
| "schema": { | |
| "type": "string", | |
| "format": "byte" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/operations/{id}/get-state": { | |
| "get": { | |
| "tags": [ | |
| "Operations" | |
| ], | |
| "summary": "Возвращает состояние и прогресс операции с заданным идентификатором\r\nили `null` (204 No Content), если операция не считается активной, например, была удалена при завершении.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор операции.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/OperationStateAndProgress" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/operations/{id}": { | |
| "get": { | |
| "tags": [ | |
| "Operations" | |
| ], | |
| "summary": "Возвращает информацию по операции или `null` (204 No Content), если операция не найдена.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор операции.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "full", | |
| "in": "query", | |
| "description": "Признак того, что должна быть загружена вся информация по операции,\r\nвключая свойства Tessa.Platform.Operations.Operation.Request,\r\nTessa.Platform.Operations.Operation.RequestHash\r\nи Tessa.Platform.Operations.Operation.Response.", | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Operation" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Operations" | |
| ], | |
| "summary": "Удаляет операцию с заданным идентификатором. Операция перестаёт считаться активной.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор удаляемой операции.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/operations/get-all": { | |
| "get": { | |
| "tags": [ | |
| "Operations" | |
| ], | |
| "summary": "Возвращает список всех активных операций указанного типа typeID\r\nили вообще всех операций, если тип не указан. Возвращаемый список может быть равен `null`, если операций нет.", | |
| "parameters": [ | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "Идентификатор типа операции. Не задан, если загружаются все операции.\r\nСистемные типы перечислены в Tessa.Platform.Operations.OperationTypes.", | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "full", | |
| "in": "query", | |
| "description": "Признак того, что должна быть загружена вся информация по операциям,\r\nвключая свойства Tessa.Platform.Operations.Operation.Request,\r\nTessa.Platform.Operations.Operation.RequestHash\r\nи Tessa.Platform.Operations.Operation.Response.", | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Operation" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/operations/{id}/complete": { | |
| "post": { | |
| "tags": [ | |
| "Operations" | |
| ], | |
| "summary": "Завершает операцию с указанным идентификатором и объектом, описывающим результат операции.\r\nОперация при этом не удаляется, чтобы процесс, запустивший операцию, мог запросить результаты операции.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор операции.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "no-response", | |
| "in": "query", | |
| "description": "Признак того, что параметр response игнорируется, как если бы был передан как `null`.", | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "description": "Результат операции или `null`, если результат не передаётся.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/OperationResponse" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/operations": { | |
| "delete": { | |
| "tags": [ | |
| "Operations" | |
| ], | |
| "summary": "Удаляет все активные операции, дата создания которых старше указанной даты.\r\nВозвращает количество удалённых операций. Метод доступен только администраторам.", | |
| "parameters": [ | |
| { | |
| "name": "older-than", | |
| "in": "query", | |
| "description": "Все операции старше указанных даты и времени удаляются.", | |
| "schema": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/SAML/LoginRedirect": { | |
| "post": { | |
| "tags": [ | |
| "Saml" | |
| ], | |
| "summary": "Редирект на окно входа для использования с SAML.", | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/SAML/Metadata": { | |
| "get": { | |
| "tags": [ | |
| "Saml" | |
| ], | |
| "summary": "Запрос, возвращающий метаинформацию SAML.", | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/SAML/Login": { | |
| "post": { | |
| "tags": [ | |
| "Saml" | |
| ], | |
| "summary": "Окно входа в систему для использования совместно с SAML-авторизацией.", | |
| "parameters": [ | |
| { | |
| "name": "returnUrl", | |
| "in": "query", | |
| "description": "Обратная ссылка, по которой выполняется переход после успешного входа.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/SAML/AssertionConsumerService": { | |
| "post": { | |
| "tags": [ | |
| "Saml" | |
| ], | |
| "summary": "Метод, вызываемый при входе в систему после подтверждения авторизации SAML.\r\nВозвращает результат входа, обычно это редирект на определённую страницу.", | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/SAML/Logout": { | |
| "post": { | |
| "tags": [ | |
| "Saml" | |
| ], | |
| "summary": "Выход из системы при авторизации SAML.", | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/SAML/LoggedOut": { | |
| "post": { | |
| "tags": [ | |
| "Saml" | |
| ], | |
| "summary": "Метод, вызываемый после закрытия сессии, при этом удаляется привязка SAML,\r\nпроизводится запись в cookies о факте закрытия и редирект на основную страницу.", | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/SAML/SingleLogout": { | |
| "post": { | |
| "tags": [ | |
| "Saml" | |
| ], | |
| "summary": "Выход из системы в SAML, запрошенный пользователем для удаления информации по входу во всех SSO-приложениях,\r\nв т.ч. в системе TESSA.", | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/search-queries": { | |
| "get": { | |
| "tags": [ | |
| "SearchQueries" | |
| ], | |
| "summary": "Возвращает поисковые запросы, доступные для текущего пользователя, или общие запросы,\r\nдоступные для всех пользователей, в зависимости от параметра public.", | |
| "parameters": [ | |
| { | |
| "name": "public", | |
| "in": "query", | |
| "description": "Признак того, что требуется вернуть общие запросы, доступные для всех пользователей.\r\nЕсли указано `false`, то возвращаются поисковые запросы, доступные текущему пользователю.", | |
| "schema": { | |
| "type": "boolean", | |
| "default": false | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/JsonSearchQueryMetadata" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "SearchQueries" | |
| ], | |
| "summary": "Удаляет поисковые запросы с указанными идентификаторами.\r\nПользователи без административных прав могут удалять только свои запросы.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "query", | |
| "description": "Идентификаторы удаляемых поисковых запросов.", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/search-queries/{id}": { | |
| "get": { | |
| "tags": [ | |
| "SearchQueries" | |
| ], | |
| "summary": "Возвращает поисковый запрос по заданному идентификатору.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор поискового запроса.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/JsonSearchQueryMetadata" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/search-queries/store": { | |
| "post": { | |
| "tags": [ | |
| "SearchQueries" | |
| ], | |
| "summary": "Сохраняет поисковый запрос.", | |
| "requestBody": { | |
| "description": "Сохраняемый поисковый запрос.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/JsonSearchQueryMetadata" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/search-queries/import": { | |
| "post": { | |
| "tags": [ | |
| "SearchQueries" | |
| ], | |
| "summary": "Добавляет или изменяет (импортирует) поисковые запросы.", | |
| "requestBody": { | |
| "description": "Поисковые запросы.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/JsonSearchQueryMetadata" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/service": { | |
| "get": { | |
| "tags": [ | |
| "Service" | |
| ], | |
| "summary": "Возвращает текстовое описание для конфигурации веб-сервиса, если в конфигурации\r\nустановлена настройка `HealthCheckIsEnabled` равной `true`.", | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/service/login": { | |
| "post": { | |
| "tags": [ | |
| "Service" | |
| ], | |
| "summary": "Открывает сессию для входа пользователя по паре логин/пароль. Возвращает строку, содержащую токен сессии,\r\nкоторый должен передаваться во все другие запросы к веб-сервисам.", | |
| "requestBody": { | |
| "description": "Параметры входа.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/IntegrationLoginParameters" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "text/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "text/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "text/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/xml": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/service/winlogin": { | |
| "post": { | |
| "tags": [ | |
| "Service" | |
| ], | |
| "summary": "Открывает сессию для входа пользователя, используя windows-аутентификацию. Возвращает строку, содержащую токен сессии,\r\nкоторый должен передаваться во все другие запросы к веб-сервисам.", | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "text/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "text/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "text/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/xml": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/service/logout": { | |
| "post": { | |
| "tags": [ | |
| "Service" | |
| ], | |
| "summary": "Закрывает сессию с указанием строки с токеном сессии. Токен возвращается методом открытия сессии M:Tessa.Extensions.Server.Web.Services.ServiceController.PostLogin(Tessa.Extensions.Shared.Services.IntegrationLoginParameters,System.Threading.CancellationToken).\r\nМетоду не требуется наличие информации по сессии в HTTP-заголовке, если указан токен token.", | |
| "parameters": [ | |
| { | |
| "name": "token", | |
| "in": "query", | |
| "description": "Токен закрываемой сессии.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "text/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/x-tessa-deflate": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/service/data": { | |
| "get": { | |
| "tags": [ | |
| "Service" | |
| ], | |
| "summary": "Выполняет некоторый запрос для заданного параметра и возвращает результат.\r\nТребует наличия токена сессии в HTTP-заголовке `Tessa-Session`.\r\nЭто метод для тестирования возможностей REST веб-сервиса. Метод требует наличия сессии.", | |
| "description": "Информация по HTTP-заголовкам, используемым платформой, доступна в методе Tessa.Platform.Runtime.SessionHttpRequestHeader.", | |
| "parameters": [ | |
| { | |
| "name": "p", | |
| "in": "query", | |
| "description": "Параметр запроса.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "name": "token", | |
| "in": "query", | |
| "description": "Токен текущей сессии.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/service/data-without-login": { | |
| "get": { | |
| "tags": [ | |
| "Service" | |
| ], | |
| "summary": "Выполняет некоторый запрос для заданного параметра и возвращает результат.\r\nЭто метод для тестирования возможностей REST веб-сервиса. Метод не требует наличия сессии.", | |
| "parameters": [ | |
| { | |
| "name": "p", | |
| "in": "query", | |
| "description": "Параметр запроса.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/service/cards/get": { | |
| "post": { | |
| "tags": [ | |
| "Service" | |
| ], | |
| "summary": "Загружает карточку по заданному запросу для desktop-клиента.\r\nМетод идентичен типовому методу загрузки карточки в контроллере `CardsController`.\r\nЭто метод для тестирования возможностей REST веб-сервиса. Метод требует наличия сессии.", | |
| "requestBody": { | |
| "description": "Запрос на загрузку карточки.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardGetRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CardGetResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/service/cards/{id}": { | |
| "get": { | |
| "tags": [ | |
| "Service" | |
| ], | |
| "summary": "Открывает карточку и возвращает JSON с типизированной структурой объекта Tessa.Cards.CardGetResponse.\r\nТокен сессии передаётся в HTTP-заголовке \"Tessa-Session\".", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор карточки System.Guid. Передаётся в адресной строке.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| { | |
| "name": "type", | |
| "in": "query", | |
| "description": "Алиас типа карточки. Передаётся как параметр в адресной строке. Необязательный параметр.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/CardGetResponse" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/sessions/open": { | |
| "post": { | |
| "tags": [ | |
| "Sessions" | |
| ], | |
| "summary": "Открывает сессию для входа пользователя по паре логин/пароль. Возвращает строку, содержащую токен сессии,\r\nкоторый должен передаваться во все другие запросы к веб-сервисам.", | |
| "requestBody": { | |
| "description": "Запрос на открытие сессии. Содержит учётные данные для входа и параметры открываемой сессии,\r\nвключая информацию о приложении и о клиенте.\r\n \r\nМожет передаваться как типизированный, так и нетипизированный Json.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/OpenSessionRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "text/plain": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "application/json": { | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/sessions/close": { | |
| "post": { | |
| "tags": [ | |
| "Sessions" | |
| ], | |
| "summary": "Закрывает текущую сессию, которая определяется по HTTP-заголовку или по параметру запроса token.\r\nВозвращает признак того, что сессия существовала и была закрыта.", | |
| "parameters": [ | |
| { | |
| "name": "token", | |
| "in": "query", | |
| "description": "Токен закрываемой сессии.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/sessions/{id}": { | |
| "delete": { | |
| "tags": [ | |
| "Sessions" | |
| ], | |
| "summary": "Закрывает сессию с указанным идентификатором. Возвращает признак того, что сессия существовала и была закрыта.\r\nМетод доступен только администраторам.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор закрываемой сессии.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/sessions/increment-configuration-version": { | |
| "post": { | |
| "tags": [ | |
| "Sessions" | |
| ], | |
| "summary": "Увеличивает версию конфигурации даже в том случае, если не было выполнено изменений стандартными методами\r\n(изменений в схеме данных, карточках, локализации и др.) При изменении версии конфигурации гарантированно сбрасывается клиентский кэш в web-клиенте.\r\nМетод доступен только администраторам.", | |
| "responses": { | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/login": { | |
| "get": { | |
| "tags": [ | |
| "Spa" | |
| ], | |
| "summary": "Отображает окно входа в систему.", | |
| "parameters": [ | |
| { | |
| "name": "back_url", | |
| "in": "query", | |
| "description": "Обратная ссылка, по которой выполняется переход после успешного входа.", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Spa" | |
| ], | |
| "summary": "Выполняет вход по кнопке \"Login\" с аутентификацией по паре логин/пароль.", | |
| "requestBody": { | |
| "content": { | |
| "multipart/form-data": { | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "login": { | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "encoding": { | |
| "login": { | |
| "style": "form" | |
| }, | |
| "password": { | |
| "style": "form" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/winlogin": { | |
| "post": { | |
| "tags": [ | |
| "Spa" | |
| ], | |
| "summary": "Выполняет вход по кнопке \"Win Login\" с использованием аутентификации Windows.", | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/logout": { | |
| "post": { | |
| "tags": [ | |
| "Spa" | |
| ], | |
| "summary": "Выполняет выход из системы. Возвращает на окно входа в систему.", | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/": { | |
| "get": { | |
| "tags": [ | |
| "Spa" | |
| ], | |
| "summary": "Навигация для корневой страницы приложения. Если аутентификация не выполнена, то перенаправляет на окно входа.\r\nЕсли аутентификация выполнена, то загружает приложение и выполняет навигацию на первое представление в первом рабочем месте.", | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/card/{id}": { | |
| "get": { | |
| "tags": [ | |
| "Spa" | |
| ], | |
| "summary": "Навигация для открытия карточки с идентификатором, указанном в строке браузера.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/view/{name}": { | |
| "get": { | |
| "tags": [ | |
| "Spa" | |
| ], | |
| "summary": "Навигация для открытия узла рабочего места (обычно представления) с идентификатором, указанном в строке браузера.", | |
| "parameters": [ | |
| { | |
| "name": "name", | |
| "in": "path", | |
| "required": true, | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/offline": { | |
| "get": { | |
| "tags": [ | |
| "Spa" | |
| ], | |
| "summary": "Навигация, используемая для работы API service worker. Если API не поддерживается браузером,\r\nто выполняет навигацию на корневую страницу приложения.", | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/not-supported-browser": { | |
| "get": { | |
| "tags": [ | |
| "Spa" | |
| ], | |
| "summary": "Навигация, используемая для работы API service worker. Если API не поддерживается браузером,\r\nто выполняет навигацию на корневую страницу приложения.", | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/views": { | |
| "get": { | |
| "tags": [ | |
| "Views" | |
| ], | |
| "summary": "Возвращает общую метаинформацию по всем представлениям, доступным текущего сотруднику.\r\nТакая метаинформация требуется для выполнения запросов к представлению, но не содержит информации о внутреннем устройстве SQL запроса.", | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/JsonViewMetadata" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Views" | |
| ], | |
| "summary": "Удаляет одно или несколько представлений.\r\nМетод доступен только администраторам.", | |
| "requestBody": { | |
| "description": "Запрос на удаление представлений.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PlainStoreTessaViewRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/views/get-data": { | |
| "post": { | |
| "tags": [ | |
| "Views" | |
| ], | |
| "summary": "Выполняет представление и возвращает сериализованный результат выполнения. Представление должно быть доступно для текущего пользователя.", | |
| "requestBody": { | |
| "description": "Запрос на получение данных представления.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PlainTessaViewRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainTessaViewResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/views/get-models": { | |
| "post": { | |
| "tags": [ | |
| "Views" | |
| ], | |
| "summary": "Возвращает метаинформацию по запрошенным представлениям.\r\nМетод доступен только администраторам.", | |
| "requestBody": { | |
| "description": "Запрос на загрузку метаинформации представлений.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PlainGetModelRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainTessaViewModel" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/views/store": { | |
| "post": { | |
| "tags": [ | |
| "Views" | |
| ], | |
| "summary": "Сохраняет одно или несколько представлений.\r\nМетод доступен только администраторам.", | |
| "requestBody": { | |
| "description": "Запрос на сохранение представлений.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PlainStoreTessaViewRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/views/import": { | |
| "post": { | |
| "tags": [ | |
| "Views" | |
| ], | |
| "summary": "Импортирует заданные представления.\r\nМетод доступен только администраторам.", | |
| "requestBody": { | |
| "description": "Запрос на импорт представлений.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PlainImportTessaViewRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/workplaces": { | |
| "get": { | |
| "tags": [ | |
| "Workplaces" | |
| ], | |
| "summary": "Возвращает метаинформацию по всем рабочим местам, доступным текущему пользователю.", | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonWorkplaceMetadata" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Workplaces" | |
| ], | |
| "summary": "Удаляет одно или несколько рабочих мест.\r\nМетод доступен только администраторам.", | |
| "requestBody": { | |
| "description": "Запрос на удаление рабочих мест.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PlainStoreWorkplaceModelRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/workplaces/{id}": { | |
| "get": { | |
| "tags": [ | |
| "Workplaces" | |
| ], | |
| "summary": "Возвращает метаинформацию по заданному рабочему месту, необходимую для отображения рабочего места.\r\nРабочее место должно быть доступно текущему пользователю.", | |
| "parameters": [ | |
| { | |
| "name": "id", | |
| "in": "path", | |
| "description": "Идентификатор рабочего места.", | |
| "required": true, | |
| "schema": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IJsonWorkplaceMetadata" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/workplaces/get-models": { | |
| "post": { | |
| "tags": [ | |
| "Workplaces" | |
| ], | |
| "summary": "Возвращает метаинформацию по одному или нескольким рабочим местам. Такая метаинформация может использоваться\r\nдля изменения рабочих мест (при наличии административных прав).", | |
| "requestBody": { | |
| "description": "Запрос на получение метаинформации по одному или нескольким рабочим местам.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PlainGetModelRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/JsonWorkplaceModel" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/workplaces/store": { | |
| "post": { | |
| "tags": [ | |
| "Workplaces" | |
| ], | |
| "summary": "Сохраняет одно или несколько рабочих мест.\r\nМетод доступен только администраторам.", | |
| "requestBody": { | |
| "description": "Запрос на изменение рабочих мест.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PlainStoreWorkplaceModelRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/workplaces/import": { | |
| "post": { | |
| "tags": [ | |
| "Workplaces" | |
| ], | |
| "summary": "Импортирует заданные рабочие места.\r\nМетод доступен только администраторам.", | |
| "requestBody": { | |
| "description": "Запрос на импорт рабочих мест.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PlainImportWorkplaceModelRequest" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/workplaces/save-settings": { | |
| "post": { | |
| "tags": [ | |
| "Workplaces" | |
| ], | |
| "summary": "Сохраняет настройки одного или нескольких рабочих мест для текущего пользователя.\r\nНапример, это ширина дерева рабочего места, режим отображения пустых папок и др.\r\nИзменения недоступны других пользователям.", | |
| "requestBody": { | |
| "description": "Сохраняемые настройки рабочих мест.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/JsonWorkplaceSettingsMetadata" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/workplaces/save-properties": { | |
| "post": { | |
| "tags": [ | |
| "Workplaces" | |
| ], | |
| "summary": "Сохраняет настройки представлений в рабочих местах для текущего пользователя. Это включает настройки по сортировке,\r\nгруппировке и скрытию столбцов представлений, а также относительные размеры областей с представлениями в master-detail отчётах.", | |
| "requestBody": { | |
| "description": "Сохраняемые настройки представлений.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/JsonItemProperties" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/workplaces/user-metadata": { | |
| "get": { | |
| "tags": [ | |
| "Workplaces" | |
| ], | |
| "summary": "Возвращает метаинформацию рабочих мест для текущего пользователя, такую как информацию по добавленным поисковым запросам.\r\nДля десериализации используйте клиентское API desktop-клиента.", | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "200": { | |
| "description": "Success", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IJsonWorkplaceUserExtensionMetadata" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Workplaces" | |
| ], | |
| "summary": "Удаляет метаинформацию рабочих мест для текущего пользователя, такую как информацию по добавленным поисковым запросам.", | |
| "requestBody": { | |
| "description": "Метадата для удаления.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PlainWorkplaceComponentMetadata" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v1/workplaces/user-metadata/store": { | |
| "post": { | |
| "tags": [ | |
| "Workplaces" | |
| ], | |
| "summary": "Сохраняет метаинформацию рабочего места для текущего пользователя.\r\nНапример, добавляет поисковый запрос или папку в дерево рабочего места.\r\nИзменения недоступны других пользователям.", | |
| "requestBody": { | |
| "description": "Добавляемая метаинформация.", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PlainWorkplaceComponentMetadata" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PlainValidationResult" | |
| } | |
| } | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "components": { | |
| "schemas": { | |
| "AppearanceFontStyle": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Normal\r\n\r\n1 = Oblique\r\n\r\n2 = Italic", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Normal", | |
| "Oblique", | |
| "Italic" | |
| ] | |
| }, | |
| "ApplicationAttributesResult": { | |
| "type": "object", | |
| "properties": { | |
| "Modified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "Client64Bit": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "ApplicationDownloadRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Package": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ApplicationPackage" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "UseCompression": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "ApplicationPackage": { | |
| "type": "object", | |
| "properties": { | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ApplicationId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "AppVersion": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "GroupName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "LocalizedGroupName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ExecutableFileName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ExtensionVersion": { | |
| "type": "string", | |
| "nullable": true, | |
| "deprecated": true | |
| }, | |
| "Files": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/ApplicationPackageFile" | |
| }, | |
| "nullable": true | |
| }, | |
| "ForAdmin": { | |
| "type": "boolean" | |
| }, | |
| "Client64Bit": { | |
| "type": "boolean" | |
| }, | |
| "AppManagerApiV2": { | |
| "type": "boolean" | |
| }, | |
| "Icon": { | |
| "type": "string", | |
| "format": "byte", | |
| "nullable": true | |
| }, | |
| "Modified": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "PlatformVersion": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ActionHistoryRowID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "LocalFilesHash": { | |
| "type": "string", | |
| "format": "byte", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "ApplicationPackageFile": { | |
| "type": "object", | |
| "properties": { | |
| "ApplicationId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "State": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PackageFileState" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Unchanged\r\n\r\n1 = Inserted\r\n\r\n2 = Replaced\r\n\r\n3 = Deleted", | |
| "x-enumNames": [ | |
| "Unchanged", | |
| "Inserted", | |
| "Replaced", | |
| "Deleted" | |
| ] | |
| }, | |
| "FullName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Hash": { | |
| "type": "string", | |
| "format": "byte", | |
| "nullable": true | |
| }, | |
| "Id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Size": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "SourceType": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardFileSourceType" | |
| } | |
| ], | |
| "readOnly": true | |
| }, | |
| "SourceTypeId": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "VersionId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "IsLocal": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "AttachmentStoreMode": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Insert\r\n\r\n1 = Delete\r\n\r\n2 = NotChanged\r\n\r\n3 = Changed", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Insert", | |
| "Delete", | |
| "NotChanged", | |
| "Changed" | |
| ] | |
| }, | |
| "AttachmentType": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = File\r\n\r\n1 = Link\r\n\r\n2 = InnerItem\r\n\r\n3 = ExternalInnerItem", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "File", | |
| "Link", | |
| "InnerItem", | |
| "ExternalInnerItem" | |
| ] | |
| }, | |
| "AutoCompleteInfo": { | |
| "type": "object", | |
| "properties": { | |
| "paramAlias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "popupColumns": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "nullable": true | |
| }, | |
| "viewAlias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "refPrefix": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "Card": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "InstanceType": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardInstanceType" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Card\r\n\r\n1 = File\r\n\r\n2 = Task\r\n\r\n3 = Dialog", | |
| "x-enumNames": [ | |
| "Card", | |
| "File", | |
| "Task", | |
| "Dialog" | |
| ] | |
| }, | |
| "ID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "TypeID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "TypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TypeCaption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Created": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "CreatedByID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "CreatedByName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Modified": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "ModifiedByID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ModifiedByName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Flags": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardFlags" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None", | |
| "x-enumNames": [ | |
| "None" | |
| ] | |
| }, | |
| "Version": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "Sections": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/components/schemas/CardSection" | |
| }, | |
| "nullable": true | |
| }, | |
| "Files": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardFile" | |
| }, | |
| "nullable": true | |
| }, | |
| "Tasks": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTask" | |
| }, | |
| "nullable": true | |
| }, | |
| "TaskHistory": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTaskHistoryItem" | |
| }, | |
| "nullable": true | |
| }, | |
| "TaskHistoryGroups": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTaskHistoryGroup" | |
| }, | |
| "nullable": true | |
| }, | |
| "Permissions": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardPermissionInfo" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "Topics": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/TopicModel" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardCompressionMode": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Full", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "Full" | |
| ] | |
| }, | |
| "CardContentContext": { | |
| "type": "object", | |
| "properties": { | |
| "cardID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "fileID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "versionRowID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "source": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardFileSourceType" | |
| } | |
| ] | |
| }, | |
| "validationResult": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/IValidationResultBuilder" | |
| } | |
| ], | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardControlType": { | |
| "type": "object", | |
| "properties": { | |
| "isUnknown": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "usageMode": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardControlTypeUsageMode" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Entry\r\n\r\n1 = Table\r\n\r\n2 = Tab\r\n\r\n3 = Custom\r\n\r\n4 = Param", | |
| "x-enumNames": [ | |
| "Entry", | |
| "Table", | |
| "Tab", | |
| "Custom", | |
| "Param" | |
| ] | |
| }, | |
| "flags": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardControlTypeFlags" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = UseInCards\r\n\r\n2 = UseInFiles\r\n\r\n4 = UseInTasks\r\n\r\n7 = UseEverywhere\r\n\r\n8 = SpanByDefault\r\n\r\n16 = HideCaptionByDefault", | |
| "x-enumNames": [ | |
| "None", | |
| "UseInCards", | |
| "UseInFiles", | |
| "UseInTasks", | |
| "UseEverywhere", | |
| "SpanByDefault", | |
| "HideCaptionByDefault" | |
| ] | |
| }, | |
| "name": { | |
| "type": "string", | |
| "nullable": true, | |
| "readOnly": true | |
| }, | |
| "id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "readOnly": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardControlTypeFlags": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 4, | |
| 7, | |
| 8, | |
| 16 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = UseInCards\r\n\r\n2 = UseInFiles\r\n\r\n4 = UseInTasks\r\n\r\n7 = UseEverywhere\r\n\r\n8 = SpanByDefault\r\n\r\n16 = HideCaptionByDefault", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "UseInCards", | |
| "UseInFiles", | |
| "UseInTasks", | |
| "UseEverywhere", | |
| "SpanByDefault", | |
| "HideCaptionByDefault" | |
| ] | |
| }, | |
| "CardControlTypeUsageMode": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3, | |
| 4 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Entry\r\n\r\n1 = Table\r\n\r\n2 = Tab\r\n\r\n3 = Custom\r\n\r\n4 = Param", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Entry", | |
| "Table", | |
| "Tab", | |
| "Custom", | |
| "Param" | |
| ] | |
| }, | |
| "CardDeleteMethod": { | |
| "enum": [ | |
| 0 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Default", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Default" | |
| ] | |
| }, | |
| "CardDeleteRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "CardID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CardTypeID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CardTypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "DeletionMode": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardDeletionMode" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = WithBackup\r\n\r\n1 = WithoutBackup", | |
| "x-enumNames": [ | |
| "WithBackup", | |
| "WithoutBackup" | |
| ] | |
| }, | |
| "Method": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardDeleteMethod" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Default", | |
| "x-enumNames": [ | |
| "Default" | |
| ] | |
| }, | |
| "KeepFileContent": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardDeleteResponse": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "ValidationResult": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ValidationStorageResultBuilder" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "DeletedCardID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "RestoredCardID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CardTypeID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CardTypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ContentsToDelete": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardContentContext" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardDeletionMode": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = WithBackup\r\n\r\n1 = WithoutBackup", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "WithBackup", | |
| "WithoutBackup" | |
| ] | |
| }, | |
| "CardFile": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "RowID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "TypeID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "TypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TypeCaption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CategoryID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CategoryCaption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "OriginalFileID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "OriginalVersionRowID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "TaskID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "NewVersionTags": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Options": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "VersionRowID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "VersionNumber": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "Hash": { | |
| "type": "string", | |
| "format": "byte", | |
| "nullable": true | |
| }, | |
| "RequestInfo": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "IsVirtual": { | |
| "type": "boolean" | |
| }, | |
| "StoreSource": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardFileSourceType" | |
| } | |
| ] | |
| }, | |
| "Versions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardFileVersion" | |
| }, | |
| "nullable": true | |
| }, | |
| "VersionsLoaded": { | |
| "type": "boolean" | |
| }, | |
| "SectionRows": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { } | |
| }, | |
| "nullable": true | |
| }, | |
| "State": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardFileState" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Modified\r\n\r\n2 = Replaced\r\n\r\n3 = ModifiedAndReplaced\r\n\r\n4 = Inserted\r\n\r\n5 = Deleted", | |
| "x-enumNames": [ | |
| "None", | |
| "Modified", | |
| "Replaced", | |
| "ModifiedAndReplaced", | |
| "Inserted", | |
| "Deleted" | |
| ] | |
| }, | |
| "Flags": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardFileFlags" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = UpdateName\r\n\r\n4 = UpdateCategory\r\n\r\n8 = UpdateOrigin\r\n\r\n16 = UpdateTask\r\n\r\n32 = UpdateOptions\r\n\r\n64 = CalculateHash", | |
| "x-enumNames": [ | |
| "None", | |
| "UpdateName", | |
| "UpdateCategory", | |
| "UpdateOrigin", | |
| "UpdateTask", | |
| "UpdateOptions", | |
| "CalculateHash" | |
| ] | |
| }, | |
| "Size": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "ExternalSource": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardFileContentSource" | |
| } | |
| ], | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardFileContentMapping": { | |
| "type": "object", | |
| "properties": { | |
| "SourceFileID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "CardID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "FileID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "VersionRowID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "StoreSource": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardFileSourceType" | |
| } | |
| ] | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardFileContentSource": { | |
| "type": "object", | |
| "properties": { | |
| "CardID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "CardTypeID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "FileID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "VersionRowID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Source": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardFileSourceType" | |
| } | |
| ] | |
| }, | |
| "OriginalVersionRowID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardFileFlags": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 4, | |
| 8, | |
| 16, | |
| 32, | |
| 64 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = UpdateName\r\n\r\n4 = UpdateCategory\r\n\r\n8 = UpdateOrigin\r\n\r\n16 = UpdateTask\r\n\r\n32 = UpdateOptions\r\n\r\n64 = CalculateHash", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "UpdateName", | |
| "UpdateCategory", | |
| "UpdateOrigin", | |
| "UpdateTask", | |
| "UpdateOptions", | |
| "CalculateHash" | |
| ] | |
| }, | |
| "CardFileFormat": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Binary\r\n\r\n1 = Json", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Binary", | |
| "Json" | |
| ] | |
| }, | |
| "CardFileSourceType": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardFileState": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3, | |
| 4, | |
| 5 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Modified\r\n\r\n2 = Replaced\r\n\r\n3 = ModifiedAndReplaced\r\n\r\n4 = Inserted\r\n\r\n5 = Deleted", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "Modified", | |
| "Replaced", | |
| "ModifiedAndReplaced", | |
| "Inserted", | |
| "Deleted" | |
| ] | |
| }, | |
| "CardFileVersion": { | |
| "type": "object", | |
| "properties": { | |
| "RowID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Number": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Size": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "Created": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "CreatedByID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "CreatedByName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "LinkID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "Tags": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Options": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Hash": { | |
| "type": "string", | |
| "format": "byte", | |
| "nullable": true | |
| }, | |
| "RequestInfo": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "Source": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardFileSourceType" | |
| } | |
| ] | |
| }, | |
| "State": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardFileVersionState" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Uploading\r\n\r\n1 = Success\r\n\r\n2 = Error", | |
| "x-enumNames": [ | |
| "Uploading", | |
| "Success", | |
| "Error" | |
| ] | |
| }, | |
| "ErrorDate": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "ErrorMessage": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardFileVersionState": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Uploading\r\n\r\n1 = Success\r\n\r\n2 = Error", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Uploading", | |
| "Success", | |
| "Error" | |
| ] | |
| }, | |
| "CardFlags": { | |
| "enum": [ | |
| 0 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None" | |
| ] | |
| }, | |
| "CardGetFileContentMethod": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = Export", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Default", | |
| "Export" | |
| ] | |
| }, | |
| "CardGetFileContentRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "CardID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CardTypeID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CardTypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FileID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "FileName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FileTypeID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "FileTypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "VersionRowID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "Method": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardGetFileContentMethod" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = Export", | |
| "x-enumNames": [ | |
| "Default", | |
| "Export" | |
| ] | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardGetFileVersionsMethod": { | |
| "enum": [ | |
| 0 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Default", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Default" | |
| ] | |
| }, | |
| "CardGetFileVersionsRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "CardID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CardTypeID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CardTypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FileID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "FileName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FileTypeID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "FileTypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CompressionMode": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardCompressionMode" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Full", | |
| "x-enumNames": [ | |
| "None", | |
| "Full" | |
| ] | |
| }, | |
| "Method": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardGetFileVersionsMethod" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Default", | |
| "x-enumNames": [ | |
| "Default" | |
| ] | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardGetFileVersionsResponse": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "ValidationResult": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ValidationStorageResultBuilder" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "FileVersions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardFileVersion" | |
| }, | |
| "nullable": true | |
| }, | |
| "Compressed": { | |
| "type": "boolean" | |
| }, | |
| "DisallowCaching": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardGetMethod": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = Backup\r\n\r\n2 = Export\r\n\r\n3 = Storage", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Default", | |
| "Backup", | |
| "Export", | |
| "Storage" | |
| ] | |
| }, | |
| "CardGetMode": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Edit\r\n\r\n1 = ReadOnly", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Edit", | |
| "ReadOnly" | |
| ] | |
| }, | |
| "CardGetRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "CardID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CardTypeID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CardTypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "GetMode": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardGetMode" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Edit\r\n\r\n1 = ReadOnly", | |
| "x-enumNames": [ | |
| "Edit", | |
| "ReadOnly" | |
| ] | |
| }, | |
| "GetTaskMode": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardGetTaskMode" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = All", | |
| "x-enumNames": [ | |
| "Default", | |
| "All" | |
| ] | |
| }, | |
| "NewMode": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardNewMode" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = Valid", | |
| "x-enumNames": [ | |
| "Default", | |
| "Valid" | |
| ] | |
| }, | |
| "CompressionMode": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardCompressionMode" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Full", | |
| "x-enumNames": [ | |
| "None", | |
| "Full" | |
| ] | |
| }, | |
| "Method": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardGetMethod" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = Backup\r\n\r\n2 = Export\r\n\r\n3 = Storage", | |
| "x-enumNames": [ | |
| "Default", | |
| "Backup", | |
| "Export", | |
| "Storage" | |
| ] | |
| }, | |
| "RestrictionFlags": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardGetRestrictionFlags" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = RestrictSections\r\n\r\n2 = RestrictFiles\r\n\r\n4 = RestrictFileSections\r\n\r\n8 = RestrictTasks\r\n\r\n16 = RestrictTaskSections\r\n\r\n32 = RestrictTaskCalendar\r\n\r\n64 = RestrictTaskHistory", | |
| "x-enumNames": [ | |
| "None", | |
| "RestrictSections", | |
| "RestrictFiles", | |
| "RestrictFileSections", | |
| "RestrictTasks", | |
| "RestrictTaskSections", | |
| "RestrictTaskCalendar", | |
| "RestrictTaskHistory" | |
| ] | |
| }, | |
| "SectionsToExclude": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| }, | |
| "TasksToUnlockRowIDList": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "nullable": true | |
| }, | |
| "ExportFormat": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardFileFormat" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Binary\r\n\r\n1 = Json", | |
| "x-enumNames": [ | |
| "Binary", | |
| "Json" | |
| ] | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardGetResponse": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "ValidationResult": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ValidationStorageResultBuilder" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "Card": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/Card" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "SectionRows": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { } | |
| }, | |
| "nullable": true | |
| }, | |
| "Compressed": { | |
| "type": "boolean" | |
| }, | |
| "CancelOpening": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardGetRestrictionFlags": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 4, | |
| 8, | |
| 16, | |
| 32, | |
| 64 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = RestrictSections\r\n\r\n2 = RestrictFiles\r\n\r\n4 = RestrictFileSections\r\n\r\n8 = RestrictTasks\r\n\r\n16 = RestrictTaskSections\r\n\r\n32 = RestrictTaskCalendar\r\n\r\n64 = RestrictTaskHistory", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "RestrictSections", | |
| "RestrictFiles", | |
| "RestrictFileSections", | |
| "RestrictTasks", | |
| "RestrictTaskSections", | |
| "RestrictTaskCalendar", | |
| "RestrictTaskHistory" | |
| ] | |
| }, | |
| "CardGetTaskMode": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = All", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Default", | |
| "All" | |
| ] | |
| }, | |
| "CardInstanceType": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Card\r\n\r\n1 = File\r\n\r\n2 = Task\r\n\r\n3 = Dialog", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Card", | |
| "File", | |
| "Task", | |
| "Dialog" | |
| ] | |
| }, | |
| "CardMetadata": { | |
| "type": "object", | |
| "additionalProperties": false | |
| }, | |
| "CardMetadataColumnType": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Physical\r\n\r\n1 = Complex", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Physical", | |
| "Complex" | |
| ] | |
| }, | |
| "CardNewMethod": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = Template", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Default", | |
| "Template" | |
| ] | |
| }, | |
| "CardNewMode": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = Valid", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Default", | |
| "Valid" | |
| ] | |
| }, | |
| "CardNewRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "CardTypeID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CardTypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "NewMode": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardNewMode" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = Valid", | |
| "x-enumNames": [ | |
| "Default", | |
| "Valid" | |
| ] | |
| }, | |
| "Method": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardNewMethod" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = Template", | |
| "x-enumNames": [ | |
| "Default", | |
| "Template" | |
| ] | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardNewResponse": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "ValidationResult": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ValidationStorageResultBuilder" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "Card": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/Card" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "SectionRows": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { } | |
| }, | |
| "nullable": true | |
| }, | |
| "CancelOpening": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardPermissionFlags": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 4, | |
| 8, | |
| 16, | |
| 32, | |
| 64, | |
| 128, | |
| 256, | |
| 512, | |
| 1024, | |
| 2048, | |
| 4096, | |
| 8192, | |
| 16384, | |
| 32768, | |
| 65536, | |
| 131072 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = AllowModify\r\n\r\n2 = ProhibitModify\r\n\r\n4 = AllowInsertRow\r\n\r\n8 = ProhibitInsertRow\r\n\r\n16 = AllowDeleteRow\r\n\r\n32 = ProhibitDeleteRow\r\n\r\n64 = AllowDeleteCard\r\n\r\n128 = ProhibitDeleteCard\r\n\r\n256 = AllowInsertFile\r\n\r\n512 = ProhibitInsertFile\r\n\r\n1024 = AllowDeleteFile\r\n\r\n2048 = ProhibitDeleteFile\r\n\r\n4096 = AllowReplaceFile\r\n\r\n8192 = ProhibitReplaceFile\r\n\r\n16384 = AllowEditNumber\r\n\r\n32768 = ProhibitEditNumber\r\n\r\n65536 = AllowSignFile\r\n\r\n131072 = ProhibitSignFile", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "AllowModify", | |
| "ProhibitModify", | |
| "AllowInsertRow", | |
| "ProhibitInsertRow", | |
| "AllowDeleteRow", | |
| "ProhibitDeleteRow", | |
| "AllowDeleteCard", | |
| "ProhibitDeleteCard", | |
| "AllowInsertFile", | |
| "ProhibitInsertFile", | |
| "AllowDeleteFile", | |
| "ProhibitDeleteFile", | |
| "AllowReplaceFile", | |
| "ProhibitReplaceFile", | |
| "AllowEditNumber", | |
| "ProhibitEditNumber", | |
| "AllowSignFile", | |
| "ProhibitSignFile" | |
| ] | |
| }, | |
| "CardPermissionInfo": { | |
| "type": "object", | |
| "properties": { | |
| "Resolver": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ICardPermissionResolver" | |
| } | |
| ], | |
| "nullable": true, | |
| "readOnly": true | |
| }, | |
| "CardPermissions": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardPermissionFlags" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = AllowModify\r\n\r\n2 = ProhibitModify\r\n\r\n4 = AllowInsertRow\r\n\r\n8 = ProhibitInsertRow\r\n\r\n16 = AllowDeleteRow\r\n\r\n32 = ProhibitDeleteRow\r\n\r\n64 = AllowDeleteCard\r\n\r\n128 = ProhibitDeleteCard\r\n\r\n256 = AllowInsertFile\r\n\r\n512 = ProhibitInsertFile\r\n\r\n1024 = AllowDeleteFile\r\n\r\n2048 = ProhibitDeleteFile\r\n\r\n4096 = AllowReplaceFile\r\n\r\n8192 = ProhibitReplaceFile\r\n\r\n16384 = AllowEditNumber\r\n\r\n32768 = ProhibitEditNumber\r\n\r\n65536 = AllowSignFile\r\n\r\n131072 = ProhibitSignFile", | |
| "x-enumNames": [ | |
| "None", | |
| "AllowModify", | |
| "ProhibitModify", | |
| "AllowInsertRow", | |
| "ProhibitInsertRow", | |
| "AllowDeleteRow", | |
| "ProhibitDeleteRow", | |
| "AllowDeleteCard", | |
| "ProhibitDeleteCard", | |
| "AllowInsertFile", | |
| "ProhibitInsertFile", | |
| "AllowDeleteFile", | |
| "ProhibitDeleteFile", | |
| "AllowReplaceFile", | |
| "ProhibitReplaceFile", | |
| "AllowEditNumber", | |
| "ProhibitEditNumber", | |
| "AllowSignFile", | |
| "ProhibitSignFile" | |
| ] | |
| }, | |
| "Sections": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/components/schemas/CardSectionPermissionInfo" | |
| }, | |
| "nullable": true | |
| }, | |
| "FilePermissions": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/components/schemas/CardPermissionFlags" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "RequestType": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "CardID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CardTypeID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CardTypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FileID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "FileTypeID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "FileTypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FileVersionID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "TaskID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "TaskTypeID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "TaskTypeName": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardResponse": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "ValidationResult": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ValidationStorageResultBuilder" | |
| } | |
| ], | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardRowPermissionInfo": { | |
| "type": "object", | |
| "properties": { | |
| "RowID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "readOnly": true | |
| }, | |
| "RowPermissions": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardPermissionFlags" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = AllowModify\r\n\r\n2 = ProhibitModify\r\n\r\n4 = AllowInsertRow\r\n\r\n8 = ProhibitInsertRow\r\n\r\n16 = AllowDeleteRow\r\n\r\n32 = ProhibitDeleteRow\r\n\r\n64 = AllowDeleteCard\r\n\r\n128 = ProhibitDeleteCard\r\n\r\n256 = AllowInsertFile\r\n\r\n512 = ProhibitInsertFile\r\n\r\n1024 = AllowDeleteFile\r\n\r\n2048 = ProhibitDeleteFile\r\n\r\n4096 = AllowReplaceFile\r\n\r\n8192 = ProhibitReplaceFile\r\n\r\n16384 = AllowEditNumber\r\n\r\n32768 = ProhibitEditNumber\r\n\r\n65536 = AllowSignFile\r\n\r\n131072 = ProhibitSignFile", | |
| "x-enumNames": [ | |
| "None", | |
| "AllowModify", | |
| "ProhibitModify", | |
| "AllowInsertRow", | |
| "ProhibitInsertRow", | |
| "AllowDeleteRow", | |
| "ProhibitDeleteRow", | |
| "AllowDeleteCard", | |
| "ProhibitDeleteCard", | |
| "AllowInsertFile", | |
| "ProhibitInsertFile", | |
| "AllowDeleteFile", | |
| "ProhibitDeleteFile", | |
| "AllowReplaceFile", | |
| "ProhibitReplaceFile", | |
| "AllowEditNumber", | |
| "ProhibitEditNumber", | |
| "AllowSignFile", | |
| "ProhibitSignFile" | |
| ] | |
| }, | |
| "FieldPermissions": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/components/schemas/CardPermissionFlags" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardRowSortingType": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Auto\r\n\r\n1 = Manual", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Auto", | |
| "Manual" | |
| ] | |
| }, | |
| "CardRowState": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Modified\r\n\r\n2 = Inserted\r\n\r\n3 = Deleted", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "Modified", | |
| "Inserted", | |
| "Deleted" | |
| ] | |
| }, | |
| "CardSection": { | |
| "type": "object", | |
| "properties": { | |
| "Name": { | |
| "type": "string", | |
| "nullable": true, | |
| "readOnly": true | |
| }, | |
| "Type": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardSectionType" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Entry\r\n\r\n1 = Table", | |
| "x-enumNames": [ | |
| "Entry", | |
| "Table" | |
| ] | |
| }, | |
| "Rows": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "additionalProperties": { } | |
| }, | |
| "nullable": true | |
| }, | |
| "RowSortingType": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardRowSortingType" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Auto\r\n\r\n1 = Manual", | |
| "x-enumNames": [ | |
| "Auto", | |
| "Manual" | |
| ] | |
| }, | |
| "TableType": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardTableType" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Unspecified\r\n\r\n1 = Collection\r\n\r\n2 = Hierarchy", | |
| "x-enumNames": [ | |
| "Unspecified", | |
| "Collection", | |
| "Hierarchy" | |
| ] | |
| }, | |
| "Fields": { | |
| "type": "object", | |
| "additionalProperties": { }, | |
| "nullable": true, | |
| "readOnly": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardSectionPermissionInfo": { | |
| "type": "object", | |
| "properties": { | |
| "Name": { | |
| "type": "string", | |
| "nullable": true, | |
| "readOnly": true | |
| }, | |
| "Type": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardSectionType" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Entry\r\n\r\n1 = Table", | |
| "x-enumNames": [ | |
| "Entry", | |
| "Table" | |
| ] | |
| }, | |
| "SectionPermissions": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardPermissionFlags" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = AllowModify\r\n\r\n2 = ProhibitModify\r\n\r\n4 = AllowInsertRow\r\n\r\n8 = ProhibitInsertRow\r\n\r\n16 = AllowDeleteRow\r\n\r\n32 = ProhibitDeleteRow\r\n\r\n64 = AllowDeleteCard\r\n\r\n128 = ProhibitDeleteCard\r\n\r\n256 = AllowInsertFile\r\n\r\n512 = ProhibitInsertFile\r\n\r\n1024 = AllowDeleteFile\r\n\r\n2048 = ProhibitDeleteFile\r\n\r\n4096 = AllowReplaceFile\r\n\r\n8192 = ProhibitReplaceFile\r\n\r\n16384 = AllowEditNumber\r\n\r\n32768 = ProhibitEditNumber\r\n\r\n65536 = AllowSignFile\r\n\r\n131072 = ProhibitSignFile", | |
| "x-enumNames": [ | |
| "None", | |
| "AllowModify", | |
| "ProhibitModify", | |
| "AllowInsertRow", | |
| "ProhibitInsertRow", | |
| "AllowDeleteRow", | |
| "ProhibitDeleteRow", | |
| "AllowDeleteCard", | |
| "ProhibitDeleteCard", | |
| "AllowInsertFile", | |
| "ProhibitInsertFile", | |
| "AllowDeleteFile", | |
| "ProhibitDeleteFile", | |
| "AllowReplaceFile", | |
| "ProhibitReplaceFile", | |
| "AllowEditNumber", | |
| "ProhibitEditNumber", | |
| "AllowSignFile", | |
| "ProhibitSignFile" | |
| ] | |
| }, | |
| "FieldPermissions": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/components/schemas/CardPermissionFlags" | |
| }, | |
| "nullable": true | |
| }, | |
| "Rows": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/components/schemas/CardRowPermissionInfo" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardSectionType": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Entry\r\n\r\n1 = Table", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Entry", | |
| "Table" | |
| ] | |
| }, | |
| "CardStoreMethod": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = Restore\r\n\r\n2 = Import", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Default", | |
| "Restore", | |
| "Import" | |
| ] | |
| }, | |
| "CardStoreRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "Card": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/Card" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "FileMapping": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardFileContentMapping" | |
| }, | |
| "nullable": true | |
| }, | |
| "AffectVersion": { | |
| "type": "boolean" | |
| }, | |
| "DoesNotAffectVersion": { | |
| "type": "boolean" | |
| }, | |
| "ForceTransaction": { | |
| "type": "boolean" | |
| }, | |
| "ForceReleaseLock": { | |
| "type": "boolean" | |
| }, | |
| "Method": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardStoreMethod" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = Restore\r\n\r\n2 = Import", | |
| "x-enumNames": [ | |
| "Default", | |
| "Restore", | |
| "Import" | |
| ] | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardStoreResponse": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "ValidationResult": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ValidationStorageResultBuilder" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "CardID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "CardTypeID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "CardVersion": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "StoreDateTime": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTableType": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Unspecified\r\n\r\n1 = Collection\r\n\r\n2 = Hierarchy", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Unspecified", | |
| "Collection", | |
| "Hierarchy" | |
| ] | |
| }, | |
| "CardTask": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "RowID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "GroupRowID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "Action": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardTaskAction" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Progress\r\n\r\n2 = Reinstate\r\n\r\n3 = Complete\r\n\r\n4 = Postpone\r\n\r\n5 = PostponeFromCreated\r\n\r\n6 = TakeOver", | |
| "x-enumNames": [ | |
| "None", | |
| "Progress", | |
| "Reinstate", | |
| "Complete", | |
| "Postpone", | |
| "PostponeFromCreated", | |
| "TakeOver" | |
| ] | |
| }, | |
| "TypeID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "TypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TypeCaption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "UserID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "UserName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "OptionID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "Result": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Planned": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "PlannedQuants": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "PlannedWorkingDays": { | |
| "type": "number", | |
| "format": "double", | |
| "nullable": true | |
| }, | |
| "PlannedType": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardTaskPlannedType" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = InMasterTime", | |
| "x-enumNames": [ | |
| "None", | |
| "InMasterTime" | |
| ] | |
| }, | |
| "InProgress": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "Digest": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ParentRowID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "HistoryItemParentRowID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "ProcessID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "ProcessName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ProcessKind": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Postponed": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "PostponedTo": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "PostponeComment": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "SectionRows": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "object", | |
| "additionalProperties": { } | |
| }, | |
| "nullable": true | |
| }, | |
| "State": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardRowState" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Modified\r\n\r\n2 = Inserted\r\n\r\n3 = Deleted", | |
| "x-enumNames": [ | |
| "None", | |
| "Modified", | |
| "Inserted", | |
| "Deleted" | |
| ] | |
| }, | |
| "Flags": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardTaskFlags" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Locked\r\n\r\n2 = System\r\n\r\n4 = CanPerform\r\n\r\n8 = CanPerformAsDeputy\r\n\r\n16 = Author\r\n\r\n32 = AuthorDeputy\r\n\r\n64 = HiddenFromAuthor\r\n\r\n128 = KeepTemporaryRoles\r\n\r\n256 = UpdateDigest\r\n\r\n512 = CreateHistoryItem\r\n\r\n1024 = HistoryItemCreated\r\n\r\n2048 = CanPostpone\r\n\r\n4096 = Postponed\r\n\r\n8192 = CurrentPerformer\r\n\r\n16384 = UnlockedByPerformer\r\n\r\n32768 = UnlockedForPerformer\r\n\r\n65536 = AutoStart\r\n\r\n131072 = UpdatePlanned\r\n\r\n262144 = UpdateTaskAssignedRoles\r\n\r\n524288 = SuppressAutoTakeInProgressWhenCompleted\r\n\r\n1048576 = UpdateSettings\r\n\r\n2097152 = CanModifyTaskAssignedRoles", | |
| "x-enumNames": [ | |
| "None", | |
| "Locked", | |
| "System", | |
| "CanPerform", | |
| "CanPerformAsDeputy", | |
| "Author", | |
| "AuthorDeputy", | |
| "HiddenFromAuthor", | |
| "KeepTemporaryRoles", | |
| "UpdateDigest", | |
| "CreateHistoryItem", | |
| "HistoryItemCreated", | |
| "CanPostpone", | |
| "Postponed", | |
| "CurrentPerformer", | |
| "UnlockedByPerformer", | |
| "UnlockedForPerformer", | |
| "AutoStart", | |
| "UpdatePlanned", | |
| "UpdateTaskAssignedRoles", | |
| "SuppressAutoTakeInProgressWhenCompleted", | |
| "UpdateSettings", | |
| "CanModifyTaskAssignedRoles" | |
| ] | |
| }, | |
| "StoredState": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardTaskState" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Created\r\n\r\n1 = InProgress\r\n\r\n2 = Postponed", | |
| "x-enumNames": [ | |
| "Created", | |
| "InProgress", | |
| "Postponed" | |
| ] | |
| }, | |
| "TimeZoneID": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "TimeZoneUtcOffsetMinutes": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "Settings": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "TaskAssignedRoles": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTaskAssignedRole" | |
| }, | |
| "nullable": true | |
| }, | |
| "TaskSessionFunctionRoleList": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTaskSessionFunctionRole" | |
| }, | |
| "nullable": true | |
| }, | |
| "CalendarID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CalendarName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FormattedPlanned": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "IsLocked": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "IsLockedExplicit": { | |
| "type": "boolean", | |
| "nullable": true | |
| }, | |
| "IsLockedEffective": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "IsSystem": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "IsCanPerform": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "IsCanPerformAsDeputy": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "CanPostpone": { | |
| "type": "boolean" | |
| }, | |
| "CanPostponeExplicit": { | |
| "type": "boolean", | |
| "nullable": true | |
| }, | |
| "CanPostponeEffective": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "IsPostponed": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "IsHidden": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTaskAction": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3, | |
| 4, | |
| 5, | |
| 6 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Progress\r\n\r\n2 = Reinstate\r\n\r\n3 = Complete\r\n\r\n4 = Postpone\r\n\r\n5 = PostponeFromCreated\r\n\r\n6 = TakeOver", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "Progress", | |
| "Reinstate", | |
| "Complete", | |
| "Postpone", | |
| "PostponeFromCreated", | |
| "TakeOver" | |
| ] | |
| }, | |
| "CardTaskAssignedRole": { | |
| "type": "object", | |
| "properties": { | |
| "RowID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "TaskRoleID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "TaskRoleCaption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "RoleID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "RoleName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "RoleTypeID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Position": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ShowInTaskDetails": { | |
| "type": "boolean" | |
| }, | |
| "ParentRowID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "NoHistory": { | |
| "type": "boolean" | |
| }, | |
| "Master": { | |
| "type": "boolean" | |
| }, | |
| "State": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardTaskAssignedRoleState" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Inserted\r\n\r\n2 = Deleted\r\n\r\n3 = Modified", | |
| "x-enumNames": [ | |
| "None", | |
| "Inserted", | |
| "Deleted", | |
| "Modified" | |
| ] | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTaskAssignedRoleState": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Inserted\r\n\r\n2 = Deleted\r\n\r\n3 = Modified", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "Inserted", | |
| "Deleted", | |
| "Modified" | |
| ] | |
| }, | |
| "CardTaskFlags": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 4, | |
| 8, | |
| 16, | |
| 32, | |
| 64, | |
| 128, | |
| 256, | |
| 512, | |
| 1024, | |
| 2048, | |
| 4096, | |
| 8192, | |
| 16384, | |
| 32768, | |
| 65536, | |
| 131072, | |
| 262144, | |
| 524288, | |
| 1048576, | |
| 2097152 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Locked\r\n\r\n2 = System\r\n\r\n4 = CanPerform\r\n\r\n8 = CanPerformAsDeputy\r\n\r\n16 = Author\r\n\r\n32 = AuthorDeputy\r\n\r\n64 = HiddenFromAuthor\r\n\r\n128 = KeepTemporaryRoles\r\n\r\n256 = UpdateDigest\r\n\r\n512 = CreateHistoryItem\r\n\r\n1024 = HistoryItemCreated\r\n\r\n2048 = CanPostpone\r\n\r\n4096 = Postponed\r\n\r\n8192 = CurrentPerformer\r\n\r\n16384 = UnlockedByPerformer\r\n\r\n32768 = UnlockedForPerformer\r\n\r\n65536 = AutoStart\r\n\r\n131072 = UpdatePlanned\r\n\r\n262144 = UpdateTaskAssignedRoles\r\n\r\n524288 = SuppressAutoTakeInProgressWhenCompleted\r\n\r\n1048576 = UpdateSettings\r\n\r\n2097152 = CanModifyTaskAssignedRoles", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "Locked", | |
| "System", | |
| "CanPerform", | |
| "CanPerformAsDeputy", | |
| "Author", | |
| "AuthorDeputy", | |
| "HiddenFromAuthor", | |
| "KeepTemporaryRoles", | |
| "UpdateDigest", | |
| "CreateHistoryItem", | |
| "HistoryItemCreated", | |
| "CanPostpone", | |
| "Postponed", | |
| "CurrentPerformer", | |
| "UnlockedByPerformer", | |
| "UnlockedForPerformer", | |
| "AutoStart", | |
| "UpdatePlanned", | |
| "UpdateTaskAssignedRoles", | |
| "SuppressAutoTakeInProgressWhenCompleted", | |
| "UpdateSettings", | |
| "CanModifyTaskAssignedRoles" | |
| ] | |
| }, | |
| "CardTaskHistoryGroup": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "RowID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ParentRowID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "TypeID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "Caption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Iteration": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "State": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardTaskHistoryState" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Inserted\r\n\r\n2 = Modified\r\n\r\n3 = Deleted", | |
| "x-enumNames": [ | |
| "None", | |
| "Inserted", | |
| "Modified", | |
| "Deleted" | |
| ] | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTaskHistoryItem": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "RowID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "GroupRowID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "TypeID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "TypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TypeCaption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "OptionID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "OptionName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "OptionCaption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "UserID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "UserName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Result": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Created": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "Planned": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "InProgress": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "Completed": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "CompletedByID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CompletedByName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ParentRowID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "ProcessID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "ProcessName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ProcessKind": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "State": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardTaskHistoryState" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Inserted\r\n\r\n2 = Modified\r\n\r\n3 = Deleted", | |
| "x-enumNames": [ | |
| "None", | |
| "Inserted", | |
| "Modified", | |
| "Deleted" | |
| ] | |
| }, | |
| "TimeZoneID": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "TimeZoneUtcOffsetMinutes": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "KindID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "KindCaption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CalendarID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "CalendarName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "StageRowID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "HistoryRoles": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTaskAssignedRole" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTaskHistoryState": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Inserted\r\n\r\n2 = Modified\r\n\r\n3 = Deleted", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "Inserted", | |
| "Modified", | |
| "Deleted" | |
| ] | |
| }, | |
| "CardTaskPlannedType": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = InMasterTime", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "InMasterTime" | |
| ] | |
| }, | |
| "CardTaskSessionFunctionRole": { | |
| "type": "object", | |
| "properties": { | |
| "FunctionRoleID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "IsDeputy": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTaskState": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Created\r\n\r\n1 = InProgress\r\n\r\n2 = Postponed", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Created", | |
| "InProgress", | |
| "Postponed" | |
| ] | |
| }, | |
| "CardType": { | |
| "type": "object", | |
| "properties": { | |
| "FormClass": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FormSettings": { | |
| "type": "object", | |
| "additionalProperties": { }, | |
| "nullable": true | |
| }, | |
| "Blocks": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTypeBlock" | |
| }, | |
| "nullable": true | |
| }, | |
| "TabCaption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TabOrder": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "InstanceType": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardInstanceType" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Card\r\n\r\n1 = File\r\n\r\n2 = Task\r\n\r\n3 = Dialog", | |
| "x-enumNames": [ | |
| "Card", | |
| "File", | |
| "Task", | |
| "Dialog" | |
| ] | |
| }, | |
| "Flags": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardTypeFlags" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = StoreChangesets\r\n\r\n2 = DeleteWithBackup\r\n\r\n4 = SaveTaskWithFiles\r\n\r\n8 = AllowTasks\r\n\r\n16 = Hidden\r\n\r\n32 = AutoStartTasks\r\n\r\n64 = HiddenFromAuthor\r\n\r\n128 = Singleton\r\n\r\n256 = Administrative\r\n\r\n512 = CanPostpone\r\n\r\n1024 = NoSigning\r\n\r\n2048 = LoadWhenInitializing", | |
| "x-enumNames": [ | |
| "None", | |
| "StoreChangesets", | |
| "DeleteWithBackup", | |
| "SaveTaskWithFiles", | |
| "AllowTasks", | |
| "Hidden", | |
| "AutoStartTasks", | |
| "HiddenFromAuthor", | |
| "Singleton", | |
| "Administrative", | |
| "CanPostpone", | |
| "NoSigning", | |
| "LoadWhenInitializing" | |
| ] | |
| }, | |
| "Caption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Group": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "DigestFormat": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "SchemeItems": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTypeSchemeItem" | |
| }, | |
| "nullable": true | |
| }, | |
| "CompletionOptions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTypeCompletionOption" | |
| }, | |
| "nullable": true | |
| }, | |
| "CardTypeSections": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTypeSection" | |
| }, | |
| "nullable": true | |
| }, | |
| "Forms": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTypeNamedForm" | |
| }, | |
| "nullable": true | |
| }, | |
| "Extensions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTypeExtension" | |
| }, | |
| "nullable": true | |
| }, | |
| "Validators": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTypeValidator" | |
| }, | |
| "nullable": true | |
| }, | |
| "ID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTypeBlock": { | |
| "type": "object", | |
| "properties": { | |
| "Caption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Order": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "BlockClass": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "BlockSettings": { | |
| "type": "object", | |
| "additionalProperties": { }, | |
| "nullable": true | |
| }, | |
| "FormSettings": { | |
| "type": "object", | |
| "additionalProperties": { }, | |
| "nullable": true | |
| }, | |
| "Controls": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTypeControl" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTypeCompletionOption": { | |
| "type": "object", | |
| "properties": { | |
| "TypeID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Order": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "FormName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Flags": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardTypeCompletionOptionFlags" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Additional\r\n\r\n2 = DoNotDeleteTask\r\n\r\n4 = ShowForAuthor\r\n\r\n8 = HideForPerformer", | |
| "x-enumNames": [ | |
| "None", | |
| "Additional", | |
| "DoNotDeleteTask", | |
| "ShowForAuthor", | |
| "HideForPerformer" | |
| ] | |
| }, | |
| "Validators": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTypeValidator" | |
| }, | |
| "nullable": true | |
| }, | |
| "FunctionRoleIDs": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTypeCompletionOptionFlags": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 4, | |
| 8 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = Additional\r\n\r\n2 = DoNotDeleteTask\r\n\r\n4 = ShowForAuthor\r\n\r\n8 = HideForPerformer", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "Additional", | |
| "DoNotDeleteTask", | |
| "ShowForAuthor", | |
| "HideForPerformer" | |
| ] | |
| }, | |
| "CardTypeControl": { | |
| "type": "object", | |
| "properties": { | |
| "Caption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Order": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ToolTip": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Type": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardControlType" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "ControlSettings": { | |
| "type": "object", | |
| "additionalProperties": { }, | |
| "nullable": true | |
| }, | |
| "BlockSettings": { | |
| "type": "object", | |
| "additionalProperties": { }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTypeExtension": { | |
| "type": "object", | |
| "properties": { | |
| "Type": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardTypeExtensionType" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "ExtensionSettings": { | |
| "type": "object", | |
| "additionalProperties": { }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTypeExtensionType": { | |
| "type": "object", | |
| "properties": { | |
| "isUnknown": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "nullable": true, | |
| "readOnly": true | |
| }, | |
| "id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "readOnly": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTypeFlags": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 4, | |
| 8, | |
| 16, | |
| 32, | |
| 64, | |
| 128, | |
| 256, | |
| 512, | |
| 1024, | |
| 2048 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = StoreChangesets\r\n\r\n2 = DeleteWithBackup\r\n\r\n4 = SaveTaskWithFiles\r\n\r\n8 = AllowTasks\r\n\r\n16 = Hidden\r\n\r\n32 = AutoStartTasks\r\n\r\n64 = HiddenFromAuthor\r\n\r\n128 = Singleton\r\n\r\n256 = Administrative\r\n\r\n512 = CanPostpone\r\n\r\n1024 = NoSigning\r\n\r\n2048 = LoadWhenInitializing", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "StoreChangesets", | |
| "DeleteWithBackup", | |
| "SaveTaskWithFiles", | |
| "AllowTasks", | |
| "Hidden", | |
| "AutoStartTasks", | |
| "HiddenFromAuthor", | |
| "Singleton", | |
| "Administrative", | |
| "CanPostpone", | |
| "NoSigning", | |
| "LoadWhenInitializing" | |
| ] | |
| }, | |
| "CardTypeNamedForm": { | |
| "type": "object", | |
| "properties": { | |
| "FormClass": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FormSettings": { | |
| "type": "object", | |
| "additionalProperties": { }, | |
| "nullable": true | |
| }, | |
| "Blocks": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTypeBlock" | |
| }, | |
| "nullable": true | |
| }, | |
| "TabCaption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TabOrder": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTypeSchemeItem": { | |
| "type": "object", | |
| "properties": { | |
| "SectionID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ColumnIDList": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTypeSection": { | |
| "type": "object", | |
| "properties": { | |
| "ID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Description": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TableType": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/SchemeTableContentType" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Enumeration\r\n\r\n1 = Entries\r\n\r\n2 = Collections\r\n\r\n3 = Hierarchies", | |
| "x-enumNames": [ | |
| "Enumeration", | |
| "Entries", | |
| "Collections", | |
| "Hierarchies" | |
| ] | |
| }, | |
| "Columns": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTypeSectionColumn" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTypeSectionColumn": { | |
| "type": "object", | |
| "properties": { | |
| "ID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ColumnType": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardMetadataColumnType" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Physical\r\n\r\n1 = Complex", | |
| "x-enumNames": [ | |
| "Physical", | |
| "Complex" | |
| ] | |
| }, | |
| "SchemeType": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "DefaultValue": { | |
| "nullable": true | |
| }, | |
| "ReferencedSectionName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "IsReferencedToOwner": { | |
| "type": "boolean" | |
| }, | |
| "IsReference": { | |
| "type": "boolean" | |
| }, | |
| "ReferencedColumns": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardTypeSectionColumn" | |
| }, | |
| "nullable": true | |
| }, | |
| "Description": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardTypeStoreRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Types": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CardType" | |
| }, | |
| "nullable": true | |
| }, | |
| "TypeIdentifiersToDelete": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "Запрос на массовое сохранение типов карточек." | |
| }, | |
| "CardTypeValidator": { | |
| "type": "object", | |
| "properties": { | |
| "Type": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/CardValidatorType" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "ValidatorSettings": { | |
| "type": "object", | |
| "additionalProperties": { }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CardValidatorType": { | |
| "type": "object", | |
| "properties": { | |
| "isUnknown": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "nullable": true, | |
| "readOnly": true | |
| }, | |
| "id": { | |
| "type": "string", | |
| "format": "uuid", | |
| "readOnly": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "ConditionalOverride": { | |
| "type": "object", | |
| "properties": { | |
| "Condition": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Overrides": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CreateOperationRequest": { | |
| "type": "object", | |
| "properties": { | |
| "ID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "TypeID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Flags": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/OperationCreationFlags" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = CreateInProgress\r\n\r\n2 = ReportsProgress\r\n\r\n4 = FailWhenHasSameRequestHash", | |
| "x-enumNames": [ | |
| "None", | |
| "CreateInProgress", | |
| "ReportsProgress", | |
| "FailWhenHasSameRequestHash" | |
| ] | |
| }, | |
| "Digest": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Request": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/OperationRequest" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "RequestHash": { | |
| "type": "string", | |
| "format": "byte", | |
| "nullable": true | |
| }, | |
| "Postponed": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "CriteriaValue": { | |
| "type": "object", | |
| "properties": { | |
| "ExecutorParameterName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ReadOnly": { | |
| "type": "boolean" | |
| }, | |
| "Text": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Value": { | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "Dbms": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Unknown\r\n\r\n1 = SqlServer\r\n\r\n2 = PostgreSql", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Unknown", | |
| "SqlServer", | |
| "PostgreSql" | |
| ] | |
| }, | |
| "DeltaKind": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Unchanged\r\n\r\n1 = Added\r\n\r\n2 = Changed\r\n\r\n3 = Deleted", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Unchanged", | |
| "Added", | |
| "Changed", | |
| "Deleted" | |
| ] | |
| }, | |
| "DropDownInfo": { | |
| "type": "object", | |
| "properties": { | |
| "popupColumns": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "nullable": true | |
| }, | |
| "viewAlias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "refPrefix": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "GetWallpaperMode": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None (Стандартная смена фона.)\r\n\r\n1 = Init (Смена фона при инициализации.)\r\n\r\n2 = Default (Смена фона на корпоративный.)", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "Init", | |
| "Default" | |
| ], | |
| "x-enumDescriptions": [ | |
| "Стандартная смена фона.", | |
| "Смена фона при инициализации.", | |
| "Смена фона на корпоративный." | |
| ] | |
| }, | |
| "HttpContent": { | |
| "type": "object", | |
| "properties": { | |
| "headers": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/StringStringIEnumerableKeyValuePair" | |
| }, | |
| "nullable": true, | |
| "readOnly": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "ICardPermissionResolver": { | |
| "type": "object", | |
| "additionalProperties": false | |
| }, | |
| "IJsonExtensionMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "TypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Order": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "Data": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "Condition": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "IJsonSearchQueryMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CreatedByUserID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "IsPublic": { | |
| "type": "boolean" | |
| }, | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonSearchQueryMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "ModificationDateTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "TemplateCompositionID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ViewAlias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FormatVersion": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "Extensions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonExtensionMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "Parameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/JsonRequestParameter" | |
| }, | |
| "nullable": true | |
| }, | |
| "ParametersByState": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/JsonRequestParameter" | |
| }, | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "IJsonSortingColumn": { | |
| "type": "object", | |
| "properties": { | |
| "SortDirection": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ListSortDirection" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Ascending\r\n\r\n1 = Descending", | |
| "x-enumNames": [ | |
| "Ascending", | |
| "Descending" | |
| ] | |
| }, | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "IJsonViewAppearanceMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "Background": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FontFamily": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FontFamilyUri": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FontSize": { | |
| "type": "number", | |
| "format": "double", | |
| "nullable": true | |
| }, | |
| "FontStretch": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "FontStyle": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/AppearanceFontStyle" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Normal\r\n\r\n1 = Oblique\r\n\r\n2 = Italic", | |
| "nullable": true | |
| }, | |
| "FontWeight": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "Foreground": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ToolTip": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "HorizontalAlignment": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "VerticalAlignment": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TextAlignment": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Condition": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "IJsonViewColumnMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "Appearance": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CalendarQuantsColumn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "PlannedColumn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CalendarIDColumn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CalendarOverdueFormat": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TreatValueAsUtc": { | |
| "type": "boolean" | |
| }, | |
| "DisableGrouping": { | |
| "type": "boolean" | |
| }, | |
| "HasTag": { | |
| "type": "boolean" | |
| }, | |
| "Hidden": { | |
| "type": "boolean" | |
| }, | |
| "Localizable": { | |
| "type": "boolean" | |
| }, | |
| "MaxLength": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "SortBy": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Type": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Caption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Condition": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "IJsonViewParameterMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "AllowedOperands": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| }, | |
| "AutoCompleteInfo": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/JsonAutoCompleteInfo" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "TreatValueAsUtc": { | |
| "type": "boolean" | |
| }, | |
| "DisallowedOperands": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| }, | |
| "DropDownInfo": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/JsonDropDownInfo" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "Hidden": { | |
| "type": "boolean" | |
| }, | |
| "HideAutoCompleteButton": { | |
| "type": "boolean" | |
| }, | |
| "Multiple": { | |
| "type": "boolean" | |
| }, | |
| "RefSection": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "SourceViews": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| }, | |
| "Type": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Caption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Condition": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "IJsonViewReferenceMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "CardType": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CardTypeColumn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ColPrefix": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "DisplayValueColumn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "IsCard": { | |
| "type": "boolean" | |
| }, | |
| "OpenOnDoubleClick": { | |
| "type": "boolean" | |
| }, | |
| "RefSection": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| }, | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Condition": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "IJsonViewSubsetMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "CaptionColumn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CountColumn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "HideZeroCount": { | |
| "type": "boolean" | |
| }, | |
| "RefColumn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "RefParam": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Kind": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/SubsetKind" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = List\r\n\r\n1 = Tree", | |
| "x-enumNames": [ | |
| "List", | |
| "Tree" | |
| ] | |
| }, | |
| "TreeHasChildrenColumn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TreeRefParam": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Caption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Condition": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "IJsonWorkplaceComponentMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "OrderPos": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "OwnerId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ParentCompositionId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Extensions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonExtensionMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "ExpandedIconName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "IconName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CompositionId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "NodeClientVisibility": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/NodeClientVisibility" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Always\r\n\r\n1 = TessaClient\r\n\r\n2 = ThinClient", | |
| "x-enumNames": [ | |
| "Always", | |
| "TessaClient", | |
| "ThinClient" | |
| ] | |
| }, | |
| "TypeName": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "IJsonWorkplaceMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "EmptyFoldersVisible": { | |
| "type": "boolean" | |
| }, | |
| "FormatVersion": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "LeftSideWidth": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "TreeVisibility": { | |
| "type": "boolean" | |
| }, | |
| "Version": { | |
| "type": "integer", | |
| "format": "int32", | |
| "readOnly": true | |
| }, | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonWorkplaceComponentMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "OrderPos": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "OwnerId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ParentCompositionId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Extensions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonExtensionMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "ExpandedIconName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "IconName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CompositionId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "NodeClientVisibility": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/NodeClientVisibility" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Always\r\n\r\n1 = TessaClient\r\n\r\n2 = ThinClient", | |
| "x-enumNames": [ | |
| "Always", | |
| "TessaClient", | |
| "ThinClient" | |
| ] | |
| }, | |
| "TypeName": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "IJsonWorkplaceUserExtensionMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "UserSettingsLastUpdate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "FormatVersion": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "OrderPos": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "OwnerId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ParentCompositionId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Extensions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonExtensionMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "ExpandedIconName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "IconName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CompositionId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "NodeClientVisibility": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/NodeClientVisibility" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Always\r\n\r\n1 = TessaClient\r\n\r\n2 = ThinClient", | |
| "x-enumNames": [ | |
| "Always", | |
| "TessaClient", | |
| "ThinClient" | |
| ] | |
| }, | |
| "TypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonWorkplaceComponentMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "Roles": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/RoleLink" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "ITessaViewResult": { | |
| "type": "object", | |
| "properties": { | |
| "columns": { | |
| "type": "array", | |
| "items": { }, | |
| "nullable": true | |
| }, | |
| "dataTypes": { | |
| "type": "array", | |
| "items": { }, | |
| "nullable": true, | |
| "deprecated": true | |
| }, | |
| "schemeTypes": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| }, | |
| "result": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "rowCount": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "rows": { | |
| "type": "array", | |
| "items": { }, | |
| "nullable": true | |
| }, | |
| "hasTimeOut": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "IValidationResultBuilder": { | |
| "type": "object", | |
| "properties": { | |
| "Count": { | |
| "type": "integer", | |
| "format": "int32", | |
| "readOnly": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "IViewParameterMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "allowedOperands": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| }, | |
| "autoCompleteInfo": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/AutoCompleteInfo" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "treatValueAsUtc": { | |
| "type": "boolean" | |
| }, | |
| "disallowedOperands": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| }, | |
| "dropDownInfo": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/DropDownInfo" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "group": { | |
| "type": "string", | |
| "nullable": true, | |
| "deprecated": true | |
| }, | |
| "hidden": { | |
| "type": "boolean" | |
| }, | |
| "hideAutoCompleteButton": { | |
| "type": "boolean" | |
| }, | |
| "multiple": { | |
| "type": "boolean" | |
| }, | |
| "refSection": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "sourceViews": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| }, | |
| "isMissingParameter": { | |
| "type": "boolean" | |
| }, | |
| "schemeType": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "isSealed": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "caption": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "InitializationRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "Version": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "BuildDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "PublishMode": { | |
| "type": "boolean" | |
| }, | |
| "CachedConfigurationVersion": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "CachedSessionInfo": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "InitializationResponse": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "Version": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "BuildDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "ConfigurationCacheIsActual": { | |
| "type": "boolean" | |
| }, | |
| "ConfigurationVersion": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "Dbms": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/Dbms" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Unknown\r\n\r\n1 = SqlServer\r\n\r\n2 = PostgreSql", | |
| "x-enumNames": [ | |
| "Unknown", | |
| "SqlServer", | |
| "PostgreSql" | |
| ] | |
| }, | |
| "PersonalRoleSatellite": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/Card" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "CipherInfo": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/UserCipherInfoObject" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "DefaultColors": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/StorageDefaultColors" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "ValidationResult": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ValidationStorageResultBuilder" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "SessionInfo": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "IntegrationLoginParameters": { | |
| "type": "object", | |
| "properties": { | |
| "Login": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Password": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "ItemModel": { | |
| "type": "object", | |
| "properties": { | |
| "MessageID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "OriginalFileID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "Uri": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "DataBase64": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FileName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Caption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Type": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/AttachmentType" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = File\r\n\r\n1 = Link\r\n\r\n2 = InnerItem\r\n\r\n3 = ExternalInnerItem", | |
| "x-enumNames": [ | |
| "File", | |
| "Link", | |
| "InnerItem", | |
| "ExternalInnerItem" | |
| ] | |
| }, | |
| "StoreMode": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/AttachmentStoreMode" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Insert\r\n\r\n1 = Delete\r\n\r\n2 = NotChanged\r\n\r\n3 = Changed", | |
| "x-enumNames": [ | |
| "Insert", | |
| "Delete", | |
| "NotChanged", | |
| "Changed" | |
| ] | |
| }, | |
| "ShowInToolbar": { | |
| "type": "boolean" | |
| }, | |
| "FileSize": { | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "JsonAutoCompleteInfo": { | |
| "type": "object", | |
| "properties": { | |
| "ParamAlias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "PopupColumns": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "nullable": true | |
| }, | |
| "ViewAlias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "RefPrefix": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "JsonCriteriaValue": { | |
| "type": "object", | |
| "properties": { | |
| "Text": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Value": { | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "JsonDropDownInfo": { | |
| "type": "object", | |
| "properties": { | |
| "PopupColumns": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "nullable": true | |
| }, | |
| "ViewAlias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "RefPrefix": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "JsonItemProperties": { | |
| "type": "object", | |
| "properties": { | |
| "ExpandedIconName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "IconName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CompositionId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "NodeClientVisibility": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/NodeClientVisibility" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Always\r\n\r\n1 = TessaClient\r\n\r\n2 = ThinClient", | |
| "x-enumNames": [ | |
| "Always", | |
| "TessaClient", | |
| "ThinClient" | |
| ] | |
| }, | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "OrderPos": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "OwnerId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ParentCompositionId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Extensions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonExtensionMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "TypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "PropertyClass": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "PropertyState": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PropertyState" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Persisted\r\n\r\n1 = Changed", | |
| "x-enumNames": [ | |
| "Persisted", | |
| "Changed" | |
| ] | |
| }, | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonWorkplaceComponentMetadata" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "JsonRequestCriteria": { | |
| "type": "object", | |
| "properties": { | |
| "CriteriaName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Values": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/JsonCriteriaValue" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "JsonRequestParameter": { | |
| "type": "object", | |
| "properties": { | |
| "CriteriaValues": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/JsonRequestCriteria" | |
| }, | |
| "nullable": true | |
| }, | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "JsonSearchQueryMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "Extensions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonExtensionMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "Parameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/JsonRequestParameter" | |
| }, | |
| "nullable": true | |
| }, | |
| "ParametersByState": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/JsonRequestParameter" | |
| }, | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CreatedByUserID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "IsPublic": { | |
| "type": "boolean" | |
| }, | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonSearchQueryMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "ModificationDateTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "TemplateCompositionID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ViewAlias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FormatVersion": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "JsonViewMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Caption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Appearance": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Appearances": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonViewAppearanceMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "AutoWidthRowLimit": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "Columns": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonViewColumnMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "DefaultSortColumns": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonSortingColumn" | |
| }, | |
| "nullable": true | |
| }, | |
| "EnableAutoWidth": { | |
| "type": "boolean" | |
| }, | |
| "ExportDataPageLimit": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "GroupingColumn": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "MultiSelect": { | |
| "type": "boolean" | |
| }, | |
| "PageLimit": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "Paging": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/Paging" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = No\r\n\r\n1 = Always\r\n\r\n2 = Optional", | |
| "x-enumNames": [ | |
| "No", | |
| "Always", | |
| "Optional" | |
| ] | |
| }, | |
| "Parameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonViewParameterMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "QuickSearchParam": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "References": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonViewReferenceMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "RowCounterVisible": { | |
| "type": "boolean" | |
| }, | |
| "RowCountSubset": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "SelectionMode": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ViewSelectionMode" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Row\r\n\r\n1 = Cell", | |
| "x-enumNames": [ | |
| "Row", | |
| "Cell" | |
| ] | |
| }, | |
| "Subsets": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonViewSubsetMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "TreatAsSingleQuery": { | |
| "type": "boolean" | |
| }, | |
| "TreeGroupDisplayValue": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TreeGroup": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TreeGroupId": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TreeGroupParentId": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TreeId": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TreeParentId": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Extensions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonExtensionMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "Overrides": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/ConditionalOverride" | |
| }, | |
| "nullable": true | |
| }, | |
| "ValidationResult": { | |
| "nullable": true | |
| }, | |
| "ConnectionAlias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "LabelsColumn": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "JsonViewModel": { | |
| "type": "object", | |
| "properties": { | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Caption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Description": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "GroupName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "FormatVersion": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "ModifiedByID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ModifiedByName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ModifiedDateTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "MsQuerySource": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "PgQuerySource": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "JsonMetadataSource": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "MetadataSource": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Roles": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/RoleLink" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "JsonWorkplace": { | |
| "type": "object", | |
| "properties": { | |
| "Metadata": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/IJsonWorkplaceMetadata" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "Roles": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/RoleLink" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "JsonWorkplaceModel": { | |
| "type": "object", | |
| "properties": { | |
| "Content": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/JsonWorkplace" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "Views": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/JsonViewModel" | |
| }, | |
| "nullable": true, | |
| "readOnly": true | |
| }, | |
| "SearhQueries": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/JsonSearchQueryMetadata" | |
| }, | |
| "nullable": true, | |
| "readOnly": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "JsonWorkplaceSettingsMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "ExpandedIconName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "IconName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CompositionId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "NodeClientVisibility": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/NodeClientVisibility" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Always\r\n\r\n1 = TessaClient\r\n\r\n2 = ThinClient", | |
| "x-enumNames": [ | |
| "Always", | |
| "TessaClient", | |
| "ThinClient" | |
| ] | |
| }, | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "OrderPos": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "OwnerId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ParentCompositionId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Extensions": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/IJsonExtensionMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "TypeName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "EmptyFoldersVisible": { | |
| "type": "boolean" | |
| }, | |
| "LeftSideWidth": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "TreeVisibility": { | |
| "type": "boolean", | |
| "nullable": true | |
| }, | |
| "WorkplaceId": { | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "ListSortDirection": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Ascending\r\n\r\n1 = Descending", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Ascending", | |
| "Descending" | |
| ] | |
| }, | |
| "MessageBody": { | |
| "type": "object", | |
| "properties": { | |
| "Text": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Users": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| }, | |
| "Roles": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "MessageModel": { | |
| "type": "object", | |
| "properties": { | |
| "Created": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "MessageID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "MessageBody": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/MessageBody" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "AuthorID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "AuthorName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "TopicID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ModifiedByID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "ModifiedByName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ModifiedAt": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "Reply": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "Type": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/MessageType" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = AddUser\r\n\r\n2 = RemoveUser\r\n\r\n3 = AddRoles\r\n\r\n4 = RemoveRole\r\n\r\n5 = Custom", | |
| "x-enumNames": [ | |
| "Default", | |
| "AddUser", | |
| "RemoveUser", | |
| "AddRoles", | |
| "RemoveRole", | |
| "Custom" | |
| ] | |
| }, | |
| "LastName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FirstName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Attachments": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/ItemModel" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "MessageType": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3, | |
| 4, | |
| 5 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Default\r\n\r\n1 = AddUser\r\n\r\n2 = RemoveUser\r\n\r\n3 = AddRoles\r\n\r\n4 = RemoveRole\r\n\r\n5 = Custom", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Default", | |
| "AddUser", | |
| "RemoveUser", | |
| "AddRoles", | |
| "RemoveRole", | |
| "Custom" | |
| ] | |
| }, | |
| "NodeClientVisibility": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Always\r\n\r\n1 = TessaClient\r\n\r\n2 = ThinClient", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Always", | |
| "TessaClient", | |
| "ThinClient" | |
| ] | |
| }, | |
| "OpenSessionRequest": { | |
| "type": "object", | |
| "properties": { | |
| "CultureLCID": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "UICultureLCID": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "UtcOffsetMinutes": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "OSName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "UserAgent": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "DeviceType": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "Client64Bit": { | |
| "type": "boolean", | |
| "nullable": true | |
| }, | |
| "Client64BitOS": { | |
| "type": "boolean", | |
| "nullable": true | |
| }, | |
| "ApplicationID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "Login": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Password": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "EncodeBase64": { | |
| "type": "boolean" | |
| }, | |
| "ServiceType": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/SessionServiceType" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Unknown\r\n\r\n1 = DesktopClient\r\n\r\n2 = WebClient", | |
| "x-enumNames": [ | |
| "Unknown", | |
| "DesktopClient", | |
| "WebClient" | |
| ] | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "Operation": { | |
| "type": "object", | |
| "properties": { | |
| "ID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "TypeID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "State": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/OperationState" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Created\r\n\r\n1 = InProgress\r\n\r\n2 = Completed\r\n\r\n3 = Postponed", | |
| "x-enumNames": [ | |
| "Created", | |
| "InProgress", | |
| "Completed", | |
| "Postponed" | |
| ] | |
| }, | |
| "CreatedByID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "CreatedByName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Created": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "InProgress": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "Completed": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "Postponed": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "Progress": { | |
| "type": "number", | |
| "format": "double", | |
| "nullable": true | |
| }, | |
| "ReportsProgress": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "Digest": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Request": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/OperationRequest" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "RequestHash": { | |
| "type": "string", | |
| "format": "byte", | |
| "nullable": true | |
| }, | |
| "Response": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/OperationResponse" | |
| } | |
| ], | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "OperationCreationFlags": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 4 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = None\r\n\r\n1 = CreateInProgress\r\n\r\n2 = ReportsProgress\r\n\r\n4 = FailWhenHasSameRequestHash", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "None", | |
| "CreateInProgress", | |
| "ReportsProgress", | |
| "FailWhenHasSameRequestHash" | |
| ] | |
| }, | |
| "OperationRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "OperationResponse": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "ValidationResult": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ValidationStorageResultBuilder" | |
| } | |
| ], | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "OperationState": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Created\r\n\r\n1 = InProgress\r\n\r\n2 = Completed\r\n\r\n3 = Postponed", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Created", | |
| "InProgress", | |
| "Completed", | |
| "Postponed" | |
| ] | |
| }, | |
| "OperationStateAndProgress": { | |
| "type": "object", | |
| "properties": { | |
| "State": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/OperationState" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Created\r\n\r\n1 = InProgress\r\n\r\n2 = Completed\r\n\r\n3 = Postponed", | |
| "readOnly": true, | |
| "x-enumNames": [ | |
| "Created", | |
| "InProgress", | |
| "Completed", | |
| "Postponed" | |
| ] | |
| }, | |
| "Progress": { | |
| "type": "number", | |
| "format": "double", | |
| "nullable": true, | |
| "readOnly": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PackageFileState": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Unchanged\r\n\r\n1 = Inserted\r\n\r\n2 = Replaced\r\n\r\n3 = Deleted", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Unchanged", | |
| "Inserted", | |
| "Replaced", | |
| "Deleted" | |
| ] | |
| }, | |
| "Paging": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = No\r\n\r\n1 = Always\r\n\r\n2 = Optional", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "No", | |
| "Always", | |
| "Optional" | |
| ] | |
| }, | |
| "PlainCriteriaValue": { | |
| "type": "object", | |
| "properties": { | |
| "Value": { | |
| "nullable": true | |
| }, | |
| "Text": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ExecutorParameterName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ReadOnly": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainGetModelRequest": { | |
| "type": "object", | |
| "additionalProperties": false | |
| }, | |
| "PlainImportTessaViewRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Models": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainTessaViewModel" | |
| }, | |
| "nullable": true | |
| }, | |
| "ImportRoles": { | |
| "type": "boolean" | |
| }, | |
| "NeedClear": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainImportWorkplaceModelRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Models": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainTessaExchangeWorkplaceModel" | |
| }, | |
| "nullable": true | |
| }, | |
| "ImportRoles": { | |
| "type": "boolean" | |
| }, | |
| "ImportViews": { | |
| "type": "boolean" | |
| }, | |
| "ImportSearchQueries": { | |
| "type": "boolean" | |
| }, | |
| "NeedClear": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainLocalizationEntry": { | |
| "type": "object", | |
| "properties": { | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Comment": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Strings": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainLocalizationString" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainLocalizationLibrary": { | |
| "type": "object", | |
| "properties": { | |
| "ID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Priority": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "Entries": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainLocalizationEntry" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainLocalizationString": { | |
| "type": "object", | |
| "properties": { | |
| "Culture": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "Value": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainRequestCriteria": { | |
| "type": "object", | |
| "properties": { | |
| "CriteriaName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ReadOnly": { | |
| "type": "boolean" | |
| }, | |
| "Values": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainCriteriaValue" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainRequestParameter": { | |
| "type": "object", | |
| "properties": { | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ReadOnly": { | |
| "type": "boolean" | |
| }, | |
| "CriteriaValues": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainRequestCriteria" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainRoleLink": { | |
| "type": "object", | |
| "properties": { | |
| "DeltaKind": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/DeltaKind" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Unchanged\r\n\r\n1 = Added\r\n\r\n2 = Changed\r\n\r\n3 = Deleted", | |
| "x-enumNames": [ | |
| "Unchanged", | |
| "Added", | |
| "Changed", | |
| "Deleted" | |
| ] | |
| }, | |
| "ObjectId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "RoleId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "RoleName": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainSearchQueryMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "CreatedByUserID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "IsPublic": { | |
| "type": "boolean" | |
| }, | |
| "ModificationDateTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "Parameters": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainRequestParameter" | |
| }, | |
| "nullable": true | |
| }, | |
| "ParametersByState": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainRequestParameter" | |
| }, | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "TemplateCompositionID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ViewAlias": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainSortingColumn": { | |
| "type": "object", | |
| "properties": { | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Descending": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainStoreTessaViewRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Models": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainTessaViewModel" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainStoreWorkplaceModelRequest": { | |
| "type": "object", | |
| "properties": { | |
| "Models": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainWorkplaceModel" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainTessaExchangeWorkplaceModel": { | |
| "type": "object", | |
| "properties": { | |
| "SearchQueries": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainSearchQueryMetadata" | |
| }, | |
| "nullable": true | |
| }, | |
| "Views": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainTessaViewModel" | |
| }, | |
| "nullable": true | |
| }, | |
| "Workplace": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/PlainWorkplaceModel" | |
| } | |
| ], | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainTessaViewModel": { | |
| "type": "object", | |
| "properties": { | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Caption": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Description": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "GroupName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Id": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "MetadataSource": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ModifiedById": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "ModifiedByName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ModifiedDateTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "MsQuerySource": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "PgQuerySource": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Roles": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainRoleLink" | |
| }, | |
| "nullable": true | |
| }, | |
| "JsonMetadataSource": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainTessaViewRequest": { | |
| "type": "object", | |
| "properties": { | |
| "ViewAlias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "SubsetName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "CalculateRowCounting": { | |
| "type": "boolean" | |
| }, | |
| "ExecutionTimeOut": { | |
| "type": "integer", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "SortingColumns": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainSortingColumn" | |
| }, | |
| "nullable": true | |
| }, | |
| "Values": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainRequestParameter" | |
| }, | |
| "nullable": true | |
| }, | |
| "SkipErrorLogging": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainTessaViewResult": { | |
| "type": "object", | |
| "properties": { | |
| "rowcount": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "columns": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| }, | |
| "datatypes": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true, | |
| "deprecated": true | |
| }, | |
| "schemetypes": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| }, | |
| "rows": { | |
| "type": "array", | |
| "items": { | |
| "type": "array", | |
| "items": { } | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainValidationResult": { | |
| "type": "object", | |
| "properties": { | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainValidationResultItem" | |
| }, | |
| "nullable": true | |
| }, | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainValidationResultItem": { | |
| "type": "object", | |
| "properties": { | |
| "Key": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Type": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ValidationResultType" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Info\r\n\r\n1 = Warning\r\n\r\n2 = Error", | |
| "x-enumNames": [ | |
| "Info", | |
| "Warning", | |
| "Error" | |
| ] | |
| }, | |
| "Message": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ObjectName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ObjectType": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FieldName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Details": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainWorkplaceComponentMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "FolderMetadata": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "DataNodeMetadata": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "SearchQueryMetadata": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "UnusedComponentMetadata": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "WorkplaceUserExtensionMetadata": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PlainWorkplaceModel": { | |
| "type": "object", | |
| "properties": { | |
| "ID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Metadata": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Roles": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/PlainRoleLink" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "PropertyState": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Persisted\r\n\r\n1 = Changed", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Persisted", | |
| "Changed" | |
| ] | |
| }, | |
| "RequestCriteria": { | |
| "type": "object", | |
| "properties": { | |
| "CriteriaName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ReadOnly": { | |
| "type": "boolean" | |
| }, | |
| "Values": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/CriteriaValue" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "RequestParameter": { | |
| "type": "object", | |
| "properties": { | |
| "CriteriaValues": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/RequestCriteria" | |
| }, | |
| "nullable": true | |
| }, | |
| "IsHidden": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "Metadata": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/IViewParameterMetadata" | |
| } | |
| ], | |
| "nullable": true | |
| }, | |
| "Name": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ReadOnly": { | |
| "type": "boolean" | |
| }, | |
| "SchemeType": { | |
| "type": "string", | |
| "nullable": true, | |
| "readOnly": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "RoleLink": { | |
| "type": "object", | |
| "properties": { | |
| "DeltaKind": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/DeltaKind" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Unchanged\r\n\r\n1 = Added\r\n\r\n2 = Changed\r\n\r\n3 = Deleted", | |
| "x-enumNames": [ | |
| "Unchanged", | |
| "Added", | |
| "Changed", | |
| "Deleted" | |
| ] | |
| }, | |
| "ObjectId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "RoleId": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "RoleName": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "SchemeTableContentType": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2, | |
| 3 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Enumeration\r\n\r\n1 = Entries\r\n\r\n2 = Collections\r\n\r\n3 = Hierarchies", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Enumeration", | |
| "Entries", | |
| "Collections", | |
| "Hierarchies" | |
| ] | |
| }, | |
| "SessionServiceType": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Unknown\r\n\r\n1 = DesktopClient\r\n\r\n2 = WebClient", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Unknown", | |
| "DesktopClient", | |
| "WebClient" | |
| ] | |
| }, | |
| "SortingColumn": { | |
| "type": "object", | |
| "properties": { | |
| "Alias": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "SortDirection": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ListSortDirection" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Ascending\r\n\r\n1 = Descending", | |
| "x-enumNames": [ | |
| "Ascending", | |
| "Descending" | |
| ] | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "StorageDefaultColors": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "ForegroundColors": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "nullable": true | |
| }, | |
| "BackgroundColors": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "nullable": true | |
| }, | |
| "BlockColors": { | |
| "type": "array", | |
| "items": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "Stream": { | |
| "type": "object", | |
| "properties": { | |
| "canRead": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "canSeek": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "canTimeout": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "canWrite": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "length": { | |
| "type": "integer", | |
| "format": "int64", | |
| "readOnly": true | |
| }, | |
| "position": { | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| "readTimeout": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "writeTimeout": { | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "StringStringIEnumerableKeyValuePair": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "value": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "SubsetKind": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = List\r\n\r\n1 = Tree", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "List", | |
| "Tree" | |
| ] | |
| }, | |
| "TopicModel": { | |
| "type": "object", | |
| "properties": { | |
| "ID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Title": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Description": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Created": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "IsArchived": { | |
| "type": "boolean" | |
| }, | |
| "LastUpdateDateTime": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "AuthorID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "AuthorName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "LastMessageAuthorID": { | |
| "type": "string", | |
| "format": "uuid", | |
| "nullable": true | |
| }, | |
| "LastMessageAuthorName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "LastReadMessageTime": { | |
| "type": "string", | |
| "format": "date-time", | |
| "nullable": true | |
| }, | |
| "Messages": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/MessageModel" | |
| }, | |
| "nullable": true | |
| }, | |
| "MessagesCount": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "CurrentMessageNumber": { | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| "CurrentParticipantInfo": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "TypeID": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "EnableFullTextMessageSearch": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "UserCipherInfoObject": { | |
| "type": "object", | |
| "properties": { | |
| "Info": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "nullable": true | |
| }, | |
| "nullable": true | |
| }, | |
| "IsEncrypted": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "LocalExpiryDates": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "nullable": true | |
| }, | |
| "LocalPrivateKeys": { | |
| "type": "array", | |
| "items": { | |
| "type": "string", | |
| "format": "byte" | |
| }, | |
| "nullable": true | |
| }, | |
| "Nonce": { | |
| "type": "string", | |
| "format": "byte", | |
| "nullable": true | |
| }, | |
| "Tag": { | |
| "type": "string", | |
| "format": "byte", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "ValidationResultType": { | |
| "enum": [ | |
| 0, | |
| 1, | |
| 2 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Info\r\n\r\n1 = Warning\r\n\r\n2 = Error", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Info", | |
| "Warning", | |
| "Error" | |
| ] | |
| }, | |
| "ValidationStorageResultBuilder": { | |
| "type": "object", | |
| "properties": { | |
| "Items": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/ValidationStorageResultItem" | |
| }, | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "ValidationStorageResultItem": { | |
| "type": "object", | |
| "properties": { | |
| "Key": { | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| "Type": { | |
| "allOf": [ | |
| { | |
| "$ref": "#/components/schemas/ValidationResultType" | |
| } | |
| ], | |
| "description": "\r\n\r\n0 = Info\r\n\r\n1 = Warning\r\n\r\n2 = Error", | |
| "x-enumNames": [ | |
| "Info", | |
| "Warning", | |
| "Error" | |
| ] | |
| }, | |
| "Message": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "FieldName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ObjectName": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "ObjectType": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "Details": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "ViewSelectionMode": { | |
| "enum": [ | |
| 0, | |
| 1 | |
| ], | |
| "type": "integer", | |
| "description": "\r\n\r\n0 = Row\r\n\r\n1 = Cell", | |
| "format": "int32", | |
| "x-enumNames": [ | |
| "Row", | |
| "Cell" | |
| ] | |
| }, | |
| "WebViewRequest": { | |
| "type": "object", | |
| "properties": { | |
| "calculateRowCounting": { | |
| "type": "boolean", | |
| "description": "Признак того, что помимо данных представления вычисляется общее количество строк (сабсет Count),\r\nчтобы определить общее количество страниц." | |
| }, | |
| "executionTimeOut": { | |
| "type": "integer", | |
| "description": "Максимальное время выполнения представления на сервере или `null`, если сервер не ограничивает время.", | |
| "format": "int32", | |
| "nullable": true | |
| }, | |
| "sortingColumns": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/SortingColumn" | |
| }, | |
| "description": "Колонки для сортировки представления. Может быть пустая коллекция или `null`, если используется сортировка, заданная в представлении.", | |
| "nullable": true | |
| }, | |
| "subsetName": { | |
| "type": "string", | |
| "description": "Алиас сабсета, в режиме которого выполняется представление, или `null`, если представление выполняется в режиме отображения (без сабсета).", | |
| "nullable": true | |
| }, | |
| "values": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/RequestParameter" | |
| }, | |
| "description": "Список параметров фильтрации представления или `null`, если параметры не передаются.", | |
| "nullable": true | |
| }, | |
| "viewAlias": { | |
| "type": "string", | |
| "description": "Алиас выполняемого представления.", | |
| "nullable": true | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "description": "Запрос на загрузку данных представления." | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| { | |
| "name": "Applications", | |
| "description": "Предоставляет доступ для скачивания приложений в Tessa Applications (desktop-клиент)." | |
| }, | |
| { | |
| "name": "Cards", | |
| "description": "Предоставляет средства для работы с карточками." | |
| }, | |
| { | |
| "name": "CardTypes", | |
| "description": "Предоставляет средства для работы с типами карточек Tessa.Cards.CardType в desktop-клиенте.\r\nВ качестве типов могут выступать типы собственно карточек Tessa.Cards.CardInstanceType.Card,\r\nтипы файлов Tessa.Cards.CardInstanceType.File, типы заданий Tessa.Cards.CardInstanceType.Task\r\nи типы диалогов Tessa.Cards.CardInstanceType.Dialog." | |
| }, | |
| { | |
| "name": "Check", | |
| "description": "Предоставляет доступ к проверкам состояния веб-сервиса, если в конфигурации\r\nустановлена настройка `HealthCheckIsEnabled` равной `true`." | |
| }, | |
| { | |
| "name": "Initialization", | |
| "description": "Предоставляет средства для инициализации приложений desktop-клиента.\r\nИнициализация выполняется в момент запуска приложения." | |
| }, | |
| { | |
| "name": "Localization", | |
| "description": "Предоставляет доступ к библиотекам локализации." | |
| }, | |
| { | |
| "name": "Operations", | |
| "description": "Предоставляет средства для создания, чтения, изменения и удаления активных операций." | |
| }, | |
| { | |
| "name": "SearchQueries", | |
| "description": "Предоставляет средства для работы с поисковыми запросами." | |
| }, | |
| { | |
| "name": "Sessions", | |
| "description": "Предоставляет методы управления сессиями. Методы открытия сессии не требуют наличия токена сессии в HTTP-заголовке при обращении." | |
| }, | |
| { | |
| "name": "Views", | |
| "description": "Предоставляет средства для работы с представлениями." | |
| }, | |
| { | |
| "name": "Workplaces", | |
| "description": "Предоставляет средства взаимодействия с рабочими местами." | |
| }, | |
| { | |
| "name": "OnlyOffice", | |
| "description": "Предоставляет средства интеграции с сервером документов OnlyOffice\r\nдля просмотра и редактирования документов офисных форматов." | |
| }, | |
| { | |
| "name": "Service", | |
| "description": "Контроллер, для которого задан базовый путь \"service\". Является примером реализации сервисов в рамках приложения TESSA." | |
| }, | |
| { | |
| "name": "Client", | |
| "description": "Методы, используемые web-клиентом TESSA для бизнес-логики." | |
| }, | |
| { | |
| "name": "Saml", | |
| "description": "Предоставляет методы для SSO-авторизации (Single Sign On) по протоколу SAML.\r\nМожет использоваться для интеграции с доменом Active Directory Foundation Services.\r\nИспользуется в web-клиенте TESSA." | |
| }, | |
| { | |
| "name": "Spa", | |
| "description": "Предоставляет средства для управления SPA-приложением через адресную строку, в т.ч. окно входа (логина),\r\nвыход из системы, навигация между карточками и представлениями, и др. Используется в web-клиенте TESSA." | |
| } | |
| ] | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment