URL: /api/v2/scripts/scenario_id

Method: GET

Параметры запросаОписание
scenario_id

Идентификатор сценария

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

{
    "name": string,    // Название сценария
    "description": string,    // описание сценария
    "steps_count": int ,    // количество шагов сценария
    "used_cubes": [
        {
            "name": string,    // Название мультисферы
            "id": string,    // ID мультисферы
            "state": string, // доступность мультисферы для пользователя
            "used_dimensions": [string], // ID используемых размерностей
            "used_facts": [string] // ID используемых фактов
        },
        {
            "name": string,    // Название мультисферы
            "id":  string,    // ID мультисферы
            "state": string, // доступность мультисферы для пользователя
            "used_dimensions": [string], // ID используемых размерностей
            "used_facts": [string] // ID используемых фактов 
        }
    ],
    "owner": string, // автор сценария
    "created_at": 1687872608215997, // временная метка создания
    "updated_at": 1687872608217010, // временная метка обновления
    "played_at": int, // количество воспроизведённых шагов
    "shared": boolean, // наличие пользователей, кому передан этот сценарий
    "has_changes": false, // флаг наличия изменений в сценарии
    "parent": string, // идентификатор родительского сценария
    "path": [string], // путь до сценария
    "access_granted": string // характер доступа к ресурсу
}

available: 

  • true — доступна
  • false — не доступна

shared:

  • true — есть пользователи, которые владеют правами на данный сценарий
  • false — нет пользователей, кому доступен этот сценарий

has_changes:

  • true — были изменения в сценарии
  • false — изменений не было

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

access_granted:

  • "personally" — доступ предоставлен лично или пользователь является создателем ресурса
  • "by_group" — доступ предоставлен через группу
  • "personally_and_by_group" — доступ предоставлен лично и через группу или пользователь является создателем ресурса и входит в группу, которой предоставлен доступ к ресурсу
ОтветыОписание

200

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

Forbidden - текущему пользователю запрещено получать список шагов для данного сценария (например, если нет доступа к сценарию).

404

Not Found - сценарий не найден.

500Internal Server Error - внутренняя ошибка сервера.
  • Нет меток