ELMA RPA > API / Process context

Process context

Process context description

The structure presented below describes one context variable:

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

Context variable description:

Parameter

Type

Description

name

string

Context variable name

caption

string

Context variable description

isArray

bool

Context variable is an array

type

string

Type (accepted values are: bool, datetime, double, file, int, string)

scope

string

Variable scope (accepted values are: In — input, Out — output, InOut — input/output)

Input process context

A context is a JSON object (the example is presented below), which key represents the context variable name. The key value is the value of the variable.

{
    "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": "Value 1",
    "name12": ["value 2", "value 3"],
}

Key

Type

Array

name1

bool


name2

bool

name3

datetime


name4

datetime

name5

double


name6

double

name7

file


name8

file

name9

int


name10

int

name11

string


name12

string

Output process context

It presents a JSON object similar to the input context. The only difference is the File type variables that cannot be found in the input context.

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

Key

Type

Array

name7

file


name8

file

You can download the file using the API get a file from the output context of the completed task.

Found a typo? Highlight the text, press ctrl + enter and notify us