Redque (Preview)

Reference

Accessing and managing the Redque system.

This connector is available in the following products and regions:

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

Contact
Name	Redque s.r.o.
URL	https://redque.com
Email	info@redque.com

Connector Metadata
Publisher	Redque s.r.o.
Website	https://redque.cz/en/
Privacy policy	https://redque.cz/policy.html
Categories	AI;Finance

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add permissions	Adds permissions to the user.
Change password	Changes user's password.
Change user's password	Changes password for specified user. Requires user management permission.
Create folder	Creates a new folder.
Create new enum	Note that enum key is auto generated and value keys must only contain lowercase letter, uppercase letters, numbers, underscore, dash
Create user	Creates a new user.
Delete user	Deletes a user.
Deletes enum with specific id	Deletes a specific enum.
Download document's file	Downloads document's file.
Download folder	Downloads all documents in a folder as a single archive.
Extract document	Requests extraction of a document. After document is retrieved it is scheduled for deletion.
Filter documents	Returns list of documents based on parameters.
Filter users	Gets the list of user by criteria.
Find folder	Finds folder by ID.
Find user	Finds a user.
Generate token	Generates new registration token.
Get document's metadata	Gets document's metadata.
Get extracted document	Extracted document is marked for removal and will be deleted within several hours of being accessed. This gives users time to retry retrieving the result if they happen to fail.
Grant document access to specified user	Grants document access to specified user.
Image for a given page	Returns an image for a given page.
License information	Returns license information.
Lock document	Locks (opens) document preventing other users from modifying it.
Remove access to the document for specified user	Removes access to the document for specified user.
Remove existing document	Removes existing document.
Remove folder	Removes existing folder.
Remove permissions	Revokes user's permissions.
Removes token	Removes registration token.
Return all enums	Returns list of all enums.
Return document to issuer for corrections	Returns document to issuer for corrections to provided e-mail address.
Return enum	Returns specific enum.
Return to sender configuration	Retrieve current configuration for return to sender action.
Return token	Returns current registration token or nothing if token is not active.
Unlock locked document	Unlocks locked (closes) document to allow other users to modify its contents.
Update document	Updates document.
Update folder data	Updates folder data.
Update return to sender configuration	Updates return to sender configuration.
Update specific enum	Updates a specific enum.
Update user	Partially updates a specified user.
Upload a document and schedules it for processing	Uploads the document and schedules it for processing.

Add permissions

Operation ID:: AddUserPermissions

Adds permissions to the user.

Parameters

Name	Key	Required	Type	Description
User ID	userId	True	string	Id of the user
permissions	permissions		array of string	Access data

Change password

Operation ID:: ChangePassword

Changes user's password.

Parameters

Name	Key	Required	Type	Description
User ID	userId	True	string	Id of the user
body	body		string	Password of the user

Change user's password

Operation ID:: ForceUserPasswordChange

Changes password for specified user. Requires user management permission.

Parameters

Name	Key	Required	Type	Description
User ID	userId	True	string	Id of the user
password	password		string	Password of user
accountId	accountId		string	Account Id of user
activationkey	activationkey		string	Activation key of user

Create folder

Operation ID:: CreateFolder

Creates a new folder.

Returns

Result from container creation

Body: ApiFolderCreationResult

Create new enum

Operation ID:: CreateEnum

Note that enum key is auto generated and value keys must only contain lowercase letter, uppercase letters, numbers, underscore, dash

Parameters

Name	Key	Type	Description
id	id	string	Enum identifier
name	name	string	User friendly enum name
values	values	object	List of enum values
isEditable	isEditable	boolean	Indicates whether enum can be edited

Returns

Generic response value

Body: StringApiValue

Create user

Operation ID:: CreateUser

Creates a new user.

Parameters

Name	Key	Type	Description
firstName	firstName	string	First name of user
lastName	lastName	string	Last name of user
password	password	string	Password of account
email	email	string	Email (Login name) of user

Delete user

Operation ID:: DeleteUser

Deletes a user.

Parameters

Name	Key	Required	Type	Description
User ID	userId	True	string	User Id

Deletes enum with specific id

Operation ID:: DeleteEnum

Deletes a specific enum.

Parameters

Name	Key	Required	Type	Description
Enum key	id	True	string	Enum identifier/key

