API в скриптах

API предоставляет пользователям возможность работать программными средствами с объектами доменов. Для использования API при работе с объектами доменов используется пакет SDK @playbooks/sdk. Он содержит клиенты для работы со следующими ресурсами:

объекты доменов и счетчики счетчики (cms);
активные списки (activeList);
схемы автоматизации (calculation);
конфигурации (configuration);
переменные (variable);
данные пользователей, ролей и организаций;
автоматизации;
отчеты и шаблоны отчетов.

С помощью API можно также получить информацию о пользователе, который запустил скрипт или плейбук, либо отменил его выполнение. Если скрипт или плейбук был запущен с помощью триггера по событию, доступны данные контекста этого триггера.

Вызовы API осуществляются через скрипт, написанный на языке TypeScript или Python.

Работа с контекстом автоматизации

Если скрипт или плейбук запускается через автоматизацию с триггером по наступлению события аудита, внутри скрипта можно получить контекст этой автоматизации. Контекстом автоматизации служит информация из поля data события аудита.

Функция получения контекста

get_context()

Примеры получения контекста

Пример скрипта с get_context в TypeScript

id: get_context_deno
name: Получение контекста в Deno
version: 0.0.1
type: script
source: !deno |
  export async function main() {
    const ctx = get_context();
    console.log(ctx);
  }

Пример скрипта с get_context в Python

id: get_context_py
name: Получение контекста в Python
version: 0.0.1
type: script
source: !py |
    def main():
      ctx = get_context()
      print(ctx)

Отображение ошибок при работе с пакетом SDK

Ранее при запуске любого метода система возвращала информацию об объекте в виде полей, упакованных в структуру Rust. Теперь система возвращает непосредственно информацию о данных объекта. Возможную ошибку, возвращаемую методом, можно перехватить c помощью стандартной конструкции TypeScript try…catch.

Была ли полезна эта страница?