Advanced Data Operations

Reference

A suite of advanced operations designed to assist in the transformation of bulk datasets.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	State Solutions Support
URL	https://www.statesolutions.com.au/contact-us
Email	support@statesolutions.com.au

Connector Metadata
Publisher	State Solutions
Website	https://www.statesolutions.com.au
Privacy Policy	https://www.statesolutions.com.au/privacy-policy
Categories	Data

The operations offered as a part of this service provides data & integration engineers with the ability to transform bulk datasets from one structure into a another.

Along with the core operations, the framework has custom functions built in which extend the functionality even further again. These added custom functions provide field specific level extensibility that can be applied against the dataset being transformed.

The operations within the framework helps to reduce overhead, such as looping, overuse of inline expressions and other basic data operations, within the developed flows. This results in a more readable and more supportable end product for your organisation and all of this made possible without a single piece of infrastructure required to be invoked from your own organisations perspective.

Prerequisites

You'll need to sign up for a subscription.

One can be obtained by signing up to a paid plan or by activating a trial subscription. Details can be found on our website under the pricing page ... http://www.statesolutions.com.au/pricing/

How to get credentials

As per the previous section, navigate to our pricing page and sign up for the plan that you feel suits your organisation best.

If you sign up for a paid subscription, the process will direct you to enter details relating to yourself and your organisation. You will then be asked to provide credit card information so the monthly (or annual if desired) billing cycle can charge you accordingly.

If you sign up for a trial subscription, you will be asked for nothing more than your name and email address. Your trial subscription limits you to 100 calls with no time limit on when those 100 calls need to be used up.

Your details (email address and product purchased) are used when invoking services on our side to track any and all usage that is required for quota limiting (please note that not all plans have a quota limit).

Get started with your connector

After you've received your subscription and API key, you'll be ready to execute your first call.

Overview - http://www.statesolutions.com.au/overview/

The overview section of of our website explains the basics and more importantly, details the main endpoint that's used to make each API call.

Custom Functions - http://www.statesolutions.com.au/custom-functions/

Not all operations support the use of custom functions but for those that do, you'll want to be across that which is possible given it will give you an immense amount of flexibility when transforming your data.

Supported Operations

'Aggregate' - Aggregate one or more properties by a grouped set of fields within a JSON array dataset.
'Cartesian Join' - Perform a Cartesian join over two or more datasets.
'Concatenate' - Concatenate a field from an array of objects into a single string output.
'Concatenate (Simple)' - Concatenate an array of values into a delimited string.
'C# Evaluate' - Evaluates a C# expression and returns the result.
'C# Script Execute' - Takes in and executes a C# script.
'CSV to JSON' - Transform a comma separated table of data into an array of JSON objects.
'Distinct' - Select a set of distinct property values from an array of objects.
'Distinct (Simple)' - Provide a distinct set of values from an array.
'Expert' - Execute a SQL statement over one or more supplied datasets.
'Flatten Object Array' - Flatten an array of complex, multi-level objects into an array of single level JSON objects.
'Get Data Schema' - Get the schema (i.e. properties and their associated types) from an array of objects.
'GZip Compress' - Compress a stream of text into a GZip archive.
'GZip Decompress' - Decompress a GZip archive into a base64 string.
'Join' - Join exactly two datasets using a left or inner join technique.
'JSON to CSV' - Transform a JSON array of objects into a comma separated table format.
'JSON to Table' - Transform a JSON structure into a tabluar format.
'JSON to Text' - Transform a JSON array of objects into a tab delimited text format.
'JSON Properties to Name/Value Pair Array' - Transforms a JSON structure to an array of name/value pairs.
'JSON Schema Validate' - Validates a JSON object against a JSON schema.
'Levenshtein Distance' - Use the Levenshtein Distance algorithm to calculate a set of ratios for indicating how similar two strings are to each other.
'Parquet to JSON' - Transform a base64 encoded parquet dataset into an array of JSON objects.
'Regex Matches' - Produce a set of matches for a string using a regular expression pattern.
'Sort Object Array' - Sort an array of complex, multi-level objects by one or more properties contained within each item in the array.
'Split' - Split each item of an array into one or more new items by a defined set of criteria.
'Text to JSON' - Transform a tab delimited textual dataset into an array of JSON objects.
'Transform' - Transform a set of properties in a dataset using any of the 100+ custom transformation functions provided by the framework.
'XML to JSON' - Transform an XML structure to JSON using XPath statements and any of the 100+ custom transformation functions provided by the framework.
'Zip Archive Decompress' - Decompress a Zip archive into a list of files with content (if requested).