Download document's file

Operation ID:: DownloadFileAsync

Downloads document's file.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Document identifier

Download folder

Operation ID:: DownloadFolderArchived

Downloads all documents in a folder as a single archive.

Parameters

Name	Key	Required	Type	Description
Folder ID	folderId	True	string	Folder identifier

Extract document

Operation ID:: ExtractDocument

Requests extraction of a document. After document is retrieved it is scheduled for deletion.

Parameters

Name	Key	Required	Type	Description
Document ID	externalDocumentId		string	Document ID (optional - your external document ID)
File	file		file	File

Filter documents

Operation ID:: ListAllDocuments

Returns list of documents based on parameters.

Parameters

Name	Key	Type	Description
text	text	string	Search text used for general searches
value	value	string
values	values	string	State of the document
values	values	string	State of the document
value	value	string
value	value	boolean
values	values	string
values	values	array of string
from	from	date-time
to	to	date-time
fields	fields	object	Field filters
skip	skip	integer	How many items to skip from the start of the list. Allows for pagination.
take	take	integer	Maximum number of list items that will be returned
field	field	string	List of properties on which the results can be sorted
direction	direction	string	Direction in which list values are sorted
scopes	scopes	string	Document scope that filters what parts of the document should be returned

Returns

Search result

Body: ApiDocumentApiListResult

Filter users

Operation ID:: ListOfUsers

Gets the list of user by criteria.

Parameters

Name	Key	Type	Description
text	text	string	Search text used for general searches
value	value	string
skip	skip	integer	How many items to skip from the start of the list. Allows for pagination.
take	take	integer	Maximum number of list items that will be returned
field	field	string	Enum for declaring sorting parameters of user
direction	direction	string	Direction in which list values are sorted

Returns

Search result

Body: ApiUserApiListResult

Find folder

Operation ID:: GetFolder

Finds folder by ID.

Parameters

Name	Key	Required	Type	Description
Folder ID	folderId	True	string	Folder identifier
With members	withMembers		boolean	True if document with members

Returns

Container metadata with metadata of documents inside the container

Body: ApiFolderWithMembers

Find user

Operation ID:: GetUser

Finds a user.

Parameters

Name	Key	Required	Type	Description
User ID	userId	True	string	Id of the user

Returns

User information

Body: ApiUser

Generate token

Operation ID:: GenerateRegistrationToken

Generates new registration token.

Returns

Generic response value

Body: StringApiValue

Get document's metadata

Operation ID:: GetDocument

Gets document's metadata.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	document id
Is document ID external ID ?	isExternalId		boolean	Is document ID external ID ?

Returns

Body: ApiDocument

Get extracted document

Operation ID:: GetExtractDocument

Extracted document is marked for removal and will be deleted within several hours of being accessed. This gives users time to retry retrieving the result if they happen to fail.

Parameters

Name	Key	Required	Type	Description
Document ID	id	True	string	Document ID (provided by RedQue or external)

Grant document access to specified user

Operation ID:: GrantDocumentAccess

Grants document access to specified user.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Document ID
User ID	userId	True	string	User ID
documentId	documentId		string	Document id
userId	userId		string	User id
message	message		string

Image for a given page

Operation ID:: GetImage

Returns an image for a given page.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Document ID
Page index	pageIndex	True	integer	Page index
Preview	isPreview		boolean	True if reduced size image should be returned.

Returns

response: uri

License information

Operation ID:: GetLicenseInfo

Returns license information.

Returns

Body: MLicense

Lock document

Operation ID:: LockDocument

Locks (opens) document preventing other users from modifying it.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Document ID

Remove access to the document for specified user

Operation ID:: RemoveDocumentAccess

Removes access to the document for specified user.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Document identifier
User ID	userId	True	string	User identifier

Remove existing document

Operation ID:: DeleteDocument

Removes existing document.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	document id

Remove folder

Operation ID:: DeleteFolder

Removes existing folder.

Parameters

Name	Key	Required	Type	Description
Folder ID	folderId	True	string	Folder identifier

Remove permissions

Operation ID:: RemoveUserPermissions

Revokes user's permissions.

Parameters

Name	Key	Required	Type	Description
User ID	userId	True	string	Id of the user
permissions	permissions		array of string	Access data

Removes token

