-
activate
Activate Task Worker
POST /workflow_engine/activateActivate Task Worker
-
addDuration
Add duration to time
No Northbound API AvailableAdds duration to a time and returns a new time.
-
arrayConcat
Concatenates arrays together.
No Northbound API AvailableUsed to merge two arrays
-
arrayIncludes
Finds if an array contains an element.
No Northbound API AvailableDetermines whether an array includes a certain element, returning true or false as appropriate.
-
arrayIndexOf
Finds the starting index of an element.
No Northbound API AvailableReturns the first index at which a given element can be found in the array, or -1 if it is not present.
-
arrayLastIndexOf
Searches the array for the last index of an element.
No Northbound API AvailableReturns the last index at which a given element can be found in the array, or -1 if it is not present. The array is searched backwards, starting at fromIndex.
-
arrayLength
Gets the length of an array.
No Northbound API AvailableReturns the number of elements in that array. The value is an unsigned, 32-bit integer that is always numerically greater than the highest index in the array.
-
arrayPop
Removes the last element.
No Northbound API AvailableRemoves the last element from an array and returns the new array with an element removed. This method changes the length of the array.
-
arrayPush
Adds an element to the end of the array.
No Northbound API AvailableAdds one element to the end of an array and returns the (newly modified) array.
-
arrayShift
Shifts the array by one.
No Northbound API AvailableRemoves the first element from an array. This method changes the length of the array.
-
arraySlice
Slices the array and returns the sliced portion.
No Northbound API AvailableReturns a shallow copy of a portion of an array into a new array object selected from begin to end(end not included). The original array will not be modified.
-
arrayToLocaleString
Converts an array to a locale string.
No Northbound API AvailableReturns a string representing the elements of the array.
-
arrayToString
Converts the array to a string.
No Northbound API AvailableReturns a string representing the specified array and its elements.
-
asciiToBase64
ASCII to Base64
No Northbound API AvailableConvert ASCII to Base64
-
assign
Copies an object and assigns new properties.
No Northbound API AvailableCopies the values of all enumerable own properties from one source object to a target object. It will return the target object.
-
base64ToAscii
Base64 to ASCII
No Northbound API AvailableConvert Base64 to ASCII
-
calculateTimeDiff
Calculate time difference
No Northbound API AvailableSubtracts the difference between two given times and returns the result between them as a duration.
-
charAt
Gets the character at a given index.
No Northbound API AvailableReturns a new string of a single UTF-16 code unit located at the specified offset in the string.
-
charCodeAt
Gets UTF-16 code of a string at an index.
No Northbound API AvailableReturns an integer between 0 and 65535 representing the UTF-16 code unit at the given index.
-
checkWorkflowForJobVariables
Get job variables of a workflow
GET /workflow_engine/workflows/variables/:nameGet job variables of a workflow by workflow name.
-
childJob
Run Child Job
No Northbound API AvailableRuns a child job inside a workflow.
-
codePointAt
Gets Unicode value of a character in a string.
No Northbound API AvailableReturns a non-negative integer that is the Unicode code point value.
-
convertEpochToObject
Convert epoch to object
No Northbound API AvailableConverts an epoch time to object
-
convertTimeFormat
Convert time format
No Northbound API AvailableConverts an input time to a new format. Can be used to extract more complex sets of information than extractField
-
convertTimeToEpoch
Convert time to epoch
No Northbound API AvailableConverts time to epoch
-
convertTimezone
Convert timezone
No Northbound API AvailableChanges the timezone of a time
-
copyWithin
Copies part of an array within the same array.
No Northbound API AvailableShallow copies part of an array to another location in the same array and returns it, without modifying its size.
-
csvStringToJson
CSV String to JSON
No Northbound API AvailableConvert a CSV String to JSON
-
deactivate
Deactivate Task Worker
POST /workflow_engine/deactivateDeactivate Task Worker
-
decision
Decide branch path
No Northbound API AvailableDecide branch path
-
deepmerge
Deep Merge Data
No Northbound API AvailableMerge data using extend
-
delay
Delay a Job
No Northbound API AvailableDelay a Job for a duration by Job ID and number of seconds.
-
endsWith
If one string is included at the end of another.
No Northbound API AvailableDetermines whether a string ends with the characters of a specified string.
-
ErrorHandling
Error Handling (manual workflow task)
/workflow_engine/task/ErrorHandlingDo error handling within a workflow
-
evaluation
Run Evaluation Task
No Northbound API AvailableRun an evaluation
-
eventListenerJob
Job Event Listener
No Northbound API AvailableWaits for an event that matches the topic and schema, can use job variables.
-
excelToJson
Excel to JSON
No Northbound API AvailableConvert an encoded Base64 Excel file to JSON
-
extractField
Extract time field
No Northbound API AvailableExtracts the day, month, year, or other field from a given time
-
fill
Fills part of an array with a value.
No Northbound API AvailableFills all the elements of an array from a start index to an end index with a static value.
-
FlattenJSONFormInput
Flatten JSON Form Input
No Northbound API AvailableUsed to convert key values of arrays with a single value into simple key value pairs
-
forEach
For Each Loop
No Northbound API AvailableIterate over each item in an array
-
getJobMetrics
Get aggregate job metrics
GET /workflow_engine/jobs/metricsSearch aggregate job metrics with options
-
getTaskDetails
Get Task Details
GET /workflow_engine/locations/:location/packages/:pckg/tasks/:methodGet the detailed information model for a task
-
getTaskMetrics
Get aggregate task metrics
GET /workflow_engine/tasks/metricsSearch aggregate task metrics with options
-
getTime
Get time
No Northbound API AvailableGets the current time with an optional offset, timezone shift, and format string
-
getWorkflowsDetailedByName
Get Details of a Workflow
GET /workflow_engine/workflows/detailed/:nameGet the details of a Workflow by Workflow name.
-
isActive
Check Staterator State
GET /workflow_engine/activeCheck if Staterator is currently active
-
isArray
Checks if the input is an array.
No Northbound API AvailableReturns a boolean that indicates if the input element is an array.
-
join
Joins all elements in an array.
No Northbound API AvailableJoins all elements of an array (or an array-like object) into a string and returns this string.
-
keys
Gets the keys of an object.
No Northbound API AvailableReturns an array of a given object's property names, in the same order as we get with a normal loop.
-
localeCompare
Compares two strings.
No Northbound API AvailableReturns a number indicating whether a reference string comes before or after or is the same as the given string in sort order.
-
makeData
Convert input into a different data type
No Northbound API AvailableThis task takes an input and converts it to a different data type. For example, converting a number into a string.
-
map
Map
No Northbound API AvailableMap input to an array of values
-
match
Finds regex matches in a string.
No Northbound API AvailableRetrieves the matches when matching a string against a regular expression.
-
merge
Merge Data
No Northbound API AvailableMerge data into a single object
-
modify
Modify Data
No Northbound API AvailableModify data
-
newVariable
Create a Job Variable
No Northbound API AvailableCreate a new Job variable by Job ID and assign it a value.
-
normalize
Normalizes a string.
No Northbound API AvailableReturns the Unicode Normalization Form of a given string.
-
numberToString
Convert number to string.
No Northbound API AvailableReturns a string representing the specified Number object.
-
objectHasOwnProperty
Determines whether an object has a property.
No Northbound API AvailableReturns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).
-
objectToString
Converts a valid JSON value to a string.
No Northbound API AvailableConverts a valid JSON value to a JSON string, optionally replacing values if a replacer function is specified or optionally including only the specified properties if a replacer array is specified.
-
padEnd
Pads the end of a string with another string.
No Northbound API AvailablePads the current string with a given string (repeated, if needed) so that the resulting string reaches a given length. The padding is applied from the end of the current string.
-
padStart
Pads the start of a string with another string.
No Northbound API AvailablePads the current string with a given string (repeated, if needed) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string.
-
parse
Parses a string to create an object.
No Northbound API AvailableParses a JSON string, constructing the JavaScript value or object described by the string.
-
parseInt
Converts a string to an integer.
No Northbound API AvailableParses a string argument and returns an integer of the specified radix or base.
-
pop
Array Pop
No Northbound API AvailablePop off the end data item from a job variable array
-
push
Push Item to Array
No Northbound API AvailablePush item to a job variable array
-
query
Query Data Using 'json-query' Format
POST /workflow_engine/queryQuery data using a dot/bracket notation string and a matching key/value pair.
-
repeat
Copies a string a specified number times.
No Northbound API AvailableConstructs and returns a new string which contains the specified number of copies of the string on which it was called, concatenated together.
-
replace
Replaces a string with another string.
No Northbound API AvailableReturns a new string with some or all matches of a pattern replaced by a replacement. The pattern can be a string or a RegExp, and the replacement can be a string or a function to be called for each match (function type not supported in workflow engine).
-
restCall
REST Call
No Northbound API AvailableExecute a REST call
-
reverse
Reverses the array.
No Northbound API AvailableReverses an array in place. The first array element becomes the last, and the last array element becomes the first.
-
runEvaluationGroup
Evaluation
POST /workflow_engine/runEvaluationGroupRun a test evaluation.
-
runEvaluationGroups
Evaluation Group
POST /workflow_engine/runEvaluationGroupsRun a test evaluation group.
-
runValidation
Validate a workflow
POST /workflow_engine/workflows/validateValidate a workflow, and return the resulting errors and warnings arrays.
-
search
Searches for matches in a string.
No Northbound API AvailableSearches for a match between a regular expression and this String object.
-
searchWorkflows
Search Workflows
POST /workflow_engine/workflows/searchSearch Workflows with Options
-
setObjectKey
Set Object Key
No Northbound API AvailableSet an object key
-
shift
Array Shift
No Northbound API AvailableShift off the top data item from a job variable array
-
sort
Sort
No Northbound API AvailableSort input
-
split
Splits a string into an array of substrings
No Northbound API AvailableSplits a string into an array of strings by separating the string into substrings, using a specified separator string to determine where to make each split.
-
startsWith
Determines if string starts with another string.
No Northbound API AvailableDetermines whether a string begins with the characters of a specified string, returning true or false
-
stringConcat
Concatenates strings together.
No Northbound API AvailableConcatenates a string with a second string(s). The second parameter can be a string or array.
-
stringIncludes
Finds whether one string is included within another.
No Northbound API AvailableDetermines whether one string can be found within another string, returning true or false
-
stringIndexOf
Gets index of first string value within another.
No Northbound API AvailableReturns the index within the first argument, str, of the first occurrence of the specified value, starting the search at fromIndex. Returns -1 if value not found
-
stringLastIndexOf
Last index of string value within a string.
No Northbound API AvailableReturns the index within the str of the last occurrence of the specified value, searching backwards from fromIndex.
-
stringLength
Gets the length of a string.
No Northbound API AvailableReturns the length of a string, in UTF-16 code units.
-
stringSlice
Extracts part of a string.
No Northbound API AvailableExtracts a section of a string and returns it as a new string, without modifying the original string.
-
stringValueOf
Returns the primitive string.
No Northbound API AvailableReturns the primitive value of a String object.
-
stub
Stub
No Northbound API AvailableCreate a stub for an automated task
-
substring
Gets a substring using specified indices.
No Northbound API AvailableReturns the part of the string between the start and end indexes, or to the end of the string.
-
toLocaleLowerCase
Converts a string to locale lower case.
No Northbound API AvailableReturns the calling string value converted to lower case, according to any locale-specific case mappings.
-
toLocaleUpperCase
Converts a string to locale upper case.
No Northbound API AvailableReturns the calling string value converted to upper case, according to any locale-specific case mappings.
-
toLowerCase
Converts a string to lower case.
No Northbound API AvailableReturns the calling string value converted to lower case.
-
toUpperCase
Converts a string to upper case.
No Northbound API AvailableReturns the calling string value converted to upper case.
-
transformation
JSON Transformation
No Northbound API AvailablePerform a JSON Transformation using the JST library.
-
trim
Removes whitespace.
No Northbound API AvailableRemoves whitespace from both ends of a string.
-
trimEnd
Removes whitespace from the right.
No Northbound API AvailableRemoves whitespace from the end of a string.
-
trimStart
Removes whitespace from the left.
No Northbound API AvailableRemoves whitespace from the beginning of a string.
-
unshift
Adds an element to the front of an array.
No Northbound API AvailableAdds one element to the beginning of an array.
-
updateJobDescription
Update Job Description
No Northbound API AvailableOverwrite the job description with a new one
-
validateJsonSchema
Validate JSON data with schema.
No Northbound API AvailablePerform a JSON Schema validation.
-
values
Gets the values of keys in an object.
No Northbound API AvailableReturns an array of a given object's own enumerable property values, in the same order as that provided by a for...in loop (the difference being that a for-in loop enumerates properties in the prototype chain as well).
-
ViewData
Display Message with Data (manual workflow task)
/workflow_engine/task/ViewDataDisplays a message and runtime data to an operator. This can be used to request a decision, or used for acknowledgement only.
-
ViewDiff
View Diff (manual workflow task)
/workflow_engine/task/ViewDiffView diff in a pretty format
-
ViewHTML
Display Dialog with HTML contents (manual workflow task)
/workflow_engine/task/ViewHTMLDisplays HTML.
2021.2 (latest)
- API REFERENCE
- USER
- ADMIN
- DEVELOPER
- PRODUCT NOTICES