Skip to main content

/api/v2/bpm/step​

Универсальный шаговый метод. Самый важный элемент для работы мобильных приложений (процессов) построенных с помощью BPMS

Query Parameters
  • nodeWithTokens boolean

    Если возникнет необходимость в выпуске новых токенов, будут выпущены новые токены + будет добавлен ответный шаг, как если бы запрос уже был с новыми токенами

    Example: false
  • isCastTypes boolean

    Влияет на то, что настройки ноды в ответе будут приходить в соответствии с их типом. Если в параметре не указан тип, это будет строка. Если приведение типа не удается, это будет строка

    Example: false
  • currentScreen boolean

    Когда приложение использует кэширование экрана, оно всегда имеет следующий экран, передаваемый из предыдущих шагов. Если установлено значение true, вместо следующего экрана будет отображаться только его id

    Example: true
  • autoComponents boolean

    Параметр определяет, будет ли информация о компоненте извлекаться во время перехода между экранами. Это значительно замедляет переход. Приложение должно быть настроено на работу с компонентами

    Example: true
  • nextNodes boolean

    Этот параметр определяет, будут ли экраны, следующие за целевым экраном, включены в ответ

    Example: false
Request Body
  • device object

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

  • id string

    Possible values: non-empty and <= 255 characters

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

  • name string

    Possible values: non-empty and <= 255 characters

    Краткое наименование устройства

  • projectId string

    Possible values: non-empty and <= 255 characters

    Несмотря на название поля, пока что здесь фигурирует наименование проекта

  • lang string

    Possible values: non-empty and <= 255 characters

    Наименование языка (en, ru и т.д)

  • screenId int64

    ID текущего экрана (ноды типа 'экран') необходим для позиционирования действия пользователя

  • destination string

    Possible values: non-empty and <= 255 characters

    Поле, содержащее команду для осуществления перехода. Принимает два значения: 'next' и 'previous'. Этот параметр используется, когда отсутствует элемент и идентификатор события, в этом случае метод будет проверять переходы, которые не связаны с конкретными элементами

  • eventId int64

    ID события, которое может является триггером для выполнения перехода

  • elementId int64

    ID любого элемента экрана (ноды типа 'поле'). Используется, если событие на экране относится к определенному элементу и содержит действие 'goto'

  • fastEnter boolean

    Флаг свидетельствует о состоянии сессии. Будет ли осуществлен быстрый вход в приложение или придется начать со стартового экрана. Подробности в разделе 'step'

  • nodeData object

    Объект содержащий данные необходимые для передачи на сервер, например, данные с экрана пользователя. Данные с ключей будут сохранены в одноименных пользовательских переменных

Responses

OK

Schema
  • object
Loading...