Known issues and limitations

The service is hosted on Azure cloud infrastructure and like any computing based service is limited when it comes to CPU and memory usage. Therefore, the primary limitation our connector faces is those which fall in line with system resources.

Testing has revealed that payloads should not exceed around 30mb's (+/-) in size for each call being made. This limitation may be resolved in the future but as of right now, the limitation exists and needs to be dealt with from the calling side of the equation.

The way to work around this is to split up your payloads into logical chunks and process those one by one. An example of logical chunks can be taken from financial data, it may be best to split the payloads up by fiscal period, fiscal year or some kind of logical organisational attribute.

Common errors and remedies

'Error 401' : The quota limit for this subscription has been exceeded OR your subscription is not permitted to use this operation.

You have exceeded your quota for the billing period. You'll need to upgrade your subscription or wait until the next billing period. Alternatively, if your quota has not been exceeded, the operation you are attempting to call is not supported by the subscription level you've paid for.

FAQ

You can find an FAQ page on our website ... http://www.statesolutions.com.au/faq

Creating a connection

The connector supports the following authentication types:


Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Advanced Data Operations API Key	securestring	API Key	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Aggregate	Aggregate one or more properties by a grouped set of fields within a JSON array dataset.
C# Evaluate Expression	Evaluates a C# expression and returns the result.
C# Script Execute	Takes in and executes a C# script.
Cartesian Join	Perform a Cartesian join over two or more datasets.
Concatenate	Concatenate a field from an array of objects into a single string output.
Concatenate (Simple)	Concatenate an array of values into a delimited string.
CSV to Json	Transform a comma separated table of data into an array of JSON objects.
Distinct	Select a set of distinct property values from an array of objects.
Distinct (Simple)	Provide a distinct set of values from an array.
Expert	Execute a SQL statement over one or more supplied datasets.
Filter Object Array	Filter an array of complex, multi-level objects by one or more properties contained within each item in the array.
Flatten Object Array	Flatten an array of complex, multi-level objects into an array of single JSON objects.
Get Data Schema	Get the schema (i.e. properties and their associated types) from an array of objects.
GZip Compress	Compress a stream of text into a GZip archive.
GZip Decompress	Decompress a GZip archive into a base64 string.
Join	Join exactly two datasets using a left or inner join technique.
Json Properties to Name Value Pair Array	Transform a JSON structure to name/value pairs.
Json Schema Validate	Validates a JSON schema using more advanced functionality than standard.
Json to CSV	Transform a JSON array of objects into a comma separated table format.
Json to Table	Transform a JSON structure into a tabular format.
Json to Text	Transform a JSON array of objects into a tab delimited text format.
Levenshtein Distance	Use the Levenshtein Distance algorithm to calculate a set of ratios for indicating how similar two strings are to each other.
Parquet to Json	Transform a base64 encoded parquet dataset into an array of JSON objects.
Regex Matches	Produce a set of matches for a string using a regular expression pattern.
Sort Object Array	Sort an array of complex, multi-level objects by one or more properties contained within each item in the array.
Split	Split all objects contained within an array by a defined criteria.
Text to Json	Transform a tab delimited textual dataset into an array of JSON objects.
Transform	Transform a set of properties in a dataset using any of the available custom transformation functions.
Xml to Json	Transform an XML structure to JSON using XPath statements and any of the 100+ custom transformation functions provided by the framework.
Zip Archive Decompress	Decompress a Zip archive into a list of files with content (if requested).

