Udostępnij przez

Redque (wersja zapoznawcza)

Uzyskiwanie dostępu do systemu Redque i zarządzanie nim.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Redque s.r.o.
adres URL https://redque.com
Email info@redque.com
Metadane łącznika
Publisher Redque s.r.o.
Witryna internetowa https://redque.cz/en/
Zasady ochrony prywatności https://redque.cz/policy.html
Kategorie AI; Finanse

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Aktualizacja powrotu do konfiguracji nadawcy

Aktualizacje wracają do konfiguracji nadawcy.
Aktualizowanie danych folderu

Aktualizuje dane folderów.
Aktualizowanie dokumentu

Aktualizuje dokument.
Aktualizowanie określonego wyliczenia

Aktualizuje określone wyliczenie.
Aktualizowanie użytkownika

Częściowo aktualizuje określonego użytkownika.
Blokowanie dokumentu

Blokuje (otwiera) dokument uniemożliwiający innym użytkownikom modyfikowanie go.
Dodawanie uprawnień

Dodaje uprawnienia do użytkownika.
Filtrowanie dokumentów

Zwraca listę dokumentów na podstawie parametrów.
Filtrowanie użytkowników

Pobiera listę użytkowników według kryteriów.
Folder pobierania

Pobiera wszystkie dokumenty w folderze jako pojedyncze archiwum.
Generowanie tokenu

Generuje nowy token rejestracji.
Informacje o licencji

Zwraca informacje o licencji.
Obraz dla danej strony

Zwraca obraz dla danej strony.
Odblokowywanie zablokowanego dokumentu

Odblokowywane (zamyka) dokument, aby umożliwić innym użytkownikom modyfikowanie jego zawartości.
Pobieranie metadanych dokumentu

Pobiera metadane dokumentu.
Pobieranie pliku dokumentu

Pobiera plik dokumentu.
Pobieranie wyodrębnionego dokumentu

Wyodrębniony dokument jest oznaczony do usunięcia i zostanie usunięty w ciągu kilku godzin od uzyskania dostępu. Daje to użytkownikom czas na ponowienie próby pobrania wyniku, jeśli wystąpi niepowodzenie.
Powrót do konfiguracji nadawcy

Pobierz bieżącą konfigurację, aby powrócić do akcji nadawcy.
Przekazywanie dokumentu i planowanie jego przetwarzania

Przekazuje dokument i planuje jego przetwarzanie.
Tworzenie nowego wyliczenia

Należy pamiętać, że klucz wyliczenia jest generowany automatycznie, a klucze wartości muszą zawierać tylko małe litery, wielkie litery, cyfry, podkreślenie, kreskę
Udzielanie dostępu do dokumentu określonemu użytkownikowi

Udziela dostępu do dokumentu określonemu użytkownikowi.
Usuwa token

Usuwa token rejestracji.
Usuwa wyliczenie o określonym identyfikatorze

Usuwa określone wyliczenie.
Usuwanie dostępu do dokumentu dla określonego użytkownika

Usuwa dostęp do dokumentu dla określonego użytkownika.
Usuwanie uprawnień

Odwołuje uprawnienia użytkownika.
Usuwanie użytkownika

Usuwa użytkownika.
Usuń folder

Usuwa istniejący folder.
Usuń istniejący dokument

Usuwa istniejący dokument.
Utwórz folder

Tworzy nowy folder.
Utwórz użytkownika

Tworzy nowego użytkownika.
Wyodrębnianie dokumentu

Żąda wyodrębniania dokumentu. Po pobraniu dokumentu zaplanowano jego usunięcie.
Zmienianie hasła użytkownika

Zmienia hasło dla określonego użytkownika. Wymaga uprawnień do zarządzania użytkownikami.
Zmień hasło

Zmienia hasło użytkownika.
Znajdowanie użytkownika

Znajduje użytkownika.
Znajdź folder

Znajduje folder według identyfikatora.
Zwracane wyliczenie

Zwraca określone wyliczenie.
Zwracanie dokumentu do wystawcy w celu uzyskania poprawek

Zwraca dokument do wystawcy w celu skorygowania podanego adresu e-mail.
Zwracanie tokenu

