API / Контекст процесса

Контекст процесса

Описание контекста процесса

Структура, представленная ниже, описывает одну переменную контекста:

{
    "caption": "description_property",
    "name": "name_property",
    "type": "int",
    "isArray": true,
    "scope": "In"
}

Описание контекстной переменной:

Параметр

Тип

Описание

name

string

Название контекстной перменной

caption

string

Описание контекстной переменной

isArray

bool

Контекстная переменная представляет собой массив

type

string

Тип, допустимы следующие значения: bool, datetime, double, file, int, string

scope

string

Вид переменной, допустимы следующие значения: In — входящая, Out — исходящая, InOut — входящая/исходящая

Входящий контекст процесса

Контекст — JSON объект (пример с описанием ниже), где ключ представляет собой название переменной контекста, а значение этого ключа — значение переменной.

{
    "name1": true,
    "name2": [true, false, true],
    "name3": "2020-06-04T03:03:00Z",
    "name4": ["2020-06-04T05:04:00Z","2020-06-04T16:01:24Z"],
    "name5": 12.5,
    "name6": [13.5, 14, 16.7],
    "name7": "http://ELMA_BPM.ru/tr?1",
    "name8": ["http://ELMA_BPM.ru/tr?2", "http://ELMA_BPM.ru/tr?3"],
    "name9": 4,
    "name10": [53, 44, 1408],
    "name11": "Значение 1",
    "name12": ["значение 2", "значение 3"],
}

Ключ

Тип

Массив

name1

bool


name2

bool

name3

datetime


name4

datetime

name5

double


name6

double

name7

file


name8

file

name9

int


name10

int

name11

string


name12

string

Исходящий контекст процесса

Представляет собой JSON объект по аналогии с входящим контекстом с разницей только в переменных типа File.

{
    "name7": "file.doc",
    "name8": ["file1.doc", "file2.doc"],
}

Ключ

Тип

Массив

name7

file


name8

file

Сам файл можно скачать с помощью API получение файла из исходящего контекста выполненной задачи.