Aggregate

Operation ID:: Aggregate

Aggregate one or more properties by a grouped set of fields within a JSON array dataset.

Parameters

Name	Key	Required	Type	Description
Operation	aggregationType	True	string	The aggregation type.
aggregateBy	aggregateBy	True	array of string
aggregateOn	aggregateOn	True	array of string
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
Data	Data		object

Returns

Name	Path	Type	Description
		array of object
items		object

C# Evaluate Expression

Operation ID:: CSharpEvaluate

Evaluates a C# expression and returns the result.

Parameters

Name	Key	Required	Type	Description
C# Expression	expression	True	string	The C# expression that will be evaluated.

Returns

Evaluated Result

Evaluated Result: object

C# Script Execute

Operation ID:: CSharpScriptExecute

Takes in and executes a C# script.

Parameters

Name	Key	Required	Type	Description
C# Script	script	True	string	The C# script that will be executed.
Class Definitions	classDefinitions		array of string	An array of class definitions that are able to be referenced from the script.
Parameters	parameters		object	Parameters used to pass into and be consumed by the script.

Returns

Script Result

Script Result: object

Cartesian Join

Operation ID:: CartesianJoin

Perform a Cartesian join over two or more datasets.

Parameters

Name	Key	Required	Type	Description
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
Data	data	True	object	Defines multiple datasets by the way of an object with each property value being an array of objects. Each property name is the name of a dataset that is able to be referenced by way of the operation being undertaken.

Returns

Name	Path	Type	Description
		array of object
items		object

Concatenate

Operation ID:: Concatenate

Concatenate a field from an array of objects into a single string output.

Parameters

Name	Key	Required	Type	Description
Field	field	True	string	Field from the source data set to concatenate.
Separator	separator		string	The string used to delimit the resulting concatenated string.
Ignore Empty	ignoreEmpty	True	boolean	Ignore blank/null strings when concatenating.
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
Data	Data		object

Returns

response: string

Concatenate (Simple)

Operation ID:: SimpleConcatenate

Concatenate an array of values into a delimited string.

Parameters

Name	Key	Required	Type	Description
Separator	separator		string	The string used to delimit the resulting concatenated string.
Ignore Empty	ignoreEmpty		boolean	Ignore blank/null strings when concatenating.
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		string	Sorting direction (i.e. ASC or DESC).
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
data	data	True	array of string

Returns

response: string

CSV to Json

Operation ID:: CsvToJson

Transform a comma separated table of data into an array of JSON objects.

Parameters

Name	Key	Required	Type	Description
Header Row	headerRow		boolean	Contains header row
Row Separator	rowSeparator		string	The character(s) separating each row, default = \n
Delimiter	delimiter		string	The character(s) separating each column, default = ,
Escape Character	escapeCharacter		string	The escape character to use when splitting each field, default is double quotes.
Encoding	encoding		string	The encoding of the file content, default = UTF8.
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
Data	data	True	string	Delimited string table

Returns

Name	Path	Type	Description
		array of object
items		object

Distinct

Operation ID:: Distinct

Select a set of distinct property values from an array of objects.

Parameters

Name	Key	Required	Type	Description
Fields	fields	True	array of string	The list of fields to include in the result set. Supports the dynamic field selection syntax.
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
Data	Data		object

Distinct (Simple)

Operation ID:: SimpleDistinct

Provide a distinct set of values from an array.

Parameters

Name	Key	Required	Type	Description
Field	field	True	string	Field to perform the distinct on.
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		string	Sorting direction (i.e. ASC or DESC).
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
Data	Data		object

Expert

Operation ID:: Expert

Execute a SQL statement over one or more supplied datasets.

Parameters