Zwraca bieżący token rejestracji lub nic, jeśli token nie jest aktywny.
Zwracanie wszystkich wyliczenia

Zwraca listę wszystkich wyliczenia.

Aktualizacja powrotu do konfiguracji nadawcy

Identyfikator operacji:
StoreReturnDocumentConfiguration

Aktualizacje wracają do konfiguracji nadawcy.

Parametry

Nazwa Klucz Wymagane Typ Opis
szablon
 template string
Temat
 subject string

Aktualizowanie danych folderu

Identyfikator operacji:
UpdateContainerData

Aktualizuje dane folderów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator folderu
 folderId True string

Identyfikator folderu
folderId
 folderId string

Identyfikator dokumentu.
Identyfikator właściciela
 ownerId string

Identyfikator właściciela kontenera
utworzone
 created date-time

Czas tworzenia kontenera
metadane
 metadata object

Wszystkie nagłówki dołączone do kontenera

Aktualizowanie dokumentu

Identyfikator operacji:
UpdateDocuments

Aktualizuje dokument.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu
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
operacja
 operation string
klucz
 key string
komunikat
 message string
isWarning
 isWarning boolean
wordIds
 wordIds array of integer
value
 value string
operacja
 operation string
klucz
 key string
komunikat
 message string
isWarning
 isWarning boolean
wordIds
 wordIds array of integer
userId
 userId string
userId
 userId string
stan
 state string

Stan dokumentu
value
 value string
operacja
 operation string
value
 value string
operacja
 operation string

Zwraca

Dane odpowiedzi o stanie. Używana jako odpowiedź, gdy żądanie nie zwraca żadnych danych.

Body
RedQueStatus

Aktualizowanie określonego wyliczenia

Identyfikator operacji:
UpdateEnum

Aktualizuje określone wyliczenie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator wyliczenia
 id True string

Identyfikator wyliczenia
id
 id string

Identyfikator wyliczenia
nazwa
 name string

Przyjazna nazwa wyliczenia
values
 values object

Lista wartości wyliczenia
jest edytowalny
 isEditable boolean

Wskazuje, czy można edytować wyliczenie

Aktualizowanie użytkownika

Identyfikator operacji:
UpdateUser

Częściowo aktualizuje określonego użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
 userId True string

Identyfikator użytkownika
imię
 firstName string

Imię użytkownika
nazwisko
 lastName string

Nazwisko użytkownika

Blokowanie dokumentu

Identyfikator operacji:
LockDocument

Blokuje (otwiera) dokument uniemożliwiający innym użytkownikom modyfikowanie go.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu

Dodawanie uprawnień

Identyfikator operacji:
AddUserPermissions

Dodaje uprawnienia do użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
 userId True string

Identyfikator użytkownika
uprawnienia
 permissions array of string

Dostęp do danych

Filtrowanie dokumentów

Identyfikator operacji:
ListAllDocuments

Zwraca listę dokumentów na podstawie parametrów.

Parametry

Nazwa Klucz Wymagane Typ Opis
SMS
 text string

Tekst wyszukiwania używany do wyszukiwania ogólnego
value
 value string
values
 values string

Stan dokumentu
values
 values string

Stan dokumentu
value
 value string
value
 value boolean
values
 values string
values
 values array of string
z
 from date-time
na
 to date-time
pola
 fields object

Filtry pól
pominąć
 skip integer

Ile elementów należy pominąć od początku listy. Umożliwia stronicowanie.
brać
 take integer

Maksymalna liczba elementów listy, które zostaną zwrócone
pole
 field string

Lista właściwości, na których można sortować wyniki
kierunek
 direction string

Kierunek sortowania wartości listy
zakresy
 scopes string

Zakres dokumentu, który filtruje, które części dokumentu powinny być zwracane

Zwraca

Wynik wyszukiwania

Body
ApiDocumentApiListResult

Filtrowanie użytkowników

Identyfikator operacji:
ListOfUsers

Pobiera listę użytkowników według kryteriów.

Parametry

Nazwa Klucz Wymagane Typ Opis
SMS
 text string

Tekst wyszukiwania używany do wyszukiwania ogólnego
value
 value string
