InfoShare
Usługa InfoShare jest przeznaczona do użytku w firmach, które chcą zoptymalizować sposób zarządzania dokumentami cyfrowymi, informacjami, powiązaniami i procesami.
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 | Obsługa systemu Kendox |
| adres URL | https://kendox.com/en/service/support-services |
| support@kendox.com |
| Metadane łącznika | |
|---|---|
| Publisher | Kendox AG |
| Witryna internetowa | https://www.kendox.com/en |
| Zasady ochrony prywatności | https://www.kendox.com/en/about-us/data-protection |
| Kategorie | Kolaboracja; Zawartość i pliki |
Łącznik Kendox InfoShare
Kendox InfoShare udostępnia zaawansowany i bardzo rozbudowany interfejs API REST. Za pomocą tego interfejsu API można tworzyć dokumenty i procesy oraz zarządzać nimi w programie InfoShare. Wraz z łącznikiem Kendox InfoShare Power Automate można usprawnić procesy zawartości w szerokim krajobrazie aplikacji, unikając w ten sposób silosów informacji.
Pre-requisites
Aby kontynuować, musisz wykonać następujące czynności:
- Licencja na korzystanie z tego łącznika dostępna za pośrednictwem programu sales365@kendox.com.
- Kendox InfoShare z punktami końcowymi usługi WCF osiągalnymi w trybie online.
- Poświadczenia logowania usługi Kendox InfoShare.
Obsługiwane operacje
Łącznik obsługuje następujące operacje:
General
-
Logon: Zaloguj się do serwera InfoShare -
Logon with hashed password: Zaloguj się do serwera InfoShare -
Logoff: Logowanie z serwera InfoShare -
Get documents and processes selection: Pobieranie dokumentów i procesów wybranych na kliencie sieci Web dla urządzeń przenośnych za pomocą akcji przycisku niestandardowego
Dokument
-
Create document (deprecated): Tworzenie dokumentu w programie InfoShare, przestarzałej wersji -
Create document (V2): Tworzenie dokumentu w programie InfoShare, sugerowana wersja -
Update document (deprecated): Aktualizowanie dokumentu w programie InfoShare, przestarzałej wersji -
Update document (V2): Aktualizowanie dokumentu w elemecie InfoShare, sugerowana wersja -
Get document properties: Pobieranie właściwości dokumentu z elementu InfoShare -
Get file content: Pobieranie zawartości pliku z programu InfoShare -
Get file content converted: konwertuje zawartość pliku na inny format (e.g. tiff do formatu pdf). Pobieranie zawartości pliku, w tym adnotacji i nakładek -
Get document: Zwraca informacje o dokumencie (struktura) z elementu InfoShare -
Merge PDF documents: Scalanie co najmniej dwóch dokumentów PDF z dokumentem docelowym
Proces
-
Create process: Tworzenie i uruchamianie procesu -
Update process (deprecated): Aktualizowanie procesu w programie InfoShare, przestarzałej wersji -
Update process (V2): Aktualizowanie procesu w programie InfoShare, sugerowana wersja -
Close an open process: Zamykanie procesu w programie InfoShare -
Close task and continue process: Zamykanie zadania procesu w programie InfoShare -
Close current task and assign user to next task: Zamknij zadanie procesu i przypisz użytkownika do następnego zadania w programie InfoShare -
Get process: Zwraca listę informacji o procesie (struktura) z elementu InfoShare -
Get process properties: Pobieranie właściwości procesu z elementu InfoShare
Search
-
Document Search (deprecated): Wyszukiwanie dokumentów w obszarze InfoShare, przestarzała wersja -
Document Search (V2): Wyszukiwanie dokumentów w elemecie InfoShare, sugerowana wersja -
List processes (deprecated): Pobieranie listy procesów w programie InfoShare zastąpione akcją wyszukiwania procesów -
Process search: wyszukiwanie procesów w programie InfoShare
Tabele użytkowników
-
Create a user table: Tworzy tabelę użytkownika -
Get rows from a user table: Pobiera kilka wierszy z tabeli użytkownika -
Insert rows into a user table: Wstawianie wierszy do tabeli użytkownika -
Update a row in a user table: Aktualizowanie wiersza do tabeli użytkownika -
Delete user table rows: usuwa niektóre wiersze z tabeli użytkownika
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: Wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja Power App zostanie udostępniona innemu użytkownikowi, inny użytkownik zostanie poproszony o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Klucz interfejsu API | securestring | Klucz interfejsu API dla tego interfejsu API | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie dokumentu (przestarzałe) [PRZESTARZAŁE] |
Aktualizowanie dokumentu (przestarzałe) |
| Aktualizowanie dokumentu (wersja 2) |
Aktualizowanie dokumentu (wersja 2) |
| Aktualizowanie wiersza w tabeli użytkownika |
Aktualizowanie wiersza w tabeli użytkownika |
| Logoff |
Logoff |
| Logon |
Logon |
| Logowanie przy użyciu skrótu hasła |
Logowanie przy użyciu skrótu hasła |
| Pobieranie dokumentu |
Pobieranie dokumentu |
| Pobieranie dokumentów i procesów wyboru |
Pobieranie dokumentów i procesów wybranych na kliencie sieci Web dla urządzeń przenośnych za pomocą akcji przycisku niestandardowego |
| Pobieranie procesu |
Pobierz proces |
| Pobieranie przekonwertowanej zawartości pliku |
Przekonwertuj zawartość pliku na inny format. Dodawanie adnotacji lub nakładki do zawartości pliku |
| Pobieranie wierszy z tabeli użytkownika |
Pobieranie wierszy z tabeli użytkownika |
| Pobieranie właściwości dokumentu |
Pobieranie właściwości dokumentu |
| Pobieranie właściwości procesu |
Pobieranie właściwości procesu |
| Pobierz zawartość pliku |
Pobierz zawartość pliku |
| Proces aktualizacji (przestarzały) [PRZESTARZAŁE] |
Proces aktualizacji (przestarzały) |
| Proces aktualizacji (wersja 2) |
Proces aktualizacji (wersja 2) |
| Scalanie dokumentów PDF |
Scalanie co najmniej dwóch dokumentów PDF w jednym dokumencie |
| Tworzenie dokumentu (przestarzałe) [PRZESTARZAŁE] |
Tworzenie dokumentu (przestarzałe) |
| Tworzenie dokumentu (wersja 2) |
Tworzenie dokumentu (wersja 2) |
| Tworzenie procesu |
Tworzenie procesu |
| Tworzenie tabeli użytkownika |
Tworzenie tabeli użytkownika |
| Usuwanie wierszy tabeli użytkownika |
Usuwanie wierszy tabeli użytkownika |
| Wstawianie wierszy do tabeli użytkownika |
Importowanie wierszy tabeli do tabeli użytkownika |
| Wyszukiwanie dokumentów (przestarzałe) [PRZESTARZAŁE] |
Wyszukiwanie dokumentów (przestarzałe) |
| Wyszukiwanie dokumentów (wersja 2) |
Wyszukiwanie dokumentów (wersja 2) |
| Wyszukiwanie procesów |
Wyszukiwanie procesów |
| Wyświetlanie listy procesów (przestarzałe) [PRZESTARZAŁE] |
Wyświetlanie listy procesów (przestarzałe) |
| Zamknij bieżące zadanie i przypisz użytkownika do następnego zadania |
Zamknij bieżące zadanie i przypisz użytkownika do następnego zadania |
| Zamknij zadanie i kontynuuj proces |
Zamknij zadanie i kontynuuj proces |
| Zamykanie otwartego procesu |
Zamykanie otwartego procesu |
Aktualizowanie dokumentu (przestarzałe) [PRZESTARZAŁE]
Aktualizowanie dokumentu (przestarzałe)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
Identyfikator dokumentu
|
DocumentId | True | string |
Identyfikator dokumentu |
|
DocumentTitle
|
DocumentTitle | string |
Tytuł dokumentu |
|
|
Właściwości dokumentu
|
DocumentProperties | string |
Format aktualizacji właściwości dokumentu: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Kultura
|
Culture | string |
Kultura, w której podano tekst (de, en, fr, ...). Wartość domyślna = de |
|
|
PlikContent
|
FileContent | string |
Ciąg base64 zawartości pliku |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
abonnements
|
abonnements | array of object |
abonnements |
|
OnContentChange
|
abonnements.onContentChange | boolean |
Abonnement jest aktywny w przypadku zmian plików |
|
OnDelete
|
abonnements.onDelete | boolean |
Abonnement jest aktywny po usunięciu |
|
OnMetadataChange
|
abonnements.onMetadataChange | boolean |
Abonnement jest aktywny w przypadku zmian indeksu |
|
UserId
|
abonnements.userId | string |
Identyfikator użytkownika dla tej abonnnement |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
Data utworzenia
|
annotationManager.postItAnnotations.createdDate | string |
Data utworzenia z adnotacji |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
Identyfikator użytkownika twórcy z adnotacji |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
Jest kursywą czcionki z adnotacji |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
Czy czcionka jest wykreślona z adnotacji |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
Czy czcionka jest podkreślona po adnotacji |
|
Name
|
annotationManager.postItAnnotations.fontInfo.name | string |
Nazwa czcionki z adnotacji. Ustawienie domyślne = Arial |
|
Ton lub wysokość dźwięku
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Rzut czcionki z adnotacji |
|
Rozmiar
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Rozmiar czcionki z adnotacji. Przykład: rozmiar:12 to 12000. Potrzebujesz współczynnika 1000 |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Grubość czcionki z adnotacji |
|
Id
|
annotationManager.postItAnnotations.id | string |
Identyfikator adnotacji wpisu |
|
Data modyfikacji
|
annotationManager.postItAnnotations.modifiedDate | string |
Data modyfikacji z adnotacji. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Numer strony
|
annotationManager.postItAnnotations.pageNumber | integer |
Liczba stron z adnotacji |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Poziom zabezpieczeń dla adnotacji (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Ustawienie domyślne = publicznie dostępne |
|
Wybieralny
|
annotationManager.postItAnnotations.selectable | boolean |
Określa, czy adnotacja jest wybierana przez użytkownika |
|
Tekst
|
annotationManager.postItAnnotations.text | string |
Tekst zdefiniowany przez użytkownika w celu opublikowania jej adnotacji |
|
X
|
annotationManager.postItAnnotations.x | integer |
Współrzędna X w pikselach na cal dla 7200 DPI po adnotacji |
|
Y
|
annotationManager.postItAnnotations.y | integer |
Współrzędna Y w pikselach na cal dla 7200 DPI po adnotacji |
|
rectangleAnnotations
|
annotationManager.rectangleAnnotations | array of object |
rectangleAnnotations |
|
Kolor
|
annotationManager.rectangleAnnotations.color | integer |
Kolor prostokąta (32-bitowa wartość ARGB) z adnotacji prostokąta Przykład:: -16777216 Biały: -1 Czerwony: -65536 Zielony: -16744448 Niebieski: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Kolor prostokąta (kod szesnastkowy RGB) z adnotacji prostokąta. Przykład:: #0000000 Biały: #FFFFFF Czerwony: #FF0000 Zielony: #008000 Niebieski: #0000FF |
|
Data utworzenia
|
annotationManager.rectangleAnnotations.createdDate | string |
Data utworzenia z adnotacji prostokąta. Format daty: rrrr-MM-ddTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
CreatorId |
|
Wysokość
|
annotationManager.rectangleAnnotations.height | integer |
Wysokość prostokąta w pikselach na cal dla 7200 DPI |
|
Id
|
annotationManager.rectangleAnnotations.Id | string |
Identyfikator adnotacji prostokąta |
|
Data modyfikacji
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Data modyfikacji adnotacji prostokąta. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Numer strony
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Liczba stron z adnotacji prostokąta |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Poziom zabezpieczeń adnotacji prostokąta (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Ustawienie domyślne = publicznie dostępne |
|
Wybieralny
|
annotationManager.rectangleAnnotations.selectable | boolean |
Określa, czy adnotacja prostokąta jest wybierana przez użytkownika |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
Prostokąt powinien być przezroczysty (wyróżnienie) |
|
Szerokość
|
annotationManager.rectangleAnnotations.width | integer |
Szerokość prostokąta w pikselach na cal dla 7200 DPI |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
Współrzędna X w pikselach na cal dla 7200 DPI z adnotacji prostokąta |
|
Y
|
annotationManager.rectangleAnnotations.y | integer |
Współrzędna Y w pikselach na cal dla 7200 DPI z adnotacji prostokąta |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
textAnnotations |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Kolor tła (32-bitowa wartość ARGB) z adnotacji tekstowej. Przykład:: -16777216 Biały: -1 Czerwony: -65536 Zielony: -16744448 Niebieski: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Kolor tła (kod szesnastkowy RGB) z adnotacji tekstu. Przykład:: #0000000 Biały: #FFFFFF Czerwony: #FF0000 Zielony: #008000 Niebieski: #0000FF |
|
Data utworzenia
|
annotationManager.textAnnotations.createdDate | string |
data utworzenia z adnotacji tekstowej. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
Identyfikator użytkownika twórcy z adnotacji tekstowej |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
Jest kursywą czcionki z adnotacji tekstowej |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
Czy czcionka jest wykreślona z adnotacji tekstowych |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
Jest podkreśleniem czcionki z adnotacji tekstowej |
|
Name
|
annotationManager.textAnnotations.fontInfo.name | string |
Nazwa czcionki z adnotacji tekstowej. Ustawienie domyślne = Arial |
|
Ton lub wysokość dźwięku
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Rzut czcionki z adnotacji tekstowej |
|
Rozmiar
|
annotationManager.textAnnotations.fontInfo.size | integer |
Rozmiar czcionki z adnotacji tekstu. Przykład: rozmiar:12 to 12000. Potrzebujesz współczynnika 1000 |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Waga czcionki z adnotacji tekstu |
|
ForegroundColor
|
annotationManager.textAnnotations.foregroundColor | integer |
Kolor pierwszego planu (32-bitowa wartość ARGB) z adnotacji tekstowej. Przykład:: -16777216 Biały: -1 Czerwony: -65536 Zielony: -16744448 Niebieski: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Kolor pierwszego planu (kod szesnastkowy RGB) z adnotacji tekstu. Przykład:: #0000000 Biały: #FFFFFF Czerwony: #FF0000 Zielony: #008000 Niebieski: #0000FF |
|
Wysokość
|
annotationManager.textAnnotations.height | integer |
Wysokość tekstu w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
Id
|
annotationManager.textAnnotations.id | string |
Identyfikator adnotacji tekstu |
|
Data modyfikacji
|
annotationManager.textAnnotations.modifiedDate | string |
Data modyfikacji adnotacji tekstowej. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Numer strony
|
annotationManager.textAnnotations.pageNumber | integer |
Liczba stron z adnotacji tekstowych |
|
Rotacja
|
annotationManager.textAnnotations.rotation | integer |
Rotacja w stopniach z adnotacji tekstu |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Poziom zabezpieczeń adnotacji tekstu (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Ustawienie domyślne = publicznie dostępne |
|
Wybieralny
|
annotationManager.textAnnotations.selectable | boolean |
Określa, czy adnotacja tekstowa jest wybierana przez użytkownika |
|
Tekst
|
annotationManager.textAnnotations.text | string |
Zdefiniowany przez użytkownika tekst adnotacji |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
Adnotacja tekstowa powinna być przezroczysta |
|
Szerokość
|
annotationManager.textAnnotations.width | integer |
Szerokość tekstu w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
X
|
annotationManager.textAnnotations.x | integer |
Współrzędna X w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
Y
|
annotationManager.textAnnotations.y | integer |
Współrzędna Y w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
blogi
|
blogs | array of object |
blogi |
|
Data utworzenia
|
blogs.createdDate | string |
Data utworzenia bloga. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
blogs.creatorId | string |
Identyfikator użytkownika w blogu tworzenia użytkownika |
|
Id
|
blogs.id | string |
Identyfikator bloga |
|
Tekst
|
blogs.text | string |
Tekst elementu blogu |
|
CheckOutStateEnum
|
checkOutStateEnum | string |
Stan wyewidencjonowania dokumentu (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Identyfikator użytkownika, dla którego dokument jest wyewidencjonowany |
|
documentData
|
documentData | array of object |
documentData |
|
Id
|
documentData.id | string |
Identyfikator danych dokumentu |
|
Name
|
documentData.name | string |
Nazwa danych dokumentu |
|
Wersje
|
documentData.renditions | array of |
Wersje |
|
HasOverlay
|
hasOverlay | boolean |
Określa, czy dokument powinien być wyświetlany z nakładką |
|
Id
|
id | string |
Identyfikator dokumentu |
|
ImportTemplateId
|
importTemplateId | string |
Identyfikator szablonu importu dla tego dokumentu |
|
Identyfikator magazynu informacji
|
infoStoreId | string |
Identyfikator magazynu informacji |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Stan cyklu życia wyewidencjonowania |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Obliczona data zakończenia cyklu życia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Data rozpoczęcia cyklu życia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Identyfikator stanu LifeCycle |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Następny automatyczny stan cyklu życia |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
nextLifeCycleStates |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Zezwalaj na usuwanie dokumentu po wygaśnięciu ochrony |
|
Id
|
lifeCycleManager.lifeCycleProtections.id | string |
Identyfikator ochrony stanu cyklu życia |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Ochrona przed zmianami adnotacji |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Ochrona przed wyewidencjonowywaniem |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Ochrona przed zmianą zawartości |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Ochrona przed usunięciem |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Ochrona przed zmianami właściwości |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Ochrona przed zmianami zabezpieczeń |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Czas trwania ochrony |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Identyfikator życia |
|
MainFileLength
|
mainFileLength | integer |
Rozmiar pliku głównego |
|
Name
|
name | string |
Nazwa dokumentu |
|
PageCount
|
pageCount | integer |
Liczba stron pliku głównego |
|
properties
|
properties | array of object |
properties |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
kultura
|
properties.globalValues.values.culture | string |
Kultura |
|
SMS
|
properties.globalValues.values.text | string |
Tekst |
|
NazwaWłaściwości
|
properties.propertyName | string |
Nazwa właściwości |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Identyfikator typu pola indeksu |
|
values
|
properties.values | array of string |
Wartości WłaściwościType |
|
ProtectionDomainId
|
protectionDomainId | string |
Identyfikator domeny ochrony |
|
Przypomnienia
|
reminders | array of object |
Przypomnienia |
|
Description
|
reminders.description | string |
Opis przypomnienia |
|
Odstęp
|
reminders.interval | integer |
Interwał w dniach między przypomnieniami |
|
ProcessTemplateId
|
reminders.processTemplateId | string |
Identyfikator szablonu procesu dla tego przypomnienia |
|
PrzypomnienieDate
|
reminders.reminderDate | string |
Data przypomnienia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
ReminderId
|
reminders.reminderId | string |
Identyfikator przypomnienia |
|
subjectIds
|
reminders.subjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
reminders.useUserFromProcessTemplate | boolean |
Określa, czy zostanie użyta definicja użytkownika z szablonu procesu |
|
SigningProfileId
|
signingProfileId | string |
Identyfikator profilu podpisywania |
|
Identyfikator wersji
|
versionId | string |
Identyfikator wersji dokumentu |
Aktualizowanie dokumentu (wersja 2)
Aktualizowanie dokumentu (wersja 2)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
DocumentTitle
|
DocumentTitle | string |
Tytuł dokumentu |
|
|
Właściwości dokumentu
|
DocumentProperties | string |
Format aktualizacji właściwości dokumentu: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
RemoveDocumentProperties
|
RemoveDocumentProperties | string |
Lista rozdzielonych średnikami właściwości Nazw lub identyfikatorów do usunięcia z dokumentu, takich jak "FistName; b9cfbdf7-f6fb-4179-91c8-d9681fb680dd; Działy" |
|
|
Kultura
|
Culture | string |
Kultura, w której podano tekst (de, en, fr, ...). Wartość domyślna = de |
|
|
Identyfikator dokumentu
|
DocumentId | True | string |
Identyfikator dokumentu |
|
ProtectionDomain
|
ProtectionDomain | string |
Nazwa lub identyfikator domeny ochrony |
|
|
Blog internetowy
|
Blog | string |
Dodawanie wpisu tekstowego w blogu w dokumencie |
|
|
UploadMethod
|
UploadMethod | string |
Metoda używana podczas przekazywania dokumentu do programu InfoShare. Ustawienie domyślne = UploadFileBytesLarge |
|
|
PlikContent
|
FileContent | string |
Ciąg base64 zawartości pliku |
|
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Cofnij wyewidencjonowanie dokumentu. Wartość domyślna = false |
|
|
Rozmiar fragmentu
|
ChunkSize | integer |
Rozmiar fragmentu przekazywania pliku używanego z metodami przekazywania UploadStreamChunks i UploadFileBytesLarge, domyślne 262144 |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
abonnements
|
abonnements | array of object |
Abonnements |
|
OnContentChange
|
abonnements.onContentChange | boolean |
Abonnement jest aktywny w przypadku zmian plików |
|
OnDelete
|
abonnements.onDelete | boolean |
Abonnement jest aktywny po usunięciu |
|
OnMetadataChange
|
abonnements.onMetadataChange | boolean |
Abonnement jest aktywny w przypadku zmian indeksu |
|
UserId
|
abonnements.userId | string |
Identyfikator użytkownika dla tej abonnnement |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Lista wyliczenie praw dostępu |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
Data utworzenia
|
annotationManager.postItAnnotations.createdDate | string |
Data utworzenia z adnotacji |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
Identyfikator użytkownika twórcy z adnotacji |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
Jest kursywą czcionki z adnotacji |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
Czy czcionka jest wykreślona z adnotacji |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
Czy czcionka jest podkreślona po adnotacji |
|
Name
|
annotationManager.postItAnnotations.fontInfo.name | string |
Nazwa czcionki z adnotacji. Ustawienie domyślne = Arial |
|
Ton lub wysokość dźwięku
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Rzut czcionki z adnotacji |
|
Rozmiar
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Rozmiar czcionki z adnotacji. Przykład: rozmiar:12 to 12000. Potrzebujesz współczynnika 1000 |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Grubość czcionki z adnotacji |
|
Id
|
annotationManager.postItAnnotations.id | string |
Adnotacja opublikuj go w identyfikatorze |
|
Data modyfikacji
|
annotationManager.postItAnnotations.modifiedDate | string |
Data modyfikacji z adnotacji. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Numer strony
|
annotationManager.postItAnnotations.pageNumber | integer |
Liczba stron z adnotacji |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Poziom zabezpieczeń dla adnotacji (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Ustawienie domyślne = publicznie dostępne |
|
Wybieralny
|
annotationManager.postItAnnotations.selectable | boolean |
Określa, czy adnotacja jest wybierana przez użytkownika |
|
Tekst
|
annotationManager.postItAnnotations.text | string |
Tekst zdefiniowany przez użytkownika w celu opublikowania jej adnotacji |
|
X
|
annotationManager.postItAnnotations.x | integer |
Współrzędna X w pikselach na cal dla 7200 DPI po adnotacji |
|
Y
|
annotationManager.postItAnnotations.y | integer |
Współrzędna Y w pikselach na cal dla 7200 DPI po adnotacji |
|
rectangleAnnotations
|
annotationManager.rectangleAnnotations | array of object |
rectangleAnnotations |
|
Kolor
|
annotationManager.rectangleAnnotations.color | integer |
Kolor prostokąta (32-bitowa wartość ARGB) z adnotacji prostokąta Przykład:: -16777216 Biały: -1 Czerwony: -65536 Zielony: -16744448 Niebieski: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Kolor prostokąta (kod szesnastkowy RGB) z adnotacji prostokąta. Przykład:: #0000000 Biały: #FFFFFF Czerwony: #FF0000 Zielony: #008000 Niebieski: #0000FF |
|
Data utworzenia
|
annotationManager.rectangleAnnotations.createdDate | string |
Data utworzenia z adnotacji prostokąta. Format daty: rrrr-MM-ddTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
Identyfikator twórcy adnotacji prostokąta |
|
Wysokość
|
annotationManager.rectangleAnnotations.height | integer |
Wysokość prostokąta w pikselach na cal dla 7200 DPI |
|
Id
|
annotationManager.rectangleAnnotations.Id | string |
Identyfikator adnotacji prostokąta |
|
Data modyfikacji
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Data modyfikacji adnotacji prostokąta. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Numer strony
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Liczba stron z adnotacji prostokąta |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Poziom zabezpieczeń adnotacji prostokąta (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Ustawienie domyślne = publicznie dostępne |
|
Wybieralny
|
annotationManager.rectangleAnnotations.selectable | boolean |
Określa, czy adnotacja prostokąta jest wybierana przez użytkownika |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
Prostokąt powinien być przezroczysty (wyróżnienie) |
|
Szerokość
|
annotationManager.rectangleAnnotations.width | integer |
Szerokość prostokąta w pikselach na cal dla 7200 DPI |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
Współrzędna X w pikselach na cal dla 7200 DPI z adnotacji prostokąta |
|
Y
|
annotationManager.rectangleAnnotations.y | integer |
Współrzędna Y w pikselach na cal dla 7200 DPI z adnotacji prostokąta |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
Adnotacje tekstowe |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Kolor tła (32-bitowa wartość ARGB) z adnotacji tekstowej. Przykład:: -16777216 Biały: -1 Czerwony: -65536 Zielony: -16744448 Niebieski: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Kolor tła (kod szesnastkowy RGB) z adnotacji tekstu. Przykład:: #0000000 Biały: #FFFFFF Czerwony: #FF0000 Zielony: #008000 Niebieski: #0000FF |
|
Data utworzenia
|
annotationManager.textAnnotations.createdDate | string |
data utworzenia z adnotacji tekstowej. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
Identyfikator użytkownika twórcy z adnotacji tekstowej |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
Jest kursywą czcionki z adnotacji tekstowej |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
Czy czcionka jest wykreślona z adnotacji tekstowych |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
Jest podkreśleniem czcionki z adnotacji tekstowej |
|
Name
|
annotationManager.textAnnotations.fontInfo.name | string |
Nazwa czcionki z adnotacji tekstowej. Ustawienie domyślne = Arial |
|
Ton lub wysokość dźwięku
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Rzut czcionki z adnotacji tekstowej |
|
Rozmiar
|
annotationManager.textAnnotations.fontInfo.size | integer |
Rozmiar czcionki z adnotacji tekstu. Przykład: rozmiar:12 to 12000. Potrzebujesz współczynnika 1000 |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Waga czcionki z adnotacji tekstu |
|
ForegroundColor
|
annotationManager.textAnnotations.foregroundColor | integer |
Kolor pierwszego planu (32-bitowa wartość ARGB) z adnotacji tekstowej. Przykład:: -16777216 Biały: -1 Czerwony: -65536 Zielony: -16744448 Niebieski: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Kolor pierwszego planu (kod szesnastkowy RGB) z adnotacji tekstu. Przykład:: #0000000 Biały: #FFFFFF Czerwony: #FF0000 Zielony: #008000 Niebieski: #0000FF |
|
Wysokość
|
annotationManager.textAnnotations.height | integer |
Wysokość tekstu w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
Id
|
annotationManager.textAnnotations.id | string |
Identyfikator adnotacji tekstu |
|
Data modyfikacji
|
annotationManager.textAnnotations.modifiedDate | string |
Data modyfikacji adnotacji tekstowej. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Numer strony
|
annotationManager.textAnnotations.pageNumber | integer |
Liczba stron z adnotacji tekstowych |
|
Rotacja
|
annotationManager.textAnnotations.rotation | integer |
Rotacja w stopniach z adnotacji tekstu |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Poziom zabezpieczeń adnotacji tekstu (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Ustawienie domyślne = publicznie dostępne |
|
Wybieralny
|
annotationManager.textAnnotations.selectable | boolean |
Określa, czy adnotacja tekstowa jest wybierana przez użytkownika |
|
Tekst
|
annotationManager.textAnnotations.text | string |
Zdefiniowany przez użytkownika tekst adnotacji |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
Adnotacja tekstowa powinna być przezroczysta |
|
Szerokość
|
annotationManager.textAnnotations.width | integer |
Szerokość tekstu w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
X
|
annotationManager.textAnnotations.x | integer |
Współrzędna X w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
Y
|
annotationManager.textAnnotations.y | integer |
Współrzędna Y w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
blogi
|
blogs | array of object |
blogi |
|
Data utworzenia
|
blogs.createdDate | string |
Data utworzenia bloga. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
blogs.creatorId | string |
Identyfikator użytkownika w blogu tworzenia użytkownika |
|
Id
|
blogs.id | string |
Identyfikator bloga |
|
Tekst
|
blogs.text | string |
Tekst elementu blogu |
|
CheckOutStateEnum
|
checkOutStateEnum | string |
Stan wyewidencjonowania dokumentu (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Identyfikator użytkownika, dla którego dokument jest wyewidencjonowany |
|
documentData
|
documentData | array of object |
Dane dokumentu |
|
Id
|
documentData.id | string |
Identyfikator danych dokumentu |
|
Name
|
documentData.name | string |
Nazwa danych dokumentu |
|
Wersje
|
documentData.renditions | array of |
Wersje |
|
HasOverlay
|
hasOverlay | boolean |
Określa, czy dokument powinien być wyświetlany z nakładką |
|
Id
|
id | string |
Identyfikator dokumentu |
|
ImportTemplateId
|
importTemplateId | string |
Identyfikator szablonu importu dla tego dokumentu |
|
Identyfikator magazynu informacji
|
infoStoreId | string |
Identyfikator magazynu informacji |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Stan cyklu życia wyewidencjonowania |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Obliczona data zakończenia cyklu życia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Data rozpoczęcia cyklu życia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Identyfikator stanu LifeCycle |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Następny automatyczny stan cyklu życia |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
Następne stany cyklu życia |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Zezwalaj na usuwanie dokumentu po wygaśnięciu ochrony |
|
Id
|
lifeCycleManager.lifeCycleProtections.id | string |
Identyfikator ochrony stanu cyklu życia |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Ochrona przed zmianami adnotacji |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Ochrona przed wyewidencjonowywaniem |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Ochrona przed zmianą zawartości |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Ochrona przed usunięciem |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Ochrona przed zmianami właściwości |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Ochrona przed zmianami zabezpieczeń |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Czas trwania ochrony |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Identyfikator życia |
|
MainFileLength
|
mainFileLength | integer |
Rozmiar pliku głównego |
|
Name
|
name | string |
Nazwa dokumentu |
|
PageCount
|
pageCount | integer |
Liczba stron pliku głównego |
|
properties
|
properties | array of object |
Właściwości |
|
globalValues
|
properties.globalValues | array of object |
Wartości globalne |
|
values
|
properties.globalValues.values | array of object |
values |
|
kultura
|
properties.globalValues.values.culture | string |
Globalna kultura wartości |
|
SMS
|
properties.globalValues.values.text | string |
Tekst wartości globalnej |
|
NazwaWłaściwości
|
properties.propertyName | string |
Nazwa właściwości |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Identyfikator typu pola indeksu |
|
values
|
properties.values | array of string |
Wartości typu właściwości |
|
ProtectionDomainId
|
protectionDomainId | string |
Identyfikator domeny ochrony |
|
Przypomnienia
|
reminders | array of object |
Przypomnienia |
|
Description
|
reminders.description | string |
Opis przypomnienia |
|
Odstęp
|
reminders.interval | integer |
Interwał w dniach między przypomnieniami |
|
ProcessTemplateId
|
reminders.processTemplateId | string |
Identyfikator szablonu procesu dla tego przypomnienia |
|
PrzypomnienieDate
|
reminders.reminderDate | string |
Data przypomnienia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
ReminderId
|
reminders.reminderId | string |
Identyfikator przypomnienia |
|
subjectIds
|
reminders.subjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
reminders.useUserFromProcessTemplate | boolean |
Określa, czy zostanie użyta definicja użytkownika z szablonu procesu |
|
SigningProfileId
|
signingProfileId | string |
Identyfikator profilu podpisywania |
|
Identyfikator wersji
|
versionId | string |
Identyfikator wersji dokumentu |
Aktualizowanie wiersza w tabeli użytkownika
Aktualizowanie wiersza w tabeli użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
Nazwa tabeli użytkownika
|
UserTable | True | string |
Nazwa tabeli użytkownika |
|
RowData
|
RowData | True | string |
Ciąg zawierający dane wierszy do zaktualizowania, oddzielony średnikami, pierwszy element musi być InternalRecord_Id wiersza do aktualizacji "100" w następującym przykładzie: 100; John; Łania; 2024-01-01; 2024-12-31 |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
userTableUpdateRowResult
|
userTableUpdateRowResult | integer |
userTableUpdateRowResult |
Logoff
Logoff
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wylogowywanie
|
LogoffResult | string |
Wynik wylogowania |
Logon
Logon
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
Nazwa użytkownika
|
Username | True | string |
Nazwa użytkownika logowania |
|
Hasło
|
Password | True | string |
Hasło |
|
Nazwa dzierżawy
|
Tenantname | string |
Nazwa dzierżawy do logowania |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
ConnectionId
|
connectionId | string |
Zawiera identyfikator połączenia, jeśli pomyślnie się zalogowano |
|
ConnectionTimeoutSeconds
|
connectionTimeoutSeconds | integer |
Limit czasu połączenia |
|
IsApplicationLicence
|
isApplicationLicence | string |
Czy typ licencji aplikacji |
|
IsConcurrentLicence
|
isConcurrentLicence | string |
Jest współbieżny typ licencji |
|
IsNamedLicence
|
isNamedLicence | string |
Jest nazwany typ licencji |
|
IsVerificationCodeNeeded
|
isVerificationCodeNeeded | string |
Czy wymagany jest kod weryfikacyjny |
|
PossibleTwoWayAuthenticationType
|
possibleTwoWayAuthenticationType | string |
Możliwy dwukierunkowy typ uwierzytelniania (Brak, Poczta, SMS) |
|
TwoWayAuthenticationTargetMail
|
twoWayAuthenticationTargetMail | string |
Zamaskowany adres e-mail, na który wysyła się wiadomość e-mail z twoWayAuthentication |
Logowanie przy użyciu skrótu hasła
Logowanie przy użyciu skrótu hasła
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
Nazwa użytkownika
|
userName | True | string |
Nazwa użytkownika logowania |
|
Hasło skrótu
|
passwordHashed | True | string |
Hasło użytkownika do logowania (skrót SHA 512 zakodowany w formacie Base64) |
|
Nazwa dzierżawy
|
tenantName | string |
Nazwa dzierżawy do logowania |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
ConnectionId
|
LogonResult.ConnectionId | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
ConnectionTimeoutSeconds
|
LogonResult.ConnectionTimeoutSeconds | integer |
Czas oczekiwania na połączenie w sekundach |
|
IsApplicationLicence
|
LogonResult.IsApplicationLicence | boolean |
Czy typ licencji aplikacji |
|
IsConcurrentLicence
|
LogonResult.IsConcurrentLicence | boolean |
Jest współbieżny typ licencji |
|
IsNamedLicence
|
LogonResult.IsNamedLicence | boolean |
Ma nazwę typu licencji |
|
IsVerificationCodeNeeded
|
LogonResult.IsVerificationCodeNeeded | boolean |
Czy wymagany jest kod weryfikacyjny |
|
JWTToken
|
LogonResult.JWTToken | string |
Token JWT dla tego połączenia |
|
PossibleTwoWayAuthenticationType
|
LogonResult.PossibleTwoWayAuthenticationType | string |
Możliwy dwukierunkowy typ uwierzytelniania (Brak, Poczta, SMS) |
|
TwoWayAuthenticationTargetMail
|
LogonResult.TwoWayAuthenticationTargetMail | string |
Zamaskowany adres e-mail, na który wysyła się wiadomość e-mail z twoWayAuthentication |
Pobieranie dokumentu
Pobieranie dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
Identyfikator dokumentu
|
documentId | True | string |
Identyfikator dokumentu |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Abonnements
|
GetDocumentResult.Abonnements | array of object |
Abonnements |
|
OnContentChange
|
GetDocumentResult.Abonnements.OnContentChange | boolean |
Abonnement jest aktywny w przypadku zmian plików |
|
OnDelete
|
GetDocumentResult.Abonnements.OnDelete | boolean |
Abonnement jest aktywny po usunięciu |
|
OnMetadataChange
|
GetDocumentResult.Abonnements.OnMetadataChange | boolean |
Abonnement jest aktywny w przypadku zmian indeksu |
|
UserId
|
GetDocumentResult.Abonnements.UserId | string |
Identyfikator użytkownika dla tej abonnnement |
|
AccessRightsEnumList
|
GetDocumentResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
Adnotacje postItAnnotation
|
GetDocumentResult.AnnotationManager.PostItAnnotations | array of object |
Adnotacje postItAnnotation |
|
Data utworzenia
|
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatedDate | string |
Data utworzenia z adnotacji |
|
CreatorId
|
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatorId | string |
Identyfikator użytkownika twórcy z adnotacji |
|
IsItalic
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsItalic | boolean |
Jest kursywą czcionki z adnotacji |
|
IsStrikeOut
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsStrikeOut | boolean |
Czy czcionka jest wykreślona z adnotacji |
|
IsUnderline
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsUnderline | boolean |
Czy czcionka jest podkreślona po adnotacji |
|
Name
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Name | string |
Nazwa czcionki z adnotacji. Ustawienie domyślne = Arial |
|
Ton lub wysokość dźwięku
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Pitch | integer |
Rzut czcionki z adnotacji |
|
Rozmiar
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Size | integer |
Rozmiar czcionki z adnotacji. Przykład: rozmiar:12 to 12000. Potrzebujesz współczynnika 1000 |
|
Weight
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Weight | integer |
Grubość czcionki z adnotacji |
|
Id
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Id | string |
Identyfikator adnotacji wpisu |
|
Data modyfikacji
|
GetDocumentResult.AnnotationManager.PostItAnnotations.ModifiedDate | string |
Data modyfikacji z adnotacji. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Numer strony
|
GetDocumentResult.AnnotationManager.PostItAnnotations.PageNumber | integer |
Liczba stron z adnotacji |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.PostItAnnotations.SecurityLevelEnum | string |
Poziom zabezpieczeń dla adnotacji (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Ustawienie domyślne = publicznie dostępne |
|
Wybieralny
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Selectable | boolean |
Określa, czy adnotacja jest wybierana przez użytkownika |
|
Tekst
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Text | string |
Tekst zdefiniowany przez użytkownika w celu opublikowania jej adnotacji |
|
X
|
GetDocumentResult.AnnotationManager.PostItAnnotations.X | integer |
Współrzędna X w pikselach na cal dla 7200 DPI po adnotacji |
|
Y
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Y | integer |
Współrzędna Y w pikselach na cal dla 7200 DPI po adnotacji |
|
ProstokątyAnnotations
|
GetDocumentResult.AnnotationManager.RectangleAnnotations | array of object |
ProstokątyAnnotations |
|
Kolor
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Color | integer |
Kolor prostokąta (32-bitowa wartość ARGB) z adnotacji prostokąta. Przykład:: -16777216 Biały: -1 Czerwony: -65536 Zielony: -16744448 Niebieski: -16776961 |
|
ColorHexCode
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.ColorHexCode | string |
Kolor prostokąta (kod szesnastkowy RGB) z adnotacji prostokąta. Przykład:: #0000000 Biały: #FFFFFF Czerwony: #FF0000 Zielony: #008000 Niebieski: #0000FF |
|
Data utworzenia
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatedDate | string |
Data utworzenia z adnotacji prostokąta. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatorId | string |
CreatorId |
|
Wysokość
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Height | integer |
Wysokość prostokąta w pikselach na cal dla 7200 DPI |
|
Id
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Id | string |
Identyfikator adnotacji prostokąta |
|
Data modyfikacji
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.ModifiedDate | string |
Data modyfikacji adnotacji prostokąta. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Numer strony
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.PageNumber | integer |
Liczba stron z adnotacji prostokąta |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.SecurityLevelEnum | string |
Poziom zabezpieczeń adnotacji prostokąta (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Ustawienie domyślne = publicznie dostępne |
|
Wybieralny
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Selectable | boolean |
Określa, czy adnotacja prostokąta jest wybierana przez użytkownika |
|
Transparent
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Transparent | boolean |
Prostokąt powinien być przezroczysty (wyróżnienie) |
|
Szerokość
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Width | integer |
Szerokość prostokąta w pikselach na cal dla 7200 DPI |
|
X
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.X | integer |
Współrzędna X w pikselach na cal dla 7200 DPI z adnotacji prostokąta |
|
Y
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Y | integer |
Współrzędna Y w pikselach na cal dla 7200 DPI z adnotacji prostokąta |
|
Adnotacje tekstowe
|
GetDocumentResult.AnnotationManager.TextAnnotations | array of object |
Adnotacje tekstowe |
|
BackgroundColor
|
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColor | integer |
Kolor tła (32-bitowa wartość ARGB) z adnotacji tekstowej. Przykład:: -16777216 Biały: -1 Czerwony: -65536 Zielony: -16744448 Niebieski: -16776961 |
|
BackgroundColorHexCode
|
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColorHexCode | string |
Kolor tła (kod szesnastkowy RGB) z adnotacji tekstu. Przykład:: #0000000 Biały: #FFFFFF Czerwony: #FF0000 Zielony: #008000 Niebieski: #0000FF |
|
Data utworzenia
|
GetDocumentResult.AnnotationManager.TextAnnotations.CreatedDate | string |
data utworzenia z adnotacji tekstowej. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.AnnotationManager.TextAnnotations.CreatorId | string |
Identyfikator użytkownika twórcy z adnotacji tekstowej |
|
IsItalic
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsItalic | boolean |
Jest kursywą czcionki z adnotacji tekstowej |
|
IsStrikeOut
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsStrikeOut | boolean |
Czy czcionka jest wykreślona z adnotacji tekstowych |
|
IsUnderline
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsUnderline | boolean |
Jest podkreśleniem czcionki z adnotacji tekstowej |
|
Name
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Name | string |
Nazwa czcionki z adnotacji tekstowej. Ustawienie domyślne = Arial |
|
Ton lub wysokość dźwięku
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Pitch | integer |
Rzut czcionki z adnotacji tekstowej |
|
Rozmiar
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Size | integer |
Rozmiar czcionki z adnotacji tekstu. Przykład: rozmiar:12 to 12000. Potrzebujesz współczynnika 1000 |
|
Weight
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Weight | integer |
Waga czcionki z adnotacji tekstu |
|
ForegroundColor
|
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColor | integer |
Kolor pierwszego planu (32-bitowa wartość ARGB) z adnotacji tekstowej. Przykład:: -16777216 Biały: -1 Czerwony: -65536 Zielony: -16744448 Niebieski: -16776961 |
|
ForegroundColorHexCode
|
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColorHexCode | string |
Kolor pierwszego planu (kod szesnastkowy RGB) z adnotacji tekstu. Przykład:: #0000000 Biały: #FFFFFF Czerwony: #FF0000 Zielony: #008000 Niebieski: #0000FF |
|
Wysokość
|
GetDocumentResult.AnnotationManager.TextAnnotations.Height | integer |
Wysokość tekstu w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
Id
|
GetDocumentResult.AnnotationManager.TextAnnotations.Id | string |
Identyfikator adnotacji tekstu |
|
Data modyfikacji
|
GetDocumentResult.AnnotationManager.TextAnnotations.ModifiedDate | string |
Data modyfikacji adnotacji tekstowej. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Numer strony
|
GetDocumentResult.AnnotationManager.TextAnnotations.PageNumber | integer |
Liczba stron z adnotacji tekstowych |
|
Rotacja
|
GetDocumentResult.AnnotationManager.TextAnnotations.Rotation | integer |
Rotacja w stopniach z adnotacji tekstu |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.TextAnnotations.SecurityLevelEnum | string |
Poziom zabezpieczeń adnotacji tekstu (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Ustawienie domyślne = publicznie dostępne |
|
Wybieralny
|
GetDocumentResult.AnnotationManager.TextAnnotations.Selectable | boolean |
Określa, czy adnotacja tekstowa jest wybierana przez użytkownika |
|
Tekst
|
GetDocumentResult.AnnotationManager.TextAnnotations.Text | string |
Zdefiniowany przez użytkownika tekst adnotacji |
|
Transparent
|
GetDocumentResult.AnnotationManager.TextAnnotations.Transparent | boolean |
Adnotacja tekstowa powinna być przezroczysta |
|
Szerokość
|
GetDocumentResult.AnnotationManager.TextAnnotations.Width | integer |
Szerokość tekstu w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
X
|
GetDocumentResult.AnnotationManager.TextAnnotations.X | integer |
Współrzędna X w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
Y
|
GetDocumentResult.AnnotationManager.TextAnnotations.Y | integer |
Współrzędna Y w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
Blogs
|
GetDocumentResult.Blogs | array of object |
Blogs |
|
Data utworzenia
|
GetDocumentResult.Blogs.CreatedDate | string |
Data utworzenia bloga. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.Blogs.CreatorId | string |
Identyfikator użytkownika w blogu tworzenia użytkownika |
|
Id
|
GetDocumentResult.Blogs.Id | string |
Identyfikator bloga |
|
Tekst
|
GetDocumentResult.Blogs.Text | string |
Tekst elementu blogu |
|
CheckOutStateEnum
|
GetDocumentResult.CheckOutStateEnum | string |
Stan wyewidencjonowania dokumentu (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
GetDocumentResult.CheckOutUserId | string |
Identyfikator użytkownika, dla którego dokument jest wyewidencjonowany |
|
DocumentData
|
GetDocumentResult.DocumentData | array of object |
DocumentData |
|
Id
|
GetDocumentResult.DocumentData.Id | string |
Identyfikator odwzorowania dokumentu |
|
Name
|
GetDocumentResult.DocumentData.Name | string |
Nazwa dokumentu odwzorowania |
|
Wersje
|
GetDocumentResult.DocumentData.Renditions | array of object |
Wersje |
|
ContentProtections (Zabezpieczenia zawartości)
|
GetDocumentResult.DocumentData.Renditions.ContentProtections | array of |
ContentProtections (Zabezpieczenia zawartości) |
|
Extension
|
GetDocumentResult.DocumentData.Renditions.Extension | string |
Extension |
|
Files
|
GetDocumentResult.DocumentData.Renditions.Files | array of object |
Files |
|
Ścieżka obiektu blob
|
GetDocumentResult.DocumentData.Renditions.Files.BlobPath | string |
Ścieżka obiektu blob |
|
BlobStoreId
|
GetDocumentResult.DocumentData.Renditions.Files.BlobStoreId | string |
BlobStoreId |
|
HashValue
|
GetDocumentResult.DocumentData.Renditions.HashValue | array of integer |
HashValue |
|
Id
|
GetDocumentResult.DocumentData.Renditions.Id | string |
Id |
|
PageCount
|
GetDocumentResult.DocumentData.Renditions.PageCount | integer |
PageCount |
|
Rozmiar
|
GetDocumentResult.DocumentData.Renditions.Size | integer |
Rozmiar |
|
HasOverlay
|
GetDocumentResult.HasOverlay | boolean |
Określa, czy dokument powinien być wyświetlany z nakładką |
|
Id
|
GetDocumentResult.Id | string |
Identyfikator dokumentu |
|
ImportTemplateId
|
GetDocumentResult.ImportTemplateId | string |
Identyfikator szablonu importu dla tego dokumentu |
|
Identyfikator magazynu informacji
|
GetDocumentResult.InfoStoreId | string |
Identyfikator magazynu informacji |
|
CheckOutLifeCycleStateId
|
GetDocumentResult.LifeCycleManager.CheckOutLifeCycleStateId | string |
Stan cyklu życia wyewidencjonowania |
|
LifeCycleEndDate
|
GetDocumentResult.LifeCycleManager.LifeCycleEndDate | string |
Obliczona data zakończenia cyklu życia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
GetDocumentResult.LifeCycleManager.LifeCycleStartDate | string |
Data rozpoczęcia cyklu życia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
GetDocumentResult.LifeCycleManager.LifeCycleStateId | string |
Identyfikator stanu LifeCycle |
|
NextAutomaticLifeCycleStateId
|
GetDocumentResult.LifeCycleManager.NextAutomaticLifeCycleStateId | string |
Następny automatyczny stan cyklu życia |
|
NextLifeCycleStates
|
GetDocumentResult.LifeCycleManager.NextLifeCycleStates | array of string |
NextLifeCycleStates |
|
LifeCycleProtections
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections | array of object |
LifeCycleProtections |
|
DeleteAfterExpiration
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.DeleteAfterExpiration | boolean |
Zezwalaj na usuwanie dokumentu po wygaśnięciu ochrony |
|
Id
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.Id | string |
Identyfikator ochrony stanu cyklu życia |
|
ProtectAnnotationChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectAnnotationChange | boolean |
Ochrona przed zmianami adnotacji |
|
ProtectCheckOut
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectCheckOut | boolean |
Ochrona przed wyewidencjonowywaniem |
|
ProtectContentChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectContentChange | boolean |
Ochrona przed zmianą zawartości |
|
ProtectDelete
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectDelete | boolean |
Ochrona przed usunięciem |
|
ProtectPropertyChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectPropertyChange | boolean |
Ochrona przed zmianami właściwości |
|
ProtectProtectionDomainChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectProtectionDomainChange | boolean |
Ochrona przed zmianami zabezpieczeń |
|
ProtectionDurationTicks
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectionDurationTicks | integer |
Czas trwania ochrony |
|
LifeCycleId
|
GetDocumentResult.LifeCycleManager.LifeCycleId | string |
Identyfikator życia |
|
MainFileLength
|
GetDocumentResult.MainFileLength | integer |
Rozmiar pliku głównego |
|
Name
|
GetDocumentResult.Name | string |
Nazwa dokumentu |
|
PageCount
|
GetDocumentResult.PageCount | integer |
Liczba stron pliku głównego |
|
Właściwości
|
GetDocumentResult.Properties | array of object |
Właściwości |
|
GlobalValues
|
GetDocumentResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Wartości
|
GetDocumentResult.Properties.GlobalValues.Values | array of object |
Wartości |
|
Kultura
|
GetDocumentResult.Properties.GlobalValues.Values.Culture | string |
Kultura |
|
Tekst
|
GetDocumentResult.Properties.GlobalValues.Values.Text | string |
Tekst |
|
PropertyTypeId
|
GetDocumentResult.Properties.PropertyTypeId | string |
Identyfikator typu pola indeksu |
|
Wartości
|
GetDocumentResult.Properties.Values | array of string |
Wartości |
|
ProtectionDomainId
|
GetDocumentResult.ProtectionDomainId | string |
Identyfikator domeny ochrony |
|
Przypomnienia
|
GetDocumentResult.Reminders | array of object |
Przypomnienia |
|
Description
|
GetDocumentResult.Reminders.Description | string |
Opis przypomnienia |
|
Odstęp
|
GetDocumentResult.Reminders.Interval | integer |
Interwał w dniach między przypomnieniami |
|
ProcessTemplateId
|
GetDocumentResult.Reminders.ProcessTemplateId | string |
Identyfikator szablonu procesu dla tego przypomnienia |
|
PrzypomnienieDate
|
GetDocumentResult.Reminders.ReminderDate | string |
Data przypomnienia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
ReminderId
|
GetDocumentResult.Reminders.ReminderId | string |
Identyfikator przypomnienia |
|
Identyfikatory podmiotu
|
GetDocumentResult.Reminders.SubjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
GetDocumentResult.Reminders.UseUserFromProcessTemplate | boolean |
Określa, czy zostanie użyta definicja użytkownika z szablonu procesu |
|
SessionCount
|
GetDocumentResult.SessionCount | integer |
Liczba sesji |
|
SigningProfileId
|
GetDocumentResult.SigningProfileId | string |
Identyfikator profilu podpisywania |
|
Identyfikator wersji
|
GetDocumentResult.VersionId | string |
Identyfikator wersji dokumentu |
Pobieranie dokumentów i procesów wyboru
Pobieranie dokumentów i procesów wybranych na kliencie sieci Web dla urządzeń przenośnych za pomocą akcji przycisku niestandardowego
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
SelectionId
|
SelectionId | True | string |
Identyfikator wyboru wybranych dokumentów i procesów w kliencie sieci Web dla urządzeń przenośnych za pomocą akcji przycisku niestandardowego |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Identyfikator zaznaczenia |
|
id
|
parentObjectId.id | string |
Identyfikator listy obiektu nadrzędnego w kliencie sieci Web dla urządzeń przenośnych |
|
objectId
|
parentObjectId.objectId | string |
Identyfikator obiektu nadrzędnego (dokument, proces,...) |
|
objectTypeEnum
|
parentObjectId.objectTypeEnum | string |
ObjectTypeEnum obiektu nadrzędnego — np. Dokument, Proces, ... |
|
objectIds
|
objectIds | array of object |
Wybrane dokumenty i procesy w kliencie sieci Web dla urządzeń przenośnych |
|
id
|
objectIds.id | string |
Identyfikator listy klienta sieci Web dla urządzeń przenośnych |
|
objectId
|
objectIds.objectId | string |
Identyfikator obiektu wybranego dokumentu lub procesu w kliencie sieci Web dla urządzeń przenośnych |
|
objectTypeEnum
|
objectIds.objectTypeEnum | string |
ObjectTypeEnum wybranego dokumentu lub procesu w kliencie sieci Web dla urządzeń przenośnych |
|
allObjectIds
|
allObjectIds | array of object |
Wybrane i niezaznaczone dokumenty i procesy w kliencie sieci Web dla urządzeń przenośnych |
|
id
|
allObjectIds.id | string |
Identyfikator listy klienta sieci Web dla urządzeń przenośnych |
|
objectId
|
allObjectIds.objectId | string |
Identyfikator obiektu zaznaczonego i niezaznaczonego dokumentu lub procesu w kliencie sieci Web dla urządzeń przenośnych |
|
objectTypeEnum
|
allObjectIds.objectTypeEnum | string |
ObjectTypeEnum zaznaczonego i niezaznaczonego dokumentu lub procesu w kliencie sieci Web dla urządzeń przenośnych |
Pobieranie procesu
Pobierz proces
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
ProcessId
|
processId | True | string |
Identyfikator procesu (Guid) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
AccessRightsEnumList
|
GetProcessResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
GetProcessResult.CheckOutStateEnum | string |
Stan wyewidencjonowania dokumentu (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
GetProcessResult.CheckOutUserId | string |
Identyfikator użytkownika, dla którego proces jest wyewidencjonowany |
|
Comments
|
GetProcessResult.Comments | array of object |
Comments |
|
Date
|
GetProcessResult.Comments.Date | string |
Data komentarza |
|
Id
|
GetProcessResult.Comments.Id | string |
Identyfikator komentarza |
|
Tekst
|
GetProcessResult.Comments.Text | string |
Komentarz zdefiniowany przez użytkownika |
|
UserId
|
GetProcessResult.Comments.UserId | string |
Identyfikator użytkownika, który ustawił komentarz |
|
Data ukończenia
|
GetProcessResult.CompletedDate | string |
Data ukończenia procesu. Format daty: rrrr-MM-ddTHH:mm:ss |
|
UkończonoZadania
|
GetProcessResult.CompletedTasks | array of object |
UkończonoZadania |
|
Akcja
|
GetProcessResult.CompletedTasks.Action | string |
Tekst akcji użytkownika. Wyświetlane użytkownikowi końcowemu |
|
Przypisane identyfikatory użytkownika
|
GetProcessResult.CompletedTasks.AssignedUserIds | array of |
assignedUserIds |
|
Comments
|
GetProcessResult.CompletedTasks.Comments | array of object |
Comments |
|
Date
|
GetProcessResult.CompletedTasks.Comments.Date | string |
Data komentarza |
|
Id
|
GetProcessResult.CompletedTasks.Comments.Id | string |
Identyfikator komentarza |
|
Tekst
|
GetProcessResult.CompletedTasks.Comments.Text | string |
Komentarz zdefiniowany przez użytkownika |
|
UserId
|
GetProcessResult.CompletedTasks.Comments.UserId | string |
Identyfikator użytkownika, który ustawił komentarz |
|
Data ukończenia
|
GetProcessResult.CompletedTasks.CompletedDate | string |
Data ukończenia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
UkończonoUserIds
|
GetProcessResult.CompletedTasks.CompletedUserIds | array of string |
completedUserIds |
|
Data utworzenia
|
GetProcessResult.CompletedTasks.CreatedDate | string |
Data utworzenia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
GetProcessResult.CompletedTasks.CreatorId | string |
Identyfikator użytkownika twórcy |
|
Description
|
GetProcessResult.CompletedTasks.Description | string |
Opis zadania |
|
Data ukończenia
|
GetProcessResult.CompletedTasks.DueDate | string |
Data ukończenia zadania. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Identyfikatory Zamierzoneużytkownika
|
GetProcessResult.CompletedTasks.IntendedUserIds | array of |
intendedUserIds |
|
PrzypomnienieDate
|
GetProcessResult.CompletedTasks.ReminderDate | string |
Data przypomnienia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
GetProcessResult.CompletedTasks.RequiresAllRecipients | boolean |
Określa, czy wszyscy adresaci muszą zamknąć to zadanie |
|
ShowCloseTaskDialog
|
GetProcessResult.CompletedTasks.ShowCloseTaskDialog | boolean |
Pokaż okno dialogowe zamykania zadania na końcu zadania |
|
Status
|
GetProcessResult.CompletedTasks.StatusEnum | string |
Stan zadania (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
GetProcessResult.CompletedTasks.TaskTemplateId | string |
Identyfikator szablonu zadania |
|
Data utworzenia
|
GetProcessResult.CreatedDate | string |
Data utworzenia procesu. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Akcja
|
GetProcessResult.CurrentTask.Action | string |
Tekst akcji użytkownika. Wyświetlane użytkownikowi końcowemu |
|
Przypisane identyfikatory użytkownika
|
GetProcessResult.CurrentTask.AssignedUserIds | array of string |
Przypisane identyfikatory użytkownika |
|
Comments
|
GetProcessResult.CurrentTask.Comments | array of string |
Comments |
|
Data ukończenia
|
GetProcessResult.CurrentTask.CompletedDate | string |
Data ukończenia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
UkończonoUserIds
|
GetProcessResult.CurrentTask.CompletedUserIds | array of string |
UkończonoUserIds |
|
Data utworzenia
|
GetProcessResult.CurrentTask.CreatedDate | string |
Data utworzenia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
GetProcessResult.CurrentTask.CreatorId | string |
Identyfikator użytkownika twórcy |
|
Description
|
GetProcessResult.CurrentTask.Description | string |
Opis zadania |
|
Data ukończenia
|
GetProcessResult.CurrentTask.DueDate | string |
Data ukończenia zadania. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Id
|
GetProcessResult.CurrentTask.Id | string |
Identyfikator zadania |
|
Identyfikatory Zamierzoneużytkownika
|
GetProcessResult.CurrentTask.IntendedUserIds | array of string |
Identyfikatory Zamierzoneużytkownika |
|
PrzypomnienieDate
|
GetProcessResult.CurrentTask.ReminderDate | string |
Data przypomnienia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
GetProcessResult.CurrentTask.RequiresAllRecipients | boolean |
Określa, czy wszyscy adresaci muszą zamknąć to zadanie |
|
ShowCloseTaskDialog
|
GetProcessResult.CurrentTask.ShowCloseTaskDialog | boolean |
Pokaż okno dialogowe zamykania zadania na końcu zadania |
|
StatusEnum
|
GetProcessResult.CurrentTask.StatusEnum | string |
Stan zadania (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
GetProcessResult.CurrentTask.TaskTemplateId | string |
Identyfikator szablonu zadania |
|
Właściwości niestandardowe
|
GetProcessResult.CustomProperties | array of object |
Właściwości niestandardowe |
|
CustomPropertyTypeEnum
|
GetProcessResult.CustomProperties.CustomPropertyTypeEnum | string |
Lista niestandardowych typów danych właściwości (Ciąg, Data, Liczba) |
|
Name
|
GetProcessResult.CustomProperties.Name | string |
Nazwa typu właściwości niestandardowej |
|
Wartość
|
GetProcessResult.CustomProperties.Value | string |
Wartość typu właściwości niestandardowej |
|
Identyfikatory dokumentów
|
GetProcessResult.DocumentIds | array of string |
Identyfikatory dokumentów |
|
Data ukończenia
|
GetProcessResult.DueDate | string |
Data ukończenia procesu. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Id
|
GetProcessResult.Id | string |
Identyfikator procesu |
|
Wartości
|
GetProcessResult.Name.Values | array of object |
Wartości |
|
Kultura
|
GetProcessResult.Name.Values.Culture | string |
Kultura, w której podano tekst (de, en, fr, ...) |
|
Tekst
|
GetProcessResult.Name.Values.Text | string |
Tekst |
|
PluginStream
|
GetProcessResult.PluginStream | array of |
PluginStream |
|
PriorityEnum
|
GetProcessResult.PriorityEnum | string |
Priorytet procesu (Wysoki, Normalny, Niski) |
|
ProcessTemplateId
|
GetProcessResult.ProcessTemplateId | string |
Identyfikator szablonu procesu |
|
Właściwości
|
GetProcessResult.Properties | array of object |
Właściwości |
|
GlobalValues
|
GetProcessResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Wartości
|
GetProcessResult.Properties.GlobalValues.Values | array of object |
Wartości |
|
Kultura
|
GetProcessResult.Properties.GlobalValues.Values.Culture | string |
Kultura |
|
Tekst
|
GetProcessResult.Properties.GlobalValues.Values.Text | string |
Tekst |
|
PropertyTypeId
|
GetProcessResult.Properties.PropertyTypeId | string |
Identyfikator typu właściwości |
|
Wartości
|
GetProcessResult.Properties.Values | array of string |
Wartości |
|
ProtectionDomainId
|
GetProcessResult.ProtectionDomainId | string |
Identyfikator domeny ochrony procesu |
|
SessionCount
|
GetProcessResult.SessionCount | integer |
Liczba sesji |
|
StatusEnum
|
GetProcessResult.StatusEnum | string |
Stan procesu (Open, InProcess, Complete, PreparedToComplete, Error) |
Pobieranie przekonwertowanej zawartości pliku
Przekonwertuj zawartość pliku na inny format. Dodawanie adnotacji lub nakładki do zawartości pliku
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
Identyfikator dokumentu
|
DocumentId | True | string |
Identyfikator dokumentu |
|
Identyfikator wersji
|
VersionId | string |
Identyfikator wersji (Guid)Identyfikator wersji (Guid) |
|
|
DocumentDataId
|
DocumentDataId | string |
Identyfikator danych dokumentu (Guid) |
|
|
Identyfikator odwzorowania
|
RenditionId | string |
Identyfikator odwzorowania dokumentu (Guid) |
|
|
Format docelowy
|
TargetFormat | True | string |
Format docelowy (np. "png;pdf; tif;...") |
|
Dodawanie Adnotacje
|
AddAnnotatins | boolean |
Określa, czy dokument powinien być eksportowany z adnotacjami. Ustawienie domyślne = tak |
|
|
AddOverlay
|
AddOverlay | boolean |
Określa, czy dokument powinien być eksportowany z nakładkami. Ustawienie domyślne = tak |
Zwraca
Przekonwertowana zawartość pliku
- Zawartość pliku
- string
Pobieranie wierszy z tabeli użytkownika
Pobieranie wierszy z tabeli użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
UserTable
|
UserTable | True | string |
Nazwa tabeli użytkownika |
|
WhereClause
|
WhereClause | string |
Lista elementów klauzuli where SQL. Format: [<ColumnName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (np. [Firstname|Równa się|Jon|AND][Lastname|Równa się|Doe|AND]) |
|
|
OrderByClause
|
OrderByClause | string |
Lista elementów klauzuli ORDER by SQL (np. Firstname[ASC], City[DESC]) |
|
|
AddColumnHeaders
|
AddColumnHeaders | boolean |
Dodaje nagłówki kolumn jako pierwszy wiersz (wartość domyślna = false) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
UserTableGetRecordsResult
|
UserTableGetRecordsResult | array of array |
UserTableGetRecordsResult |
|
items
|
UserTableGetRecordsResult | array of string |
Pobieranie właściwości dokumentu
Pobieranie właściwości dokumentu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
Identyfikator dokumentu
|
DocumentId | True | string |
Identyfikator dokumentu |
|
Kultura
|
Culture | string |
Kultura, w której podano nazwy właściwości (de, en, fr, ...). Wartość domyślna = de |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
globalValues
|
globalValues | array of object |
globalValues |
|
values
|
globalValues.values | array of object |
values |
|
kultura
|
globalValues.values.culture | string |
Kultura |
|
SMS
|
globalValues.values.text | string |
Tekst |
|
NazwaWłaściwości
|
propertyName | string |
Nazwa właściwości |
|
PropertyTypeId
|
propertyTypeId | string |
Identyfikator typu pola indeksu |
|
values
|
values | array of string |
values |
Pobieranie właściwości procesu
Pobieranie właściwości procesu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
ProcessId
|
ProcessId | True | string |
Identyfikator procesu (Guid) |
|
Kultura
|
Culture | string |
Kultura, w której podano nazwy właściwości (de, en, fr, ...). Wartość domyślna = de |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
NazwaWłaściwości
|
propertyName | string |
Nazwa właściwości procesu |
|
PropertyTypeId
|
propertyTypeId | string |
Identyfikator typu właściwości |
|
values
|
values | array of string |
values |
Pobierz zawartość pliku
Pobierz zawartość pliku
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
Identyfikator dokumentu
|
DocumentId | True | string |
Identyfikator dokumentu |
|
Identyfikator wersji
|
VersionId | string |
Identyfikator wersji (Guid) |
|
|
DocumentDataId
|
DocumentDataId | string |
Identyfikator danych dokumentu (Guid) |
|
|
Identyfikator odwzorowania
|
RenditionId | string |
Identyfikator odwzorowania dokumentu (Guid) |
|
|
IgnoreHashValidation
|
IgnoreHashValidation | boolean |
Ignoruj konfigurację systemu na potrzeby walidacji skrótu. Ustawienie domyślne = tak |
Zwraca
Zawartość pliku
- Zawartość pliku
- string
Proces aktualizacji (przestarzały) [PRZESTARZAŁE]
Proces aktualizacji (przestarzały)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
ProcessId
|
ProcessId | True | string |
Identyfikator procesu (Guid) |
|
AssignUserLoginNames
|
AssignUserLoginNames | string |
Przypisz nazwy logowania użytkownika do bieżącego zadania. (np.: peter.muster@kendox.com;megan.muster@kendox.com) |
|
|
Właściwości procesu
|
ProcessProperties | string |
Format aktualizacji właściwości procesu: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Właściwości niestandardowe
|
CustomProperties | string |
Właściwości niestandardowe. Format: [<PropertyName>|<PropertyValue>|PropertyType] (np. [Dostawca|Muster|Ciąg][InvoiceDate|2021-01-29T13:05:45 |Date][InvoiceNo|4711|Liczba]) |
|
|
Comment
|
Comment | string |
Comment |
|
|
Kultura
|
Culture | string |
Kultura, w której podano nazwy właściwości (de, en, fr, ...). Wartość domyślna = de |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
values
|
name.values | array of object |
values |
|
kultura
|
name.values.culture | string |
kultura |
|
SMS
|
name.values.text | string |
SMS |
|
values
|
description.values | array of object |
values |
|
kultura
|
description.values.culture | string |
kultura |
|
SMS
|
description.values.text | string |
SMS |
|
id
|
id | string |
id |
|
protectionDomainId
|
protectionDomainId | string |
protectionDomainId |
|
processTemplateId
|
processTemplateId | string |
processTemplateId |
|
properties
|
properties | array of object |
properties |
|
propertyTypeId
|
properties.propertyTypeId | string |
propertyTypeId |
|
values
|
properties.values | array of string |
values |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
kultura
|
properties.globalValues.values.culture | string |
kultura |
|
SMS
|
properties.globalValues.values.text | string |
SMS |
|
propertyTypeName
|
properties.propertyTypeName | string |
propertyTypeName |
|
nazwaWłasności
|
properties.propertyName | string |
nazwaWłasności |
|
priorityEnum
|
priorityEnum | string |
priorityEnum |
|
pluginStream
|
pluginStream | string |
pluginStream |
|
data ukończenia
|
dueDate | string |
data ukończenia |
|
data utworzenia
|
createdDate | string |
data utworzenia |
|
completedDate
|
completedDate | string |
completedDate |
|
comments
|
comments | array of object |
comments |
|
id
|
comments.id | string |
id |
|
date
|
comments.date | string |
date |
|
userId
|
comments.userId | string |
userId |
|
SMS
|
comments.text | string |
SMS |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
statusEnum
|
statusEnum | string |
statusEnum |
|
customProperties (właściwości niestandardowe)
|
customProperties | array of object |
customProperties (właściwości niestandardowe) |
|
nazwa
|
customProperties.name | string |
nazwa |
|
value
|
customProperties.value | string |
value |
|
customPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
customPropertyTypeEnum |
|
id
|
currentTask.id | string |
id |
|
akcja
|
currentTask.action | string |
akcja |
|
creatorId
|
currentTask.creatorId | string |
creatorId |
|
data ukończenia
|
currentTask.dueDate | string |
data ukończenia |
|
data utworzenia
|
currentTask.createdDate | string |
data utworzenia |
|
completedDate
|
currentTask.completedDate | string |
completedDate |
|
taskTemplateId
|
currentTask.taskTemplateId | string |
taskTemplateId |
|
comments
|
currentTask.comments | array of |
comments |
|
reminderDate
|
currentTask.reminderDate | string |
reminderDate |
|
statusEnum
|
currentTask.statusEnum | string |
statusEnum |
|
opis
|
currentTask.description | string |
opis |
|
requiresAllRecipients
|
currentTask.requiresAllRecipients | boolean |
requiresAllRecipients |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
assignedUserIds |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
completedUserIds |
|
showCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
showCloseTaskDialog |
|
intendedUserIds
|
currentTask.intendedUserIds | array of |
intendedUserIds |
|
values
|
currentTask.nameGlobal.values | array of object |
values |
|
kultura
|
currentTask.nameGlobal.values.culture | string |
kultura |
|
SMS
|
currentTask.nameGlobal.values.text | string |
SMS |
|
values
|
currentTask.descriptionGlobal.values | array of object |
values |
|
kultura
|
currentTask.descriptionGlobal.values.culture | string |
kultura |
|
SMS
|
currentTask.descriptionGlobal.values.text | string |
SMS |
|
assignedUserCCIds
|
currentTask.assignedUserCCIds | array of |
assignedUserCCIds |
|
deputyRepresentations
|
currentTask.deputyRepresentations | array of |
deputyRepresentations |
|
taskActionEnum
|
currentTask.taskActionEnum | string |
taskActionEnum |
|
completedTasks
|
completedTasks | array of object |
completedTasks |
|
id
|
completedTasks.id | string |
id |
|
akcja
|
completedTasks.action | string |
akcja |
|
creatorId
|
completedTasks.creatorId | string |
creatorId |
|
data ukończenia
|
completedTasks.dueDate | string |
data ukończenia |
|
data utworzenia
|
completedTasks.createdDate | string |
data utworzenia |
|
completedDate
|
completedTasks.completedDate | string |
completedDate |
|
taskTemplateId
|
completedTasks.taskTemplateId | string |
taskTemplateId |
|
comments
|
completedTasks.comments | array of |
comments |
|
reminderDate
|
completedTasks.reminderDate | string |
reminderDate |
|
statusEnum
|
completedTasks.statusEnum | string |
statusEnum |
|
opis
|
completedTasks.description | string |
opis |
|
requiresAllRecipients
|
completedTasks.requiresAllRecipients | boolean |
requiresAllRecipients |
|
assignedUserIds
|
completedTasks.assignedUserIds | array of string |
assignedUserIds |
|
completedUserIds
|
completedTasks.completedUserIds | array of string |
completedUserIds |
|
showCloseTaskDialog
|
completedTasks.showCloseTaskDialog | boolean |
showCloseTaskDialog |
|
intendedUserIds
|
completedTasks.intendedUserIds | array of |
intendedUserIds |
|
values
|
completedTasks.nameGlobal.values | array of object |
values |
|
kultura
|
completedTasks.nameGlobal.values.culture | string |
kultura |
|
SMS
|
completedTasks.nameGlobal.values.text | string |
SMS |
|
values
|
completedTasks.descriptionGlobal.values | array of object |
values |
|
kultura
|
completedTasks.descriptionGlobal.values.culture | string |
kultura |
|
SMS
|
completedTasks.descriptionGlobal.values.text | string |
SMS |
|
assignedUserCCIds
|
completedTasks.assignedUserCCIds | array of |
assignedUserCCIds |
|
deputyRepresentations
|
completedTasks.deputyRepresentations | array of |
deputyRepresentations |
|
taskActionEnum
|
completedTasks.taskActionEnum | string |
taskActionEnum |
|
documentIds
|
documentIds | array of string |
documentIds |
|
checkOutStateEnum
|
checkOutStateEnum | string |
checkOutStateEnum |
|
checkOutUserId
|
checkOutUserId | string |
checkOutUserId |
|
sessionCount
|
sessionCount | integer |
sessionCount |
Proces aktualizacji (wersja 2)
Proces aktualizacji (wersja 2)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
ProcessId
|
ProcessId | True | string |
Identyfikator procesu (Guid) |
|
Właściwości procesu
|
ProcessProperties | string |
Format aktualizacji właściwości procesu: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
RemoveProcessProperties
|
RemoveProcessProperties | string |
Lista rozdzielonych średnikami właściwości Nazw lub identyfikatorów do usunięcia z procesu, takich jak "FistName; b9cfbdf7-f6fb-4179-91c8-d9681fb680dd; Działy" |
|
|
Właściwości niestandardowe
|
CustomProperties | string |
Właściwości niestandardowe. Format: [<PropertyName>|<PropertyValue>|PropertyType] (np. [Dostawca|Muster|Ciąg][InvoiceDate|2021-01-29T13:05:45 |Date][InvoiceNo|4711|Liczba]) |
|
|
Comment
|
Comment | string |
Dodawanie tekstu komentarza procesu |
|
|
AssignUserLoginNames
|
AssignUserLoginNames | string |
Przypisane nazwy logowania użytkownika oddzielone średnikami, takie jak user1; użytkownik2 |
|
|
AddDocumentIds
|
AddDocumentIds | string |
Rozdzielona średnikami lista identyfikatorów dokumentów do dodania do procesu, np. "1450c90e-2783-419b-b428-6ffa3b7cabe2; 0339a105-e06a-4af4-8fa2-d0b6b837fc16" |
|
|
RemoveDocumentIds
|
RemoveDocumentIds | string |
Rozdzielona średnikami lista identyfikatorów dokumentów do usunięcia z procesu, np. "1450c90e-2783-419b-b428-6ffa3b7cabe2; 0339a105-e06a-4af4-8fa2-d0b6b837fc16" |
|
|
Data ukończenia
|
DueDate | string |
Data ukończenia procesu. Format daty: rrrr-MM-ddTHH:mm:ss. Wartość domyślna = bieżąca data |
|
|
Priority
|
Priority | string |
Priorytet procesu (np. Niski, Normalny, Wysoki). Wartość domyślna = normalna |
|
|
Kultura
|
Culture | string |
Kultura, w której podano tekst (de, en, fr, ...). Wartość domyślna = de |
|
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Wymuś cofnięcie wyewidencjonowania procesu w razie potrzeby |
|
|
Domena ochrony
|
ProtectionDomain | string |
Identyfikator domeny ochrony lub nazwa |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
values
|
name.values | array of object |
Wartości właściwości |
|
kultura
|
name.values.culture | string |
Kultura właściwości |
|
SMS
|
name.values.text | string |
Tekst właściwości |
|
values
|
description.values | array of object |
values |
|
kultura
|
description.values.culture | string |
Kultura właściwości |
|
SMS
|
description.values.text | string |
Tekst właściwości |
|
id
|
id | string |
Identyfikator procesu |
|
protectionDomainId
|
protectionDomainId | string |
Identyfikator domeny ochrony procesów |
|
processTemplateId
|
processTemplateId | string |
Identyfikator szablonu procesu |
|
properties
|
properties | array of object |
Właściwości |
|
propertyTypeId
|
properties.propertyTypeId | string |
Identyfikator właściwości |
|
values
|
properties.values | array of string |
Wartości właściwości |
|
globalValues
|
properties.globalValues | array of object |
Wartości globalne |
|
values
|
properties.globalValues.values | array of object |
values |
|
kultura
|
properties.globalValues.values.culture | string |
Globalna kultura wartości |
|
SMS
|
properties.globalValues.values.text | string |
Tekst wartości globalnej |
|
propertyTypeName
|
properties.propertyTypeName | string |
Nazwa właściwości |
|
nazwaWłasności
|
properties.propertyName | string |
Nazwa właściwości |
|
priorityEnum
|
priorityEnum | string |
Wyliczenie priorytetu procesu |
|
pluginStream
|
pluginStream | string |
Przetwarzanie strumienia wtyczki |
|
data ukończenia
|
dueDate | string |
Data ukończenia procesu |
|
data utworzenia
|
createdDate | string |
Data utworzenia procesu |
|
completedDate
|
completedDate | string |
Data ukończenia procesu |
|
comments
|
comments | array of object |
Comments |
|
id
|
comments.id | string |
Identyfikator komentarza procesu |
|
date
|
comments.date | string |
Data komentarza procesu |
|
userId
|
comments.userId | string |
Identyfikator użytkownika komentarza procesu |
|
SMS
|
comments.text | string |
Przetwarzanie tekstu komentarza |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Lista wyliczenie praw dostępu |
|
statusEnum
|
statusEnum | string |
Wyliczenie stanu |
|
customProperties (właściwości niestandardowe)
|
customProperties | array of object |
Właściwości niestandardowe |
|
nazwa
|
customProperties.name | string |
Nazwa właściwości niestandardowej |
|
value
|
customProperties.value | string |
Wartość właściwości niestandardowej |
|
customPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
Wyliczenie typu właściwości niestandardowej |
|
id
|
currentTask.id | string |
Bieżący identyfikator zadania |
|
akcja
|
currentTask.action | string |
Bieżąca akcja zadania |
|
creatorId
|
currentTask.creatorId | string |
Identyfikator bieżącego twórcy zadania |
|
data ukończenia
|
currentTask.dueDate | string |
Bieżąca data ukończenia zadania |
|
data utworzenia
|
currentTask.createdDate | string |
Bieżąca data utworzenia zadania |
|
completedDate
|
currentTask.completedDate | string |
Bieżąca data ukończenia zadania |
|
taskTemplateId
|
currentTask.taskTemplateId | string |
Identyfikator szablonu bieżącego zadania |
|
comments
|
currentTask.comments | array of |
Bieżące komentarze zadań |
|
reminderDate
|
currentTask.reminderDate | string |
Bieżąca data przypomnienia zadania |
|
statusEnum
|
currentTask.statusEnum | string |
Bieżące wyliczenie stanu zadania |
|
opis
|
currentTask.description | string |
Bieżący opis zadania |
|
requiresAllRecipients
|
currentTask.requiresAllRecipients | boolean |
Bieżące zadanie wymaga wszystkich adresatów |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
Bieżące identyfikatory użytkownika przydzielone do zadania |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
Bieżące identyfikatory użytkownika ukończonego zadania |
|
showCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
Bieżące zadanie pokazuje okno dialogowe zamykania zadania |
|
intendedUserIds
|
currentTask.intendedUserIds | array of |
Bieżące zadanie docelowe identyfikatory użytkownika |
|
values
|
currentTask.nameGlobal.values | array of object |
values |
|
kultura
|
currentTask.nameGlobal.values.culture | string |
Kultura nazw globalnych |
|
SMS
|
currentTask.nameGlobal.values.text | string |
Tekst nazwy globalnej |
|
values
|
currentTask.descriptionGlobal.values | array of object |
values |
|
kultura
|
currentTask.descriptionGlobal.values.culture | string |
Kultura opisu globalnego |
|
SMS
|
currentTask.descriptionGlobal.values.text | string |
Tekst opisu globalnego |
|
assignedUserCCIds
|
currentTask.assignedUserCCIds | array of |
Identyfikatory dw przypisanego użytkownika |
|
deputyRepresentations
|
currentTask.deputyRepresentations | array of |
Zastępca reprezentacji |
|
taskActionEnum
|
currentTask.taskActionEnum | string |
Wyliczenie akcji zadania |
|
completedTasks
|
completedTasks | array of object |
Ukończone zadania |
|
id
|
completedTasks.id | string |
Identyfikator ukończonego zadania |
|
akcja
|
completedTasks.action | string |
Ukończona akcja zadania |
|
creatorId
|
completedTasks.creatorId | string |
Identyfikator twórcy ukończonego zadania |
|
data ukończenia
|
completedTasks.dueDate | string |
Data ukończenia zadania ukończonego |
|
data utworzenia
|
completedTasks.createdDate | string |
Data utworzenia zadania ukończonego |
|
completedDate
|
completedTasks.completedDate | string |
Data ukończenia zadania ukończonego |
|
taskTemplateId
|
completedTasks.taskTemplateId | string |
Identyfikator szablonu zadania ukończonego |
|
comments
|
completedTasks.comments | array of |
Komentarze ukończonych zadań |
|
reminderDate
|
completedTasks.reminderDate | string |
Data przypomnienia o ukończonym zadaniu |
|
statusEnum
|
completedTasks.statusEnum | string |
Ukończono wyliczenie stanu zadania |
|
opis
|
completedTasks.description | string |
opis |
|
requiresAllRecipients
|
completedTasks.requiresAllRecipients | boolean |
Ukończone zadanie wymaga wszystkich adresatów |
|
assignedUserIds
|
completedTasks.assignedUserIds | array of string |
Ukończono identyfikatory użytkownika przydzielone do zadania |
|
completedUserIds
|
completedTasks.completedUserIds | array of string |
Ukończone zadanie ukończone identyfikatory użytkownika |
|
showCloseTaskDialog
|
completedTasks.showCloseTaskDialog | boolean |
Ukończone zadanie wyświetla okno dialogowe zamykania zadania |
|
intendedUserIds
|
completedTasks.intendedUserIds | array of |
Ukończone zadanie — identyfikatory zamierzonego użytkownika |
|
values
|
completedTasks.nameGlobal.values | array of object |
values |
|
kultura
|
completedTasks.nameGlobal.values.culture | string |
Kultura nazw globalnych |
|
SMS
|
completedTasks.nameGlobal.values.text | string |
Tekst nazwy globalnej |
|
values
|
completedTasks.descriptionGlobal.values | array of object |
values |
|
kultura
|
completedTasks.descriptionGlobal.values.culture | string |
Kultura opisu globalnego |
|
SMS
|
completedTasks.descriptionGlobal.values.text | string |
Tekst opisu globalnego |
|
assignedUserCCIds
|
completedTasks.assignedUserCCIds | array of |
Ukończono zadanie przydzielone użytkownikowi dw ids |
|
deputyRepresentations
|
completedTasks.deputyRepresentations | array of |
Ukończone reprezentacje zastępcy zadań |
|
taskActionEnum
|
completedTasks.taskActionEnum | string |
Ukończono wyliczenie akcji zadania podrzędnego |
|
documentIds
|
documentIds | array of string |
Identyfikatory dokumentu ukończonego zadania |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Ukończone zadanie wyewidencjonowanie stanu |
|
checkOutUserId
|
checkOutUserId | string |
Ukończone zadanie wyewidencjonuj identyfikator użytkownika |
|
sessionCount
|
sessionCount | integer |
Liczba ukończonych sesji zadań |
Scalanie dokumentów PDF
Scalanie co najmniej dwóch dokumentów PDF w jednym dokumencie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
Identyfikator dokumentu
|
DocumentId | True | string |
Identyfikator pierwszego dokumentu PDF, zostanie utworzona nowa wersja z nową scaloną zawartością |
|
DocumentIdToAppend
|
DocumentIdToAppend | True | string |
Identyfikatory dokumentów, które zostaną dołączone (scalone) do pierwszego rozdzielonego średnikiem, tj. "77b3c69d-7a9a-4083-9d75-83a5e6f3deca; 82514f19-057c-484f-8ee2-c21df81a928" |
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Cofnij wyewidencjonowanie pierwszego dokumentu PDF zgodnie z potrzebami. Wartość domyślna = false |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa dokumentu |
|
id
|
id | string |
Identyfikator dokumentu |
|
versionId
|
versionId | string |
Identyfikator wersji dokumentu |
|
currentVersionId
|
currentVersionId | string |
Identyfikator bieżącej wersji dokumentu |
|
protectionDomainId
|
protectionDomainId | string |
Identyfikator domeny ochrony dokumentów |
|
infoStoreId
|
infoStoreId | string |
Identyfikator magazynu informacji |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Wyliczenie stanu wyewidencjonu |
|
checkOutUserId
|
checkOutUserId | string |
Wyewidencjonuj identyfikator użytkownika |
|
properties
|
properties | array of object |
Właściwości |
|
propertyTypeId
|
properties.propertyTypeId | string |
Identyfikator właściwości |
|
values
|
properties.values | array of string |
Wartości WłaściwościType |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
kultura
|
properties.globalValues.values.culture | string |
Kultura wartości globalnych |
|
SMS
|
properties.globalValues.values.text | string |
Tekst wartości globalnych |
|
propertyTypeName
|
properties.propertyTypeName | string |
Nazwa właściwości |
|
nazwaWłasności
|
properties.propertyName | string |
Nazwa właściwości |
|
importTemplateId
|
importTemplateId | string |
Identyfikator szablonu importu |
|
blogi
|
blogs | array of object |
Blogs |
|
data utworzenia
|
blogs.createdDate | string |
Data utworzenia bloga |
|
creatorId
|
blogs.creatorId | string |
Identyfikator twórcy bloga |
|
SMS
|
blogs.text | string |
Tekst blogu |
|
id
|
blogs.id | string |
Identyfikator bloga |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Lista wyliczenie praw dostępu |
|
Przypomnienia
|
reminders | array of |
Przypomnienia |
|
pageCount
|
pageCount | integer |
Liczba stron |
|
mainFileLength
|
mainFileLength | integer |
Długość pliku głównego |
|
abonnements
|
abonnements | array of |
Abonnements |
|
textAnnotations
|
annotationManager.textAnnotations | array of |
Adnotacje tekstowe |
|
rectangleAnnotations
|
annotationManager.rectangleAnnotations | array of |
Adnotacje prostokątne |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of |
Adnotacje postIt |
|
stampAnnotations
|
annotationManager.stampAnnotations | array of |
Adnotacje sygnatur |
|
documentData
|
documentData | array of object |
Dane dokumentu |
|
id
|
documentData.id | string |
Identyfikator danych dokumentu |
|
nazwa
|
documentData.name | string |
Nazwa danych dokumentu |
|
Wersje
|
documentData.renditions | array of object |
Wersje |
|
id
|
documentData.renditions.id | string |
Identyfikator odwzorowania |
|
size
|
documentData.renditions.size | string |
Rozmiar odwzorowania |
|
files
|
documentData.renditions.files | array of object |
Pliki odwzorowania |
|
BlobStoreId
|
documentData.renditions.files.blobStoreId | string |
Identyfikator magazynu obiektów blob odwzorowania |
|
BlobPath
|
documentData.renditions.files.blobPath | string |
Ścieżka odwzorowania obiektu blob |
|
pageCount
|
documentData.renditions.pageCount | string |
Liczba stron odwzorowania |
|
rozszerzenie
|
documentData.renditions.extension | string |
Rozszerzenie odwzorowania |
|
hashValue
|
documentData.renditions.hashValue | array of integer |
Wartość skrótu odwzorowania |
|
contentProtections
|
documentData.renditions.contentProtections | array of |
Odwzorowanie ochrony zawartości |
|
signingProfileId
|
signingProfileId | string |
Identyfikator profilu podpisywania |
|
lifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Identyfikator cyklu życia |
|
lifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Identyfikator stanu cyklu życia |
|
lifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Data rozpoczęcia cyklu życia |
|
lifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Data zakończenia cyklu życia |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of |
Następne stany cyklu życia |
|
checkOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Sprawdź identyfikator stanu cyklu życia |
|
nextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Następny identyfikator stanu automatycznego cyklu życia |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
Zabezpieczenia cyklu życia |
|
id
|
lifeCycleManager.lifeCycleProtections.id | string |
Identyfikator ochrony cyklu życia |
|
protectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Czas trwania trwania cyklu życia |
|
protectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Wyewidencjonowywanie ochrony cyklu życia |
|
protectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Zmiana zawartości ochrony cyklu życia |
|
protectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Zmiana właściwości ochrony cyklu życia |
|
protectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Zmiana adnotacji ochrony cyklu życia |
|
protectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Zmiana domeny ochrony przed cyklem życia |
|
protectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Usuwanie ochrony cyklu życia |
|
deleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Usuwanie ochrony cyklu życia po wygaśnięciu |
|
hasOverlay
|
hasOverlay | boolean |
Ma nakładkę |
|
sessionCount
|
sessionCount | integer |
Liczba sesji |
|
hasSignature
|
hasSignature | boolean |
Ma podpis |
|
hasBlog
|
hasBlog | boolean |
Ma blog |
|
hasAnnotation
|
hasAnnotation | boolean |
Zawiera adnotację |
|
hasTempAccess
|
hasTempAccess | boolean |
Ma dostęp tymczasowy |
|
hasReminders
|
hasReminders | boolean |
Zawiera przypomnienia |
|
hasLinks
|
hasLinks | boolean |
Zawiera łącza |
|
hasAbonnement
|
hasAbonnement | boolean |
Ma abonnement |
Tworzenie dokumentu (przestarzałe) [PRZESTARZAŁE]
Tworzenie dokumentu (przestarzałe)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
DocumentTitle
|
DocumentTitle | True | string |
Tytuł dokumentu (rozszerzenie incl. ) |
|
ImportTemplate
|
ImportTemplate | True | string |
Importowanie szablonu |
|
Właściwości dokumentu
|
DocumentProperties | string |
Właściwości dokumentu wstaw format: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Kultura
|
Culture | string |
Kultura, w której podano nazwy właściwości (de, en, fr, ...). Wartość domyślna = de |
|
|
PlikContent
|
FileContent | True | string |
Ciąg base64 zawartości pliku |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
abonnements
|
abonnements | array of string |
abonnements |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
Data utworzenia
|
annotationManager.postItAnnotations.createdDate | string |
Data utworzenia z adnotacji |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
Identyfikator użytkownika twórcy z adnotacji |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
Jest kursywą czcionki z adnotacji |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
Czy czcionka jest wykreślona z adnotacji |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
Czy czcionka jest podkreślona po adnotacji |
|
Name
|
annotationManager.postItAnnotations.fontInfo.name | string |
Nazwa czcionki z adnotacji. Ustawienie domyślne = Arial |
|
Ton lub wysokość dźwięku
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Rzut czcionki z adnotacji |
|
Rozmiar
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Rozmiar czcionki z adnotacji. Przykład: rozmiar:12 to 12000. Potrzebujesz współczynnika 1000 |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Grubość czcionki z adnotacji |
|
Id
|
annotationManager.postItAnnotations.id | string |
Identyfikator adnotacji wpisu |
|
Data modyfikacji
|
annotationManager.postItAnnotations.modifiedDate | string |
Data modyfikacji z adnotacji. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Numer strony
|
annotationManager.postItAnnotations.pageNumber | integer |
Liczba stron z adnotacji |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Poziom zabezpieczeń dla adnotacji (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Ustawienie domyślne = publicznie dostępne |
|
Wybieralny
|
annotationManager.postItAnnotations.selectable | boolean |
Określa, czy adnotacja jest wybierana przez użytkownika |
|
Tekst
|
annotationManager.postItAnnotations.text | string |
Tekst zdefiniowany przez użytkownika w celu opublikowania jej adnotacji |
|
X
|
annotationManager.postItAnnotations.x | integer |
Współrzędna X w pikselach na cal dla 7200 DPI po adnotacji |
|
Y
|
annotationManager.postItAnnotations.y | integer |
Współrzędna Y w pikselach na cal dla 7200 DPI po adnotacji |
|
rectangleAnnotations
|
annotationManager.rectangleAnnotations | array of object |
rectangleAnnotations |
|
Kolor
|
annotationManager.rectangleAnnotations.color | integer |
Kolor prostokąta (32-bitowa wartość ARGB) z adnotacji prostokąta Przykład:: -16777216 Biały: -1 Czerwony: -65536 Zielony: -16744448 Niebieski: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Kolor prostokąta (kod szesnastkowy RGB) z adnotacji prostokąta. Przykład:: #0000000 Biały: #FFFFFF Czerwony: #FF0000 Zielony: #008000 Niebieski: #0000FF |
|
Data utworzenia
|
annotationManager.rectangleAnnotations.createdDate | string |
Data utworzenia z adnotacji prostokąta. Format daty: rrrr-MM-ddTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
CreatorId |
|
Wysokość
|
annotationManager.rectangleAnnotations.height | integer |
Wysokość prostokąta w pikselach na cal dla 7200 DPI |
|
Id
|
annotationManager.rectangleAnnotations.Id | string |
Identyfikator adnotacji prostokąta |
|
Data modyfikacji
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Data modyfikacji adnotacji prostokąta. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Numer strony
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Liczba stron z adnotacji prostokąta |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Poziom zabezpieczeń adnotacji prostokąta (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Ustawienie domyślne = publicznie dostępne |
|
Wybieralny
|
annotationManager.rectangleAnnotations.selectable | boolean |
Określa, czy adnotacja prostokąta jest wybierana przez użytkownika |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
Prostokąt powinien być przezroczysty (wyróżnienie) |
|
Szerokość
|
annotationManager.rectangleAnnotations.width | integer |
Szerokość prostokąta w pikselach na cal dla 7200 DPI |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
Współrzędna X w pikselach na cal dla 7200 DPI z adnotacji prostokąta |
|
Y
|
annotationManager.rectangleAnnotations.y | integer |
Współrzędna Y w pikselach na cal dla 7200 DPI z adnotacji prostokąta |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
textAnnotations |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Kolor tła (32-bitowa wartość ARGB) z adnotacji tekstowej Przykład:: -16777216 Biały: -1 Czerwony: -65536 Zielony: -16744448 Niebieski: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Kolor tła (kod szesnastkowy RGB) z adnotacji tekstowej Przykład:: #000000 Biały: #FFFFFF Czerwony: #FF0000 Zielony: #008000 Niebieski: #0000FF |
|
Data utworzenia
|
annotationManager.textAnnotations.createdDate | string |
data utworzenia z adnotacji tekstowej. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
Identyfikator użytkownika twórcy z adnotacji tekstowej |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
Jest kursywą czcionki z adnotacji tekstowej |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
Czy czcionka jest wykreślona z adnotacji tekstowych |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
Jest podkreśleniem czcionki z adnotacji tekstowej |
|
Name
|
annotationManager.textAnnotations.fontInfo.name | string |
Nazwa czcionki z adnotacji tekstowej. Ustawienie domyślne = Arial |
|
Ton lub wysokość dźwięku
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Rzut czcionki z adnotacji tekstowej |
|
Rozmiar
|
annotationManager.textAnnotations.fontInfo.size | integer |
Rozmiar czcionki z adnotacji tekstu. Przykład: rozmiar:12 to 12000. Potrzebujesz współczynnika 1000 |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Waga czcionki z adnotacji tekstu |
|
ForegroundColor
|
annotationManager.textAnnotations.foregroundColor | integer |
Kolor pierwszego planu (32-bitowa wartość ARGB) z adnotacji tekstowej. Przykład:: -16777216 Biały: -1 Czerwony: -65536 Zielony: -16744448 Niebieski: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Kolor pierwszego planu (kod szesnastkowy RGB) z adnotacji tekstu. Przykład:: #0000000 Biały: #FFFFFF Czerwony: #FF0000 Zielony: #008000 Niebieski: #0000FF |
|
Wysokość
|
annotationManager.textAnnotations.height | integer |
Wysokość tekstu w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
Id
|
annotationManager.textAnnotations.id | string |
Identyfikator adnotacji tekstu |
|
Data modyfikacji
|
annotationManager.textAnnotations.modifiedDate | string |
Data modyfikacji adnotacji tekstowej. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Numer strony
|
annotationManager.textAnnotations.pageNumber | integer |
Liczba stron z adnotacji tekstowych |
|
Rotacja
|
annotationManager.textAnnotations.rotation | integer |
Rotacja w stopniach z adnotacji tekstu |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Poziom zabezpieczeń adnotacji tekstu (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Ustawienie domyślne = publicznie dostępne |
|
Wybieralny
|
annotationManager.textAnnotations.selectable | boolean |
Określa, czy adnotacja tekstowa jest wybierana przez użytkownika |
|
Tekst
|
annotationManager.textAnnotations.text | string |
Zdefiniowany przez użytkownika tekst adnotacji |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
Adnotacja tekstowa powinna być przezroczysta |
|
Szerokość
|
annotationManager.textAnnotations.width | integer |
Szerokość tekstu w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
X
|
annotationManager.textAnnotations.x | integer |
Współrzędna X w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
Y
|
annotationManager.textAnnotations.y | integer |
Współrzędna Y w pikselach na cal dla 7200 DPI z adnotacji tekstu |
|
blogi
|
blogs | array of object |
blogi |
|
Blogs
|
blogs | object |
Lista wszystkich elementów blogu |
|
CheckOutState
|
checkOutStateEnum | string |
Stan wyewidencjonowania dokumentu (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Identyfikator użytkownika, dla którego dokument jest wyewidencjonowany |
|
documentData
|
documentData | array of object |
documentData |
|
Id
|
documentData.id | string |
Identyfikator odwzorowania dokumentu |
|
Name
|
documentData.name | string |
Nazwa dokumentu odwzorowania |
|
Wersje
|
documentData.renditions | array of |
Wersje |
|
HasOverlay
|
hasOverlay | boolean |
Określa, czy dokument powinien być wyświetlany z nakładką |
|
Id
|
id | string |
Identyfikator dokumentu |
|
ImportTemplateId
|
importTemplateId | string |
Identyfikator szablonu importu dla tego dokumentu |
|
Identyfikator magazynu informacji
|
infoStoreId | string |
Identyfikator magazynu informacji |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Stan cyklu życia wyewidencjonowania |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Obliczona data zakończenia cyklu życia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Data rozpoczęcia cyklu życia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Identyfikator stanu LifeCycle |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Następny automatyczny stan cyklu życia |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
nextLifeCycleStates |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Zezwalaj na usuwanie dokumentu po wygaśnięciu ochrony |
|
Id
|
lifeCycleManager.lifeCycleProtections.id | string |
Identyfikator ochrony stanu cyklu życia |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Ochrona przed zmianami adnotacji |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Ochrona przed wyewidencjonowywaniem |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Ochrona przed zmianą zawartości |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Ochrona przed usunięciem |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Ochrona przed zmianami właściwości |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Ochrona przed zmianami zabezpieczeń |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Czas trwania ochrony |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Identyfikator życia |
|
MainFileLength
|
mainFileLength | integer |
Rozmiar pliku głównego |
|
Name
|
name | string |
Nazwa dokumentu |
|
PageCount
|
pageCount | integer |
Liczba stron pliku głównego |
|
properties
|
properties | array of object |
properties |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
kultura
|
properties.globalValues.values.culture | string |
Kultura |
|
SMS
|
properties.globalValues.values.text | string |
Tekst |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Identyfikator typu pola indeksu |
|
values
|
properties.values | array of string |
Wartości WłaściwościType |
|
ProtectionDomainId
|
protectionDomainId | string |
Identyfikator domeny ochrony |
|
Przypomnienia
|
reminders | array of object |
Przypomnienia |
|
Przypomnienia
|
reminders | object |
Lista wszystkich przypomnień |
|
SessionCount
|
sessionCount | integer |
Liczba sesji |
|
SigningProfileId
|
signingProfileId | string |
Identyfikator profilu podpisywania |
|
Identyfikator wersji
|
versionId | string |
Identyfikator wersji dokumentu |
Tworzenie dokumentu (wersja 2)
Tworzenie dokumentu (wersja 2)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
DocumentTitle
|
DocumentTitle | True | string |
Tytuł dokumentu (rozszerzenie incl. ) |
|
ImportTemplate
|
ImportTemplate | string |
Zaimportuj wartości Nazwa szablonu lub Identyfikator, jeśli są puste, należy podać wartości InfoStore i ProtectionDomain. |
|
|
Właściwości dokumentu
|
DocumentProperties | string |
Właściwości dokumentu wstaw format: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Blog internetowy
|
Blog | string |
Dodawanie wpisu tekstowego w blogu w dokumencie |
|
|
Kultura
|
Culture | string |
Kultura, w której podano nazwy właściwości (de, en, fr, ...). Wartość domyślna = de |
|
|
Magazyn informacji
|
InfoStore | string |
Jeśli importTemplate jest pusty, należy podać nazwę lub identyfikator magazynu informacji |
|
|
Cykl życia
|
LifeCycle | string |
Nazwa lub identyfikator cyklu życia |
|
|
ProtectionDomain
|
ProtectionDomain | string |
Jeśli importTemplate jest pusty, należy podać nazwę lub identyfikator domeny ochrony |
|
|
UploadMethod
|
UploadMethod | string |
Metoda używana podczas przekazywania dokumentu do programu InfoShare. Ustawienie domyślne = UploadFileBytesLarge |
|
|
OriginalFileFormat
|
OriginalFileFormat | string |
Oryginalny format pliku na potrzeby konwersji, np. "html". Przekonwertowane na plik PDF |
|
|
Rozmiar fragmentu
|
ChunkSize | integer |
Rozmiar fragmentu przekazywania pliku używanego z metodami przekazywania UploadStreamChunks i UploadFileBytesLarge, domyślne |
|
|
PlikContent
|
FileContent | True | string |
Ciąg base64 zawartości pliku |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
nazwa |
|
id
|
id | string |
Identyfikator dokumentu |
|
versionId
|
versionId | string |
Identyfikator wersji |
|
currentVersionId
|
currentVersionId | string |
Bieżący identyfikator wersji |
|
protectionDomainId
|
protectionDomainId | string |
Identyfikator domeny ochrony |
|
infoStoreId
|
infoStoreId | string |
Identyfikator magazynu informacji |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Stan wyewidencjonowania dokumentu (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
checkOutUserId
|
checkOutUserId | string |
Wyewidencjonowany identyfikator użytkownika |
|
properties
|
properties | array of object |
Właściwości |
|
propertyTypeId
|
properties.propertyTypeId | string |
Identyfikator właściwości |
|
values
|
properties.values | array of string |
Wartości WłaściwościType |
|
globalValues
|
properties.globalValues | array of object |
Wartości globalne |
|
values
|
properties.globalValues.values | array of object |
values |
|
kultura
|
properties.globalValues.values.culture | string |
Globalna kultura wartości |
|
SMS
|
properties.globalValues.values.text | string |
Tekst wartości globalnej |
|
propertyTypeName
|
properties.propertyTypeName | string |
Nazwa właściwości |
|
nazwaWłasności
|
properties.propertyName | string |
Nazwa właściwości |
|
importTemplateId
|
importTemplateId | string |
Identyfikator szablonu importu |
|
blogi
|
blogs | array of object |
blogi |
|
data utworzenia
|
blogs.createdDate | string |
Data utworzenia bloga |
|
creatorId
|
blogs.creatorId | string |
Identyfikator twórcy bloga |
|
SMS
|
blogs.text | string |
Tekst blogu |
|
id
|
blogs.id | string |
Identyfikator bloga |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
Przypomnienia
|
reminders | array of |
Przypomnienia |
|
pageCount
|
pageCount | integer |
Liczba stron |
|
mainFileLength
|
mainFileLength | integer |
Długość pliku głównego |
|
abonnements
|
abonnements | array of |
Abonnements |
|
textAnnotations
|
annotationManager.textAnnotations | array of |
Tekst adnotacji |
|
rectangleAnnotations
|
annotationManager.rectangleAnnotations | array of |
Prostokąt adnotacji |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of |
Adnotacje publikują je |
|
stampAnnotations
|
annotationManager.stampAnnotations | array of |
Sygnatura adnotacji |
|
documentData
|
documentData | array of object |
Dane dokumentu |
|
id
|
documentData.id | string |
Identyfikator danych dokumentu |
|
nazwa
|
documentData.name | string |
Nazwa danych dokumentu |
|
Wersje
|
documentData.renditions | array of object |
Wersje |
|
id
|
documentData.renditions.id | string |
Identyfikator odwzorowania |
|
size
|
documentData.renditions.size | string |
Rozmiar odwzorowania |
|
files
|
documentData.renditions.files | array of object |
files |
|
BlobStoreId
|
documentData.renditions.files.blobStoreId | string |
Identyfikator magazynu obiektów blob |
|
BlobPath
|
documentData.renditions.files.blobPath | string |
Ścieżka obiektu blob |
|
pageCount
|
documentData.renditions.pageCount | string |
Liczba stron odwzorowania |
|
rozszerzenie
|
documentData.renditions.extension | string |
Rozszerzenie odwzorowania |
|
hashValue
|
documentData.renditions.hashValue | array of integer |
Wartość skrótu odwzorowania |
|
contentProtections
|
documentData.renditions.contentProtections | array of |
Odwzorowanie ochrony zawartości |
|
signingProfileId
|
signingProfileId | string |
Identyfikator profilu podpisywania |
|
lifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Identyfikator cyklu życia |
|
lifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Identyfikator stanu cyklu życia |
|
lifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Data rozpoczęcia cyklu życia |
|
lifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Data zakończenia cyklu życia |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of |
Następne stany cyklu życia |
|
checkOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Sprawdź identyfikator stanu cyklu życia |
|
nextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Następny identyfikator stanu automatycznego cyklu życia |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
Zabezpieczenia cyklu życia |
|
id
|
lifeCycleManager.lifeCycleProtections.id | string |
Identyfikator ochrony cyklu życia |
|
protectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Czas trwania trwania cyklu życia |
|
protectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Wyewidencjonowywanie cyklu życia |
|
protectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Cykl życia chroni zmianę zawartości |
|
protectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Zmiana właściwości ochrony cyklu życia |
|
protectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Zmiana adnotacji w cyklu życia |
|
protectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Zmiana domeny ochrony przed cyklem życia |
|
protectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Usuwanie w cyklu życia |
|
deleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Usuwanie cyklu życia po wygaśnięciu |
|
hasOverlay
|
hasOverlay | boolean |
Ma nakładkę |
|
sessionCount
|
sessionCount | integer |
Liczba sesji |
|
hasSignature
|
hasSignature | boolean |
Ma podpis |
|
hasBlog
|
hasBlog | boolean |
Ma blog |
|
hasAnnotation
|
hasAnnotation | boolean |
Zawiera adnotację |
|
hasTempAccess
|
hasTempAccess | boolean |
Ma dostęp tymczasowy |
|
hasReminders
|
hasReminders | boolean |
Zawiera przypomnienia |
|
hasLinks
|
hasLinks | boolean |
Zawiera łącza |
|
hasAbonnement
|
hasAbonnement | boolean |
Ma abonnement |
Tworzenie procesu
Tworzenie procesu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
Właściwości procesu
|
ProcessProperties | string |
Format aktualizacji właściwości procesu: Firstname=Peter|Lastname=Muller|InvoiceNo=4711; 4712; 4713 |
|
|
Właściwości niestandardowe
|
CustomProperties | string |
Właściwości niestandardowe. Format: [<PropertyName>|<PropertyValue>|PropertyType] (np. [Dostawca|Muster|Ciąg][InvoiceDate|2021-01-29T13:05:45 |Date][InvoiceNo|4711|Liczba]) |
|
|
Identyfikatory dokumentów
|
DocumentIds | string |
Lista wszystkich identyfikatorów dokumentów do dołączenia |
|
|
ProcessTemplateName
|
ProcessTemplateName | True | string |
Nazwa szablonu procesu |
|
Data ukończenia
|
DueDate | string |
Data ukończenia procesu. Format daty: rrrr-MM-ddTHH:mm:ss. Wartość domyślna = bieżąca data |
|
|
Priority
|
Priority | string |
Priorytet procesu (np. Niski, Normalny, Wysoki). Wartość domyślna = normalna |
|
|
Comment
|
Comment | string |
Komentarz procesu |
|
|
Kultura
|
Culture | string |
Kultura, w której podano tekst (de, en, fr, ...). Wartość domyślna = de |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutState
|
checkOutStateEnum | string |
Stan wyewidencjonowania dokumentu (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Identyfikator użytkownika, dla którego proces jest wyewidencjonowany |
|
comments
|
comments | array of object |
comments |
|
Date
|
comments.date | string |
Data komentarza |
|
Id
|
comments.id | string |
Identyfikator komentarza |
|
Tekst
|
comments.text | string |
Komentarz zdefiniowany przez użytkownika |
|
UserId
|
comments.userId | string |
Identyfikator użytkownika |
|
Data ukończenia
|
completedDate | string |
Data ukończenia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
completedTasks
|
completedTasks | array of string |
completedTasks |
|
Data utworzenia
|
createdDate | string |
Data utworzenia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Akcja
|
currentTask.action | string |
Tekst akcji użytkownika. Wyświetlane użytkownikowi końcowemu |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
assignedUserIds |
|
comments
|
currentTask.comments | array of string |
comments |
|
Data ukończenia
|
currentTask.completedDate | string |
Data ukończenia bieżącego zadania. Format daty: rrrr-MM-ddTHH:mm:ss |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
completedUserIds |
|
Data utworzenia
|
currentTask.createdDate | string |
Data utworzenia bieżącego zadania. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
currentTask.creatorId | string |
Identyfikator użytkownika twórcy dla bieżącego zadania |
|
Description
|
currentTask.description | string |
Opis bieżącego zadania |
|
Data ukończenia
|
currentTask.dueDate | string |
Data ukończenia bieżącego zadania. Format daty: rrrr-MM-ddTHH:mm:ss |
|
intendedUserIds
|
currentTask.intendedUserIds | array of string |
intendedUserIds |
|
PrzypomnienieDate
|
currentTask.reminderDate | string |
Data przypomnienia o bieżącym zadaniu. Format daty: rrrr-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
currentTask.requiresAllRecipients | boolean |
Określa, czy wszyscy adresaci muszą zamknąć to zadanie |
|
ShowCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
Pokaż okno dialogowe zamykania zadania na końcu zadania |
|
StatusEnum
|
currentTask.statusEnum | string |
Bieżące zadanie stanu (Otwarte, InProcess, Ukończone, PrzygotowaneDopełnianie, Błąd) |
|
TaskTemplateId
|
currentTask.taskTemplateId | string |
Identyfikator szablonu bieżącego zadania |
|
customProperties (właściwości niestandardowe)
|
customProperties | array of object |
customProperties (właściwości niestandardowe) |
|
CustomPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
Wartość wyliczeniowa typu właściwości niestandardowej (Ciąg, Data, Liczba) |
|
Name
|
customProperties.name | string |
Nazwa właściwości niestandardowej |
|
Wartość
|
customProperties.value | string |
Wartość właściwości niestandardowej |
|
documentIds
|
documentIds | array of string |
documentIds |
|
Data ukończenia
|
dueDate | string |
Data ukończenia procesu. Format daty: rrrr-MM-ddTHH:mm:ss |
|
FolderElementId
|
folderElementId | string |
Identyfikator dokumentu jako elementu folderu |
|
HasLinks
|
hasLinks | boolean |
Identyfikator dokumentu jako elementu folderu |
|
Id
|
id | string |
Identyfikator procesu |
|
values
|
name.values | array of object |
values |
|
Kultura
|
name.values.culture | string |
Kultura, w której podano tekst (de, en, fr, ...) |
|
Tekst
|
name.values.text | string |
Tekst dla tego języka |
|
PriorityEnum
|
priorityEnum | string |
Priorytet procesu (Wysoki, Normalny, Niski). Wartość domyślna = normalna |
|
PluginStream
|
pluginStream | string | |
|
ProcessTemplateId
|
processTemplateId | string |
Identyfikator szablonu procesu |
|
properties
|
properties | array of object |
properties |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
kultura
|
properties.globalValues.values.culture | string |
kultura |
|
SMS
|
properties.globalValues.values.text | string |
SMS |
|
NazwaWłaściwości
|
properties.propertyName | string |
Nazwa właściwości procesu |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Identyfikator właściwości procesu |
|
values
|
properties.values | array of string |
values |
|
ProtectionDomainId
|
protectionDomainId | string |
Identyfikator domeny ochrony procesu |
|
StatusEnum
|
statusEnum | string |
Stan procesu (Open, InProcess, Complete, PreparedToComplete, Error) |
Tworzenie tabeli użytkownika
Tworzenie tabeli użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
UserTable
|
UserTable | True | string |
Nazwa tabeli użytkownika (np. adres) |
|
Kolumny nagłówkowe
|
ColumnHeaders | True | string |
Lista nagłówków kolumn (np. Imię,Nazwisko,Miasto) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Tabela użytkowników
|
userTable | string |
Nazwa tabeli użytkowników |
Usuwanie wierszy tabeli użytkownika
Usuwanie wierszy tabeli użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
UserTable
|
UserTable | True | string |
Nazwa tabeli użytkowników |
|
WhereClause
|
WhereClause | string |
Lista elementów klauzuli where SQL. Format: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (np. [Firstname|Równa się|Jon|AND][Lastname|Równa się|Doe|OR]) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
userTableDeleteRecordsResult
|
userTableDeleteRecordsResult | integer |
userTableDeleteRecordsResult |
Wstawianie wierszy do tabeli użytkownika
Importowanie wierszy tabeli do tabeli użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
UserTable
|
UserTable | True | string |
Nazwa tabeli użytkownika |
|
Wartości
|
Values | True | string |
Lista wartości wierszy i kolumn do wstawienia (np. [Jan; Łania; Nowy Jork],[Peter; Zbierać; Bern]) |
|
DeleteAllValues
|
DeleteAllValues | boolean |
Określa, czy usunąć wszystkie wartości w tabeli UserTable (wartość domyślna = false) |
|
|
FirstRowContainsColumnHeaders
|
FirstRowContainsColumnHeaders | boolean |
Określa, czy pierwszy wiersz parametru wartości zawiera nagłówki kolumn (wartość domyślna = false) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Tabela użytkowników
|
userTable | string |
Nazwa tabeli użytkowników |
|
Wstawione wiersze
|
insertedRows | integer |
Liczba wstawionych wierszy |
Wyszukiwanie dokumentów (przestarzałe) [PRZESTARZAŁE]
Wyszukiwanie dokumentów (przestarzałe)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
Conditions
|
Conditions | string |
Format warunku wyszukiwania: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn" RelationEnums:"And,Or". np.: [Ostatnie zaewidencjonuj|Mniej|2021-12-31|And][Firstname|Równa się|Piotr|I] |
|
|
Kultura
|
Culture | string |
Kultura (de,en,fr,...). Wartość domyślna = de |
|
|
Tekst pełnotekstowy
|
FulltextWords | string |
Wyszukiwane wyrazy z pełnym tekstem |
|
|
FulltextWordRelation
|
FulltextWordRelation | string |
Relacja wyrazu pełnotekstowego (AND, OR). Wartość domyślna = AND |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Maksymalna liczba wyników wyszukiwania dokumentów. Wartość domyślna : 100 |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Dokumentów
|
documents | array of object |
Dokumentów |
|
Abonnements
|
documents.abonnements | string |
Lista abonnements |
|
accessRightsEnumList
|
documents.accessRightsEnumList | array of string |
accessRightsEnumList |
|
AnnotationManager
|
documents.annotationManager | string |
Adnotacje dla głównego pliku dokumentu |
|
Blogs
|
documents.blogs | string |
Lista wszystkich elementów blogu |
|
CheckOutState
|
documents.checkOutStateEnum | string |
Stan wyewidencjonowania dokumentu (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
documents.checkOutUserId | string |
Identyfikator użytkownika, dla którego dokument jest wyewidencjonowany |
|
DocumentData
|
documents.documentData | string |
Lista danych dokumentu |
|
HasOverlay
|
documents.hasOverlay | boolean |
Określa, czy dokument powinien być wyświetlany z nakładką |
|
Id
|
documents.id | string |
Identyfikator dokumentu |
|
ImportTemplateId
|
documents.importTemplateId | string |
Identyfikator szablonu importu dla tego dokumentu |
|
Identyfikator magazynu informacji
|
documents.infoStoreId | string |
Identyfikator magazynu informacji |
|
LifeCycleManager
|
documents.lifeCycleManager | string |
Informacje o cyklu życia |
|
MainFileLength
|
documents.mainFileLength | integer |
Rozmiar pliku głównego |
|
Name
|
documents.name | string |
Nazwa dokumentu |
|
PageCount
|
documents.pageCount | integer |
Liczba stron pliku głównego |
|
properties
|
documents.properties | array of |
properties |
|
ProtectionDomainId
|
documents.protectionDomainId | string |
Identyfikator domeny ochrony |
|
Przypomnienia
|
documents.reminders | string |
Lista wszystkich przypomnień |
|
SessionCount
|
documents.sessionCount | integer |
Liczba sesji |
|
SigningProfileId
|
documents.signingProfileId | string |
Identyfikator profilu podpisywania |
|
Identyfikator wersji
|
documents.versionId | string |
Identyfikator wersji dokumentu |
|
HasMore
|
hasMore | boolean |
Wskazuje, czy istnieje więcej wyników, czy nie. Flaga jest ustawiona na wartość true, jeśli dostępnych jest więcej wyników |
|
Wznawianie programuPoint
|
resumePoint | string |
Punkt wznawiania z poprzedniej operacji wyszukiwania. Ustaw wartość null dla pierwszej operacji wyszukiwania |
Wyszukiwanie dokumentów (wersja 2)
Wyszukiwanie dokumentów (wersja 2)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
Conditions
|
Conditions | string |
Format warunku wyszukiwania: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn,Between" RelationEnums:"And,Or". np.: [Ostatnie zaewidencjonuj|Mniej|2021-12-31|And][Firstname|Równa się|Piotr|And][Date|Między|2021-12-31; 2022-12-31|I] |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Maksymalna liczba wyników wyszukiwania dokumentów. Wartość domyślna : 100 |
|
|
ResultProperties
|
ResultProperties | string |
Lista właściwości wyników, rozdzielona przecinkami. Może to być nazwa właściwości lub identyfikator, na przykład "Name,Last check in,68b901cd-4d8f-11e6-aa6f-00ff04d7e62a" |
|
|
Kultura
|
Culture | string |
Kultura, w której podano tekst (de, en, fr, ...). Wartość domyślna = de |
|
|
Sklepy
|
Stores | string |
Rozdzielona przecinkami lista magazynów informacji do wyszukania. Może to być nazwa magazynu lub identyfikator, taki jak "Standard,9cd306e3-7e96-486c-8280-65d9f0239776" |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Dokumentów
|
documents | array of object |
Wynik wyszukiwania dokumentów |
|
nazwa
|
documents.name | string |
Nazwa dokumentu |
|
id
|
documents.id | string |
Identyfikator dokumentu |
|
folderElementId
|
documents.folderElementId | string |
Identyfikator elementu folderu |
|
checkOutStateEnum
|
documents.checkOutStateEnum | string |
Wyliczenie stanu wyewidencjonu |
|
hasSignature
|
documents.hasSignature | boolean |
Ma podpis |
|
hasBlog
|
documents.hasBlog | boolean |
Ma blog |
|
hasAnnotation
|
documents.hasAnnotation | boolean |
Zawiera adnotację |
|
hasLinks
|
documents.hasLinks | boolean |
Zawiera łącza |
|
properties
|
documents.properties | array of object |
Właściwości |
|
propertyTypeId
|
documents.properties.propertyTypeId | string |
Identyfikator właściwości |
|
values
|
documents.properties.values | array of string |
Wartości typu właściwości |
|
globalValues
|
documents.properties.globalValues | array of object |
Wartości globalne |
|
values
|
documents.properties.globalValues.values | array of object |
values |
|
kultura
|
documents.properties.globalValues.values.culture | string |
Kultura wartości globalnych |
|
SMS
|
documents.properties.globalValues.values.text | string |
Tekst wartości globalnych |
|
propertyTypeName
|
documents.properties.propertyTypeName | string |
Nazwa właściwości |
|
nazwaWłasności
|
documents.properties.propertyName | string |
Nazwa właściwości |
|
hasTempAccess
|
documents.hasTempAccess | boolean |
Ma dostęp tymczasowy |
|
accessRightsEnumList
|
documents.accessRightsEnumList | array of string |
Lista wyliczenie praw dostępu |
|
mainFileLength
|
documents.mainFileLength | integer |
Długość pliku głównego |
|
versionId
|
documents.versionId | string |
Identyfikator wersji |
|
hasReminders
|
documents.hasReminders | boolean |
Zawiera przypomnienia |
|
hasAbonnement
|
documents.hasAbonnement | boolean |
Ma abonnement |
|
hasOverlay
|
documents.hasOverlay | boolean |
Nakładka systemu operacyjnego |
|
hasMore
|
hasMore | boolean |
Ma więcej |
|
resumePoint
|
resumePoint | string |
Punkt wznawiania |
Wyszukiwanie procesów
Wyszukiwanie procesów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
Conditions
|
Conditions | string |
Format warunku wyszukiwania: [<PropertyName>|<ComparisonEnum>|<PropertyValue>|<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn,Between" RelationEnums:"And,Or". np.: [Ostatnie zaewidencjonuj|Mniej|2021-12-31|And][Firstname|Równa się|Piotr|And][Date|Między|2021-12-31; 2022-12-31|I] |
|
|
ResultProperties
|
ResultProperties | string |
Lista właściwości wyników, rozdzielona przecinkami. Może to być nazwa właściwości lub identyfikator, na przykład "Name,Last check in,68b901cd-4d8f-11e6-aa6f-00ff04d7e62a" |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Maksymalna liczba wyników wyszukiwania dokumentów. Wartość domyślna : 100 |
|
|
Kultura
|
Culture | string |
Kultura, w której podano tekst (de, en, fr, ...). Wartość domyślna = de |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
processes
|
processes | array of object |
Wynik wyszukiwania procesów |
|
values
|
processes.name.values | array of object |
Wartości właściwości |
|
kultura
|
processes.name.values.culture | string |
Kultura właściwości |
|
SMS
|
processes.name.values.text | string |
Tekst właściwości |
|
id
|
processes.id | string |
Identyfikator procesu |
|
folderElementId
|
processes.folderElementId | string |
Identyfikator elementu folderu |
|
checkOutStateEnum
|
processes.checkOutStateEnum | string |
Wyliczenie stanu wyewidencjonu |
|
properties
|
processes.properties | array of object |
Właściwości |
|
propertyTypeId
|
processes.properties.propertyTypeId | string |
Identyfikator właściwości |
|
values
|
processes.properties.values | array of string |
Wartości właściwości |
|
globalValues
|
processes.properties.globalValues | array of object |
Wartości globalne |
|
values
|
processes.properties.globalValues.values | array of object |
values |
|
kultura
|
processes.properties.globalValues.values.culture | string |
Globalna kultura wartości |
|
SMS
|
processes.properties.globalValues.values.text | string |
Tekst wartości globalnej |
|
propertyTypeName
|
processes.properties.propertyTypeName | string |
Nazwa właściwości |
|
nazwaWłasności
|
processes.properties.propertyName | string |
Nazwa właściwości |
|
priorityEnum
|
processes.priorityEnum | string |
Wyliczenie priorytetu |
|
statusEnum
|
processes.statusEnum | string |
Wyliczenie stanu |
|
data ukończenia
|
processes.dueDate | string |
Termin |
|
hasLinks
|
processes.hasLinks | boolean |
Zawiera łącza |
|
accessRightsEnumList
|
processes.accessRightsEnumList | array of string |
Lista wyliczenie praw dostępu |
|
hasMore
|
hasMore | boolean |
Ma więcej |
|
resumePoint
|
resumePoint | string |
Punkt wznawiania |
Wyświetlanie listy procesów (przestarzałe) [PRZESTARZAŁE]
Wyświetlanie listy procesów (przestarzałe)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
Odbiornik
|
Receiver | string |
Nazwy logowania odbiorników z procesów (np. john@sample.com|megan@sample.com). Jest pusty, zalogowany użytkownik zostanie odebrany jako odbiornik |
|
|
Status
|
Status | string |
Stan procesu. Ustawienie domyślne = otwarte |
|
|
IgnoreReceiver
|
IgnoreReceiver | boolean |
Jeśli tak, zostaną wyświetlone wszystkie procesy zależne od odbiornika. Wartość domyślna = false |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Maksymalna liczba wyników wyszukiwania procesu. Wartość domyślna : 100 |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
processes
|
processes | array of object |
processes |
|
accessRightsEnumList
|
processes.accessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
processes.checkOutStateEnum | string |
Sprawdź stan procesu (NotCheckedOut, CheckOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
processes.checkOutUserId | string |
Identyfikator użytkownika, dla którego dokument jest wyewidencjonowany |
|
comments
|
processes.comments | array of object |
comments |
|
Date
|
processes.comments.date | string |
Data komentarza |
|
Id
|
processes.comments.id | string |
Identyfikator komentarza |
|
Tekst
|
processes.comments.text | string |
Komentarz zdefiniowany przez użytkownika |
|
UserId
|
processes.comments.userId | string |
Identyfikator użytkownika, który ustawił komentarz |
|
Data ukończenia
|
processes.completedDate | string |
Data ukończenia procesu. Format daty: rrrr-MM-ddTHH:mm:ss |
|
completedTasks
|
processes.completedTasks | array of object |
completedTasks |
|
Akcja
|
processes.completedTasks.action | string |
Tekst akcji użytkownika. Wyświetlane użytkownikowi końcowemu |
|
assignedUserIds
|
processes.completedTasks.assignedUserIds | array of |
assignedUserIds |
|
comments
|
processes.completedTasks.comments | array of object |
comments |
|
Date
|
processes.completedTasks.comments.date | string |
Data komentarza |
|
Id
|
processes.completedTasks.comments.id | string |
Identyfikator komentarza |
|
Tekst
|
processes.completedTasks.comments.text | string |
Komentarz zdefiniowany przez użytkownika |
|
UserId
|
processes.completedTasks.comments.userId | string |
Identyfikator użytkownika, który ustawił komentarz |
|
Data ukończenia
|
processes.completedTasks.completedDate | string |
Data ukończenia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
completedUserIds
|
processes.completedTasks.completedUserIds | array of string |
completedUserIds |
|
Data utworzenia
|
processes.completedTasks.createdDate | string |
Data utworzenia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
processes.completedTasks.creatorId | string |
Identyfikator użytkownika twórcy |
|
Description
|
processes.completedTasks.description | string |
Opis zadania |
|
Data ukończenia
|
processes.completedTasks.dueDate | string |
Data ukończenia zadania. Format daty: rrrr-MM-ddTHH:mm:ss |
|
intendedUserIds
|
processes.completedTasks.intendedUserIds | array of |
intendedUserIds |
|
PrzypomnienieDate
|
processes.completedTasks.reminderDate | string |
Data przypomnienia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
processes.completedTasks.requiresAllRecipients | boolean |
Określa, czy wszyscy adresaci muszą zamknąć to zadanie |
|
ShowCloseTaskDialog
|
processes.completedTasks.showCloseTaskDialog | boolean |
Pokaż okno dialogowe zamykania zadania na końcu zadania |
|
Status
|
processes.completedTasks.statusEnum | string |
Stan zadania (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
processes.completedTasks.taskTemplateId | string |
Identyfikator szablonu zadania |
|
Data utworzenia
|
processes.createdDate | string |
Data utworzenia procesu. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CurrentTask
|
processes.currentTask | string |
Aktualnie aktywne zadanie |
|
Właściwości niestandardowe
|
processes.customProperties | string |
Lista wszystkich właściwości niestandardowych |
|
Identyfikatory dokumentów
|
processes.documentIds | string |
Lista wszystkich dołączonych identyfikatorów dokumentów |
|
Data ukończenia
|
processes.dueDate | string |
Data ukończenia procesu Format daty: rrrr-MM-ddTHH:mm:ss |
|
FolderElementId
|
processes.folderElementId | string |
Identyfikator procesu jako element folderu |
|
HasLinks
|
processes.hasLinks | boolean |
Flaga, czy proces zawiera łącza |
|
Id
|
processes.id | string |
Identyfikator procesu |
|
values
|
processes.name.values | array of object |
values |
|
kultura
|
processes.name.values.culture | string |
kultura |
|
SMS
|
processes.name.values.text | string |
SMS |
|
PriorityEnum
|
processes.priorityEnum | string |
Priorytet procesu (Wysoki, Normalny, Niski) |
|
PluginStream
|
processes.pluginStream | string |
Kontener danych dla wtyczek |
|
ProcessTemplateId
|
processes.processTemplateId | string |
Identyfikator szablonu procesu |
|
properties
|
processes.properties | array of object |
properties |
|
nazwaWłasności
|
processes.properties.propertyName | string |
nazwaWłasności |
|
propertyTypeId
|
processes.properties.propertyTypeId | string |
propertyTypeId |
|
values
|
processes.properties.values | array of string |
values |
|
ProtectionDomainId
|
processes.protectionDomainId | string |
Identyfikator domeny ochrony procesu |
|
StatusEnum
|
processes.statusEnum | string |
Stan procesu (Open, InProcess, Complete, PreparedToComplete, Error) |
|
HasMore
|
hasMore | boolean |
Wskazuje, czy istnieje więcej wyników, czy nie. Flaga jest ustawiona na wartość true, jeśli dostępnych jest więcej wyników |
|
Wznawianie programuPoint
|
resumePoint | string |
Punkt wznawiania z poprzednich operacji wyszukiwania. Ustaw wartość null dla pierwszej operacji wyszukiwania |
Zamknij bieżące zadanie i przypisz użytkownika do następnego zadania
Zamknij bieżące zadanie i przypisz użytkownika do następnego zadania
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
ProcessId
|
ProcessId | True | string |
Identyfikator procesu (Guid) |
|
Identyfikator zadania
|
TaskId | string |
Identyfikator zadania (Guid) |
|
|
Comment
|
Comment | string |
Comment |
|
|
AssignUserLoginNames
|
AssignUserLoginNames | True | string |
AssignUserLoginNames |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Akcja
|
action | string |
Tekst akcji użytkownika. Wyświetlane użytkownikowi końcowemu |
|
assignedUserIds
|
assignedUserIds | array of string |
assignedUserIds |
|
comments
|
comments | array of object |
comments |
|
Date
|
comments.date | string |
Data komentarza |
|
Id
|
comments.id | string |
Identyfikator komentarza |
|
Tekst
|
comments.text | string |
Komentarz zdefiniowany przez użytkownika |
|
UserId
|
comments.userId | string |
Identyfikator użytkownika, który ustawił komentarz |
|
Data ukończenia
|
completedDate | string |
Data ukończenia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
UkończonoUserIds
|
CompletedUserIds | array of string |
UkończonoUserIds |
|
Data utworzenia
|
createdDate | string |
Data utworzenia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
creatorId | string |
Identyfikator użytkownika twórcy |
|
Description
|
description | string |
Opis zadania |
|
Data ukończenia
|
dueDate | string |
Data ukończenia zadania. Format daty: rrrr-MM-ddTHH:mm:ss |
|
intendedUserIds
|
intendedUserIds | array of string |
intendedUserIds |
|
PrzypomnienieDate
|
reminderDate | string |
Data przypomnienia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
requiresAllRecipients | boolean |
Określa, czy wszyscy adresaci muszą zamknąć to zadanie |
|
ShowCloseTaskDialog
|
showCloseTaskDialog | boolean |
Pokaż okno dialogowe zamykania zadania na końcu zadania |
|
Status
|
statusEnum | string |
Stan zadania (Otwarte, InProcess, Ukończone, PrzygotowaneDopełnianie, Błąd) |
|
TaskTemplateId
|
taskTemplateId | string |
Identyfikator szablonu zadania |
Zamknij zadanie i kontynuuj proces
Zamknij zadanie i kontynuuj proces
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
ProcessId
|
processId | True | string |
Identyfikator procesu (Guid) |
|
Comment
|
comment | string |
Komentarz do dodania |
|
|
Identyfikator zadania
|
taskId | string |
Identyfikator zadania |
|
|
Przypisywanie użytkowników
|
assignUsers | True | boolean |
Przypisz do użytkowników. Jeśli ustawiono wartość nie, przypisz użytkownika za pomocą akcji Proces aktualizacji |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Akcja
|
action | string |
Tekst akcji użytkownika. Wyświetlane użytkownikowi końcowemu |
|
Przypisane identyfikatory użytkownika
|
assignedUserIds | string |
Lista przypisanych identyfikatorów użytkowników |
|
comments
|
comments | array of object |
comments |
|
Date
|
comments.date | string |
Data komentarza |
|
Id
|
comments.id | string |
Identyfikator komentarza |
|
Tekst
|
comments.text | string |
Komentarz zdefiniowany przez użytkownika |
|
UserId
|
comments.userId | string |
Identyfikator użytkownika |
|
Data ukończenia
|
completedDate | string |
Data ukończenia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
UkończonoUserIds
|
completedUserIds | string |
Lista wszystkich ukończonych identyfikatorów użytkownika |
|
Data utworzenia
|
createdDate | string |
Data utworzenia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
creatorId | string |
Identyfikator użytkownika twórcy |
|
Description
|
description | string |
Opis zadania |
|
Data ukończenia
|
dueDate | string |
Data ukończenia zadania. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Identyfikatory Zamierzoneużytkownika
|
intendedUserIds | string |
Przeznaczoni użytkownicy dla tego zadania |
|
PrzypomnienieDate
|
reminderDate | string |
Data przypomnienia. Format daty: rrrr-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
requiresAllRecipients | boolean |
Określa, czy wszyscy adresaci muszą zamknąć to zadanie |
|
ShowCloseTaskDialog
|
showCloseTaskDialog | boolean |
Pokaż okno dialogowe zamykania zadania na końcu zadania |
|
Status
|
statusEnum | string |
Stan zadania (Otwarte, InProcess, Ukończone, PrzygotowaneDopełnianie, Błąd) |
|
TaskTemplateId
|
taskTemplateId | string |
Identyfikator szablonu zadania |
Zamykanie otwartego procesu
Zamykanie otwartego procesu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
Adres URL interfejsu API archiwum (np. https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
Identyfikator połączenia w celu zidentyfikowania połączenia |
|
ProcessId
|
processId | True | string |
Identyfikator procesu (Guid) |
|
Comment
|
comment | string |
Komentarz do dodania |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
AccessRightsEnumList
|
CloseProcessResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
CloseProcessResult.CheckOutStateEnum | string |
Stan wyewidencjonowania dokumentu (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
CloseProcessResult.CheckOutUserId | string |
Identyfikator użytkownika, dla którego proces jest wyewidencjonowany |
|
Comments
|
CloseProcessResult.Comments | array of object |
Comments |
|
Date
|
CloseProcessResult.Comments.Date | string |
Data komentarza |
|
Id
|
CloseProcessResult.Comments.Id | string |
Identyfikator komentarza |
|
Tekst
|
CloseProcessResult.Comments.Text | string |
Komentarz zdefiniowany przez użytkownika |
|
UserId
|
CloseProcessResult.Comments.UserId | string |
Identyfikator użytkownika |
|
Data ukończenia
|
CloseProcessResult.CompletedDate | string |
Data ukończenia procesu. Format daty: rrrr-MM-ddTHH:mm:ss |
|
UkończonoZadania
|
CloseProcessResult.CompletedTasks | array of object |
UkończonoZadania |
|
Akcja
|
CloseProcessResult.CompletedTasks.Action | string |
Tekst akcji użytkownika |
|
Przypisane identyfikatory użytkownika
|
CloseProcessResult.CompletedTasks.AssignedUserIds | array of |
Przypisane identyfikatory użytkownika |
|
Comments
|
CloseProcessResult.CompletedTasks.Comments | array of object |
Comments |
|
Date
|
CloseProcessResult.CompletedTasks.Comments.Date | string |
Data komentarza |
|
Id
|
CloseProcessResult.CompletedTasks.Comments.Id | string |
Identyfikator komentarza |
|
Tekst
|
CloseProcessResult.CompletedTasks.Comments.Text | string |
Komentarz zdefiniowany przez użytkownika |
|
UserId
|
CloseProcessResult.CompletedTasks.Comments.UserId | string |
Identyfikator użytkownika, który ustawił komentarz |
|
Data ukończenia
|
CloseProcessResult.CompletedTasks.CompletedDate | string |
Data ukończenia ukończonego zadania. Format daty: rrrr-MM-ddTHH:mm:ss |
|
UkończonoUserIds
|
CloseProcessResult.CompletedTasks.CompletedUserIds | array of string |
UkończonoUserIds |
|
Data utworzenia
|
CloseProcessResult.CompletedTasks.CreatedDate | string |
Data utworzenia ukończonego zadania. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
CloseProcessResult.CompletedTasks.CreatorId | string |
Identyfikator użytkownika twórcy ukończonego zadania |
|
Description
|
CloseProcessResult.CompletedTasks.Description | string |
Opis zadania ukończonego |
|
Data ukończenia
|
CloseProcessResult.CompletedTasks.DueDate | string |
Data ukończenia zadania. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Id
|
CloseProcessResult.CompletedTasks.Id | string |
Identyfikator zadania |
|
Identyfikatory Zamierzoneużytkownika
|
CloseProcessResult.CompletedTasks.IntendedUserIds | array of |
Identyfikatory Zamierzoneużytkownika |
|
PrzypomnienieDate
|
CloseProcessResult.CompletedTasks.ReminderDate | string |
Data przypomnienia o ukończonym zadaniu. Format daty: rrrr-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
CloseProcessResult.CompletedTasks.RequiresAllRecipients | boolean |
Określa, czy wszyscy adresaci muszą zamknąć to zadanie |
|
ShowCloseTaskDialog
|
CloseProcessResult.CompletedTasks.ShowCloseTaskDialog | boolean |
Pokaż okno dialogowe zamykania zadania na końcu zadania |
|
StatusEnum
|
CloseProcessResult.CompletedTasks.StatusEnum | string |
Stan zadania (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
CloseProcessResult.CompletedTasks.TaskTemplateId | string |
Identyfikator szablonu zadania |
|
Data utworzenia
|
CloseProcessResult.CreatedDate | string |
Data utworzenia formatu daty procesu: rrrr-MM-ddTHH:mm:ss |
|
Akcja
|
CloseProcessResult.CurrentTask.Action | string |
Tekst akcji użytkownika |
|
Przypisane identyfikatory użytkownika
|
CloseProcessResult.CurrentTask.AssignedUserIds | array of string |
Przypisane identyfikatory użytkownika |
|
Comments
|
CloseProcessResult.CurrentTask.Comments | array of object |
Comments |
|
Date
|
CloseProcessResult.CurrentTask.Comments.Date | string |
Data komentarza |
|
Id
|
CloseProcessResult.CurrentTask.Comments.Id | string |
Identyfikator komentarza |
|
Tekst
|
CloseProcessResult.CurrentTask.Comments.Text | string |
Komentarz zdefiniowany przez użytkownika |
|
UserId
|
CloseProcessResult.CurrentTask.Comments.UserId | string |
Identyfikator użytkownika, który ustawił komentarz |
|
Data ukończenia
|
CloseProcessResult.CurrentTask.CompletedDate | string |
Data ukończenia bieżącego zadania. Format daty: rrrr-MM-ddTHH:mm:ss |
|
UkończonoUserIds
|
CloseProcessResult.CurrentTask.CompletedUserIds | array of string |
UkończonoUserIds |
|
Data utworzenia
|
CloseProcessResult.CurrentTask.CreatedDate | string |
Data utworzenia bieżącego zadania. Format daty: rrrr-MM-ddTHH:mm:ss |
|
CreatorId
|
CloseProcessResult.CurrentTask.CreatorId | string |
Identyfikator użytkownika twórcy bieżącego zadania |
|
Description
|
CloseProcessResult.CurrentTask.Description | string |
Opis zadania bieżącego zadania |
|
Data ukończenia
|
CloseProcessResult.CurrentTask.DueDate | string |
Data ukończenia bieżącego zadania. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Id
|
CloseProcessResult.CurrentTask.Id | string |
Identyfikator bieżącego zadania |
|
Identyfikatory Zamierzoneużytkownika
|
CloseProcessResult.CurrentTask.IntendedUserIds | array of string |
Identyfikatory Zamierzoneużytkownika |
|
PrzypomnienieDate
|
CloseProcessResult.CurrentTask.ReminderDate | string |
Data przypomnienia o bieżącym zadaniu. Format daty: rrrr-MM-ddTHH:mm:ss |
|
RequiresAllRecipients
|
CloseProcessResult.CurrentTask.RequiresAllRecipients | boolean |
Określa, czy wszyscy adresaci muszą zamknąć bieżące zadanie |
|
ShowCloseTaskDialog
|
CloseProcessResult.CurrentTask.ShowCloseTaskDialog | boolean |
Pokaż okno dialogowe zamykania zadania w bieżącym zadaniu |
|
StatusEnum
|
CloseProcessResult.CurrentTask.StatusEnum | string |
Stan bieżącego zadania (Open, InProcess, Complete, PreparedToComplete, Error) |
|
TaskTemplateId
|
CloseProcessResult.CurrentTask.TaskTemplateId | string |
Identyfikator szablonu zadania bieżącego zadania |
|
Właściwości niestandardowe
|
CloseProcessResult.CustomProperties | array of object |
Właściwości niestandardowe |
|
CustomPropertyTypeEnum
|
CloseProcessResult.CustomProperties.CustomPropertyTypeEnum | string |
Wartość wyliczeniowa typu właściwości niestandardowej (Ciąg, Data, Liczba) |
|
Name
|
CloseProcessResult.CustomProperties.Name | string |
Nazwa właściwości niestandardowej |
|
Wartość
|
CloseProcessResult.CustomProperties.Value | string |
Wartość właściwości niestandardowej |
|
Identyfikatory dokumentów
|
CloseProcessResult.DocumentIds | array of string |
Identyfikatory dokumentów |
|
Data ukończenia
|
CloseProcessResult.DueDate | string |
Data ukończenia procesu. Format daty: rrrr-MM-ddTHH:mm:ss |
|
Id
|
CloseProcessResult.Id | string |
Identyfikator procesu |
|
Wartości
|
CloseProcessResult.Name.Values | array of object |
Wartości |
|
Kultura
|
CloseProcessResult.Name.Values.Culture | string |
Kultura, w której podano tekst (de, en, fr, ...) |
|
Tekst
|
CloseProcessResult.Name.Values.Text | string |
Nazwa procesu |
|
PluginStream
|
CloseProcessResult.PluginStream | array of |
PluginStream |
|
PriorityEnum
|
CloseProcessResult.PriorityEnum | string |
Priorytet procesu (Wysoki, Normalny, Niski) |
|
ProcessTemplateId
|
CloseProcessResult.ProcessTemplateId | string |
Identyfikator szablonu procesu |
|
Właściwości
|
CloseProcessResult.Properties | array of object |
Właściwości |
|
GlobalValues
|
CloseProcessResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Wartości
|
CloseProcessResult.Properties.GlobalValues.Values | array of object |
Wartości |
|
Kultura
|
CloseProcessResult.Properties.GlobalValues.Values.Culture | string |
Kultura |
|
Tekst
|
CloseProcessResult.Properties.GlobalValues.Values.Text | string |
Tekst |
|
PropertyTypeId
|
CloseProcessResult.Properties.PropertyTypeId | string |
Identyfikator typu pola indeksu |
|
Wartości
|
CloseProcessResult.Properties.Values | array of string |
Wartości |
|
ProtectionDomainId
|
CloseProcessResult.ProtectionDomainId | string |
Identyfikator domeny ochrony procesu |
|
SessionCount
|
CloseProcessResult.SessionCount | integer |
Liczba sesji |
|
StatusEnum
|
CloseProcessResult.StatusEnum | string |
Stan procesu (Open, InProcess, Complete, PreparedToComplete, Error) |