Name	Key	Required	Type	Description
Query String	query	True	string	Fully functioning SELECT statement that refers to and processes the incoming data set.
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
Data	data	True	object	Defines multiple datasets by the way of an object with each property value being an array of objects. Each property name is the name of a dataset that is able to be referenced by way of the operation being undertaken.

Returns

Name	Path	Type	Description
		array of object
items		object

Filter Object Array

Operation ID:: FilterObjectArray

Filter an array of complex, multi-level objects by one or more properties contained within each item in the array.

Parameters

Name	Key	Required	Type	Description
Filter Expression	filter	True	string	Filter expression as defined by the documentation.
Data	Data		object

Returns

Name	Path	Type	Description
		array of object
items		object

Flatten Object Array

Operation ID:: FlattenObjectArray

Flatten an array of complex, multi-level objects into an array of single JSON objects.

Parameters

Name	Key	Required	Type	Description
Delimiter	delimiter	True	string	The string used to delimit each property from the different levels in the object hierarchy.
Balanced Output	balancedOutput	True	boolean	If TRUE, each item in the result set will have the same set of properties, therefore, making it balanced. Filter and Sort Order only work if this is set to TRUE.
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
Data	Data		object

Returns

Name	Path	Type	Description
		array of object
items		object

Get Data Schema

Operation ID:: GetDataSchema

Get the schema (i.e. properties and their associated types) from an array of objects.

Parameters

Name	Key	Type	Description
Filter	filter	string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder	object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema	object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName	string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean	array of string	List of properties in the output that should be treated as boolean values
Data	Data	object

Returns

Name	Path	Type	Description
		array of object
items		object

GZip Compress

Operation ID:: GZipCompress

Compress a stream of text into a GZip archive.

Parameters

Name	Key	Required	Type	Description
Data	data	True	string	The string of data to archive using the GZip format.

Returns

response: string

GZip Decompress

Operation ID:: GZipDecompress

Decompress a GZip archive into a base64 string.

Parameters

Name	Key	Required	Type	Description
Data	data	True	string	A base64 representation of the GZip file to decompress.

Returns

response: string

Join

Operation ID:: Join

Join exactly two datasets using a left or inner join technique.

Parameters

Name	Key	Required	Type	Description
Join Type	joinType	True	string	The join operation to perform.
Join Fields	joinFields	True	array of string	The list of fields to join each table on.
Fields	fields	True	array of string	The list of fields to include in the result set. Supports the dynamic field selection syntax.
Force Fully Qualified Field Names	forceFullyQualifiedFieldNames		boolean	Force all field names in the resulting dataset to be prefixed with the originating dataset name.
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
Data	data	True	object	Defines multiple datasets by the way of an object with each property value being an array of objects. Each property name is the name of a dataset that is able to be referenced by way of the operation being undertaken.

Returns

Name	Path	Type	Description
		array of object
items		object

Json Properties to Name Value Pair Array

Operation ID:: JsonPropertiesToNameValuePairArray

Transform a JSON structure to name/value pairs.

Parameters

Name	Key	Required	Type	Description
JSON Data	data	True		The JSON data to be transformed.

Json Schema Validate

Operation ID:: JsonSchemaValidate

Validates a JSON schema using more advanced functionality than standard.

Parameters

Name	Key	Required	Type	Description
Schema	schema	True	object	The schema that the JSON will be validated against.
JSON Object	data	True	object	JSON object that will be used to validate against the schema.

Returns

Name	Path	Type	Description
		array of string

Json to CSV

Operation ID:: JsonToCsv

Transform a JSON array of objects into a comma separated table format.

Parameters

Name	Key	Type	Description
Header Row	headerRow	boolean	Contains header row
Row Separator	rowSeparator	string	The character(s) separating each row, default = \n
Escape Character	escapeCharacter	string	The escape character for values that contain the field separator value.
Filter	filter	string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder	object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema	object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName	string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean	array of string	List of properties in the output that should be treated as boolean values
Data	Data	object