pominąć
 skip integer

Ile elementów należy pominąć od początku listy. Umożliwia stronicowanie.
brać
 take integer

Maksymalna liczba elementów listy, które zostaną zwrócone
pole
 field string

Wyliczenie do deklarowania parametrów sortowania użytkownika
kierunek
 direction string

Kierunek sortowania wartości listy

Zwraca

Wynik wyszukiwania

Body
ApiUserApiListResult

Folder pobierania

Identyfikator operacji:
DownloadFolderArchived

Pobiera wszystkie dokumenty w folderze jako pojedyncze archiwum.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator folderu
 folderId True string

Identyfikator folderu

Generowanie tokenu

Identyfikator operacji:
GenerateRegistrationToken

Generuje nowy token rejestracji.

Zwraca

Ogólna wartość odpowiedzi

Body
StringApiValue

Informacje o licencji

Identyfikator operacji:
GetLicenseInfo

Zwraca informacje o licencji.

Zwraca

Body
MLicense

Obraz dla danej strony

Identyfikator operacji:
GetImage

Zwraca obraz dla danej strony.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu
Indeks strony
 pageIndex True integer

Indeks strony
Preview
 isPreview boolean

Wartość True, jeśli powinien zostać zwrócony obraz o zmniejszonym rozmiarze.

Zwraca

response
uri

Odblokowywanie zablokowanego dokumentu

Identyfikator operacji:
UnlockDocumentAsync

Odblokowywane (zamyka) dokument, aby umożliwić innym użytkownikom modyfikowanie jego zawartości.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu

Pobieranie metadanych dokumentu

Identyfikator operacji:
GetDocument

Pobiera metadane dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

identyfikator dokumentu
Czy identyfikator dokumentu jest identyfikatorem zewnętrznym?
 isExternalId boolean

Czy identyfikator dokumentu jest identyfikatorem zewnętrznym?

Zwraca

Body
ApiDocument

Pobieranie pliku dokumentu

Identyfikator operacji:
DownloadFileAsync

Pobiera plik dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu

Pobieranie wyodrębnionego dokumentu

Identyfikator operacji:
GetExtractDocument

Wyodrębniony dokument jest oznaczony do usunięcia i zostanie usunięty w ciągu kilku godzin od uzyskania dostępu. Daje to użytkownikom czas na ponowienie próby pobrania wyniku, jeśli wystąpi niepowodzenie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 id True string

Identyfikator dokumentu (dostarczony przez redque lub zewnętrzny)

Powrót do konfiguracji nadawcy

Identyfikator operacji:
ReturnDocumentConfiguration

Pobierz bieżącą konfigurację, aby powrócić do akcji nadawcy.

Przekazywanie dokumentu i planowanie jego przetwarzania

Identyfikator operacji:
UploadDocumentAsync

Przekazuje dokument i planuje jego przetwarzanie.

Parametry

Nazwa Klucz Wymagane Typ Opis
File
 File file

File
Identyfikator zewnętrzny dokumentu
 DocumentId string

Identyfikator dokumentu zewnętrznego
Identyfikator folderu
 FolderId string

Identyfikator folderu
Date
 Date date-time

Date
Zamówienie
 Ordinal integer

Kolejność używana do przechowywania kolejności dokumentów, które są przekazywane równolegle
Czy dokument jest załącznikiem
 IsAttachment boolean

Prawda, jeśli dokument jest załącznikiem
Klasa dokumentu
 DocumentClass string

Klasa dokumentu

Zwraca

Wynik przekazywania pliku

Body
ApiUploadResponse

Tworzenie nowego wyliczenia

Identyfikator operacji:
CreateEnum

Należy pamiętać, że klucz wyliczenia jest generowany automatycznie, a klucze wartości muszą zawierać tylko małe litery, wielkie litery, cyfry, podkreślenie, kreskę

Parametry

Nazwa Klucz Wymagane Typ Opis
id
 id string

Identyfikator wyliczenia
nazwa
 name string

Przyjazna nazwa wyliczenia
values
 values object

Lista wartości wyliczenia
jest edytowalny
 isEditable boolean

Wskazuje, czy można edytować wyliczenie

