Redque (preview)
Het Redque-systeem openen en beheren.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Redque s.r.o. |
| URL | https://redque.com |
| E-mailen | info@redque.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Redque s.r.o. |
| Webpagina | https://redque.cz/en/ |
| Privacybeleid | https://redque.cz/policy.html |
| Categorieën | AI; Financieren |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Afbeelding voor een bepaalde pagina |
Retourneert een afbeelding voor een bepaalde pagina. |
| Alle opsommingen retourneren |
Retourneert een lijst met alle opsommingen. |
| Bestaand document verwijderen |
Hiermee verwijdert u een bestaand document. |
| Bestand van document downloaden |
Downloadt het bestand van het document. |
| Document bijwerken |
Document wordt bijgewerkt. |
| Document extraheren |
Vraagt om extractie van een document. Nadat het document is opgehaald, is het gepland voor verwijdering. |
| Document retourneren aan verlener voor correcties |
Retourneert een document naar de verlener voor correcties naar het opgegeven e-mailadres. |
| Document vergrendelen |
Hiermee wordt het document vergrendeld (wordt geopend) waardoor andere gebruikers het niet kunnen wijzigen. |
| Documenten filteren |
Retourneert een lijst met documenten op basis van parameters. |
| Documenttoegang verlenen aan de opgegeven gebruiker |
Verleent documenttoegang tot de opgegeven gebruiker. |
| Een document uploaden en plannen voor verwerking |
Uploadt het document en plant het voor verwerking. |
| Gebruiker bijwerken |
Hiermee wordt een opgegeven gebruiker gedeeltelijk bijgewerkt. |
| Gebruiker maken |
Hiermee maakt u een nieuwe gebruiker. |
| Gebruiker verwijderen |
Hiermee verwijdert u een gebruiker. |
| Gebruiker zoeken |
Hiermee zoekt u een gebruiker. |
| Gebruikers filteren |
Hiermee haalt u de lijst met gebruikers op basis van criteria op. |
| Geëxtraheerd document ophalen |
Het geëxtraheerde document is gemarkeerd voor verwijdering en wordt binnen enkele uren na toegang verwijderd. Dit geeft gebruikers de tijd om het resultaat opnieuw op te halen als ze mislukken. |
| Het wachtwoord van de gebruiker wijzigen |
Hiermee wijzigt u het wachtwoord voor de opgegeven gebruiker. Hiervoor is een machtiging voor gebruikersbeheer vereist. |
| Licentiegegevens |
Retourneert licentiegegevens. |
| Machtigingen toevoegen |
Voegt machtigingen toe aan de gebruiker. |
| Machtigingen verwijderen |
Hiermee worden de machtigingen van de gebruiker ingetrokken. |
| Map downloaden |
Downloadt alle documenten in een map als één archief. |
| Map maken |
Hiermee maakt u een nieuwe map. |
| Map verwijderen |
Hiermee verwijdert u de bestaande map. |
| Map zoeken |
Hiermee zoekt u de map op id. |
| Mapgegevens bijwerken |
Hiermee worden mapgegevens bijgewerkt. |
| Metagegevens van het document ophalen |
Hiermee haalt u de metagegevens van het document op. |
| Nieuwe opsomming maken |
De enum-sleutel wordt automatisch gegenereerd en waardesleutels mogen alleen kleine letters, hoofdletters, cijfers, onderstrepingstekens, streepje bevatten |
| Opsomming retourneren |
Retourneert een specifieke opsomming. |
| Opsomming verwijderen met specifieke id |
Hiermee verwijdert u een specifieke opsomming. |
| Specifieke opsomming bijwerken |
Hiermee wordt een specifieke opsomming bijgewerkt. |
| Terug naar de configuratie van de afzender |
De huidige configuratie ophalen om terug te keren naar de afzenderactie. |
| Terugkeer naar afzenderconfiguratie bijwerken |
Updates worden terug naar de configuratie van de afzender. |
| Toegang tot het document voor de opgegeven gebruiker verwijderen |
Hiermee verwijdert u de toegang tot het document voor de opgegeven gebruiker. |
| Token genereren |
Hiermee genereert u een nieuw registratietoken. |
| Token retourneren |
Retourneert het huidige registratietoken of niets als het token niet actief is. |
| Token wordt verwijderd |
Hiermee verwijdert u het registratietoken. |
| Vergrendeld document ontgrendelen |
Ontgrendelt vergrendeld (sluit) document zodat andere gebruikers de inhoud ervan kunnen wijzigen. |
| Wachtwoord wijzigen |
Hiermee wijzigt u het wachtwoord van de gebruiker. |
Afbeelding voor een bepaalde pagina
Retourneert een afbeelding voor een bepaalde pagina.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
documentId | True | string |
Document-id |
|
Pagina-index
|
pageIndex | True | integer |
Pagina-index |
|
Voorvertoning
|
isPreview | boolean |
Waar als de afbeelding met een kleiner formaat moet worden geretourneerd. |
Retouren
- response
- uri
Alle opsommingen retourneren
Bestaand document verwijderen
Hiermee verwijdert u een bestaand document.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
documentId | True | string |
document-id |
Bestand van document downloaden
Downloadt het bestand van het document.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
documentId | True | string |
Document-id |
Document bijwerken
Document wordt bijgewerkt.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
documentId | True | string |
Document-id |
|
documentId
|
documentId | string | ||
|
waarde
|
value | string | ||
|
waarde
|
value | string | ||
|
waarde
|
value | string | ||
|
waarde
|
value | string | ||
|
waarde
|
value | string | ||
|
waarde
|
value | string | ||
|
waarde
|
value | string | ||
|
waarde
|
value | boolean | ||
|
waarde
|
value | boolean | ||
|
waarde
|
value | string | ||
|
waarde
|
value | string | ||
|
operatie
|
operation | string | ||
|
key
|
key | string | ||
|
message
|
message | string | ||
|
isWarning
|
isWarning | boolean | ||
|
wordIds
|
wordIds | array of integer | ||
|
waarde
|
value | string | ||
|
operatie
|
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 |
Status van het document |
|
|
waarde
|
value | string | ||
|
operatie
|
operation | string | ||
|
waarde
|
value | string | ||
|
operatie
|
operation | string |
Retouren
Statusantwoordgegevens. Wordt gebruikt als antwoord wanneer een aanvraag geen gegevens retourneert.
- Body
- RedQueStatus
Document extraheren
Vraagt om extractie van een document. Nadat het document is opgehaald, is het gepland voor verwijdering.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
externalDocumentId | string |
Document-id (optioneel- uw externe document-id) |
|
|
Bestand
|
file | file |
Bestand |
Document retourneren aan verlener voor correcties
Retourneert een document naar de verlener voor correcties naar het opgegeven e-mailadres.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
documentId | True | string |
Document-id |
|
additionalDocuments
|
additionalDocuments | array of string | ||
|
recipientEmail
|
recipientEmail | string | ||
|
reden
|
reason | string | ||
|
requestedByUserId
|
requestedByUserId | string |
Document vergrendelen
Hiermee wordt het document vergrendeld (wordt geopend) waardoor andere gebruikers het niet kunnen wijzigen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
documentId | True | string |
Document-id |
Documenten filteren
Retourneert een lijst met documenten op basis van parameters.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Tekst
|
text | string |
Zoektekst die wordt gebruikt voor algemene zoekopdrachten |
|
|
waarde
|
value | string | ||
|
values
|
values | string |
Status van het document |
|
|
values
|
values | string |
Status van het document |
|
|
waarde
|
value | string | ||
|
waarde
|
value | boolean | ||
|
values
|
values | string | ||
|
values
|
values | array of string | ||
|
van
|
from | date-time | ||
|
naar
|
to | date-time | ||
|
velden
|
fields | object |
Veldfilters |
|
|
skip
|
skip | integer |
Hoeveel items u wilt overslaan vanaf het begin van de lijst. Staat paginering toe. |
|
|
nemen
|
take | integer |
Maximum aantal lijstitems dat wordt geretourneerd |
|
|
veld
|
field | string |
Lijst met eigenschappen waarop de resultaten kunnen worden gesorteerd |
|
|
richting
|
direction | string |
Richting waarin lijstwaarden worden gesorteerd |
|
|
reikwijdtes
|
scopes | string |
Documentbereik waarmee wordt gefilterd welke delen van het document moeten worden geretourneerd |
Retouren
Zoekresultaat
Documenttoegang verlenen aan de opgegeven gebruiker
Verleent documenttoegang tot de opgegeven gebruiker.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
documentId | True | string |
Document-id |
|
Gebruikers-ID
|
userId | True | string |
Gebruikers-ID |
|
documentId
|
documentId | string |
Document-id |
|
|
userId
|
userId | string |
Gebruikers-id |
|
|
message
|
message | string |
Een document uploaden en plannen voor verwerking
Uploadt het document en plant het voor verwerking.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestand
|
File | file |
Bestand |
|
|
Externe id van document
|
DocumentId | string |
Externe document-id |
|
|
Map-id
|
FolderId | string |
Map-id |
|
|
Datum
|
Date | date-time |
Datum |
|
|
Bestelling
|
Ordinal | integer |
Volgorde die wordt gebruikt voor het bewaren van de volgorde van documenten die parallel worden geüpload |
|
|
Is een bijlage bij het document
|
IsAttachment | boolean |
Waar als het document een bijlage is |
|
|
Documentklasse
|
DocumentClass | string |
Documentklasse |
Retouren
Resultaat van het uploaden van een bestand
- Body
- ApiUploadResponse
Gebruiker bijwerken
Hiermee wordt een opgegeven gebruiker gedeeltelijk bijgewerkt.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikers-ID
|
userId | True | string |
Gebruikers-id |
|
voornaam
|
firstName | string |
Voornaam van gebruiker |
|
|
achternaam
|
lastName | string |
Achternaam van gebruiker |
Gebruiker maken
Hiermee maakt u een nieuwe gebruiker.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
voornaam
|
firstName | string |
Voornaam van gebruiker |
|
|
achternaam
|
lastName | string |
Achternaam van gebruiker |
|
|
wachtwoord
|
password | string |
Wachtwoord van account |
|
|
e-mailadres
|
string |
E-mail (aanmeldingsnaam) van de gebruiker |
Gebruiker verwijderen
Hiermee verwijdert u een gebruiker.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikers-ID
|
userId | True | string |
Gebruikersnaam |
Gebruiker zoeken
Hiermee zoekt u een gebruiker.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikers-ID
|
userId | True | string |
Id van de gebruiker |
Retouren
Gebruikersgegevens
- Body
- ApiUser
Gebruikers filteren
Hiermee haalt u de lijst met gebruikers op basis van criteria op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Tekst
|
text | string |
Zoektekst die wordt gebruikt voor algemene zoekopdrachten |
|
|
waarde
|
value | string | ||
|
skip
|
skip | integer |
Hoeveel items u wilt overslaan vanaf het begin van de lijst. Staat paginering toe. |
|
|
nemen
|
take | integer |
Maximum aantal lijstitems dat wordt geretourneerd |
|
|
veld
|
field | string |
Enum voor het declareren van sorteerparameters van de gebruiker |
|
|
richting
|
direction | string |
Richting waarin lijstwaarden worden gesorteerd |
Retouren
Zoekresultaat
- Body
- ApiUserApiListResult
Geëxtraheerd document ophalen
Het geëxtraheerde document is gemarkeerd voor verwijdering en wordt binnen enkele uren na toegang verwijderd. Dit geeft gebruikers de tijd om het resultaat opnieuw op te halen als ze mislukken.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
id | True | string |
Document-id (geleverd door RedQue of extern) |
Het wachtwoord van de gebruiker wijzigen
Hiermee wijzigt u het wachtwoord voor de opgegeven gebruiker. Hiervoor is een machtiging voor gebruikersbeheer vereist.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikers-ID
|
userId | True | string |
Id van de gebruiker |
|
wachtwoord
|
password | string |
Wachtwoord van gebruiker |
|
|
accountId
|
accountId | string |
Account-id van gebruiker |
|
|
activationkey
|
activationkey | string |
Activeringssleutel van gebruiker |
Licentiegegevens
Machtigingen toevoegen
Voegt machtigingen toe aan de gebruiker.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikers-ID
|
userId | True | string |
Id van de gebruiker |
|
permissions
|
permissions | array of string |
Toegang krijgen tot gegevens |
Machtigingen verwijderen
Hiermee worden de machtigingen van de gebruiker ingetrokken.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikers-ID
|
userId | True | string |
Id van de gebruiker |
|
permissions
|
permissions | array of string |
Toegang krijgen tot gegevens |
Map downloaden
Downloadt alle documenten in een map als één archief.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Map-id
|
folderId | True | string |
Map-id |
Map maken
Hiermee maakt u een nieuwe map.
Retouren
Resultaat van het maken van een container
Map verwijderen
Hiermee verwijdert u de bestaande map.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Map-id
|
folderId | True | string |
Map-id |
Map zoeken
Hiermee zoekt u de map op id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Map-id
|
folderId | True | string |
Map-id |
|
Met leden
|
withMembers | boolean |
Waar als document met leden |
Retouren
Containermetagegevens met metagegevens van documenten in de container
- Body
- ApiFolderWithMembers
Mapgegevens bijwerken
Hiermee worden mapgegevens bijgewerkt.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Map-id
|
folderId | True | string |
Map-id |
|
folderId
|
folderId | string |
Document-id. |
|
|
eigenaarId
|
ownerId | string |
Id van containereigenaar |
|
|
geschapen
|
created | date-time |
Tijd van het maken van een container |
|
|
metadata
|
metadata | object |
Alle headers die aan de container zijn gekoppeld |
Metagegevens van het document ophalen
Hiermee haalt u de metagegevens van het document op.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
documentId | True | string |
document-id |
|
Is document-id extern id?
|
isExternalId | boolean |
Is document-id extern id? |
Retouren
- Body
- ApiDocument
Nieuwe opsomming maken
De enum-sleutel wordt automatisch gegenereerd en waardesleutels mogen alleen kleine letters, hoofdletters, cijfers, onderstrepingstekens, streepje bevatten
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
identiteitskaart
|
id | string |
Opsommings-id |
|
|
naam
|
name | string |
Gebruiksvriendelijke enumnaam |
|
|
values
|
values | object |
Lijst met opsommingswaarden |
|
|
isBewerkbaar
|
isEditable | boolean |
Geeft aan of enum kan worden bewerkt |
Retouren
Algemene antwoordwaarde
- Body
- StringApiValue
Opsomming retourneren
Retourneert een specifieke opsomming.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Opsommings-id
|
id | True | string |
Opsommings-id |
Retouren
Enum-gegevens voor veldtype enum
- Body
- ApiEnum
Opsomming verwijderen met specifieke id
Hiermee verwijdert u een specifieke opsomming.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Opsommingssleutel
|
id | True | string |
Enum-id/-sleutel |
Specifieke opsomming bijwerken
Hiermee wordt een specifieke opsomming bijgewerkt.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Opsommings-id
|
id | True | string |
Opsommings-id |
|
identiteitskaart
|
id | string |
Opsommings-id |
|
|
naam
|
name | string |
Gebruiksvriendelijke enumnaam |
|
|
values
|
values | object |
Lijst met opsommingswaarden |
|
|
isBewerkbaar
|
isEditable | boolean |
Geeft aan of enum kan worden bewerkt |
Terug naar de configuratie van de afzender
De huidige configuratie ophalen om terug te keren naar de afzenderactie.
Terugkeer naar afzenderconfiguratie bijwerken
Updates worden terug naar de configuratie van de afzender.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
sjabloon
|
template | string | ||
|
Onderwerp
|
subject | string |
Toegang tot het document voor de opgegeven gebruiker verwijderen
Hiermee verwijdert u de toegang tot het document voor de opgegeven gebruiker.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
documentId | True | string |
Document-id |
|
Gebruikers-ID
|
userId | True | string |
Gebruikers-id |
Token genereren
Hiermee genereert u een nieuw registratietoken.
Retouren
Algemene antwoordwaarde
- Body
- StringApiValue
Token retourneren
Retourneert het huidige registratietoken of niets als het token niet actief is.
Retouren
Algemene antwoordwaarde
- Body
- StringApiValue
Token wordt verwijderd
Hiermee verwijdert u het registratietoken.
Vergrendeld document ontgrendelen
Ontgrendelt vergrendeld (sluit) document zodat andere gebruikers de inhoud ervan kunnen wijzigen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id
|
documentId | True | string |
Document-id |
Wachtwoord wijzigen
Hiermee wijzigt u het wachtwoord van de gebruiker.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikers-ID
|
userId | True | string |
Id van de gebruiker |
|
body
|
body | string |
Wachtwoord van de gebruiker |
Definities
ApiApproval
| Name | Pad | Type | Description |
|---|---|---|---|
|
fiatteur
|
approver | ApiUser |
Gebruikersgegevens |
|
approvalStepTime
|
approvalStepTime | date-time |
Toewijzingstijd aan de huidige fiatteur'. |
|
approvalState
|
approvalState | ApprovalState |
Status van het document |
|
delegatedTo
|
delegatedTo | ApiUser |
Gebruikersgegevens |
|
notitie
|
note | string |
Notitie fiatteur |
ApiApprovalReminder
| Name | Pad | Type | Description |
|---|---|---|---|
|
fromUser
|
fromUser | ApiUser |
Gebruikersgegevens |
|
toUser
|
toUser | ApiUser |
Gebruikersgegevens |
|
sentTime
|
sentTime | date-time |
Tijd van verzenden |
|
notitie
|
note | string |
Urgentienotitie |
ApiDocument
| Name | Pad | Type | Description |
|---|---|---|---|
|
documentId
|
documentId | string |
Document-id |
|
externalDocumentId
|
externalDocumentId | string |
Externe document-id |
|
folderId
|
folderId | string |
Documentcontainer-id |
|
contentHash
|
contentHash | string |
Hash van de inhoud |
|
pageCount
|
pageCount | integer |
Totaal aantal pagina's in het document, eerste index is 1. Dit aantal is mogelijk niet gelijk aan het aantal pagina's, omdat als het document te veel pagina's bevat, sommige pagina's mogelijk worden overgeslagen vanwege prestatieredenen |
|
fileName
|
fileName | string |
Bestandsnaam van het document |
|
owner
|
owner | ApiUser |
Gebruikersgegevens |
|
state
|
state | DocumentState |
Status van het document |
|
fout
|
error | string |
Foutcode van het document |
|
isImagesGenerated
|
isImagesGenerated | boolean |
Er zijn installatiekopieën gegenereerd |
|
isReturned
|
isReturned | boolean |
Waar als documenten naar de afzender zijn geretourneerd. |
|
returnReason
|
returnReason | string |
Reden voor de retourzending. |
|
creatietijd
|
creationTime | date-time |
Aanmaakdatum |
|
size
|
size | integer |
Grootte van het document in KB |
|
inhoudstype
|
contentType | string |
Inhoudstype |
|
source
|
source | DocumentSource | |
|
bronInfo
|
sourceInfo | string |
Brongegevens (in het algemeen e-mailadres) |
|
extractionTime
|
extractionTime | date-time |
Classificatiedatum |
|
model
|
model | string |
Type van dit document |
|
isAttachment
|
isAttachment | boolean |
Geeft aan of het document een bijlage is |
|
isValidated
|
isValidated | boolean |
Indicator of het document is gevalideerd |
|
is bewerkt
|
isEdited | boolean |
Indicator, als dit document is bewerkt (ten minste één veld, notitie of tag is gewijzigd) |
|
notitie
|
note | string |
Aangepaste gebruikersnotitie |
|
velden
|
fields | object |
Lijst met geëxtraheerde velden |
|
items
|
items | array of object |
Lijst met geëxtraheerde items |
|
items
|
items | object | |
|
pages
|
pages | array of ApiPage |
Lijst met alle pagina's die deel uitmaken van een extractie. |
|
pluginResults
|
pluginResults | array of ApiPluginResult |
Algemene resultaten |
|
isPostProcessCompleted
|
isPostProcessCompleted | boolean |
Indicator, als de naverwerking is voltooid |
|
isPrevalidated
|
isPrevalidated | boolean |
Of een document al dan niet over een aantal prevalidatie pp-scripts beschikt |
|
lastOpenTime
|
lastOpenTime | date-time |
Laatst geopende datum |
|
lastOpenUserId
|
lastOpenUserId | string |
Id van de gebruiker die dit document voor het laatst heeft geopend |
|
isLocked
|
isLocked | boolean |
Bepaalt of het document is vergrendeld of niet |
|
validationTime
|
validationTime | date-time |
Het tijdstip waarop het document is gevalideerd |
|
version
|
version | integer |
Versienummer, verhoogd met elke update |
|
approvalState
|
approvalState | ApprovalState |
Status van het document |
|
currentApproverId
|
currentApproverId | string |
Id van de gebruiker die dit document moet goedkeuren |
|
lastApprovalStepTime
|
lastApprovalStepTime | date-time |
Toewijzingstijd aan de huidige fiatteur |
|
isCurrentApproverNotificationSent
|
isCurrentApproverNotificationSent | boolean |
Er is een melding verzonden naar de huidige fiatteur |
|
approvalHistory
|
approvalHistory | array of ApiApproval |
Goedkeuringsgeschiedenis |
|
approvalReminderHistory
|
approvalReminderHistory | array of ApiApprovalReminder |
Geschiedenis goedkeuren |
|
authorizedUserIds
|
authorizedUserIds | array of string |
Gebruikers die gemachtigd zijn voor toegang tot het document |
|
duplicateDocIds
|
duplicateDocIds | array of string |
Dubbele document-id's (op basis van veldwaarden) |
|
approvedBy
|
approvedBy | ApiUser |
Gebruikersgegevens |
|
validatedBy
|
validatedBy | ApiUser |
Gebruikersgegevens |
ApiDocumentApiListResult
Zoekresultaat
| Name | Pad | Type | Description |
|---|---|---|---|
|
list
|
list | array of ApiDocument |
Lijst met alle gevonden waarden |
|
hasMore
|
hasMore | boolean |
Waar als zoeken meer waarden kan retourneren |
|
offset
|
offset | integer |
Verschuivingswaarde (aantal overgeslagen waarden) |
ApiEnum
Enum-gegevens voor veldtype enum
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string |
Opsommings-id |
|
naam
|
name | string |
Gebruiksvriendelijke enumnaam |
|
values
|
values | object |
Lijst met opsommingswaarden |
|
isBewerkbaar
|
isEditable | boolean |
Geeft aan of enum kan worden bewerkt |
ApiFolderCreationResult
Resultaat van het maken van een container
| Name | Pad | Type | Description |
|---|---|---|---|
|
folderId
|
folderId | string |
Container-ID |
ApiFolderWithMembers
Containermetagegevens met metagegevens van documenten in de container
| Name | Pad | Type | Description |
|---|---|---|---|
|
folderId
|
folderId | string |
Document-id. |
|
eigenaarId
|
ownerId | string |
Id van containereigenaar |
|
geschapen
|
created | date-time |
Tijd van het maken van een container |
|
metadata
|
metadata | object |
Alle headers die aan de container zijn gekoppeld |
|
leden
|
members | array of ApiDocument |
Lijst met alle containerleden |
ApiItemCell
| Name | Pad | Type | Description |
|---|---|---|---|
|
waarde
|
value | string |
Celwaarde |
|
modifiedByPostProcessing
|
modifiedByPostProcessing | boolean |
Geeft aan of deze waarde is gewijzigd door naverwerking |
|
pluginResults
|
pluginResults | array of ApiPluginResult |
Resultaten van invoegtoepassingen |
ApiItemColumn
Hiermee definieert u de kolom itemtabel.
| Name | Pad | Type | Description |
|---|---|---|---|
|
veld
|
field | string |
Veld |
|
width
|
width | double |
Hoogte van de rij. |
ApiItemRow
Hiermee definieert u de rij van de itemtabel.
| Name | Pad | Type | Description |
|---|---|---|---|
|
height
|
height | double |
Hoogte van de rij. |
|
Cellen
|
cells | array of ApiItemCell |
Lijst met alle cellen in deze kolom. Aantal moet altijd gelijk zijn aan het aantal kolommen. |
ApiItemTable
Tabel met items
| Name | Pad | Type | Description |
|---|---|---|---|
|
pageIndex
|
pageIndex | integer |
Index van pagina waartoe de tabel behoort. |
|
offset
|
offset | Offset |
Definieert tweedimensionale verschuiving met X- en Y-coördinaten. |
|
columns
|
columns | array of ApiItemColumn |
Lijst met kolomdefinities. |
|
rijen
|
rows | array of ApiItemRow |
Lijst met rijdefinities en cellen in elke rij. |
ApiPage
Documentpagina
| Name | Pad | Type | Description |
|---|---|---|---|
|
index
|
index | integer |
Index van documentpagina. Geïndexeerd vanaf 1. |
|
width
|
width | integer |
Breedte van de pagina in pixels. |
|
height
|
height | integer |
Hoogte van de pagina in pixels. |
|
rotatie
|
rotation | double |
Draaiing van de pagina in graden. |
|
words
|
words | array of ApiWord |
Lijst met alle woorden die op de pagina aanwezig zijn. |
|
itemTable
|
itemTable | ApiItemTable |
Tabel met items |
ApiPluginResult
| Name | Pad | Type | Description |
|---|---|---|---|
|
pluginName
|
pluginName | string |
Hiermee wordt de naam van het script opgehaald of ingesteld dat dit document heeft gevalideerd |
|
resultCode
|
resultCode | PostProcessResult |
Resultaat na verwerking |
|
waarde
|
value | string |
Hiermee haalt u de verzameling gelokaliseerde berichten op of stelt u deze in |
|
extraInformationRequired
|
extraInformationRequired | boolean |
Hiermee haalt u op of stelt u in of er extra informatie nodig is |
|
extraInformationMessage
|
extraInformationMessage | string |
Hiermee wordt het bericht over extra informatievereisten opgehaald of ingesteld |
ApiUploadResponse
Resultaat van het uploaden van een bestand
| Name | Pad | Type | Description |
|---|---|---|---|
|
documentId
|
documentId | string |
Document-id |
|
folderId
|
folderId | string |
Map-id |
ApiUser
Gebruikersgegevens
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string |
Id van gebruiker |
|
voornaam
|
firstName | string |
Voornaam van gebruiker |
|
achternaam
|
lastName | string |
Achternaam van gebruiker |
|
e-mailadres
|
string |
E-mail van gebruiker |
ApiUserApiListResult
Zoekresultaat
| Name | Pad | Type | Description |
|---|---|---|---|
|
list
|
list | array of ApiUser |
Lijst met alle gevonden waarden |
|
hasMore
|
hasMore | boolean |
Waar als zoeken meer waarden kan retourneren |
|
offset
|
offset | integer |
Verschuivingswaarde (aantal overgeslagen waarden) |
ApiWord
| Name | Pad | Type | Description |
|---|---|---|---|
|
wordId
|
wordId | integer |
Id van het woord, uniek voor één document |
|
pageIndex
|
pageIndex | integer |
Index van de pagina waarop het woord wordt weergegeven |
|
Tekst
|
text | string |
Tekst van het woord |
|
locX
|
locX | integer |
X-coördinaat van het woord |
|
locY
|
locY | integer |
Y-coördinaat van het woord |
|
width
|
width | integer |
De breedte van Word |
|
height
|
height | integer |
De hoogte van Word |
ApprovalState
Documentbron
DocumentState
LicenseTimePeriod
MLicense
| Name | Pad | Type | Description |
|---|---|---|---|
|
antwoord Code
|
responseCode | ResponseCode | |
|
responseMessage
|
responseMessage | string | |
|
validFrom
|
validFrom | date-time | |
|
validTo
|
validTo | date-time | |
|
nextPeriod
|
nextPeriod | date-time | |
|
usageLimit
|
usageLimit | integer | |
|
usageLimitPeriod
|
usageLimitPeriod | LicenseTimePeriod |
Tijdsperiode voor licenties |
|
isTrial
|
isTrial | boolean | |
|
usageCount
|
usageCount | integer |
Offset
Definieert tweedimensionale verschuiving met X- en Y-coördinaten.
| Name | Pad | Type | Description |
|---|---|---|---|
|
x
|
x | double |
Verschuiving bij X-coördinaat. |
|
y
|
y | double |
Verschuiving bij Y-coördinaat. |
PostProcessResult
RedQueStatus
Statusantwoordgegevens. Wordt gebruikt als antwoord wanneer een aanvraag geen gegevens retourneert.
| Name | Pad | Type | Description |
|---|---|---|---|
|
statuscode
|
statusCode | integer |
Statuscode |
|
message
|
message | string |
Message |
Antwoordcode
StringApiValue
Algemene antwoordwaarde
| Name | Pad | Type | Description |
|---|---|---|---|
|
waarde
|
value | string |
Waarde |