Connectors Reference

OptiAPI

The official api for OptiAPI, which connects countless of everyday actions with Power Automate.

 

Status: Preview

Tier: Premium

Version: 1.0.0

 

Actions:

Name

Summary

CalculateAverage ([internal]string Content-Type, [internal]string Accept, CalculateAverageParameterBody body)

Calculate average

ChunkAnArray ([internal]string Content-Type, [internal]string Accept, ChunkAnArrayParameterBody body)

Chunk an array

CombineArray (string Content-Type, string Accept, CombineArrayParameterBody body)

Combine array

CheckIfArrayContainAValue ([internal]string Content-Type, [internal]string Accept, CheckIfArrayContainAValueParameterBody body)

Check if array contain a value

FindDifferenceBetweenArrays ([internal]string Content-Type, [internal]string Accept, FindDifferenceBetweenArraysParameterBody body)

Find difference between arrays

FindDuplicatesInArrays ([internal]string Content-Type, [internal]string Accept, FindDuplicatesInArraysParameterBody body)

Find duplicates in arrays

FilterAnArray ([internal]string Content-Type, [internal]string Accept, FilterAnArrayParameterBody body)

Filter an array for false values

FirstWhereWithinAnArray ([internal]string Content-Type, [internal]string Accept, FirstWhereWithinAnArrayParameterBody body)

First Where within an array

FlattenAnArray ([internal]string Content-Type, [internal]string Accept, FlattenAnArrayParameterBody body)

Flatten an array

RemoveItemFromArray ([internal]string Content-Type, [internal]string Accept, RemoveItemFromArrayParameterBody body)

Remove item from array

GroupByAnArrayKey ([internal]string Content-Type, [internal]string Accept, [Optional]GroupByAnArrayKeyParameterBody body)

Group By an array key

SortAnArray ([internal]string Content-Type, [internal]string Accept, SortAnArrayParameterBody body)

Sort an array

GetUniqueItemsInAnArray ([internal]string Content-Type, [internal]string Accept, GetUniqueItemsInAnArrayParameterBody body)

Get unique items in an array

AddOrSubtractFromTimeOrDates ([internal]string Content-Type, [internal]string Accept, AddOrSubtractFromTimeOrDatesParameterBody body)

Add or subtract from time or dates

ConvertAStringToADatetimeObject (string Content-Type, string Accept, ConvertAStringToADatetimeObjectParameterBody body)

Convert a string to a datetime object

PerformOcrOnAScannedPdfOrImageFile ([internal]string Content-Type, [internal]string Accept, PerformOcrOnAScannedPdfOrImageFileParameterBody body)

Perform OCR on a scanned PDF or image file

CombineMultiplePdfFiles ([internal]string Content-Type, [internal]string Accept, CombineMultiplePdfFilesParameterBody body)

Combine multiple PDF files

GetPdfMetadataInformation ([internal]string Content-Type, [internal]string Accept, GetPdfMetadataInformationParameterBody body)

Get PDF metadata information

ConvertAPdfFileToText ([internal]string Content-Type, [internal]string Accept, ConvertAPdfFileToTextParameterBody body)

Convert a PDF file to text

SetPasswordOnAPdfFile (string Content-Type, string Accept, SetPasswordOnAPdfFileParameterBody body)

Set password on a PDF file

ReplaceTextInStringBasedOnARegularExpression ([internal]string Content-Type, [internal]string Accept, ReplaceTextInStringBasedOnARegularExpressionParameterBody body)

Replace text in string based on a regular expression

FindValuesFromAStringBasedOnARegularExpression ([internal]string Content-Type, [internal]string Accept, FindValuesFromAStringBasedOnARegularExpressionParameterBody body)

Find values from a string based on a regular expression

ReplaceTextInString (string Content-Type, string Accept, ReplaceTextInStringParameterBody body)

Replace text in string

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AddOrSubtractFromTimeOrDatesParameterBody

 

AddOrSubtractFromTimeOrDatesResponse

 