Operation ID:: DisableRegistrationToken

Removes registration token.

Return all enums

Operation ID:: GetAllEnums

Returns list of all enums.

Returns

response: array of ApiEnum

Return document to issuer for corrections

Operation ID:: ReturnDocument

Returns document to issuer for corrections to provided e-mail address.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Document ID
additionalDocuments	additionalDocuments		array of string
recipientEmail	recipientEmail		string
reason	reason		string
requestedByUserId	requestedByUserId		string

Return enum

Operation ID:: GetEnum

Returns specific enum.

Parameters

Name	Key	Required	Type	Description
Enum identifier	id	True	string	Enum identifier

Returns

Enum data for field type enum

Body: ApiEnum

Return to sender configuration

Operation ID:: ReturnDocumentConfiguration

Retrieve current configuration for return to sender action.

Return token

Operation ID:: GetRegisterToken

Returns current registration token or nothing if token is not active.

Returns

Generic response value

Body: StringApiValue

Unlock locked document

Operation ID:: UnlockDocumentAsync

Unlocks locked (closes) document to allow other users to modify its contents.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Document ID

Update document

Operation ID:: UpdateDocuments

Updates document.

Parameters

Name	Key	Required	Type	Description
Document ID	documentId	True	string	Document Id
documentId	documentId		string
value	value		string
value	value		string
value	value		string
value	value		string
value	value		string
value	value		string
value	value		string
value	value		boolean
value	value		boolean
value	value		string
value	value		string
operation	operation		string
key	key		string
message	message		string
isWarning	isWarning		boolean
wordIds	wordIds		array of integer
value	value		string
operation	operation		string
key	key		string
message	message		string
isWarning	isWarning		boolean
wordIds	wordIds		array of integer
userId	userId		string
userId	userId		string
state	state		string	State of the document
value	value		string
operation	operation		string
value	value		string
operation	operation		string

Returns

Status response data. Used as a response when request returns no data.

Body: RedQueStatus

Update folder data

Operation ID:: UpdateContainerData

Updates folder data.

Parameters

Name	Key	Required	Type	Description
Folder ID	folderId	True	string	Folder id
folderId	folderId		string	Document id.
ownerId	ownerId		string	Container owner id
created	created		date-time	Time of container creation
metadata	metadata		object	All headers attached to the container

Update return to sender configuration

Operation ID:: StoreReturnDocumentConfiguration

Updates return to sender configuration.

Parameters

Name	Key	Required	Type	Description
template	template		string
subject	subject		string

Update specific enum

Operation ID:: UpdateEnum

Updates a specific enum.

Parameters

Name	Key	Required	Type	Description
Enum identifier	id	True	string	Enum identifier
id	id		string	Enum identifier
name	name		string	User friendly enum name
values	values		object	List of enum values
isEditable	isEditable		boolean	Indicates whether enum can be edited

Update user

Operation ID:: UpdateUser

Partially updates a specified user.

Parameters

Name	Key	Required	Type	Description
User ID	userId	True	string	User id
firstName	firstName		string	First name of user
lastName	lastName		string	Last name of user

Upload a document and schedules it for processing

Operation ID:: UploadDocumentAsync

Uploads the document and schedules it for processing.

Parameters

Name	Key	Type	Description
File	File	file	File
External ID of document	DocumentId	string	External document id
Folder ID	FolderId	string	Folder id
Date	Date	date-time	Date
Order	Ordinal	integer	Order used for keeping order of documents which are uploaded in parallel
Is document an attachment	IsAttachment	boolean	True if document is an attachment
Document class	DocumentClass	string	Document class

Returns

Result of an file upload

Body: ApiUploadResponse

Definitions

ApiApproval

Name	Path	Type	Description
approver	approver	ApiUser	User information
approvalStepTime	approvalStepTime	date-time	Assignment time to the current approver´.
approvalState	approvalState	ApprovalState	State of the document
delegatedTo	delegatedTo	ApiUser	User information
note	note	string	Approver note

ApiApprovalReminder

Name	Path	Type	Description
fromUser	fromUser	ApiUser	User information
toUser	toUser	ApiUser	User information
sentTime	sentTime	date-time	Time of sending
note	note	string	Urgency note

ApiDocument

