URL: http://Host.port/api/v2/scripts[?parent=:parent_id&name=:scenario_name_filter_text&creator=:user_login&created_since=:created_since_timestamp&created_until=:created_until_timestamp
&updated_since=:updated_since_timestamp&updated_until=:updated_until_timestamp]


Method: GET

Параметры запроса:Описание
parent = 00000000

parent:

  • 00000000 — список сценариев в корне
  • 46a2aab7 — список сценариев по идентификатору папки
name = ""

Текст, по которому осуществляется поиск по вхождению в имя сценария. Заменяет параметр text.

creator = ""

Текст, по которому осуществляется поиск по вхождению в логин создателя сценария. 

created_since = ""

Временная метка. Нижняя граница диапазона искомых дат создания сценария, включительно.

created_until = ""

Временная метка. Верхняя граница диапазона искомых дат создания сценария, включительно.

updated_since = ""

Временная метка. Нижняя граница диапазона искомых дат изменения сценария, включительно.

updated_until = ""

Временная метка. Верхняя граница диапазона искомых дат изменения сценария, включительно.

text = ""

*Текст, по которому осуществляется поиск по вхождению в имя сценария. Параметр оставлен для обратной совместимости. Новый параметр — name. Если в запросе указаны оба параметра, параметр text игнорируется.

Примеры запроса:

api/v2/scripts?created_since=1735188873365115&created_until=1737044646993920


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


    "results": [
        {
            "id": "48f48c88",
            "name": string, //  имя папки
            "owner":  string, // автор папки
            "created_at": 1687973672132441, // временная метка создания
            "updated_at": 1687973672132897, // временная метка изменения
            "all_cubes_available": bool, // флаг доступности всех кубов в сценарии
            "shared": bool, // общий доступ к сценарию
            "path": [string] // путь до сценария 
        },

] }

all_cubes_available:

  • true — доступны все кубы
  • false — недоступна часть кубов


shared: 

  • true — к сценарию есть общий доступ, то есть у сценария более одного владельца
  • false — к сценарию нет общего доступа, то есть у сценария один владелец


path: Если сценарий расположен в корневой папке, то в поле пустое значение. Если сценарий находится в пользовательской папке или нескольких вложенных папках, передается список с названиями папок, начиная от первой, вложенной в корневую, до последней вложенной.  

ОтветыОписание

200

OK — запрос успешно выполнен.
400Bad request — некорректная структура запроса.
401Unauthorized — текущий пользователь не авторизован.
403

Forbidden — текущему пользователю запрещено получать список сценариев в данной родительской папке.

404

Not Found — родительская папка не найдена.

500Internal Server Error — внутренняя ошибка сервера.