Returns

response: string

Json to Table

Operation ID:: JsonToTable

Transform a JSON structure into a tabular format.

Parameters

Name	Key	Required	Type	Description
Path	path		string	JToken path used for initial selection (default = $)
Balanced Output	balancedOutput		boolean	If TRUE, each item in the result set will have the same set of properties, therefore, making it balanced.
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
Data	data	True	object	Structured JSON data.

Returns

Name	Path	Type	Description
		array of object
items		object

Json to Text

Operation ID:: JsonToText

Transform a JSON array of objects into a tab delimited text format.

Parameters

Name	Key	Type	Description
Header Row	headerRow	boolean	Contains header row
Row Separator	rowSeparator	string	The character(s) separating each row, default = \n
Filter	filter	string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder	object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema	object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName	string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean	array of string	List of properties in the output that should be treated as boolean values
Data	Data	object

Returns

response: string

Levenshtein Distance

Operation ID:: LevenshteinDistance

Use the Levenshtein Distance algorithm to calculate a set of ratios for indicating how similar two strings are to each other.

Parameters

Name	Key	Required	Type	Description
Base Value	baseValue	True	string	The base value to compare all other values against.
Comparison Values	comparisonValues	True	array of string	The base value to compare all other values against.
Ratio Threshold	ratioThreshold		double	A number between 0 and 100. If left blank, the default value will be 0, i.e. all results are returned.
Ratio Threshold	applyRatioThresholdTo		string	Apply the threshold filter to the maximum ratio returned in the data set or the average of all included.
Ratio Selection Type	ratioSelectionType		string	The type of ratios you want to perform each comparison for.
Token Sort Type	tokenSortType		string	The selection for sorting each word/token prior to comparison or not.
Case Sensitive	caseSensitive		boolean	Run the comparisons in a case sensitive way or not.
Remove Whitespace	removeWhitespace		boolean	Remove or keep all spaces prior to comparison.
Remove Special Characters	removeSpecialCharacters		boolean	Remove or keep all special characters prior to comparison.

Returns

Body: levenshteinDistanceResponse

Parquet to Json

Operation ID:: ParquetToJson

Transform a base64 encoded parquet dataset into an array of JSON objects.

Parameters

Name	Key	Required	Type	Description
Validate Only	validateOnly		boolean	Validate data only, do not return any data.
Skip	skip		integer	The amount of records to SKIP before applying the TAKE parameter.
Take	take		integer	The amount of records to TAKE after the records that were skipped.
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
Data	data	True	string	Base64 encoded string containing contents of a parquet data file.

Returns

Name	Path	Type	Description
		array of object
items		object

Regex Matches

Operation ID:: RegexMatches

Produce a set of matches for a string using a regular expression pattern.

Parameters

Name	Key	Required	Type	Description
Pattern	pattern	True	string	Regular expression pattern.
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
Data	data	True	string	Text to perform the regex pattern over

Returns

Name	Path	Type	Description
		array of string

Sort Object Array

Operation ID:: SortObjectArray

Sort an array of complex, multi-level objects by one or more properties contained within each item in the array.

Parameters

Name	Key	Required	Type	Description
Sort Order	sortOrder	True	object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Data	Data		object

Returns

Name	Path	Type	Description
		array of object
items		object

Split

Operation ID:: Split

Split all objects contained within an array by a defined criteria.

Parameters

Name	Key	Type	Description
Splits	Splits	object
Filter	filter	string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder	object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema	object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName	string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean	array of string	List of properties in the output that should be treated as boolean values
Data	Data	object

Returns

Name	Path	Type	Description
		array of object
items		object

Text to Json

Operation ID:: TextToJson

Transform a tab delimited textual dataset into an array of JSON objects.

Parameters

