disp

current

GET /catalogs/users/current

Responses

200 OK

Body

Object

string

ID текущего пользователя

Example:

fd366600-9e46-11ed-9e2b-00505692a275

name

string

Отображаемое имя текущего пользователя (передается логин вместо ФИО)

Example:

Иванов Иван Иванович

role

string

Наименование роли пользователя

Example:

200aa534-a238-11ed-9050-00505692a275

img

string

Ссылка на фотографию пользователя (должна генерироваться на беке с учетом API Outlook и логина пользователя)

Example:

https://mail.company-name.com/api/v2.0/me/Photos/64x64/$value

Example 1

GET /catalogs/users/current HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "id": "fd366600-9e46-11ed-9e2b-00505692a275",
    "name": "Иванов Иван Иванович",
    "role": "200aa534-a238-11ed-9050-00505692a275",
    "img": "https://mail.company-name.com/api/v2.0/me/Photos/64x64/$value"
}

/scenario/list

POST /scenario/list

Запрос перечня сценариев

Request body

Object

string

Поиск по наименованию сценария

Example:

Сценарий №1

status

Array

Фильтрация с мультиселектом сценариев по статасу. Принимает следующие значения: NEW Новый, READY Готов к расчету, INPROGRESS В процессе, CANCELLED Отменен, ERROR Ошибка, CALCULATED Рассчитано, WAIT Ожидание

Example:

NEW

string

Example:

NEW

intervalStartDate

string

Example:

2022-10-11T16:26:07+03:00

intervalEndDate

string

Example:

2022-10-11T16:26:07+03:00

currentQuantity

number

Для пагинации - текущее количество отображаемых на фронте записей (сценариев)

Example:

defaultQuantity

number

Для пагинации - количество записей которое нужно вернуть с бека.

Example:

favorites

boolean

Признак определяющий, будут ли отображаться на экране только избранные сценарии, или все сценарии.

Examples

{
    "search": "Сценарий №1",
    "status": [
        "NEW"
    ],
    "intervalStartDate": "2022-10-11T16:26:07+03:00",
    "intervalEndDate": "2022-10-11T16:26:07+03:00",
    "currentQuantity": 1,
    "defaultQuantity": 50,
    "favorites": true
}

Responses

200 OK

Body

Object

scenarioId

string

favorite

string

status

string

intervalStartDate

string

intervalEndDate

string

createDate

string

changeDate

string

createAuthor

string

changeAuthor

string

description

string

Examples

{
    "scenarioId": "",
    "favorite": "",
    "status": "",
    "intervalStartDate": "",
    "intervalEndDate": "",
    "createDate": "",
    "changeDate": "",
    "createAuthor": "",
    "changeAuthor": "",
    "description": ""
}

/favorites/write

POST /favorites/write

Request body

Object

string

Ссылка на сценарий

Example:

5b234866-56c8-11ee-85e7-00505692a275

favorite

boolean

Если устанавливается - true. Если удаляется - false.

Example:

true

Examples

{
    "id": "5b234866-56c8-11ee-85e7-00505692a275",
    "favorite": true
}

Responses

200 OK

Body

Object

massage

string

Example:

SUCCESS

Examples

{
    "massage": "SUCCESS"
}