Zwraca

Ogólna wartość odpowiedzi

Body
StringApiValue

Udzielanie dostępu do dokumentu określonemu użytkownikowi

Identyfikator operacji:
GrantDocumentAccess

Udziela dostępu do dokumentu określonemu użytkownikowi.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu
Identyfikator użytkownika
 userId True string

Identyfikator użytkownika
documentId
 documentId string

Identyfikator dokumentu
userId
 userId string

Identyfikator użytkownika
komunikat
 message string

Usuwa token

Identyfikator operacji:
DisableRegistrationToken

Usuwa token rejestracji.

Usuwa wyliczenie o określonym identyfikatorze

Identyfikator operacji:
DeleteEnum

Usuwa określone wyliczenie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Klucz wyliczenia
 id True string

Identyfikator/klucz wyliczenia

Usuwanie dostępu do dokumentu dla określonego użytkownika

Identyfikator operacji:
RemoveDocumentAccess

Usuwa dostęp do dokumentu dla określonego użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu
Identyfikator użytkownika
 userId True string

Identyfikator użytkownika

Usuwanie uprawnień

Identyfikator operacji:
RemoveUserPermissions

Odwołuje uprawnienia użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
 userId True string

Identyfikator użytkownika
uprawnienia
 permissions array of string

Dostęp do danych

Usuwanie użytkownika

Identyfikator operacji:
DeleteUser

Usuwa użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
 userId True string

Identyfikator użytkownika

Usuń folder

Identyfikator operacji:
DeleteFolder

Usuwa istniejący folder.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator folderu
 folderId True string

Identyfikator folderu

Usuń istniejący dokument

Identyfikator operacji:
DeleteDocument

Usuwa istniejący dokument.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

identyfikator dokumentu

Utwórz folder

Identyfikator operacji:
CreateFolder

Tworzy nowy folder.

Zwraca

Wynik tworzenia kontenera

Body
ApiFolderCreationResult

Utwórz użytkownika

Identyfikator operacji:
CreateUser

Tworzy nowego użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
imię
 firstName string

Imię użytkownika
nazwisko
 lastName string

Nazwisko użytkownika
hasło
 password string

Hasło konta
e-mail
 email string

Adres e-mail (nazwa logowania) użytkownika

Wyodrębnianie dokumentu

Identyfikator operacji:
ExtractDocument

Żąda wyodrębniania dokumentu. Po pobraniu dokumentu zaplanowano jego usunięcie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 externalDocumentId string

Identyfikator dokumentu (opcjonalnie — identyfikator dokumentu zewnętrznego)
File
 file file

File

Zmienianie hasła użytkownika

Identyfikator operacji:
ForceUserPasswordChange

Zmienia hasło dla określonego użytkownika. Wymaga uprawnień do zarządzania użytkownikami.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
 userId True string

Identyfikator użytkownika
hasło
 password string

Hasło użytkownika
accountId
 accountId string

Identyfikator konta użytkownika
klucz aktywacji
 activationkey string

Klucz aktywacji użytkownika

Zmień hasło

Identyfikator operacji:
ChangePassword

Zmienia hasło użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
 userId True string

Identyfikator użytkownika
body
 body string

Hasło użytkownika

Znajdowanie użytkownika

Identyfikator operacji:
GetUser

Znajduje użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator użytkownika
 userId True string

Identyfikator użytkownika

Zwraca

Informacje o użytkowniku

Body
ApiUser

Znajdź folder

Identyfikator operacji:
GetFolder

Znajduje folder według identyfikatora.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator folderu
 folderId True string

Identyfikator folderu
Z członkami
 withMembers boolean

Prawda, jeśli dokument z elementami członkowskimi

Zwraca

Metadane kontenera z metadanymi dokumentów wewnątrz kontenera

Body
ApiFolderWithMembers

Zwracane wyliczenie

Identyfikator operacji:
GetEnum

Zwraca określone wyliczenie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator wyliczenia
 id True string

Identyfikator wyliczenia

Zwraca

Dane wyliczeniowe dla wyliczenia typu pola

Body
ApiEnum

Zwracanie dokumentu do wystawcy w celu uzyskania poprawek