CalculateAverageParameterBody

 

CalculateAverageResponse

 

CheckIfArrayContainAValueParameterBody

 

CheckIfArrayContainAValueResponse

 

ChunkAnArrayParameterBody

 

ChunkAnArrayResponse

 

CombineArrayParameterBody

 

CombineArrayResponse

 

CombineMultiplePdfFilesParameterBody

 

CombineMultiplePdfFilesResponse

 

ConvertAPdfFileToTextParameterBody

 

ConvertAStringToADatetimeObjectParameterBody

 

ConvertAStringToADatetimeObjectResponse

 

FilterAnArrayParameterBody

 

FilterAnArrayResponse

 

FindDifferenceBetweenArraysParameterBody

 

FindDifferenceBetweenArraysResponse

 

FindDuplicatesInArraysParameterBody

 

FindDuplicatesInArraysResponse

 

FindValuesFromAStringBasedOnARegularExpressionParameterBody

 

FindValuesFromAStringBasedOnARegularExpressionResponse

 

FirstWhereWithinAnArrayParameterBody

 

FirstWhereWithinAnArrayResponse

 

FlattenAnArrayParameterBody

 

FlattenAnArrayResponse

 

GetPdfMetadataInformationParameterBody

 

GetPdfMetadataInformationResponse

 

GetUniqueItemsInAnArrayParameterBody

 

GetUniqueItemsInAnArrayResponse

 

GroupByAnArrayKeyParameterBody

 

GroupByAnArrayKeyResponse

 

PerformOcrOnAScannedPdfOrImageFileParameterBody

 

PerformOcrOnAScannedPdfOrImageFileResponse

 

RemoveItemFromArrayParameterBody

 

RemoveItemFromArrayResponse

 

ReplaceTextInStringBasedOnARegularExpressionParameterBody

 

ReplaceTextInStringBasedOnARegularExpressionResponse

 

ReplaceTextInStringParameterBody

 

ReplaceTextInStringResponse

 

SetPasswordOnAPdfFileParameterBody

 

SetPasswordOnAPdfFileResponse

 

SortAnArrayParameterBody

 

StandardArrayResponse

 

 

Actions:

CalculateAverage

Summary: Calculate average

Description: Calculates the average value of a given key.

 

Syntax:

OptiAPI.CalculateAverage ([internal]string Content-Type, [internal]string Accept, CalculateAverageParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

 

True

Accept

string

(The accept type for the request.)

 

True

body

CalculateAverageParameterBody

 

 

True

 

Returns:

          Type:CalculateAverageResponse

 

ChunkAnArray

Summary: Chunk an array

Description: Break an array down into chunks.

 

Syntax:

OptiAPI.ChunkAnArray ([internal]string Content-Type, [internal]string Accept, ChunkAnArrayParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept type for the request.)

Accept

True

body

ChunkAnArrayParameterBody

 

 

True

 

Returns:

          Type:ChunkAnArrayResponse

 

CombineArray

Summary: Combine array

Description: Combine the keys of one array with the values of another array.

 

Syntax:

OptiAPI.CombineArray (string Content-Type, string Accept, CombineArrayParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept type for the request.)

Accept

True

body

CombineArrayParameterBody

 

 

True

 

Returns:

          Type:CombineArrayResponse

 

CheckIfArrayContainAValue

Summary: Check if array contain a value

Description: Determines whether the array contains a given item.

 

Syntax:

OptiAPI.CheckIfArrayContainAValue ([internal]string Content-Type, [internal]string Accept, CheckIfArrayContainAValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Header value

True

Accept

string

(The accept type for the request.)

Header value

True

body

CheckIfArrayContainAValueParameterBody

 

 

True

 

Returns:

          Type:CheckIfArrayContainAValueResponse

 

FindDifferenceBetweenArrays

Summary: Find difference between arrays

Description: This action compares an array against another array.

 

Syntax:

OptiAPI.FindDifferenceBetweenArrays ([internal]string Content-Type, [internal]string Accept, FindDifferenceBetweenArraysParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept type for the request.)

Accept

True

body

FindDifferenceBetweenArraysParameterBody

 

 

True

 

Returns:

          Type:FindDifferenceBetweenArraysResponse

 

FindDuplicatesInArrays

Summary: Find duplicates in arrays

Description: This action retrieves and returns duplicate values from an array.

 

Syntax:

OptiAPI.FindDuplicatesInArrays ([internal]string Content-Type, [internal]string Accept, FindDuplicatesInArraysParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

 

True

Accept

string

(The accept type for the request.)

 

True

body

FindDuplicatesInArraysParameterBody

 

 

True

 

Returns:

          Type:FindDuplicatesInArraysResponse

 

FilterAnArray

Summary: Filter an array for false values

Description: This action removes false entries from an array.

 

Syntax:

OptiAPI.FilterAnArray ([internal]string Content-Type, [internal]string Accept, FilterAnArrayParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept type for the request.)

Accept

True

body

FilterAnArrayParameterBody

 

 

True

 

Returns:

          Type:FilterAnArrayResponse

 

FirstWhereWithinAnArray

Summary: First Where within an array

Description: This action returns the first element in an array with the given key / value pair.

 

Syntax:

OptiAPI.FirstWhereWithinAnArray ([internal]string Content-Type, [internal]string Accept, FirstWhereWithinAnArrayParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

 

True

Accept

string

(The accept type for the request.)

 

True

body

FirstWhereWithinAnArrayParameterBody

 

 

True

 

Returns:

          Type:FirstWhereWithinAnArrayResponse

 

FlattenAnArray

Summary: Flatten an array

Description: This action flattens a multi-dimensional array into a single dimension array.

 

Syntax:

OptiAPI.FlattenAnArray ([internal]string Content-Type, [internal]string Accept, FlattenAnArrayParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

 

True

Accept

string

(The accept type for the request.)

 

True

body

FlattenAnArrayParameterBody

 

 

True

 

Returns:

          Type:FlattenAnArrayResponse

 

RemoveItemFromArray

Summary: Remove item from array

Description: Removes an item from an array by its key value.

 

Syntax:

OptiAPI.RemoveItemFromArray ([internal]string Content-Type, [internal]string Accept, RemoveItemFromArrayParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

 

True

Accept

string

(The accept type for the request.)

 

True

body

RemoveItemFromArrayParameterBody

 

 

True

 

Returns:

          Type:RemoveItemFromArrayResponse

 

GroupByAnArrayKey

Summary: Group By an array key

Description: This action groups an array's items by a given key.

 

Syntax:

OptiAPI.GroupByAnArrayKey ([internal]string Content-Type, [internal]string Accept, [Optional]GroupByAnArrayKeyParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

 

True

Accept

string

(The accept type for the request.)

 

True

body

GroupByAnArrayKeyParameterBody

 

 

False

 

Returns:

          Type:GroupByAnArrayKeyResponse

 

SortAnArray

Summary: Sort an array

Description: Sort an array from high to low or from descending to ascending.

 

Syntax:

OptiAPI.SortAnArray ([internal]string Content-Type, [internal]string Accept, SortAnArrayParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept type for the request.)

Accept

True

body

SortAnArrayParameterBody

 

 

True

 

Returns:

          Type:StandardArrayResponse

 

GetUniqueItemsInAnArray

Summary: Get unique items in an array

Description: The action returns all of the unique items in an array.

 

Syntax:

OptiAPI.GetUniqueItemsInAnArray ([internal]string Content-Type, [internal]string Accept, GetUniqueItemsInAnArrayParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

 

True

Accept

string

(The accept type for the request.)

 

True

body

GetUniqueItemsInAnArrayParameterBody

 

 

True

 

Returns:

          Type:GetUniqueItemsInAnArrayResponse

 

AddOrSubtractFromTimeOrDates

Summary: Add or subtract from time or dates

Description: Manipulate datetime by adding or subtracting values.

 

Syntax:

OptiAPI.AddOrSubtractFromTimeOrDates ([internal]string Content-Type, [internal]string Accept, AddOrSubtractFromTimeOrDatesParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept for the request.)

Accept

True

body

AddOrSubtractFromTimeOrDatesParameterBody

 

 

True

 

Returns:

          Type:AddOrSubtractFromTimeOrDatesResponse

 

ConvertAStringToADatetimeObject

Summary: Convert a string to a datetime object

Description: Transform a string to a valid datetime format.

 

Syntax:

OptiAPI.ConvertAStringToADatetimeObject (string Content-Type, string Accept, ConvertAStringToADatetimeObjectParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept type for the request.)

Accept

True

body

ConvertAStringToADatetimeObjectParameterBody

 

 

True

 

Returns:

          Type:ConvertAStringToADatetimeObjectResponse

 

PerformOcrOnAScannedPdfOrImageFile

Summary: Perform OCR on a scanned PDF or image file

Description: Replaces a string with another word.

 

Syntax:

OptiAPI.PerformOcrOnAScannedPdfOrImageFile ([internal]string Content-Type, [internal]string Accept, PerformOcrOnAScannedPdfOrImageFileParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept type for the request.)

Accept

True

body

PerformOcrOnAScannedPdfOrImageFileParameterBody

 

 

True

 

Returns:

          Type:PerformOcrOnAScannedPdfOrImageFileResponse

 

CombineMultiplePdfFiles

Summary: Combine multiple PDF files

Description: Combine multiple PDF files into one.

 

Syntax:

OptiAPI.CombineMultiplePdfFiles ([internal]string Content-Type, [internal]string Accept, CombineMultiplePdfFilesParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept-type for the request.)

Accept

True

body

CombineMultiplePdfFilesParameterBody

 

 

True

 

Returns:

          Type:CombineMultiplePdfFilesResponse

 

GetPdfMetadataInformation

Summary: Get PDF metadata information

Description: Get metadata from a PDF file.

 

Syntax:

OptiAPI.GetPdfMetadataInformation ([internal]string Content-Type, [internal]string Accept, GetPdfMetadataInformationParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept type for the request.)

Accept

True

body

GetPdfMetadataInformationParameterBody

 

 

True

 

Returns:

          Type:GetPdfMetadataInformationResponse

 

ConvertAPdfFileToText

Summary: Convert a PDF file to text

Description: Converts a PDF file to text.

 

Syntax:

OptiAPI.ConvertAPdfFileToText ([internal]string Content-Type, [internal]string Accept, ConvertAPdfFileToTextParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept type for the request.)

Accept

True

body

ConvertAPdfFileToTextParameterBody

 

 

True

 

Returns:

          Type:StandardArrayResponse

 

SetPasswordOnAPdfFile

Summary: Set password on a PDF file

Description: Dynamically sets a custom password on a PDF file.

 

Syntax:

OptiAPI.SetPasswordOnAPdfFile (string Content-Type, string Accept, SetPasswordOnAPdfFileParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept type for the request.)

Accept

True

body

SetPasswordOnAPdfFileParameterBody

 

 

True

 

Returns:

          Type:SetPasswordOnAPdfFileResponse

 

ReplaceTextInStringBasedOnARegularExpression

Summary: Replace text in string based on a regular expression

Description: Replace one or more words with another word, based on a regular expression.

 

Syntax:

OptiAPI.ReplaceTextInStringBasedOnARegularExpression ([internal]string Content-Type, [internal]string Accept, ReplaceTextInStringBasedOnARegularExpressionParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept type for the request.)

Accept

True

body

ReplaceTextInStringBasedOnARegularExpressionParameterBody

 

 

True

 

Returns:

          Type:ReplaceTextInStringBasedOnARegularExpressionResponse

 

FindValuesFromAStringBasedOnARegularExpression

Summary: Find values from a string based on a regular expression

Description: Find one or more values in a string.

 

Syntax:

OptiAPI.FindValuesFromAStringBasedOnARegularExpression ([internal]string Content-Type, [internal]string Accept, FindValuesFromAStringBasedOnARegularExpressionParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept type for the request.)

Accept

True

body

FindValuesFromAStringBasedOnARegularExpressionParameterBody

 

 

True

 

Returns:

          Type:FindValuesFromAStringBasedOnARegularExpressionResponse

 

ReplaceTextInString

Summary: Replace text in string

Description: Replace one or more words with another word.

 

Syntax:

OptiAPI.ReplaceTextInString (string Content-Type, string Accept, ReplaceTextInStringParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Content-Type

string

(The content-type for the request.)

Content-Type

True

Accept

string

(The accept type for the request.)

Accept

True

body

ReplaceTextInStringParameterBody

 

 

True

 

Returns:

          Type:ReplaceTextInStringResponse

 


 

AddOrSubtractFromTimeOrDatesParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

action

string

 

The action to add or subtract too. This can for example be 'year', 'weekday', 'week' or 'day'.  Values: [Year, Quarter, Month, Week, Weekday, Day, Hour, Minute, Second]

datetime

string

 

The input value to either add to or subtract from.

operator

string

 

Whether we should add or subtract the value from the input date time. Can be either 'add' or 'subtract.  Values: [Add, Subtract]

outputFormat

string

 

The date time format that the string should be converted to (for example d-m-Y)

value

integer(int32)

 

The value to either add or subtract.


 

AddOrSubtractFromTimeOrDatesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

datetime

string

 

The new transformed date time


 

CalculateAverageParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array

key

string

 

The key to calculate the average for.


 

CalculateAverageResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

average

integer(int32)

 

The calculated average for the given key.


 

CheckIfArrayContainAValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array

key

string

 

The key to search for the specific value in.

search

string

 

The search term to look for.


 

CheckIfArrayContainAValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

contains

boolean

 

Whether the array contains the given item or not (bool)  Values: [, ]


 

ChunkAnArrayParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array

size

integer(int32)

 

The size of each chunk.


 

ChunkAnArrayResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array


 

CombineArrayParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

keys

array of (string)

 

keys

values

array of (string)

 

values


 

CombineArrayResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array


 

CombineMultiplePdfFilesParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

pdfs

array of (string)

 

pdfs


 

CombineMultiplePdfFilesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

content

string

 

The base64 encoded string of the combined PDF files.


 

ConvertAPdfFileToTextParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

endPage

integer(int32)

 

If set, this is the last page the action will convert to text.

layout

string

 

The layout of the output content. You can choose from 'raw' or 'original'. Original will preserve the layout..  Values: [raw, original]

mode

string

 

mode (not neeeded)

pdf

string(byte)

 

The base64 encoded string of the PDF file.

startPage

integer(int32)

 

If set, this is the first page the action will convert to text.


 

ConvertAStringToADatetimeObjectParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

inputFormat

string

 

The format of the input string.

outputFormat

string

 

The date time format that the string should be converted to.

string

string

 

The input string to convert to date time.

timezone

string

 

The timezone the datetime should be converted to (Optional)


 

ConvertAStringToADatetimeObjectResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

datetime

string

 

The new transformed date time


 

FilterAnArrayParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array

preserveKeys

boolean

 

If set to true, the returning array will preserve the keys of the original attributes.  Values: [, ]


 

FilterAnArrayResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array


 

FindDifferenceBetweenArraysParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array

compare

array of (string)

 

compare


 

FindDifferenceBetweenArraysResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array


 

FindDuplicatesInArraysParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array

key

string

 

You can specify a key in order to look for duplicates under a specific attribute (Optional)


 

FindDuplicatesInArraysResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array


 

FindValuesFromAStringBasedOnARegularExpressionParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

group

integer

 

The group to return. (default = 0)

pattern

string

 

The regular expression pattern.

text

string

 

The string to look for references in.


 

FindValuesFromAStringBasedOnARegularExpressionResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

values

array of (string)

 

values


 

FirstWhereWithinAnArrayParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array

key

string

 

The key to search for.

operator

string

 

Perform an operator clause (Optional)  Values: [>=, <=, >, <, =, !=]

value

string

 

The value to search for.


 

FirstWhereWithinAnArrayResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array


 

FlattenAnArrayParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array

depth

integer

 

The depth level that should be flattened (integer)


 

FlattenAnArrayResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array


 

GetPdfMetadataInformationParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

pdf

string(byte)

 

The base64 encoded string of the PDF file.


 

GetPdfMetadataInformationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

metadata

Metadata

 

metadata

 

Metadata

Summary:

Description: metadata

 

          Properties:

Name

Type

Summary

PDFVersion

string

 

PDFVersion

author

string

 

The author of the PDF file

creationDate

string

 

The date the PDF file was originally created.

creator

string

 

The creator of the PDF file.

encrypted

string

 

Whether the PDF file is encrypted. Returns "yes"/"no".

fileSize

string

 

The file size of the PDF file in bytes.

form

string

 

If any forms are found in the PDF file.

modDate

string

 

If the file has been changed. (default = null)

optimized

string

 

If the file was optimized. (default = "no")

output

array of (string)

 

output

pageRot

string

 

The rotation of the PDF file.

pageSize

string

 

The page size of the PDF file.

pages

string

 

The number of pages in the PDF file.

producer

string

 

The producer of the PDF file.

tagged

string

 

Whether the PDF file is tagged or not. Returns "yes"/"no".

title

string

 

The title of the PDF file.

 


 

GetUniqueItemsInAnArrayParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array

key

string

 

The specific key that determines the uniqueness.


 

GetUniqueItemsInAnArrayResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array


 

GroupByAnArrayKeyParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array

key

string

 

The key to group items by.


 

GroupByAnArrayKeyResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array


 

PerformOcrOnAScannedPdfOrImageFileParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

file

string

 

The base64 encoded string of the file (PDF or image).

language

string

 

The language of the input file. (default = eng)

oem

integer(int32)

 

The OCR engine to use. (0 = legacy, 1 = LSTM)  Values: [, ]

psm

integer(int32)

 

How should the OCR segment the input image?  Values: [, , , , , , , , , , , , , ]

trim

boolean

 

If enabled, this will remove all excess spacing and line breaks of the output text.  Values: [, ]

type

string

 

The input file type.  Values: [pdf, jpg, jpeg, png, gif]


 

PerformOcrOnAScannedPdfOrImageFileResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

text

string

 

The output text from the OCR action.


 

RemoveItemFromArrayParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array

key

string

 

Items matching this key will be removed.


 

RemoveItemFromArrayResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array


 

ReplaceTextInStringBasedOnARegularExpressionParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

pattern

string

 

The regular expression pattern to use in the search.

replacement

string

 

The string to replace the found value with.

text

string

 

The string to perform the text replace against.


 

ReplaceTextInStringBasedOnARegularExpressionResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

text

string

 

The replaced text string


 

ReplaceTextInStringParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

replace

string

 

The string or word to replace the found string with.

search

string

 

The string or word to find in the input string.

text

string

 

The input text to perform the replacement on.


 

ReplaceTextInStringResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

text

string

 

text


 

SetPasswordOnAPdfFileParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

password

string

 

The password to apply to the PDF file.

pdf

string(byte)

 

The base64 content of the PDF files.


 

SetPasswordOnAPdfFileResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

content

string

 

The base64 encoded string of the PDF file with the password.


 

SortAnArrayParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

 

array

sort

string

 

How should the array items be sorted?  Values: [Ascending, Descending]


 

StandardArrayResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

array

array of (string)

Result Array

The array containing the new items.