API очередей (QueuesApi)
Работа с очередями данных.

API-запросы удобно формировать в Swagger (Инструкция, как подключиться).
Доступны 7 способов взаимодействия с очередями:


1. Добавить элемент в очередь. (POST)
Swagger автоматически формирует ссылку.
Для этого надо указать следующие параметры:

Можно использовать шаблон запроса, прописав там нужные параметры:
//CURL
curl -X 'POST' \
  '"Ссылка для работы с мастером"/api/Queues/PushElementToQueue?queueName=queueName&data=data&priority=1&postponeDate=2022-09-21T17%3A32%3A28Z&deadlineDate=2022-09-22T17%3A32%3A28Z&comment=comment&reference=reference&isReferenceUnique=false' \
  -H 'accept: text/plain' \
  -d ''

//URL
"Ссылка для работы с мастером"/api/Queues/PushElementToQueue?queueName=queueName&data=data&priority=1&postponeDate=2022-09-21T17%3A32%3A28Z&deadlineDate=2022-09-22T17%3A32%3A28Z&comment=comment&reference=reference&isReferenceUnique=false
API-запрос можно осуществить в приложении Postman (надо установить программу на компьютере).
Для этого (1) выбираем команду POST, вставляем сформированную в Swagger ссылку (URL) и (2-3) авторизуемся по токену (API запроса токена).
Мы получим ответ в виде ключа и присвоенного значения.


2. Добавить элемент в очередь. (POST)
Этот запрос отличается от предыдущего тем, что записываемое значение указывается в Body.

Можно использовать шаблон запроса, прописав там нужные параметры:
//CURL
curl -X 'POST' \
  '"Ссылка для работы с мастером"/api/Queues/PushElementToQueueFromBodyData?priority=1&isReferenceUnique=false' \
  -H 'accept: text/plain' \
  -H 'Content-Type: application/json' \
  -d '"data"'

//URL
"Ссылка для работы с мастером"/api/Queues/PushElementToQueueFromBodyData?priority=1&isReferenceUnique=false
В Postman необходимо дополнительно указать значение в Body:

Получаем Json с полями: key – идентификатор элемента очереди, value – значение элемента очереди.

3. Получить элемент из очереди. (GET)
Сформировать запрос можно в Swagger, указав следующие параметры:

Можно задать необходимые параметры в шаблоне:
//CURL
curl -X 'GET' \
  '"Ссылка для работы с мастером"/api/Queues/GetElementFromQueue?queueName=%D0%9E%D1%87%D0%B5%D1%80%D0%B5%D0%B4%D1%8C1&reference=reference&priority=1&comment=comment' \
  -H 'accept: text/plain'

//URL
"Ссылка для работы с мастером"/api/Queues/GetElementFromQueue?queueName=%D0%9E%D1%87%D0%B5%D1%80%D0%B5%D0%B4%D1%8C1&reference=reference&priority=1&comment=comment
В результате выполнения запроса получаем Json с полями: key – идентификатор элемента очереди, value – значение элемента очереди.

4. Подтвердить обработку элемента. (POST)
Сформировать запрос можно в Swagger, указав следующие параметры:

Можно использовать шаблон запроса, прописав там нужные параметры:
//CURL
curl -X 'POST' \
  '"Ссылка для работы с мастером"/api/Queues/ConfirmQueueItemProcessFinish?id=1&isSuccess=true&errorComment=%D0%BD%D0%B5%20%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%B0%D0%BD&errorType=1' \
  -H 'accept: */*' \
  -d ''

//URL
"Ссылка для работы с мастером"/api/Queues/ConfirmQueueItemProcessFinish?id=1&isSuccess=true&errorComment=%D0%BD%D0%B5%20%D0%BE%D0%B1%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%B0%D0%BD&errorType=1
Обратите внимание, что комментарий указывается в закодированном формате.
В ответ на запрос должно выводиться сообщение "success".

5. Отменить элемент очереди. (POST)
Чтобы сформировать запрос в Swagger, надо указать следующие параметры:

Можно использовать шаблон запроса, прописав там нужные параметры:
//CURL
curl -X 'POST' \
  '"Ссылка для работы с мастером"/api/Queues/CancelQueueItem?id=1&comment=comment' \
  -H 'accept: */*' \
  -d ''

//URL
"Ссылка для работы с мастером"/api/Queues/CancelQueueItem?id=1&comment=comment

6. Получить статус элемента. (GET)
Для осуществления запроса надо указать ID элемента:
//CURL
curl -X 'GET' \
  '"Ссылка для работы с мастером"/api/Queues/GetQueueItemStatus?id=1' \
  -H 'accept: text/plain'

//URL
"Ссылка для работы с мастером"/api/Queues/GetQueueItemStatus?id=1

7. Получить элементы очереди по фильтру. (GET)
Чтобы сформировать запрос в Swagger, надо указать следующие параметры:

Можно использовать шаблон запроса, прописав там нужные параметры:
//CURL
curl -X 'GET' \
  '"Ссылка для работы с мастером"/api/Queues/GetQueueItemsByFilters?queueName=%D0%9E%D1%87%D0%B5%D1%80%D0%B5%D0%B4%D1%8C1&maxItems=100&statuses=new' \
  -H 'accept: text/plain'

//URL
"Ссылка для работы с мастером"/api/Queues/GetQueueItemsByFilters?queueName=%D0%9E%D1%87%D0%B5%D1%80%D0%B5%D0%B4%D1%8C1&maxItems=100&statuses=new
В результате получим JSON с элементами, соответствующими условиям фильтрации.