Encodian - Utilities
Extensive collection of features covering security, array manipulation, data validation + more
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 | Standard | 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 | Standard | 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 | Encodian Support |
URL | https://support.encodian.com |
support@encodian.com |
Connector Metadata | |
---|---|
Publisher | Encodian |
Website | https://www.encodian.com |
Privacy policy | https://support.encodian.com/hc/en-gb/articles/360010885513-Privacy-Policy |
Categories | Content and Files;Collaboration |
The 'Encodian Flowr Utilities' connector provides a collection of enterprise grade and simple to use Power Automate actions covering security, array manipulation, data validation + more
The Encodian 'Flowr' Utilities connector is supported by Power Automate, Azure Logic Apps and Power Apps.
An Encodian subscription is required to use the Encodian 'Flowr' Utilities connector.
Complete the sign-up form to register for a 30-day trial and obtain an API Key
Click here for a step by step guide on how to create an Encodian connection in Power Automate
Contact Encodian Support to request assistance
Encodian utility action documentation can be found here, and example flows can be found here
Visit Encodian website for subscription plan pricing.
Once your 30-day trial expires, your Encodian subscription is automatically transitioned to Encodian's 'Free' subscription tier unless a paid plan has been purchased.
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
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 |
---|---|---|---|
API Key | securestring | Get an API Key - https://www.encodian.com/apikey/ | True |
Region | string |
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Decrypts an AES encrypted string using AES decryption - https://support.encodian.com/hc/en-gb/articles/13200819253660
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The cipher (string) to decrypt |
Input Type
|
inputDataEncodingMethod | True | string |
Set the data format of the encrypted string |
Key
|
key | True | string |
Set the key (secret) used within the algorithm |
Mode
|
mode | True | string |
Set the AES encryption algorithm |
Initialization Vector
|
initializationVector | string |
Optional - The 'Initialization Vector' should only be provided when the mode is set to 'CBC' or 'CFB' |
|
Padding
|
padding | string |
Sets the padding mode used in the symmetric algorithm, default is PKCS7 |
Returns
Encrypts a plain text value (string) using AES encryption - https://support.encodian.com/hc/en-gb/articles/13200698504860
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The input string to encrypt |
Output Type
|
outputDataEncodingMethod | True | string |
Set the data format of the encrypted string |
Key
|
key | True | string |
Set the key (secret) used within the algorithm |
Mode
|
mode | True | string |
Set the AES encryption algorithm |
Initialization Vector
|
initializationVector | string |
Optional - The 'Initialization Vector' should only be provided when the mode is set to 'CBC' or 'CFB' |
|
Padding
|
padding | string |
Sets the padding mode used in the symmetric algorithm, default is PKCS7 |
Returns
Add one or more items to the array provided - https://support.encodian.com/hc/en-gb/articles/10565757970332
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The JSON array or object to modify |
Items
|
items | True | string |
The items to add to the 'Data' provided |
Item Position
|
itemPosition | True | string |
Set whether to return the first item, last item or a specified item |
Item Index
|
itemIndex | integer |
Index of the item to return. This is only applicable when the 'Item Position' property is set to 'Specific' |
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Checks if a value is contained within the array provided - https://support.encodian.com/hc/en-gb/articles/10242960376476
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The JSON data to evaluate |
Value
|
value | True | string |
The value to check is contained within the array |
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
|
Ignore Case
|
ignoreCase | boolean |
Set whether text case should be ignored when searching the array |
Returns
Count the items contained within the array provided - https://support.encodian.com/hc/en-gb/articles/10284117199004
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The JSON array or object to evaluate |
Path
|
path | string |
Select a specific node using a JSONPath expression |
Returns
Filter items from a JSON Array - https://support.encodian.com/hc/en-gb/articles/14460654575900
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The JSON data to filter |
Keywords
|
keywords | True | string |
A comma-separated list of keywords used to filter the JSON data provided |
Match Type
|
matchType | True | string |
Set how items should be filtered using the keywords provided |
Ignore Case
|
ignoreCase | boolean |
Set whether text case should be ignored when filtering items |
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Filter items from a JSON Array using a Regular Expression - https://support.encodian.com/hc/en-gb/articles/14610830128796/
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The JSON data to filter |
Regex
|
regex | True | string |
The regular expression used to find and filter matches in the 'Data' provided |
Match Type
|
matchType | True | string |
Set how items should be filtered using the keywords provided |
Ignore Case
|
ignoreCase | boolean |
Set whether text case should be ignored when filtering items |
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Get the specified item(s) from the JSON array(s) provided - https://support.encodian.com/hc/en-gb/articles/10564816481564
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The JSON array or object to evaluate |
Item Position
|
itemPosition | True | string |
Set whether to return the first item, last item or a specified item |
Item Index
|
itemIndex | integer |
Index of the item to return. This is only applicable when the 'Item Position' property is set to 'Specific' |
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Remove duplicates from the array provided - https://support.encodian.com/hc/en-gb/articles/10614334072476
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The JSON data to modify |
Ignore Case
|
ignoreCase | True | boolean |
Set whether the text case should be ignored when searching for duplicates |
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Remove one or more items from the array provided - https://support.encodian.com/hc/en-gb/articles/10597605184028
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The JSON data to modify |
Item Position
|
itemPosition | True | string |
Set whether to remove the first item, last item or a specified item |
Item Index
|
itemIndex | integer |
Index of the item to remove. This is only applicable when the 'Item Position' property is set to 'Specific' |
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Remove items from a JSON Array using a Regular Expression - https://support.encodian.com/hc/en-gb/articles/11196894053020
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The JSON data to modify |
Regex
|
regex | True | string |
The regular expression used to find matches in the 'Data' |
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Replaces an array or specified item with the value provided - https://support.encodian.com/hc/en-gb/articles/10624152774812
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The JSON data to modify |
Search Value
|
searchValue | string |
The value to locate and replace with the 'Replacement Value', a blank value is treated as white-space |
|
Replacement Value
|
replacementValue | string |
The value to replace the matched values with, a blank value will remove the matched values |
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Reverse the items in the JSON array provided - https://support.encodian.com/hc/en-gb/articles/9993904693660
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The JSON data to modify |
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Sort the items in the JSON array provided - https://support.encodian.com/hc/en-gb/articles/14510233816092
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The JSON array or object to evaluate |
Sort Type
|
sortType | string |
Set whether the data should be sorted numerically or alphabetically |
|
Sort Order
|
sortOrder | string |
Set whether the data should be sorted in Ascending or Descending order |
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Split the Array provided by match value or index - https://support.encodian.com/hc/en-gb/articles/14508988206108
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The JSON data to modify |
Split Value
|
splitValue | string |
Optional - Search the array for and split on the value provided |
|
Item Index
|
itemIndex | integer |
Optional - Set the 'Index' of the item to split on |
|
Ignore Case
|
ignoreCase | boolean |
Set whether the text case should be ignored when executing the split |
|
Path
|
path | string |
Select a specific node within the 'Data' using a JSONPath expression |
Returns
Convert an array to a named JSON object - https://support.encodian.com/hc/en-gb/articles/12731808723612
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
An array or a JSON object to select an array for conversion to a named JSON object |
Name
|
name | True | string |
The JSON node name to contain the array provided or selected |
Path
|
path | string |
Select a specific array within the 'Data' using a JSONPath expression |
Returns
Convert an array to a XML Object - https://support.encodian.com/hc/en-gb/articles/13964382131484
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
An array or a JSON object to select an array for conversion to a XML object |
Root Name
|
root | True | string |
The name of the root XML node |
Item Name
|
item | True | string |
The name of the item node XML for each array item |
Path
|
path | string |
Select a specific array within the 'Data' using a JSONPath expression |
Returns
Calculate a date value by adding or subtracting a given period of time - https://support.encodian.com/hc/en-gb/articles/11311253860508
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Date
|
date | True | string |
The date value to calculate |
Measurement
|
measurement | True | string |
Set the time measurement used for the calculation |
Operation
|
operation | True | string |
Set the operation type, either add or subtract |
Interval
|
interval | True | integer |
Set amount of time to add or subtract from the 'Date' value provided |
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Remove invalid or specified characters from the text value provided - https://support.encodian.com/hc/en-gb/articles/10072015106077
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
The text value to process |
Remove Character Set
|
removeCharacterSet | string |
Set the collection of characters to remove from the text value provided |
|
Remove Control Characters
|
removeControlChars | boolean |
Set whether to remove control characters from the text value |
|
Remove Invalid Filename Characters
|
removeInvalidFileNameChars | boolean |
Set whether to remove characters that are invalid in file names from the text value |
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the processed text value |
Returns
Compare the text values provided - https://support.encodian.com/hc/en-gb/articles/11782390540957
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Primary Text
|
primaryText | True | string |
The first text value to compare |
Secondary Text
|
secondaryText | True | string |
The second text value to compare |
Ignore Case
|
ignoreCase | boolean |
Set whether text case should be ignored when comparing the text values provided |
Returns
Concatenate text values provided - https://support.encodian.com/hc/en-gb/articles/11873576674077
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text Values
|
textList | array of string |
The array of text values to concatenate |
|
Delimiter
|
delimiter | string |
The delimiter to place between the concatenated text values |
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the processed text value |
Returns
Convert the JSON provided to XML - https://support.encodian.com/hc/en-gb/articles/14125966342428
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
JSON
|
json | True | string |
The JSON to convert to XML |
Root Name
|
rootName | string |
Set the name of the the 'Root' XML element |
|
Include Array Attribute
|
includeArrayAttribute | boolean |
Set whether to include an array attribute for collections |
Returns
Convert the date and time value provided to another time zone - https://support.encodian.com/hc/en-gb/articles/11316002119196
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Date
|
date | True | string |
The date and time value to convert |
Current Time Zone
|
currentTimeZone | string |
Set the current time zone |
|
New Time Zone
|
newTimeZone | True | string |
Set the new time zone |
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
Returns
Convert the XML provided to JSON - https://support.encodian.com/hc/en-gb/articles/14125831121948
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
XML
|
xml | True | string |
The XML to convert to JSON |
Omit Root Object
|
omitRootObject | boolean |
Set whether the root object should be omitted |
Returns
Generate a new GUID - https://support.encodian.com/hc/en-gb/articles/9563119917597
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Case
|
case | True | string |
Set the case of the GUID (Lower or Upper) |
Returns
Create a hashcode for the string provided - https://support.encodian.com/hc/en-gb/articles/360013996077-Create-Hash-Code
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
Provide the input data to be computed |
Data Type
|
cryptoInputDataType | string |
Set the data format for the input data provided. |
|
Digest Algorithm
|
digestAlgorithm | True | string |
Select the message digest algorithm |
Output Type
|
cryptoOutputDataType | string |
Set the data format for the hash code generated. |
|
Case
|
case | string |
Set the case applied to the computed value. |
|
Encoding Type
|
encoding | string |
Select the encoding type. |
Returns
Create a Hash-based message authentication code (HMAC) using a secret key - https://support.encodian.com/hc/en-gb/articles/360012782058-Create-HMAC
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | string |
Provide the input data to be computed |
|
Data Type
|
cryptoInputDataType | string |
Set the data format for the input data provided. |
|
Key
|
key | True | string |
Provide the key (secret) used to compute the hash-based message authentication code (HMAC) |
Key Type
|
cryptoKeyDataType | string |
Set the data format for the key provided. |
|
Digest Algorithm
|
digestAlgorithm | True | string |
Select the message digest algorithm |
Output Type
|
cryptoOutputDataType | string |
Set the data format for the HMAC generated |
|
Case
|
case | string |
Set the case applied to the computed value. |
|
Encoding Type
|
encoding | string |
Select the encoding type. |
Returns
Create a JSON Web Token (JWT) - https://support.encodian.com/hc/en-gb/articles/14501991985564
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Claims
|
claims | string |
Set the 'Claims' to be added to the JWT |
|
Algorithm
|
securityAlgorithm | True | string |
Set the JWT security algorithm to use: HmacSha*, RsaSha*, Es* |
Key
|
key | True | string |
Set the JWT key to be used within the selected algorithm |
Issuer
|
issuer | string |
The issuer of the JWT |
|
Subject
|
subject | string |
The subject of the JWT (the user) |
|
Audience
|
audience | string |
The recipient for which the JWT is intended |
|
Expiration Time
|
expirationTime | integer |
The time after which the JWT expires (Unix TimeStamp) |
|
Before Time
|
notBeforeTime | integer |
The time before which the JWT must not be accepted for processing (Unix TimeStamp) |
|
IssuedTime
|
issuedAtTime | integer |
The time at which the JWT was issued; can be used to determine age of the JWT (Unix TimeStamp) |
|
Unique Identifier
|
uniqueIdentifier | string |
The unique identifier; can be used to prevent the JWT from being replayed (allows a token to be used only once) |
Returns
- Body
- DtoResponseCreateJwt
Escape the HTML value provided - https://support.encodian.com/hc/en-gb/articles/11749992433437
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
HTML
|
html | True | string |
The HTML value to process |
Returns
Extract email addresses from the text value provided - https://support.encodian.com/hc/en-gb/articles/10068475924253
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
The text from which email addresses are to be extracted |
Regex
|
regex | True | string |
The default regular expression used for extraction |
Returns
Extract text from a string between the two values provided - https://support.encodian.com/hc/en-gb/articles/9604938273565
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
The text from which a value is to be extracted |
Start Value
|
startValue | string |
The text value to start the extraction from |
|
End Value
|
endValue | string |
The text value to end the extraction from |
|
Ignore Case
|
ignoreCase | boolean |
Set whether the text case should be ignored when executing the extraction |
|
Include Values
|
includeValues | string |
Set whether any or both of the 'Start Value' and 'End Value' should be included within the result |
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the extracted string |
Returns
Extract all text instances from a string between the two values provided - https://support.encodian.com/hc/en-gb/articles/11193212526108
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
The text from which values are to be extracted |
Start Value
|
startValue | string |
The text value to start an extraction from |
|
End Value
|
endValue | string |
The text value to end an extraction from |
|
Ignore Case
|
ignoreCase | boolean |
Set whether the text case should be ignored when executing an extraction |
|
Include Values
|
includeValues | string |
Set whether any or both of the 'Start Value' and 'End Value' should be included within extracted text |
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the extracted text |
|
Remove Empty Values
|
removeEmptyValues | boolean |
Set whether to remove empty or null strings from the result array if present |
Returns
Extract URL's from the text value provided - https://support.encodian.com/hc/en-gb/articles/11056297407261
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
The text from which URL's are to be extracted |
Regex
|
regex | True | string |
The default regular expression used for extraction |
Returns
Format the date value to the format configuration selected - https://support.encodian.com/hc/en-gb/articles/11053469626525
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Date
|
date | True | string |
The date value to format |
Format
|
format | True | string |
Set the date format - https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings |
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Set the case of the text (string) provided - https://support.encodian.com/hc/en-gb/articles/11009856518557
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
The text value to format |
Action
|
action | True | string |
The formatting action to apply to the text value provided |
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Create a password conforming to the specified configuration - https://support.encodian.com/hc/en-gb/articles/10720449877789
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Length
|
length | True | integer |
Set the length of the password |
Include Lower Case
|
includeLowerCase | boolean |
Set whether lower case characters should be included within the password |
|
Include Upper Case
|
includeUpperCase | boolean |
Set whether upper case characters should be included within the password |
|
Include Numbers
|
includeNumbers | boolean |
Set whether numbers should be included within the password |
|
Include Symbols
|
includeSymbols | boolean |
Set whether symbols should be included within the password |
|
Exclude Characters
|
excludeCharacters | string |
Specify a list of characters to exclude from the password |
Returns
Generate a random number conforming to the configuration supplied - https://support.encodian.com/hc/en-gb/articles/10641115110045
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Minimum Value
|
minValue | integer |
Optional - Set the minimum value of the number generated |
|
Maximum Value
|
maxValue | integer |
Optional - Set the maximum value of the number generated |
Returns
Calculate the difference between two dates and times - https://support.encodian.com/hc/en-gb/articles/11753070117661
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Start Date
|
startDateTime | True | string |
Start date (and optionally time) of the period to be calculated |
End Date
|
endDateTime | True | string |
End date (and optionally time) of the period to be calculated |
Interval
|
interval | True | string |
The interval to calculate - Year, Quarter, Month, Week, Day, Hour, Minute, Second, Millisecond |
Days to Exclude
|
daysToExclude | string |
Specify the days to be excluded from the calculation as a comma-delimited list, for example: Saturday, Sunday |
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
Returns
Get the File Extension for the filaname provided - https://support.encodian.com/hc/en-gb/articles/10931474896797
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Filename
|
fileName | True | string |
The filename to obtain a file extension from |
Case
|
case | string |
Set the case of the extracted file extension value (Lower or Upper) |
Returns
Parse a table contained within the HTML provided to JSON - https://support.encodian.com/hc/en-gb/articles/11505625014685
Parameters
)Name | Key | Required | Type | Description | |
---|---|---|---|---|---|
File Content
|
fileContent | byte |
Optional - The file content of the source HTML file. |
||
HTML Data
|
html | string |
Optional - The HTML to be parsed |
||
Table Index
|
tableIndex | integer |
Set the index of the HTML table to parse, when more than one table is present within the HTML (The default is 1) |
||
Table ID
|
tableId | string |
Set the ID of the HTML table to parse, when more than one table is present within the HTML |
||
Quantity Filter
|
quantityFilter | integer |
Get the rows with the specified number of columns |
||
Content Filter
|
contentFilter | string |
Set that only table cells which match the specified type will be parsed |
||
Generate Headers
|
generateHeaders | boolean |
When table header tags ( | ) are not present, generate headers using the first row ( | |
Returns
Remove diacritic marks from the text provided - https://support.encodian.com/hc/en-gb/articles/11774131045661
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
The text value to process |
Culture Name
|
cultureName | string |
Change the thread culture used to process the request. |
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the processed text value |
Returns
Remove text from a string between the two values provided - https://support.encodian.com/hc/en-gb/articles/10003667972892
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
The text from which a value is to be removed |
Start Value
|
startValue | True | string |
The text value to start the removal from |
End Value
|
endValue | True | string |
The text value to end the removal from |
Ignore Case
|
ignoreCase | boolean |
Set whether the text case should be ignored when executing the removal |
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the removed string |
|
Replace With
|
replaceWith | string |
Set a value to replace the removed value with |
|
Include Values
|
includeValues | string |
Set whether either or both of the Start Value and End Value should be included within the removal |
Returns
Replace a value within the text provided using a regex query - https://support.encodian.com/hc/en-gb/articles/11743215056413
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
The text value to process |
Regex
|
regex | True | string |
The regex query to use to find matches in the text value |
Replacement Text
|
replacementText | string |
Optional - The text to replace the matched values with, a blank value will remove the matched text values |
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the processed text value |
Returns
Replace a value within the text provided - https://support.encodian.com/hc/en-gb/articles/11774858455709
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
The text value to process |
Search Text
|
searchText | string |
The text to locate and replace with the 'Replacement Text' value, a blank value is treated as white-space |
|
Replacement Text
|
replacementText | string |
The text to replace the matched values with, a blank value will remove the matched text values |
|
Trim Result
|
trimResult | boolean |
Set whether white-space should be trimmed from the processed text value |
Returns
Creates an RSA key pair - https://support.encodian.com/hc/en-gb/articles/13955455670044
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Key Size
|
keySize | True | string |
Set the key size |
Key Format
|
privateKeyFormat | True | string |
Set the private key format |
Add Header and Footer
|
addHeaderAndFooter | True | boolean |
Set whether the header and footer should be added |
Returns
Decrypts an RSA encrypted string using RSA decryption - https://support.encodian.com/hc/en-gb/articles/13727862311580
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The cipher (string) to decrypt |
Input Type
|
rsaInputDataType | True | string |
Set the data format of the encrypted string |
Mode
|
mode | True | string |
Set the RSA encryption algorithm |
Key Type
|
keyType | True | string |
Set the type of key used within the algorithm |
Private Key Format
|
privateKeyFormat | string |
Set the private key format |
|
Key
|
key | True | string |
Set the key used within the algorithm |
Returns
Encrypts a plain text value (string) using RSA encryption - https://support.encodian.com/hc/en-gb/articles/13727847862300
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Data
|
data | True | string |
The input string to encrypt |
Output Type
|
rsaOutputDataType | True | string |
Set the data format of the encrypted string |
Mode
|
mode | True | string |
Set the RSA encryption algorithm |
Key Type
|
keyType | True | string |
Set the type of key used within the algorithm |
Private Key Format
|
privateKeyFormat | string |
Set the private key format |
|
Key
|
key | True | string |
Set the key used within the algorithm |
Returns
Search the text provided to find matches using the regex provided - https://support.encodian.com/hc/en-gb/articles/360006764638-Search-Text-Regex
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
The text to search with the regex string provided |
Regex Query
|
query | True | string |
The regex query to use to find matches in the string provided |
ECMAScript
|
ecmaScript | boolean |
Enables ECMAScript-compliant behavior for the expression. This value can be used only in conjunction with the IgnoreCase and Multiline options. Disabled by default. |
|
Explicit Capture
|
explicitCapture | boolean |
Specifies that the only valid captures are explicitly named or numbered groups of the form, disabled by default. |
|
Ignore Case
|
ignoreCase | boolean |
Specifies case-insensitive matching, disabled by default. |
|
Ignore Whitespace
|
ignoreWhitespace | boolean |
Eliminates unescaped white space from the pattern and enables comments marked with #, disabled by default. |
|
Multiline
|
multiline | boolean |
Changes the meaning of ^ and $ so they match at the beginning and end, respectively, of any line, and not just the beginning and end of the entire string, disabled by default. |
|
Right-to-Left
|
rightToLeft | boolean |
Specifies that the search will be from right to left instead of from left to right, disabled by default. |
|
Singleline
|
singleline | boolean |
Specifies single-line mode. Changes the meaning of the dot (.) so it matches every character (instead of every character except \n), disabled by default. |
|
Return Groups
|
returnGroups | boolean |
Specifies that the search will return match groups rather than match values |
Returns
Split the text provided using the set delimiter - https://support.encodian.com/hc/en-gb/articles/11846521179805
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
The text value to process |
Split Value
|
splitValue | string |
Set the value to split the text provided on |
|
Split On
|
splitOn | string |
Set whether the text should be split on all instances, the first instance or the last instance of the 'Split Value' |
|
Trim Values
|
trimResult | boolean |
Set whether white-space should be trimmed from the values split from the text provided |
|
Remove Empty Values
|
removeEmptyValues | boolean |
Set whether empty or null values should be removed from the array of values returned |
Returns
- Body
- DtoResponseSplitText
Check whether the text value provided contains a specified text value - https://support.encodian.com/hc/en-gb/articles/10515175130012/
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
The text to validate |
Value
|
value | True | string |
The value to check is contained within the 'Text' value |
Ignore Case
|
ignoreCase | boolean |
Set whether text case should be ignored when validating the 'Text' value |
|
Comparison Configuration
|
comparisonConfiguration | string |
Specifies the rules to be used when processing the text values provided |
|
Culture Name
|
cultureName | string |
Change the thread culture used to process the request |
Returns
Trim the text value provided aligined to the set configuration - https://support.encodian.com/hc/en-gb/articles/11769860640413
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Text
|
text | True | string |
The text value to process |
Trim Position
|
textTrimPosition | True | string |
Set whether to trim the text provided from the start position, end position or both |
Trim Characters
|
trimCharacters | string |
Optional - A list of characters (which can include white-space) to trim from the text provided, for example: &*yt^ :{ |
Returns
- Body
- DtoResponseTrimText
Unescape the HTML value provided - https://support.encodian.com/hc/en-gb/articles/11751174595357
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
HTML
|
html | True | string |
The HTML value to process |
Returns
Validate the email address provided - https://support.encodian.com/hc/en-gb/articles/9588817792925
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Email Address
|
emailAddress | True | string |
The email address to verify |
Regex
|
regex | True | string |
The regular expression used for validation |
Returns
Validate whether the GUID provided is valid - https://support.encodian.com/hc/en-gb/articles/9601440603421
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
GUID
|
guid | True | string |
The GUID to validate |
Returns
Validate the JSON data provided, optionally against a set schema - https://support.encodian.com/hc/en-gb/articles/12722049993500
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
JSON
|
json | True | string |
The JSON data to validate |
Schema
|
schema | string |
Optional - A JSON schema to apply to the validation |
Returns
Validate whether the URL provided is available - https://support.encodian.com/hc/en-gb/articles/9224582350365
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
URL
|
url | True | string |
The URL to verify, please include https:// or http:// in your request |
Validate URL
|
validateURL | boolean |
Set whether the 'URL' provided should be validated prior to checking availability |
Returns
Validate whether the URL provided has valid syntax - https://support.encodian.com/hc/en-gb/articles/9601816944413
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
URL
|
url | True | string |
The URL syntax to validate, please include https:// or http:// in your request |
Returns
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | boolean |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | integer |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | boolean |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
HMAC
|
hmac | string |
The computed HMAC |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Hash Code
|
HashCode | string |
The computed Hash Code |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | array of string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | array of string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | array of string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | integer |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | integer |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Matches
|
matches | array of string |
The matches found in the text provided |
HTTP Status Code
|
HttpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
HttpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
OperationId | string |
The unique ID assigned to this operation. |
Errors
|
Errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
OperationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | array of string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | boolean |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | boolean |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | boolean |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | boolean |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | boolean |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | boolean |
The response value for the request |
HTTP Status Code
|
httpStatusCode | integer |
The HTTP Status code for the response. |
HTTP Status Message
|
httpStatusMessage | string |
The HTTP Status message for the response. |
Operation ID
|
operationId | string |
The unique ID assigned to this operation. |
Errors
|
errors | array of string |
An array of error messages should an error occur. |
Operation Status
|
operationStatus | string |
Indicates whether the operation has completed, has been queued or has failed. |