Name	Path	Type	Description
documentId	documentId	string	Document id
externalDocumentId	externalDocumentId	string	External document ID
folderId	folderId	string	Document container id
contentHash	contentHash	string	Hash of the content
pageCount	pageCount	integer	Total number of pages in the document, first index is 1. This number might not be equal to number of Pages, because if document has too many pages, some of them may be skipped due to performance reasons
fileName	fileName	string	File name of the document
owner	owner	ApiUser	User information
state	state	DocumentState	State of the document
error	error	string	Error code of the document
isImagesGenerated	isImagesGenerated	boolean	Were images generated
isReturned	isReturned	boolean	True if documents was returned to the sender.
returnReason	returnReason	string	Reason for the return.
creationTime	creationTime	date-time	Creation date
size	size	integer	Size of the document in KB
contentType	contentType	string	Content type
source	source	DocumentSource
sourceInfo	sourceInfo	string	Source details (in general email address)
extractionTime	extractionTime	date-time	Classification date
model	model	string	Type of this document
isAttachment	isAttachment	boolean	Indicates if document is an attachment
isValidated	isValidated	boolean	Indicator if document has been validated
isEdited	isEdited	boolean	Indicator, if this document has been edited (at least one field, note or tag has been changed)
note	note	string	Custom user note
fields	fields	object	List of extracted fields
items	items	array of object	List of extracted items
items	items	object
pages	pages	array of ApiPage	List of all pages that are part of an extraction.
pluginResults	pluginResults	array of ApiPluginResult	General results
isPostProcessCompleted	isPostProcessCompleted	boolean	Indicator, if the post processing has completed
isPrevalidated	isPrevalidated	boolean	Whether or not a doc has some prevalidation pp scripts
lastOpenTime	lastOpenTime	date-time	Last open date
lastOpenUserId	lastOpenUserId	string	Id of the user that last opened this document
isLocked	isLocked	boolean	Determines whether document is locked or not
validationTime	validationTime	date-time	The time the document has been validated
version	version	integer	Version number, incremented with every update
approvalState	approvalState	ApprovalState	State of the document
currentApproverId	currentApproverId	string	Id of user that has to approve this document
lastApprovalStepTime	lastApprovalStepTime	date-time	Assignment time to the current approver
isCurrentApproverNotificationSent	isCurrentApproverNotificationSent	boolean	Notification was sent to the current approver
approvalHistory	approvalHistory	array of ApiApproval	Approval history
approvalReminderHistory	approvalReminderHistory	array of ApiApprovalReminder	Approve history
authorizedUserIds	authorizedUserIds	array of string	Users authorized to access the document
duplicateDocIds	duplicateDocIds	array of string	Duplicate document IDs (based on fields values)
approvedBy	approvedBy	ApiUser	User information
validatedBy	validatedBy	ApiUser	User information

ApiDocumentApiListResult

Search result

Name	Path	Type	Description
list	list	array of ApiDocument	List of all found values
hasMore	hasMore	boolean	True if search can return more values
offset	offset	integer	Offset value (Number of skipped values)

ApiEnum

Enum data for field type enum

Name	Path	Type	Description
id	id	string	Enum identifier
name	name	string	User friendly enum name
values	values	object	List of enum values
isEditable	isEditable	boolean	Indicates whether enum can be edited

ApiFolderCreationResult

Result from container creation

Name	Path	Type	Description
folderId	folderId	string	Container ID

ApiFolderWithMembers

Container metadata with metadata of documents inside the container

Name	Path	Type	Description
folderId	folderId	string	Document id.
ownerId	ownerId	string	Container owner id
created	created	date-time	Time of container creation
metadata	metadata	object	All headers attached to the container
members	members	array of ApiDocument	List of all container members

ApiItemCell

Name	Path	Type	Description
value	value	string	Cell value
modifiedByPostProcessing	modifiedByPostProcessing	boolean	Indicates if this value was modified by post processing
pluginResults	pluginResults	array of ApiPluginResult	Results from plugins

ApiItemColumn

Defines item table column.

Name	Path	Type	Description
field	field	string	Field
width	width	double	Height of the row.

ApiItemRow

Defines item table row.

Name	Path	Type	Description
height	height	double	Height of the row.
cells	cells	array of ApiItemCell	List of all cells in this column. Count should be always equal to number of columns.