Identyfikator operacji:
ReturnDocument

Zwraca dokument do wystawcy w celu skorygowania podanego adresu e-mail.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 documentId True string

Identyfikator dokumentu
additionalDocuments
 additionalDocuments array of string
recipientEmail
 recipientEmail string
powód
 reason string
requestedByUserId
 requestedByUserId string

Zwracanie tokenu

Identyfikator operacji:
GetRegisterToken

Zwraca bieżący token rejestracji lub nic, jeśli token nie jest aktywny.

Zwraca

Ogólna wartość odpowiedzi

Body
StringApiValue

Zwracanie wszystkich wyliczenia

Identyfikator operacji:
GetAllEnums

Zwraca listę wszystkich wyliczenia.

Zwraca

response
array of ApiEnum

Definicje

ApiApproval

Nazwa Ścieżka Typ Opis
osoba zatwierdzająca
 approver ApiUser

Informacje o użytkowniku
approvalStepTime
 approvalStepTime date-time

Czas przypisania do bieżącego osoby zatwierdzającej".
approvalState
 approvalState ApprovalState

Stan dokumentu
delegatedTo
 delegatedTo ApiUser

Informacje o użytkowniku
nuta
 note string

Notatka osoby zatwierdzającej

ApiApprovalReminder

Nazwa Ścieżka Typ Opis
fromUser
 fromUser ApiUser

Informacje o użytkowniku
doUżytkownik
 toUser ApiUser

Informacje o użytkowniku
sentTime
 sentTime date-time

Czas wysyłania
nuta
 note string

Notatka pilna

ApiDocument

Nazwa Ścieżka Typ Opis
documentId
 documentId string

Identyfikator dokumentu
externalDocumentId
 externalDocumentId string

Identyfikator dokumentu zewnętrznego
folderId
 folderId string

Identyfikator kontenera dokumentu
contentHash
 contentHash string

Skrót zawartości
pageCount
 pageCount integer

Całkowita liczba stron w dokumencie, pierwszy indeks wynosi 1. Ta liczba może nie być równa liczbie stron, ponieważ jeśli dokument zawiera zbyt wiele stron, niektóre z nich mogą zostać pominięte ze względu na wydajność
fileName
 fileName string

Nazwa pliku dokumentu
właściciel
 owner ApiUser

Informacje o użytkowniku
stan
 state DocumentState

Stan dokumentu
błąd
 error string

Kod błędu dokumentu
isImagesGenerated
 isImagesGenerated boolean

Czy wygenerowano obrazy
isReturned
 isReturned boolean

Prawda, jeśli dokumenty zostały zwrócone nadawcy.
returnReason
 returnReason string

Przyczyna zwrotu.
czasUtworzenia
 creationTime date-time

Data utworzenia
size
 size integer

Rozmiar dokumentu w KB
typ treści
 contentType string

Typ zawartości
przesłać źródło
 source DocumentSource
źródłoInfo
 sourceInfo string

Szczegóły źródła (ogólny adres e-mail)
extractionTime
 extractionTime date-time

Data klasyfikacji
model
 model string

Typ tego dokumentu
isAttachment
 isAttachment boolean

Wskazuje, czy dokument jest załącznikiem
isValidated (Zweryfikowany)
 isValidated boolean

Wskaźnik, czy dokument został zweryfikowany
isEdited
 isEdited boolean

Wskaźnik, jeśli ten dokument został edytowany (co najmniej jedno pole, notatka lub tag został zmieniony)
nuta
 note string

Notatka użytkownika niestandardowego
pola
 fields object

Lista wyodrębnionych pól
items
 items array of object

Lista wyodrębnionych elementów
items
 items object
Stron
 pages array of ApiPage

Lista wszystkich stron, które są częścią wyodrębniania.
pluginResults
 pluginResults array of ApiPluginResult

Ogólne wyniki
isPostProcessCompleted
 isPostProcessCompleted boolean

Wskaźnik, jeśli przetwarzanie po zakończeniu
isPrevalidated
 isPrevalidated boolean

Niezależnie od tego, czy dokument ma pewne skrypty prevalidation pp
lastOpenTime
 lastOpenTime date-time

