ezJSON Plugin

Actions

ezJSON actions

ezJSON Action Reference

Parse a single JSON value

ezJSON_Parse "[Var]" "Field" "[Result]"

Parameter

Type

Description

Var

[variable]

Select a VisualNeoWin variable that contains JSON text

Field

string

Field name to get value from

Result

[variable]

Select a VisualNeoWin variable to store the result value

Parse a single array value from a JSON Array

  ezJSON_GetArray "[Var]" "Field" "[Result]"

Parameter

Type

Description

Var

[variable]

Select a VisualNeoWin variable that contains JSON text

Field

string

Field name to get value from

Result

[variable]

Select a VisualNeoWin variable to store the Array result value

Parse all the JSON values available in a JSON document

  ezJSON_ParseAll "[Var]" "[Result]"

Parameter

Type

Description

Var

[variable]

Select a VisualNeoWin variable that contains JSON text

Result

[variable]

Select a VisualNeoWin variable to store the results

Find all available Arrays in a JSON document

  ezJSON_ListArrays "[Var]" "[Result]"

Parameter

Type

Description

Var

[variable]

Select a VisualNeoWin variable that contains JSON text

Result

[variable]

Select a VisualNeoWin variable to store the results

Find all available JSON paths in a JSON document. Use this to find your field names for parsing.

  ezJSON_PathFinder "[Var]" "[Result]"

Parameter

Type

Description

Var

[variable]

Select a VisualNeoWin variable that contains JSON text

Result

[variable]

Select a VisualNeoWin variable to store the results

Parse a JSON property value with an additional option to delete the leading and trailing brackets "[]". The brackets will be deleted from your JSON source before parsing. The action may also parse an object or array into a JSON value.

  ezJSON_ParseEx "[Var]" "[Result]"

Parameter

Type

Description

Var

[variable]

Select a VisualNeoWin variable that contains JSON text

Result

[variable]

Select a VisualNeoWin variable to store the results

Get a JSON Array item count

ezJSON_ArrayCount "[Var]" "Field" "[Result]"

Parameter

Type

Description

Var

[variable]

Select a VisualNeoWin variable that contains JSON text

Field

string

Array name to get value from

Result

[variable]

Select a VisualNeoWin variable to store the integer result value

Builder API Reference

Initialize Builder, call this first before building your own JSON data.

ezJSON_InitBuilder "[Var]" "Type"

Parameter

Type

Description

Var

[variable]

Select a Variable to store JSON

Type

integer

Element Type. Select Object or Array

Builder function to add an Array item to a JSON Array.

  ezJSON_AddArrayItem "[Var]" "Value" "Type"

Parameter

Type

Description

Var

[variable]

Select an Array Variable to store Array JSON

Value

string

Field contains your value

Type

integer

Element type, one of String, Integer, Boolean, Double or Variable

Builder function to add an Object to JSON..

  ezJSON_AddObjectItem "[Object]" "key" "Value" "Type"

Parameter

Type

Description

Object

[variable]

Select an Object Variable to store Object JSON

key

string

Field name to add to Object

Value

string

The Value of your new Object element

Type

integer

Element type, one of String, Integer, Boolean, Double or Variable

Builder function for advanced use to force your RAW JSON data anywhere. Use with caution!

  ezJSON_AddRawJSON "[JSON]" "RawJSON"

Parameter

Type

Description

JSON

[variable]

Select a JSON Text Variable to store Raw JSON

RawJSON

string

Raw JSON to add

Builder function to beautify JSON.

  ezJSON_FormatJSON "[Var]"

Parameter

Type

Description

Var

[variable]

Select a VisualNeoWin variable that contains JSON text to be formatted.

Delete or Clear a previously initialized Builder Variable

  ezJSON_ReleaseBuilder "[var]" "boolean"

Parameter

Type

Description

var

[variable]

Select a Variable to Delete from Initialized structure or Clear

boolean

string

False or True to save initialized variable

Creates an Array of Object key/value pairs.

  ezJSON_CreateArrayOfObjects "[object]" "name" "key" "value" "type"

Parameter

Type

Description

object

[variable]

Select an Object Variable to store Object JSON

name

string

Object Name Field to add to Object

key

string

Key identifier to add to Object

value

string

The Value of your new Key element

type

integer

Element type, one of String, Integer, Boolean, Double or Variable

Adds an Object key/value pair to an exsting Array of Objects

  ezJSON_AddToArrayOfObjects "[array]" "name" "key" "value" "type"

Parameter

Type

Description

array

[variable]

Select an existing Array of Objects Variable to store Objects JSON

name

string

Object Name Field to add to Object

key

string

Key identifier to add to Object

value

string

The Value of your new Key element

type

integer

Element type, one of String, Integer, Boolean, Double or Variable

Adds an Object key/value pair by JSON property path

  ezJSON_AddObjectByPath "[object]" "path" "key" "value" "type"

Parameter

Type

Description

object

[variable]

Select an existing Array of Objects Variable to store Object JSON

path

string

Path to create new Object at

key

string

Key identifier to add to Object

value

string

The Value of your new Key element

type

integer

Element type, one of String, Integer, Boolean, Double or Variable

Update an Object key/value pair by JSON property path

  ezJSON_UpdateObjectByPath "[object]" "path" "key" "value" "type"

Parameter

Type

Description

object

[variable]

Select an existing Array of Objects Variable to store Object JSON

path

string

Path to update Object at

key

string

Key identifier to update

value

string

The Value to update Key element with

type

integer

Element type, one of String, Integer, Boolean, Double or Variable

Delete an Object key/value pair by JSON property path

  ezJSON_DeleteObjectByPath "[object]" "path" "key"

Parameter

Type

Description

object

[variable]

Select an existing Array of Objects Variable to store Object JSON

path

string

Path to delete Name/Value pair

key

string

Key identifier to delete