Name	Key	Required	Type	Description
Header Row	headerRow		boolean	Contains header row
Row Separator	rowSeparator		string	The character(s) separating each row, default = \n
Delimiter	delimiter		string	The character(s) separating each column, default = \t
Encoding	encoding		string	The encoding of the file content, default = UTF8.
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
Data	data	True	string	Delimited string table

Returns

Name	Path	Type	Description
		array of object
items		object

Transform

Operation ID:: Transform

Transform a set of properties in a dataset using any of the available custom transformation functions.

Parameters

Name	Key	Required	Type	Description
Transformations	transformations	True	object	Object containing a source and destination set of mapping transformations.
Preserve All Properties	preserveAllProperties		boolean	If TRUE, all properties not specifically called out in the transformations property will be preserved in the resulting dataset.
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).
Schema	schema		object	Manual schema override to force an incoming field to a specific primitive type.
Culture Name	cultureName		string	Allows the calling application to change the culture so date parsing, etc. produces the correct result.
Boolean Properties	isBoolean		array of string	List of properties in the output that should be treated as boolean values
Data	Data		object

Returns

Name	Path	Type	Description
		array of object
items		object

Xml to Json

Operation ID:: XmlToJson

Transform an XML structure to JSON using XPath statements and any of the 100+ custom transformation functions provided by the framework.

Parameters

Name	Key	Required	Type	Description
Primary Loop at Element	primaryLoopAtElement		string	XPath statement selecting a set of elements to loop over.
Map Object	map		object	Json object containing properties with values that map to source using XPath statements.
Map Name	mapName		string	The name used to distinguished this map from others.
XPath Query	xPathQuery		string	XPath statement selecting a set of elements to loop over.
Map Object	map		object	Json object containing properties with values that map to source using XPath statements.
Data	data	True	string	XML string.

Returns

Name	Path	Type	Description
		array of object
items		object

Zip Archive Decompress

Operation ID:: ZipArchiveDecompress

Decompress a Zip archive into a list of files with content (if requested).

Parameters

Name	Key	Required	Type	Description
Data	data	True	string	A base64 representation of the zip archive to decompress.
Get File Contents	getFileContents	True	boolean	Retrieve the contents of each file?
Filter	filter		string	String based WHERE clause used to filter the returned result set.
Sort Order	sortOrder		object	Object with one or more field names and the sorting direction (i.e. ASC or DESC).

Returns

Name	Path	Type	Description
		array of object
Name	name	string	The name of the file or folder.
Path	path	string	The full path of the file or folder.
Compressed Size	compressedSize	number	The size of the file in its compressed state.
Uncompressed Size	uncompressedSize	number	The size of the file in its uncompressed state.
File Content	fileContent	string	A base64 representation of the file content.

Definitions

levenshteinDistanceResponse

Name	Path	Type
Supplied	BaseValue.Supplied	string
Actual	BaseValue.Actual	string
RatioThreshold	ComparisonSettings.RatioThreshold	double
ApplyRatioThresholdTo	ComparisonSettings.ApplyRatioThresholdTo	string
CaseSensitive	ComparisonSettings.CaseSensitive	boolean
RemoveWhitespace	ComparisonSettings.RemoveWhitespace	boolean
RemoveSpecialCharacters	ComparisonSettings.RemoveSpecialCharacters	boolean
RatioSelectionType	ComparisonSettings.RatioSelectionType	string
TokenSortType	ComparisonSettings.TokenSortType	string
Comparisons	Comparisons	array of object
Supplied	Comparisons.Comparison.Supplied	string
Actual	Comparisons.Comparison.Actual	string
Ratio	Comparisons.Results.Ratio	integer
PartialRatio	Comparisons.Results.PartialRatio	integer
SortedRatio	Comparisons.Results.SortedRatio	integer
SortedPartialRatio	Comparisons.Results.SortedPartialRatio	integer
MaxRatio	Comparisons.Results.MaxRatio	integer
AvgRatio	Comparisons.Results.AvgRatio	double

object

This is the type 'object'.

string

This is the basic data type 'string'.