Data ostatniego otwarcia
lastOpenUserId
 lastOpenUserId string

Identyfikator użytkownika, który ostatnio otworzył ten dokument
isLocked
 isLocked boolean

Określa, czy dokument jest zablokowany, czy nie
validationTime
 validationTime date-time

Czas weryfikacji dokumentu
wersja
 version integer

Numer wersji, zwiększany przy każdej aktualizacji
approvalState
 approvalState ApprovalState

Stan dokumentu
currentApproverId
 currentApproverId string

Identyfikator użytkownika, który musi zatwierdzić ten dokument
lastApprovalStepTime
 lastApprovalStepTime date-time

Czas przypisania do bieżącego osoby zatwierdzającej
isCurrentApproverNotificationSent
 isCurrentApproverNotificationSent boolean

Powiadomienie zostało wysłane do bieżącego osoby zatwierdzającej
approvalHistory
 approvalHistory array of ApiApproval

Historia zatwierdzania
approvalReminderHistory
 approvalReminderHistory array of ApiApprovalReminder

Zatwierdzanie historii
authorizedUserIds
 authorizedUserIds array of string

Użytkownicy autoryzowani do uzyskiwania dostępu do dokumentu
duplicateDocIds
 duplicateDocIds array of string

Zduplikowane identyfikatory dokumentów (na podstawie wartości pól)
approvedBy
 approvedBy ApiUser

Informacje o użytkowniku
validatedBy
 validatedBy ApiUser

Informacje o użytkowniku

ApiDocumentApiListResult

Wynik wyszukiwania

Nazwa Ścieżka Typ Opis
list
 list array of ApiDocument

Lista wszystkich znalezionych wartości
hasMore
 hasMore boolean

Prawda, jeśli wyszukiwanie może zwracać więcej wartości
przesunąć
 offset integer

Wartość przesunięcia (liczba pominiętych wartości)

ApiEnum

Dane wyliczeniowe dla wyliczenia typu pola

Nazwa Ścieżka Typ Opis
id
 id string

Identyfikator wyliczenia
nazwa
 name string

Przyjazna nazwa wyliczenia
values
 values object

Lista wartości wyliczenia
jest edytowalny
 isEditable boolean

Wskazuje, czy można edytować wyliczenie

ApiFolderCreationResult

Wynik tworzenia kontenera

Nazwa Ścieżka Typ Opis
folderId
 folderId string

Identyfikator kontenera

ApiFolderWithMembers

Metadane kontenera z metadanymi dokumentów wewnątrz kontenera

Nazwa Ścieżka Typ Opis
folderId
 folderId string

Identyfikator dokumentu.
Identyfikator właściciela
 ownerId string

Identyfikator właściciela kontenera
utworzone
 created date-time

Czas tworzenia kontenera
metadane
 metadata object

Wszystkie nagłówki dołączone do kontenera
Członkowie
 members array of ApiDocument

Lista wszystkich elementów członkowskich kontenera

ApiItemCell

Nazwa Ścieżka Typ Opis
value
 value string

Wartość komórki
modifiedByPostProcessing
 modifiedByPostProcessing boolean

Wskazuje, czy ta wartość została zmodyfikowana przez przetwarzanie końcowe
pluginResults
 pluginResults array of ApiPluginResult

Wyniki z wtyczek

Kolumna apiItem

Definiuje kolumnę tabeli elementów.

Nazwa Ścieżka Typ Opis
pole
 field string

(No changes needed)
width
 width double

Wysokość wiersza.

ApiItemRow

Definiuje wiersz tabeli elementów.

Nazwa Ścieżka Typ Opis
height
 height double

Wysokość wiersza.
Komórek
 cells array of ApiItemCell

Lista wszystkich komórek w tej kolumnie. Liczba powinna być zawsze równa liczbie kolumn.

ApiItemTable

Tabela elementów

Nazwa Ścieżka Typ Opis
pageIndex
 pageIndex integer

Indeks strony, do której należy tabela.
przesunąć
 offset Offset

Definiuje przesunięcie dwuwymiarowe ze współrzędnymi X i Y.
columns
 columns array of ApiItemColumn