ApiItemTable

Table of items

Name	Path	Type	Description
pageIndex	pageIndex	integer	Index of page to which the table belongs.
offset	offset	Offset	Defines two-dimensional offset with X and Y coordinates.
columns	columns	array of ApiItemColumn	List of column definitions.
rows	rows	array of ApiItemRow	List of row definitions and cells in each row.

ApiPage

Document page

Name	Path	Type	Description
index	index	integer	Document page index. Indexed from 1.
width	width	integer	Width of the page in pixels.
height	height	integer	Height of the page in pixels.
rotation	rotation	double	Rotation of the page in degrees.
words	words	array of ApiWord	List of all words present on the page.
itemTable	itemTable	ApiItemTable	Table of items

ApiPluginResult

Name	Path	Type	Description
pluginName	pluginName	string	Gets or sets name of script that has validated this document
resultCode	resultCode	PostProcessResult	Post processing result
value	value	string	Gets or sets the collection of localized messages
extraInformationRequired	extraInformationRequired	boolean	Gets or sets whether extra information is needed
extraInformationMessage	extraInformationMessage	string	Gets or sets the extra information requirements message

ApiUploadResponse

Result of an file upload

Name	Path	Type	Description
documentId	documentId	string	Document Id
folderId	folderId	string	Folder id

ApiUser

User information

Name	Path	Type	Description
id	id	string	Id of user
firstName	firstName	string	First name of user
lastName	lastName	string	Last name of user
email	email	string	Email of user

ApiUserApiListResult

Search result

Name	Path	Type	Description
list	list	array of ApiUser	List of all found values
hasMore	hasMore	boolean	True if search can return more values
offset	offset	integer	Offset value (Number of skipped values)

ApiWord

Name	Path	Type	Description
wordId	wordId	integer	Id of the word, unique for one document
pageIndex	pageIndex	integer	Index of the page the word is presented
text	text	string	Text of the word
locX	locX	integer	X-coordinate of the word
locY	locY	integer	Y-coordinate of the word
width	width	integer	Word's width
height	height	integer	Word's height

ApprovalState

State of the document

: string

DocumentSource

: string

DocumentState

State of the document

: string

LicenseTimePeriod

Time period for licenses

: string

MLicense

Name	Path	Type	Description
responseCode	responseCode	ResponseCode
responseMessage	responseMessage	string
validFrom	validFrom	date-time
validTo	validTo	date-time
nextPeriod	nextPeriod	date-time
usageLimit	usageLimit	integer
usageLimitPeriod	usageLimitPeriod	LicenseTimePeriod	Time period for licenses
isTrial	isTrial	boolean
usageCount	usageCount	integer

Offset

Defines two-dimensional offset with X and Y coordinates.

Name	Path	Type	Description
x	x	double	Offset at X coordinate.
y	y	double	Offset at Y coordinate.

PostProcessResult

Post processing result

: string

RedQueStatus

Status response data. Used as a response when request returns no data.

Name	Path	Type	Description
statusCode	statusCode	integer	Status code
message	message	string	Message

ResponseCode

: string

StringApiValue

Generic response value

Name	Path	Type	Description
value	value	string	Value

uri

: uri

Share via

Redque (Preview)

Throttling Limits

Actions

Add permissions

Parameters

Change password

Parameters

Change user's password

Parameters

Create folder

Returns

Create new enum

Parameters

Returns

Create user

Parameters

Delete user

Parameters

Deletes enum with specific id

Parameters

Download document's file

Parameters

Download folder

Parameters

Extract document

Parameters

Filter documents

Parameters

Returns

Filter users

Parameters

Returns

Find folder

Parameters

Returns

Find user

Parameters

Returns

Generate token

Returns

Get document's metadata

Parameters

Returns

Get extracted document

Parameters

Grant document access to specified user

Parameters

Image for a given page

Parameters

Returns

License information

Returns

Lock document

Parameters

Remove access to the document for specified user

Parameters

Remove existing document

Parameters

Remove folder

Parameters

Remove permissions

Parameters

Removes token

Return all enums

Returns

Return document to issuer for corrections

Parameters

Return enum

Parameters

Returns

Return to sender configuration

Return token

Returns

Unlock locked document

Parameters

Update document

Parameters

Returns

Update folder data