Journals
/api/journal/get
Получить информацию об журнале
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры для получения информации о журнале (содержит идентификатор)
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Идентификатор журнала | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | JournalResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/auditservice public JournalsController Get(ASE.MD.Platform.Infrastructure.AuditService.Models.JournalIdentifier)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | audit:journal:read |
/components/securitySchemes/auditservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | audit:event:read |
/api/journal/del
Удалить журнал
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры для удаления журнала (содержит идентификатор)
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| id | integer (int32) | Идентификатор журнала | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Пользовательское сообщение об ошибке. | нет | |
| code | string | Код ошибки. | да | |
| isError | boolean | Признак наличия ошибки. | да | |
| stackTrace | string | Трейс стека вызовов. | нет | |
| innerErrors | IErrorDescription[] | Вложенные исключения. | нет | |
| techMessage | string | Техническое сообщение об ошибке. | нет | |
| dateTime | string (date-time) | Дата и время возникновения ошибки (с часовым поясом). | нет | |
| data | object | Дополнительные данные. | нет | |
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/auditservice public JournalsController Del(ASE.MD.Platform.Infrastructure.AuditService.Models.JournalIdentifier)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | audit:journal:write |
/components/securitySchemes/auditservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | audit:event:read |
/api/journal/add
Добавить новый журнал
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры для создания нового журнала
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя | нет | |
| description | string | Описание | нет | |
| settings | JournalSettings |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | JournalResult | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/auditservice public JournalsController Add(ASE.MD.Platform.Infrastructure.AuditService.Models.NewJournalParameter)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | audit:journal:write |
/components/securitySchemes/auditservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | audit:event:read |
/api/journal/edit
Редактировать журнал
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
параметры для редактирования журнала
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| name | string | Имя | нет | |
| description | string | Описание | нет | |
| settings | JournalSettings | |||
| id | integer (int32) | Идентификатор журнала | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| message | string | Пользовательское сообщение об ошибке. | нет | |
| code | string | Код ошибки. | да | |
| isError | boolean | Признак наличия ошибки. | да | |
| stackTrace | string | Трейс стека вызовов. | нет | |
| innerErrors | IErrorDescription[] | Вложенные исключения. | нет | |
| techMessage | string | Техническое сообщение об ошибке. | нет | |
| dateTime | string (date-time) | Дата и время возникновения ошибки (с часовым поясом). | нет | |
| data | object | Дополнительные данные. | нет | |
| exceptionType | string | Тип исключения. | нет | |
| source | string | Имя источника. | нет | |
| inners | InnerInfo[] | Элементы исключений. | нет | |
| extra | string | Трейс стека. | нет | |
| id | string | Идентификатор ошибки. | нет | |
| type | ErrorTypes |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/auditservice public JournalsController Edit(ASE.MD.Platform.Infrastructure.AuditService.Models.JournalParameter)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | audit:journal:write |
/components/securitySchemes/auditservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | audit:event:read |
/api/journal/list
Получить список журналов
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
Результат выполнения операции
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | JournalResult[] | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/auditservice public JournalsController All()
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | audit:journal:read |
/components/securitySchemes/auditservice
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | audit:event:read |