API docs by RedoclyScap.Service (1.0)
Download OpenAPI specification:Download
Авторизация пользователя в системе SCAP.
Получение токена авторизации из сервиса лицензирования через SCAP.
Authorizations:
Bearer
path Parameters
| username required | string |
query Parameters
| tenantName | string |
Request Body schema: required
| password required | string non-empty Значение пароля. |
Responses
Request samples
- Payload
Content type
{- "password": "string"
}Response samples
- 200
- 400
- 500
Content type
application/json
{- "token": "string",
- "role": "string",
- "login": "string",
- "tenantInfo": {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "email": "string",
- "locality": "string"
}
}Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
[- {
- "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
- "taskId": "string",
- "name": "string",
- "description": "string",
- "remark": "string",
- "threadId": 0,
- "pluginName": "string",
- "tenantName": "string",
- "pluginVersion": "string",
- "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
- "registrationDate": "2019-08-24T14:15:22Z",
- "modificationDate": "2019-08-24T14:15:22Z",
- "callsNumber": 0,
- "status": "Executing",
- "childProcesses": [
- { }
], - "processMessages": [
- {
- "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85",
- "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
- "status": "Success",
- "message": "string",
- "messageGroup": "string",
- "remark": "string",
- "messageCode": "string",
- "registrationDate": "2019-08-24T14:15:22Z",
- "registrationTimestamp": 0,
- "entities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "processMessageId": "591023db-8215-48c5-a71e-7eeca68071d3",
- "entityType": "string",
- "entityId": "string"
}
], - "stackTrace": "string"
}
]
}
]Получить список сообщений.
Предназначен для получения списка логов сообщений с фильтрацией.
Authorizations:
Bearer
path Parameters
| taskId required | string |
Request Body schema:
| groupingOperator | string or null Оператор группировки фильтра. |
Array of objects or null (LoggerRequestFilterExpression) Список фильтров. |
Responses
Request samples
- Payload
Content type
{- "groupingOperator": "string",
- "lines": [
- {
- "field": "string",
- "operator": "IsEqual",
- "values": [
- "string"
]
}
]
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
[- {
- "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85",
- "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
- "status": "Success",
- "message": "string",
- "messageGroup": "string",
- "remark": "string",
- "messageCode": "string",
- "registrationDate": "2019-08-24T14:15:22Z",
- "registrationTimestamp": 0,
- "entities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "processMessageId": "591023db-8215-48c5-a71e-7eeca68071d3",
- "entityType": "string",
- "entityId": "string"
}
], - "stackTrace": "string"
}
]Получить список процессов.
Предназначен для получения списка логов процессов плагина с фильтрацией.
Authorizations:
Bearer
path Parameters
| taskId required | string |
Request Body schema:
| groupingOperator | string or null Оператор группировки фильтра. |
Array of objects or null (LoggerRequestFilterExpression) Список фильтров. |
Responses
Request samples
- Payload
Content type
{- "groupingOperator": "string",
- "lines": [
- {
- "field": "string",
- "operator": "IsEqual",
- "values": [
- "string"
]
}
]
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
{- "taskId": "string",
- "lines": [
- {
- "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
- "taskId": "string",
- "name": "string",
- "description": "string",
- "remark": "string",
- "threadId": 0,
- "pluginName": "string",
- "tenantName": "string",
- "pluginVersion": "string",
- "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
- "registrationDate": "2019-08-24T14:15:22Z",
- "registrationTimestamp": 0,
- "modificationDate": "2019-08-24T14:15:22Z",
- "callsNumber": 0,
- "executingDuration": 0,
- "status": "Executing",
- "messagesNumber": 0,
- "successMessagesNumber": 0,
- "infoMessagesNumber": 0,
- "tipMessagesNumber": 0,
- "warningMessagesNumber": 0,
- "failureMessagesNumber": 0,
- "exceptionMessagesNumber": 0,
- "childProcesses": [
- {
- "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
- "taskId": "string",
- "name": "string",
- "description": "string",
- "remark": "string",
- "threadId": 0,
- "pluginName": "string",
- "tenantName": "string",
- "pluginVersion": "string",
- "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
- "registrationDate": "2019-08-24T14:15:22Z",
- "modificationDate": "2019-08-24T14:15:22Z",
- "callsNumber": 0,
- "status": "Executing",
- "childProcesses": [
- { }
], - "processMessages": [
- {
- "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85",
- "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
- "status": "Success",
- "message": "string",
- "messageGroup": "string",
- "remark": "string",
- "messageCode": "string",
- "registrationDate": "2019-08-24T14:15:22Z",
- "registrationTimestamp": 0,
- "entities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "processMessageId": "591023db-8215-48c5-a71e-7eeca68071d3",
- "entityType": "string",
- "entityId": "string"
}
], - "stackTrace": "string"
}
]
}
], - "processMessages": [
- {
- "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85",
- "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
- "status": "Success",
- "message": "string",
- "messageGroup": "string",
- "remark": "string",
- "messageCode": "string",
- "registrationDate": "2019-08-24T14:15:22Z",
- "registrationTimestamp": 0,
- "entities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "processMessageId": "591023db-8215-48c5-a71e-7eeca68071d3",
- "entityType": "string",
- "entityId": "string"
}
], - "stackTrace": "string"
}
], - "entities": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "processMessageId": "591023db-8215-48c5-a71e-7eeca68071d3",
- "entityType": "string",
- "entityId": "string"
}
]
}
], - "linesNumber": 0
}Получить информацию о задаче. Если передан заголовок Breadcrumb - возвращает позицию задачи в очереди.
Authorizations:
Bearer
path Parameters
| taskId required | string |
header Parameters
| Breadcrumb | string |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
{- "statuses": [
- {
- "status": "InQueue",
- "date": "2019-08-24T14:15:22Z"
}
], - "executingDuration": 0,
- "taskInQueue": 0
}Получить информацию об очереди задач.
Authorizations:
Bearer
header Parameters
| Breadcrumb required | string |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
Content type
application/json
{- "tenant": "string",
- "queues": [
- {
- "pluginName": "string",
- "tasks": [
- {
- "taskId": "string",
- "statuses": [
- {
- "status": "InQueue",
- "date": "2019-08-24T14:15:22Z"
}
]
}
]
}
]
}Получить информацию об очереди задач в разрезе всех тенантов.
Authorizations:
Bearer
header Parameters
| Breadcrumb required | string |
Responses
Response samples
- 200
- 401
- 403
- 500
Content type
application/json
[- {
- "tenant": "string",
- "queues": [
- {
- "pluginName": "string",
- "tasks": [
- {
- "taskId": "string",
- "statuses": [
- {
- "status": "InQueue",
- "date": "2019-08-24T14:15:22Z"
}
]
}
]
}
]
}
]Response samples
- 200
- 401
- 403
- 500
Content type
application/json
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "tenantName": "string",
- "body": "string",
- "expirationDate": "2019-08-24T14:15:22Z",
- "components": {
- "property1": 0,
- "property2": 0
}, - "isValid": true,
- "isTrial": true,
- "allowOverLimit": true
}
]Получить XML файл для офлайн запроса на предоставление лицензии.
Authorizations:
Bearer
Request Body schema: required
| productCode required | string Приложение. |
| organisationName required | string Наименование организации клиента. |
| clientEmail required | string E-mail клиента. |
| productPin required | string Пин-код продукта. |
Responses
Request samples
- Payload
Content type
{- "productCode": "string",
- "organisationName": "string",
- "clientEmail": "string",
- "productPin": "string"
}Response samples
- 400
- 401
- 403
- 500
Content type
application/json
{- "message": "string"
}Получить статистику по лицензиям.
Authorizations:
Bearer
query Parameters
| startDateTime required | string <date-time> |
| endDateTime required | string <date-time> |
| tenantName | string |
Responses
Response samples
- 200
- 400
- 401
- 403
- 500
Content type
application/json
[- {
- "tenantName": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "allPointCountByPlugin": {
- "property1": 0,
- "property2": 0
}, - "remainPointCountByPlugin": {
- "property1": 0,
- "property2": 0
}
}
]Response samples
- 200
- 400
- 401
- 403
- 500
Content type
application/json
[- {
- "name": "string",
- "displayName": "string",
- "email": "string",
- "locality": "string",
- "users": [
- {
- "login": "string",
- "expires": "2019-08-24T14:15:22Z",
- "role": "string",
- "tenantName": "string"
}
]
}
]Создать организацию в БД.
Authorizations:
Bearer
Request Body schema: required
| name required | string [ 1 .. 255 ] characters ^[A-Za-z0-9]+$ Название организации. |
| displayName required | string or null [ 1 .. 255 ] characters Отображаемое название организации. |
| email required | string <axelot@axelot.ru> [ 6 .. 255 ] characters ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2... Почта организации. |
| locality required | string <ru-RU> [ 2 .. 16 ] characters Default: "ru-RU" Локализация организации. Основные локализации: ru-RU, en-EN. |
Responses
Request samples
- Payload
Content type
{- "name": "^A$",
- "displayName": "string",
- "email": "^a@a\\.a{2,}$",
- "locality": "ru-RU"
}Response samples
- 201
- 400
- 401
- 403
- 500
Content type
application/json
{- "name": "^A$",
- "displayName": "string",
- "email": "^a@a\\.a{2,}$",
- "locality": "ru-RU"
}Обновить организацию в БД.
Authorizations:
Bearer
Request Body schema: required
| name required | string [ 1 .. 255 ] characters Название организации. |
| displayName | string or null [ 1 .. 255 ] characters Отображаемое название организации. |
string or null <axelot@axelot.ru> [ 6 .. 255 ] characters ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2... Почта организации. | |
| locality | string or null <ru-RU> [ 2 .. 16 ] characters Default: "ru-RU" Локализация организации. Основные локализации: ru-RU, en-EN. |
Responses
Request samples
- Payload
Content type
{- "name": "string",
- "displayName": "string",
- "email": "^a@a\\.a{2,}$",
- "locality": "ru-RU"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
{- "name": "string",
- "displayName": "string",
- "email": "^a@a\\.a{2,}$",
- "locality": "ru-RU"
}Создать нового пользователя в БД.
Authorizations:
Bearer
Request Body schema: required
| login required | string [ 1 .. 255 ] characters ^[A-Za-z0-9]+$ Логин. |
| password required | string [ 6 .. 127 ] characters Пароль. |
| tenantName required | string [ 1 .. 255 ] characters Название организации. |
| role | string or null [ 1 .. 255 ] characters Default: null Роль. Основные роли: GlobalAdmin, Admin или без роли. |
| expires required | string <date-time> Дата, до какого числа активен аккаунт. |
Responses
Request samples
- Payload
Content type
{- "login": "^A$",
- "password": "string",
- "tenantName": "string",
- "role": null,
- "expires": "2019-08-24T14:15:22Z"
}Response samples
- 201
- 400
- 401
- 403
- 404
- 500
Content type
application/json
{- "login": "string",
- "expires": "2019-08-24T14:15:22Z",
- "role": "string",
- "tenantName": "string"
}Обновить пользователя в БД.
Authorizations:
Bearer
Request Body schema: required
| login required | string [ 1 .. 255 ] characters Логин. |
| password | string [ 6 .. 127 ] characters Пароль. |
| tenantName | string [ 1 .. 255 ] characters Название организации. |
| role | string or null [ 1 .. 255 ] characters Роль. Основные роли: GlobalAdmin, Admin или без роли. Передача пустой строки убирает назначенную роль. |
| expires | string <date-time> Дата, до какого числа активен аккаунт. |
Responses
Request samples
- Payload
Content type
{- "login": "string",
- "password": "string",
- "tenantName": "string",
- "role": "string",
- "expires": "2019-08-24T14:15:22Z"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
{- "login": "string",
- "expires": "2019-08-24T14:15:22Z",
- "role": "string",
- "tenantName": "string"
}