Lista definicji kolumn.
wiersze
 rows array of ApiItemRow

Lista definicji wierszy i komórek w każdym wierszu.

ApiPage

Strona dokumentu

Nazwa Ścieżka Typ Opis
indeks
 index integer

Indeks strony dokumentu. Indeksowane z 1.
width
 width integer

Szerokość strony w pikselach.
height
 height integer

Wysokość strony w pikselach.
obrót
 rotation double

Obrót strony w stopniach.
words
 words array of ApiWord

Lista wszystkich wyrazów znajdujących się na stronie.
itemTable
 itemTable ApiItemTable

Tabela elementów

ApiPluginResult

Nazwa Ścieżka Typ Opis
pluginName
 pluginName string

Pobiera lub ustawia nazwę skryptu, który zweryfikował ten dokument
resultCode
 resultCode PostProcessResult

Wynik przetwarzania końcowego
value
 value string

Pobiera lub ustawia kolekcję zlokalizowanych komunikatów
extraInformationRequired
 extraInformationRequired boolean

Pobiera lub ustawia, czy potrzebne są dodatkowe informacje
extraInformationMessage
 extraInformationMessage string

Pobiera lub ustawia komunikat o dodatkowych wymaganiach dotyczących informacji

ApiUploadResponse

Wynik przekazywania pliku

Nazwa Ścieżka Typ Opis
documentId
 documentId string

Identyfikator dokumentu
folderId
 folderId string

Identyfikator folderu

ApiUser

Informacje o użytkowniku

Nazwa Ścieżka Typ Opis
id
 id string

Identyfikator użytkownika
imię
 firstName string

Imię użytkownika
nazwisko
 lastName string

Nazwisko użytkownika
e-mail
 email string

Adres e-mail użytkownika

ApiUserApiListResult

Wynik wyszukiwania

Nazwa Ścieżka Typ Opis
list
 list array of ApiUser

Lista wszystkich znalezionych wartości
hasMore
 hasMore boolean

Prawda, jeśli wyszukiwanie może zwracać więcej wartości
przesunąć
 offset integer

Wartość przesunięcia (liczba pominiętych wartości)

ApiWord

Nazwa Ścieżka Typ Opis
wordId
 wordId integer

Identyfikator wyrazu, unikatowy dla jednego dokumentu
pageIndex
 pageIndex integer

Indeks strony, w ramach których jest wyświetlany wyraz
SMS
 text string

Tekst słowa
locX
 locX integer

Współrzędna X słowa
locY
 locY integer

Współrzędna Y słowa
width
 width integer

Szerokość wyrazu
height
 height integer

Wysokość wyrazu

ApprovalState

Stan dokumentu

Stan dokumentu

string

DocumentSource

string

DocumentState

Stan dokumentu

Stan dokumentu

string

LicenseTimePeriod

Okres dla licencji

Okres dla licencji

string

MLicense

Nazwa Ścieżka Typ Opis
responseCode (kod odpowiedzi)
 responseCode ResponseCode
responseMessage
 responseMessage string
validFrom
 validFrom date-time
validTo
 validTo date-time
NextPeriod
 nextPeriod date-time
usageLimit
 usageLimit integer
usageLimitPeriod
 usageLimitPeriod LicenseTimePeriod

Okres dla licencji
isTrial
 isTrial boolean
usageCount
 usageCount integer

Przesunięcie

Definiuje przesunięcie dwuwymiarowe ze współrzędnymi X i Y.

Nazwa Ścieżka Typ Opis
x
 x double

Przesunięcie na współrzędnych X.
y
 y double

Przesunięcie na współrzędnych Y.

PostProcessResult

Wynik przetwarzania końcowego

Wynik przetwarzania końcowego

string

RedQueStatus

Dane odpowiedzi o stanie. Używana jako odpowiedź, gdy żądanie nie zwraca żadnych danych.

Nazwa Ścieżka Typ Opis
kod statusu
 statusCode integer

Kod stanu
komunikat
 message string

Message

Kod odpowiedzi

string

StringApiValue

Ogólna wartość odpowiedzi

Nazwa Ścieżka Typ Opis
value
 value string

Wartość

URI

uri