Типы данных
UniqueTaskID
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| taskID | string | идентификатор задания | нет |
ADSErrorSection
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | описание ошибки в удобном для восприятия человека виде | нет | |
| exceptionType | string | тип исключения | нет | |
| code | string | код ошибки в номерации сервиса | нет | |
| source | string | источник возникновения ошибки | нет | |
| inners | object[] | вспомогательная информация | нет | |
| extra | string | дополнительная информация об ошибке | нет | |
| isError | boolean | признак обнаружения ошибки при работе сервиса | нет | |
| id | string | идентификатор сквозной трассировки | нет | |
| type | string | тип ошибки | нет |
ADSResponse
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
ADSTypeInfoSection
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | тип результата в случае успешного завершения работы сервиса | нет |
Page
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| page | integer (int32) | номер страницы (начиная с 0) | да | |
| size | integer (int32) | максимальное число записей на странице | да | |
| sort | string | порядок сортировки записей (формат <поле сортировки>:<порядок сортировки>) | да |
TasksPageByUserID
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| userID | string | идентификатор пользователя | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
TasksPageByState
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| state | string | статус задания | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
TasksPageByStartDate
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| startDate | string (date-time) | дата начала обработки задания | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
TasksPageBySendNotification
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| sendNotification | boolean | признак необходимости отправки нотификации пользователю о завершении выполнения задания | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
TasksPageBySendNotificationAndUserID
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| sendNotification | boolean | признак необходимости отправки нотификации пользователю о завершении выполнения задания | нет | |
| userID | string | идентификатор пользователя | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
TasksPageByKind
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| kind | string | вид (тип) задания | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
TasksPageByCompletionDate
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| completionDate | string (date-time) | дата завершения обработки задания | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
TasksPageByAssignmentDate
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| assignmentDate | string (date-time) | дата поступления задания | нет | |
| page | integer (int32) | да | ||
| size | integer (int32) | да | ||
| sort | string | да |
ID
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int64) | идентификатор | нет |
TaskAddReq
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| kind | string | вид задания | да | |
| parameters | string | параметры выполнения задания | нет | |
| locale | string | локализация | нет | |
| sendNotification | boolean | признак необходимости отправки пользователю, инициировавшему задание, уведомления о его завершении | да |
AliasAndNamespaceReq
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| namespace | string | пространство имён | нет | |
| alias | string | псевдоним | нет |
ReportTemplateAndSettingsReq
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| template | string (byte) | файл шаблона отчёта Jasper Reports | нет | |
| settings | string (byte) | файл настроек порядка формирования отчёта | нет |
FilesDownloadUrlParameters
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| fileID | string | идентификатор файла, для которого формируется URL выгрузки | нет | |
| archiveName | string | наименование архивного файла, выгружаемого по сформированному URL | нет | |
| forPLM | boolean | признак формирования URL выгрузки для PLM | нет |
ExportReportsParameters
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| alias | string | псевдоним | нет | |
| namespace | string | пространство имён | нет | |
| type | string | формат отчёта | нет | PDF, XLS, XLSX, XML, JSON, HTML, CSV, RTF, TXT |
| destinationType | string | тип места назначения выгрузки файла отчёта (допустимые значения: PLM, FILES_SERVICE) | нет | PLM, FILES_SERVICE |
| parameters | string | параметры построения отчёта | нет | |
| locale | string | локализация | нет |
ExportReportsParametersCallback
Тип: object
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| alias | string | псевдоним | нет | |
| namespace | string | пространство имён | нет | |
| type | string | формат отчёта | нет | PDF, XLS, XLSX, XML, JSON, HTML, CSV, RTF, TXT |
| destinationType | string | тип места назначения выгрузки файла отчёта (допустимые значения: PLM, FILES_SERVICE) | нет | PLM, FILES_SERVICE |
| parameters | string | параметры построения отчёта | нет | |
| callbackURL | string | URL обратного вызова возврата результата выполнения метода | нет | |
| externalURL | boolean | признак необходимости разрешения URL обратного вызова результата выполнения метода посредством сервиса Discovery ИС Multi-D Platform | нет | |
| locale | string | локализация | нет |