Методы группы Tasks внешнего программного интерфейса менеджера сервиса предназначены для выполнения действий с задачами пользователя, которые показываются пользователю в его личном кабинете. Например, с задачами по предоставлению доступа к приложению абонента или к резервной копии приложения.

Сводка по методам

МетодНазначение
root
listПолучение списка задач на предоставление доступа в область или к резервной копии
infoПолучение описания задачи
executeОтправка подтверждения или отказа по задаче в менеджер сервиса
files
new_multipartНачать составную загрузку файла
new_partСделать новую часть файла при составной загрузке
complete_multipartЗавершить составную загрузку файла
abort_multipartОтменить составную загрузку файла

tasks/list

Получение списка задач на предоставление доступа в область или к резервной копии

ПараметрТипОписание
Запрос
Нет параметров
Ответ tasks(0..*)
nameСтрокаИмя задачи для списка
idСтрока

Номер задачи

 Вверх

task/info

Получение описания задачи

ПараметрТипОписание
Запрос

id

СтрокаНомер задачи
Ответ tasks(0..*)
typeСтрока

Тип задачи:

  • Доступ - access
  • Получение РК - replication
  • Доступ к API приложения - api_access
authorСтрокаАвтор задачи
descriptionСтрокаОписание задачи
tenantСтрокаНаименование приложения
subscriberСтрокаНаименование ведущего абонента (Абонент ОО или ЛК)
backup_typeСтрокаВид запрашиваемой резервной копии (Для поддержки или нет)

 Вверх

task/execute

Отправка подтверждения или отказа по задаче в менеджер сервиса

ПараметрТипОписание
Запрос

id

СтрокаНомер задачи

result

Булево

Принятое решение (True- одобрено; False- Отказано)

date_accessДатаДата истечения доступа (при запросе удалённого доступа) - необязательное
backup_idGUIDУникальный идентификатор резервной копии (при запросе копии) - необязательное
backup_existingБулевоСуществующая копия или нет
Ответ (1)
Нет параметров

 Вверх

tasks/files/new_multipart

Получение списка задач текущего пользователя.

ПараметрТипОписаниеПример
Запрос
Нет параметров
Ответ task(0..*)
nameСтрока переменная (150)Наименование задачиЗадача на предоставление доступа (доступ к РК)
idСтрока неограниченной длины

Номер задачи

00000002500001
Пример запроса
{
"auth": {
   "tenant": 2000,
   "account": 1010
},
"general": {
  "version": 11,
  "type": "usr",
  "method": "task/list",
  "debug": true
}
}
Пример ответа
{
"task": [
  {"id": "00000002500001",
   "name": "Задача на предоставление доступа (доступ к РК)"
  }
],
"general": {
  "response": 10200,
  "error": false,
  "message": "",
  "version": 11,
  "sm_version": "1.0.97.11",
  "sm_timezone": "Europe/Moscow"
}
}

 Вверх

tasks/files/new_part

Начать загрузку следующей части файла при составной загрузке.

После успешного вызова метода можно загрузить следующую часть файла с помощью  HTTP-запроса PUT по адресу, полученному в параметре ответа url. В HTTP-запросе следует использовать HTTP-заголовки, переданные в параметре ответа headers.

ПараметрТипОписаниеПример
Запрос
file_idСтрока переменная (36)Идентификатор файла (полученный в параметре ответа file_id метода files/new_multipart)85bb388c-1517-11ea-6d94-0242ac130033
part_numberЧислоНомер части файла, которая будет загружаться (номера частей начинаются с 1)3
Ответ
urlСтрока неограниченной длиныURL для загрузки следующей части файлаhttps://backups.example.ru/00/89/2b/85bb388c-1517-11ea-6d94-0242ac130033
typeСтрока неограниченной длиныТип адреса: dt или s3 s3
headers *Список (0..*) строк неограниченной длиныЗаголовки для запроса при загрузке следующей части файла (массив строк "заголовок: значение")["x-header-1: value1", "x-header-2: value2"]
Пример запроса
{
"file_id": "85bb388c-1517-11ea-6d94-0242ac130033",
"part_number": 1,
"general": {
  "version": 11,
  "type": "srv",
  "method": "files/new_part",
  "debug": true
}
}
Пример ответа
{
"url": "https://backups.example.ru/00/89/2b/85bb388c-1517-11ea-6d94-0242ac130033",
"type": "s3",
"headers": ["x-header-1: value1"],
"general": {
  "response": 10200,
  "error": false,
  "message": "",
  "version": 11,
  "sm_version": "1.0.97.9",
  "sm_timezone": "Europe/Moscow"
}
}

 Вверх

tasks/files/complete_multipart

Завершить составную загрузку файла (метод вызывается только при загрузке файла с типом адреса s3)

ПараметрТипОписаниеПример
Запрос
file_idСтрока переменная (36)Идентификатор файла (полученный в параметре ответа file_id метода files/new_multipart)85bb388c-1517-11ea-6d94-0242ac130033
partsСписок (0..*) строк неограниченной длиныИдентификаторы частей файла (они получаются из HTTP-заголовков Etag ответа при загрузке частей файла)[
"0c78aef83f66abc1fa1e8477f296d394",
"fa1e8477f296d3078aef83c1c78aef83"
]
Ответ (1)
нет параметров
Пример запроса
{
"file_id": "85bb388c-1517-11ea-6d94-0242ac130033",
"parts": [
  "0c78aef83f66abc1fa1e8477f296d394",
  "fa1e8477f296d3078aef83c1c78aef83"
],
"general": {
  "version": 11,
  "type": "srv",
  "method": "files/complete_multipart",
  "debug": true
}
}
Пример ответа
{
"general": {
  "response": 10200,
  "error": false,
  "message": "",
  "version": 11,
  "sm_version": "1.0.97.9",
  "sm_timezone": "Europe/Moscow"
}
}

 Вверх

tasks/files/abort_multipart

Отменить составную загрузку файла

ПараметрТипОписаниеПример
Запрос
file_idСтрока переменная (36)Идентификатор файла (полученный в параметре ответа file_id метода files/new_multipart)85bb388c-1517-11ea-6d94-0242ac130033
Ответ (1)
нет параметров
Пример запроса
{
"file_id": "85bb388c-1517-11ea-6d94-0242ac130033",
"general": {
  "version": 11,
  "type": "srv",
  "method": "files/abort_multipart",
  "debug": true
}
}
Пример ответа
{
"general": {
  "response": 10200,
  "error": false,
  "message": "",
  "version": 11,
  "sm_version": "1.0.97.9",
  "sm_timezone": "Europe/Moscow"
}
}

 Вверх