InfoShare
InfoShare is ontworpen voor gebruik in bedrijven die de manier waarop ze digitale documenten, informatie, binders en processen beheren, optimaliseren.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Ondersteuning voor Kendox |
| URL | https://kendox.com/en/service/support-services |
| E-mailen | support@kendox.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Kendox AG |
| Webpagina | https://www.kendox.com/en |
| Privacybeleid | https://www.kendox.com/en/about-us/data-protection |
| Categorieën | Samenwerking; Inhoud en bestanden |
Kendox InfoShare Connector
Kendox InfoShare biedt een krachtige en zeer uitgebreide REST API. Met deze API kunt u documenten en processen maken en beheren in InfoShare. Samen met de Kendox InfoShare Power Automate Connector kunt u inhoudsprocessen stroomlijnen in een wijdverspreid toepassingslandschap, waardoor informatiesilo's worden vermeden.
Pre-requisites
U hebt het volgende nodig om door te gaan:
- Een licentie voor het gebruik van deze connector die beschikbaar is via sales365@kendox.com.
- Kendox InfoShare met de WCF-service-eindpunten die online bereikbaar zijn.
- Aanmeldingsreferenties voor Kendox InfoShare.
Ondersteunde bewerkingen
De connector ondersteunt de volgende bewerkingen:
General
-
Logon: Aanmelden bij InfoShare Server -
Logon with hashed password: Aanmelden bij InfoShare Server -
Logoff: Aanmelden vanaf InfoShare Server -
Get documents and processes selection: Documenten en processen ophalen die zijn geselecteerd op Mobile Web Client via aangepaste knopactie
Document
-
Create document (deprecated): Een document maken in InfoShare, afgeschafte versie -
Create document (V2): Een document maken in InfoShare, voorgestelde versie -
Update document (deprecated): Het document bijwerken in InfoShare, afgeschafte versie -
Update document (V2): Het document bijwerken in InfoShare, voorgestelde versie -
Get document properties: De eigenschappen van een document ophalen uit InfoShare -
Get file content: De inhoud van een bestand ophalen uit InfoShare -
Get file content converted: converteert inhoud van een bestand naar een andere bestandsindeling (e.g. tiff naar pdf). Bestandsinhoud ophalen, inclusief aantekeningen en overlays -
Get document: retourneert documentinformatie (structuur) van InfoShare -
Merge PDF documents: twee of meer PDF-documenten samenvoegen naar een doeldocument
Proces
-
Create process: Een proces maken en starten -
Update process (deprecated): Een proces bijwerken in InfoShare, afgeschafte versie -
Update process (V2): Een proces bijwerken in InfoShare, voorgestelde versie -
Close an open process: Een proces sluiten in InfoShare -
Close task and continue process: Een procestaak sluiten in InfoShare -
Close current task and assign user to next task: Sluit een procestaak en wijs de gebruiker toe aan de volgende taak in InfoShare -
Get process: retourneert een lijst met procesgegevens (structuur) van InfoShare -
Get process properties: De eigenschappen van een proces ophalen uit InfoShare
Zoeken
-
Document Search (deprecated): Zoeken naar documenten in InfoShare, afgeschafte versie -
Document Search (V2): Documenten zoeken in InfoShare, voorgestelde versie -
List processes (deprecated): Een lijst met processen ophalen in InfoShare, vervangen door proceszoekactie -
Process search: Zoeken naar processen in InfoShare
Gebruikerstabellen
-
Create a user table: Hiermee maakt u een gebruikerstabel -
Get rows from a user table: Haalt enkele rijen op uit een gebruikerstabel -
Insert rows into a user table: Rijen invoegen in een gebruikerstabel -
Update a row in a user table: Een rij bijwerken in een gebruikerstabel -
Delete user table rows: Hiermee verwijdert u enkele rijen uit een gebruikerstabel
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| API-sleutel | beveiligde string | De API-sleutel voor deze API | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Aanmelden met gehasht wachtwoord |
Aanmelden met gehasht wachtwoord |
| Bestandsinhoud converteren |
Bestandsinhoud converteren naar een andere indeling. Aantekeningen of overlay toevoegen aan bestandsinhoud |
| Bestandsinhoud ophalen |
Bestandsinhoud ophalen |
| Document bijwerken (afgeschaft) [AFGESCHAFT] |
Document bijwerken (afgeschaft) |
| Document bijwerken (V2) |
Document bijwerken (V2) |
| Document maken (afgeschaft) [AFGESCHAFT] |
Document maken (afgeschaft) |
| Document maken (V2) |
Document maken (V2) |
| Document ophalen |
Document ophalen |
| Document zoeken (afgeschaft) [AFGESCHAFT] |
Document zoeken (afgeschaft) |
| Document zoeken (V2) |
Document zoeken (V2) |
| Documenteigenschappen ophalen |
Documenteigenschappen ophalen |
| Een gebruikerstabel maken |
Een gebruikerstabel maken |
| Een geopend proces sluiten |
Een geopend proces sluiten |
| Een rij in een gebruikerstabel bijwerken |
Een rij in een gebruikerstabel bijwerken |
| Huidige taak sluiten en gebruiker toewijzen aan volgende taak |
Huidige taak sluiten en gebruiker toewijzen aan volgende taak |
| Logoff |
Logoff |
| Logon |
Logon |
| PDF-documenten samenvoegen |
Twee of meer PDF-documenten samenvoegen in één document |
| Proces maken |
Proces maken |
| Proces ophalen |
Proces ophalen |
| Proceseigenschappen ophalen |
Proceseigenschappen ophalen |
| Processen weergeven (afgeschaft) [AFGESCHAFT] |
Lijstprocessen (afgeschaft) |
| Proceszoekopdracht |
Proceszoekopdracht |
| Rijen in gebruikerstabellen verwijderen |
Rijen in gebruikerstabellen verwijderen |
| Rijen invoegen in een gebruikerstabel |
Tabelrijen importeren in een gebruikerstabel |
| Rijen ophalen uit een gebruikerstabel |
Rijen ophalen uit een gebruikerstabel |
| Selectie van documenten en processen ophalen |
Documenten en processen ophalen die zijn geselecteerd op Mobile Web Client via aangepaste knopactie |
| Taak sluiten en proces voortzetten |
Taak sluiten en proces voortzetten |
| Updateproces (afgeschaft) [AFGESCHAFT] |
Updateproces (afgeschaft) |
| Updateproces (V2) |
Updateproces (V2) |
Aanmelden met gehasht wachtwoord
Aanmelden met gehasht wachtwoord
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
Gebruikersnaam
|
userName | True | string |
Gebruikersnaam voor aanmelding |
|
Gehasht wachtwoord
|
passwordHashed | True | string |
Gebruikerswachtwoord voor aanmelding (Base64 gecodeerde SHA 512-hash) |
|
Tenantnaam
|
tenantName | string |
Tenantnaam voor aanmelding bij |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
ConnectionId
|
LogonResult.ConnectionId | string |
De verbindings-id om uw verbinding te identificeren |
|
ConnectionTimeoutSeconds
|
LogonResult.ConnectionTimeoutSeconds | integer |
Verbindingstime-out in seconden |
|
IsApplicationLicence
|
LogonResult.IsApplicationLicence | boolean |
Is toepassingslicentietype |
|
IsConcurrentLicence
|
LogonResult.IsConcurrentLicence | boolean |
Is gelijktijdig licentietype |
|
IsNamedLicence
|
LogonResult.IsNamedLicence | boolean |
Heeft het licentietype de naam |
|
IsVerificationCodeNeeded
|
LogonResult.IsVerificationCodeNeeded | boolean |
Is verificatiecode vereist |
|
JWTToken
|
LogonResult.JWTToken | string |
Het JWT-token voor deze verbinding |
|
PossibleTwoWayAuthenticationType
|
LogonResult.PossibleTwoWayAuthenticationType | string |
Mogelijk verificatietype in twee richtingen (Geen, E-mail, SMS) |
|
TwoWayAuthenticationTargetMail
|
LogonResult.TwoWayAuthenticationTargetMail | string |
Het gemaskeerde e-mailadres waarnaar twoWayAuthentication e-mail verzendt |
Bestandsinhoud converteren
Bestandsinhoud converteren naar een andere indeling. Aantekeningen of overlay toevoegen aan bestandsinhoud
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
DocumentId
|
DocumentId | True | string |
Id van document |
|
VersionId
|
VersionId | string |
Id van versie (Guid)Id van versie (Guid) |
|
|
DocumentDataId
|
DocumentDataId | string |
Id van documentgegevens (Guid) |
|
|
Weergave-id
|
RenditionId | string |
Id van documentweergave (Guid) |
|
|
TargetFormat
|
TargetFormat | True | string |
De doelindeling (bijvoorbeeld "png;pdf; tif;...") |
|
AddAnnotations
|
AddAnnotatins | boolean |
Hiermee definieert u of het document moet worden geëxporteerd met aantekeningen. Standaard = ja |
|
|
AddOverlay
|
AddOverlay | boolean |
Hiermee definieert u of het document moet worden geëxporteerd met overlays. Standaard = ja |
Retouren
Geconverteerde bestandsinhoud
- Bestandsinhoud
- string
Bestandsinhoud ophalen
Bestandsinhoud ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
DocumentId
|
DocumentId | True | string |
Id van document |
|
VersionId
|
VersionId | string |
Id van versie (Guid) |
|
|
DocumentDataId
|
DocumentDataId | string |
Id van documentgegevens (Guid) |
|
|
Weergave-id
|
RenditionId | string |
Id van documentweergave (Guid) |
|
|
IgnoreHashValidation
|
IgnoreHashValidation | boolean |
Systeemconfiguratie voor hashvalidatie negeren. Standaard = ja |
Retouren
Bestandsinhoud
- Bestandsinhoud
- string
Document bijwerken (afgeschaft) [AFGESCHAFT]
Document bijwerken (afgeschaft)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
DocumentId
|
DocumentId | True | string |
Id van document |
|
DocumentTitle
|
DocumentTitle | string |
Titel van document |
|
|
DocumentProperties
|
DocumentProperties | string |
Update-indeling van documenteigenschappen: Voornaam=Peter|Achternaam=Microsoft|InvoiceNo=4711; 4712; 4713 |
|
|
Cultuur
|
Culture | string |
De cultuur waarin de tekst wordt gegeven (de, en, fr, ...). Standaard = de |
|
|
FileContent
|
FileContent | string |
Base64-tekenreeks voor bestandsinhoud |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
abonnementen
|
abonnements | array of object |
abonnementen |
|
OnContentChange
|
abonnements.onContentChange | boolean |
Abonnement is actief bij bestandswijzigingen |
|
OnDelete
|
abonnements.onDelete | boolean |
Abonnement is actief bij verwijderen |
|
OnMetadataChange
|
abonnements.onMetadataChange | boolean |
Abonnement is actief bij indexwijzigingen |
|
UserId
|
abonnements.userId | string |
De gebruikers-id voor dit abonnnement |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
CreatedDate
|
annotationManager.postItAnnotations.createdDate | string |
Aantekeningsdatum maken vanaf bericht |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
Gebruikers-id van maker van het bericht |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
Is lettertype cursief van berichtaantekening |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
Is font strike out from post it annotation (Is lettertype doorhalen van bericht) |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
Is lettertype onderstrepen na het aantekenen |
|
Naam
|
annotationManager.postItAnnotations.fontInfo.name | string |
De naam van het lettertype na de aantekening. Standaard = Arial |
|
Toonhoogte
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Lettertypepitch van bericht toevoegen |
|
Grootte
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Tekengrootte van bericht aantekening. Voorbeeld: Grootte:12 is 12000. U hebt factor 1000 nodig |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Tekengewicht van bericht toevoegen |
|
Identiteitsbewijs
|
annotationManager.postItAnnotations.id | string |
Id van de berichtaantekening |
|
ModifiedDate
|
annotationManager.postItAnnotations.modifiedDate | string |
Datum van wijziging na aantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.postItAnnotations.pageNumber | integer |
Aantal pagina's na het aantekenen |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Beveiligingsniveau voor het posten van aantekeningen (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Selecteerbaar
|
annotationManager.postItAnnotations.selectable | boolean |
Definieert of een aantekening kan worden geselecteerd door de gebruiker |
|
Tekst
|
annotationManager.postItAnnotations.text | string |
Door de gebruiker gedefinieerde tekst voor het posten van aantekeningen |
|
X
|
annotationManager.postItAnnotations.x | integer |
X-coördinaat in pixel per inch voor 7200 DPI van post-aantekening |
|
Ja
|
annotationManager.postItAnnotations.y | integer |
Y-coördinaat in pixel per inch voor 7200 DPI van berichtaantekening |
|
rechthoekAnnotations
|
annotationManager.rectangleAnnotations | array of object |
rechthoekAnnotations |
|
Kleur
|
annotationManager.rectangleAnnotations.color | integer |
Kleur van rechthoek (32-bits ARGB-waarde) uit rechthoekaantekening Voorbeeld: Zwart: -16777216 Wit: -1 Rood: -65536 Groen: -16744448 Blauw: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Kleur van rechthoek (RGB-hexadecimale code) van rechthoekaantekening. Voorbeeld: Zwart: #000000 Wit: #FFFFFF Rood: #FF0000 Groen: #008000 Blauw: #0000FF |
|
CreatedDate
|
annotationManager.rectangleAnnotations.createdDate | string |
Aantekeningsdatum van rechthoek. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
CreatorId |
|
Hoogte
|
annotationManager.rectangleAnnotations.height | integer |
Hoogte van rechthoek in pixel per inch voor 7200 DPI |
|
Identiteitsbewijs
|
annotationManager.rectangleAnnotations.Id | string |
Id van de aantekening van de rechthoek |
|
ModifiedDate
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Datum van wijziging van rechthoekaantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Aantal pagina's uit rechthoekaantekening |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Beveiligingsniveau voor aantekening van rechthoeken (openbaar beschikbaar, persoonlijk, persoonlijk beveiligd, onlyeditors). Default = PubliclyAvailable |
|
Selecteerbaar
|
annotationManager.rectangleAnnotations.selectable | boolean |
Hiermee wordt gedefinieerd of de aantekening van een rechthoek door de gebruiker kan worden geselecteerd |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
Rechthoek moet transparant zijn (markering) |
|
Breedte
|
annotationManager.rectangleAnnotations.width | integer |
Breedte van rechthoek in pixel per inch voor 7200 DPI |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
X-coördinaat in pixel per inch voor 7200 DPI van rechthoekaantekening |
|
Ja
|
annotationManager.rectangleAnnotations.y | integer |
Y-coördinaat in pixel per inch voor 7200 DPI van rechthoekaantekening |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
textAnnotations |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Kleur van achtergrond (32-bits ARGB-waarde) van tekstaantekening. Voorbeeld: Zwart: -16777216 Wit: -1 Rood: -65536 Groen: -16744448 Blauw: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Kleur van achtergrond (RGB-hexadecimale code) van tekstaantekening. Voorbeeld: Zwart: #000000 Wit: #FFFFFF Rood: #FF0000 Groen: #008000 Blauw: #0000FF |
|
CreatedDate
|
annotationManager.textAnnotations.createdDate | string |
aanmaakdatum van tekstaantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
Gebruikers-id van maker van tekstaantekening |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
Is lettertype cursief van tekstaantekening |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
Is lettertype doorhalen uit tekstaantekening |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
Is lettertype onderstrepen van tekstaantekening |
|
Naam
|
annotationManager.textAnnotations.fontInfo.name | string |
De naam van het lettertype van tekstaantekening. Standaard = Arial |
|
Toonhoogte
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Tekenhoogte van tekstaantekening |
|
Grootte
|
annotationManager.textAnnotations.fontInfo.size | integer |
Tekengrootte van tekstaantekening. Voorbeeld: Grootte:12 is 12000. U hebt factor 1000 nodig |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Tekstdikte van tekstaantekening |
|
Voorgrondkleur
|
annotationManager.textAnnotations.foregroundColor | integer |
Kleur van de voorgrond (32-bits ARGB-waarde) van tekstaantekening. Voorbeeld: Zwart: -16777216 Wit: -1 Rood: -65536 Groen: -16744448 Blauw: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Kleur van voorgrond (RGB-hexadecimale code) van tekstaantekening. Voorbeeld: Zwart: #000000 Wit: #FFFFFF Rood: #FF0000 Groen: #008000 Blauw: #0000FF |
|
Hoogte
|
annotationManager.textAnnotations.height | integer |
Hoogte van tekst in pixel per inch voor 7200 DPI van tekstaantekening |
|
Identiteitsbewijs
|
annotationManager.textAnnotations.id | string |
Id van tekstaantekening |
|
ModifiedDate
|
annotationManager.textAnnotations.modifiedDate | string |
Datum van wijziging van tekstaantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.textAnnotations.pageNumber | integer |
Aantal pagina's van tekstaantekening |
|
Rotation
|
annotationManager.textAnnotations.rotation | integer |
Draaiing in graden van tekstaantekening |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Beveiligingsniveau voor tekstaantekening (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Selecteerbaar
|
annotationManager.textAnnotations.selectable | boolean |
Definieert of tekstaantekening door de gebruiker kan worden geselecteerd |
|
Tekst
|
annotationManager.textAnnotations.text | string |
Door de gebruiker gedefinieerde tekst van tekstaantekening |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
Tekstaantekening moet transparant zijn |
|
Breedte
|
annotationManager.textAnnotations.width | integer |
Breedte van tekst in pixel per inch voor 7200 DPI van tekstaantekening |
|
X
|
annotationManager.textAnnotations.x | integer |
X coördinaat in pixel per inch voor 7200 DPI van tekstaantekening |
|
Ja
|
annotationManager.textAnnotations.y | integer |
Y-coördinaat in pixel per inch voor 7200 DPI van tekstaantekening |
|
blogs
|
blogs | array of object |
blogs |
|
CreatedDate
|
blogs.createdDate | string |
Datum waarop de blog is gemaakt. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
blogs.creatorId | string |
Gebruikers-id van het maken van een gebruikersblog |
|
Identiteitsbewijs
|
blogs.id | string |
Id van de blog |
|
Tekst
|
blogs.text | string |
Tekst van blogitem |
|
CheckOutStateEnum
|
checkOutStateEnum | string |
Status van het document uitchecken (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Id van de gebruiker waarvoor het document is uitgecheckt |
|
documentData
|
documentData | array of object |
documentData |
|
Identiteitsbewijs
|
documentData.id | string |
Id van documentgegevens |
|
Naam
|
documentData.name | string |
Documentgegevensnaam |
|
Uitleveringen
|
documentData.renditions | array of |
Uitleveringen |
|
HasOverlay
|
hasOverlay | boolean |
Definieert of het document moet worden weergegeven met een overlay |
|
Identiteitsbewijs
|
id | string |
Id van het document |
|
ImportTemplateId
|
importTemplateId | string |
Id van de importsjabloon voor dit document |
|
InfoStoreId
|
infoStoreId | string |
Id van het gegevensarchief |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Levenscyclusstatus uitchecken |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Berekende einddatum van de levenscyclus. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Begindatum van de levenscyclus. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Id van de LifeCycle-status |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Volgende status van de automatische levenscyclus |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
nextLifeCycleStates |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Document verwijderen na verloop van beveiliging toestaan |
|
Identiteitsbewijs
|
lifeCycleManager.lifeCycleProtections.id | string |
Id van de statusbeveiliging van de levenscyclus |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Beveiligen tegen wijzigingen in aantekeningen |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Beveiligen tegen uitchecken |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Beveiligen tegen inhoudswijziging |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Beveiligen tegen verwijderen |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Beveiligen tegen eigenschapswijzigingen |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Beveiliging tegen beveiligingswijziging |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Duur van de beveiliging |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Id van de LifeCycle |
|
MainFileLength
|
mainFileLength | integer |
Hoofdbestandsgrootte |
|
Naam
|
name | string |
Naam van het document |
|
PageCount
|
pageCount | integer |
Aantal pagina's van hoofdbestand |
|
properties
|
properties | array of object |
properties |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultuur
|
properties.globalValues.values.culture | string |
Cultuur |
|
Tekst
|
properties.globalValues.values.text | string |
Tekst |
|
Eigenschapsnaam
|
properties.propertyName | string |
Naam van eigenschap |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Type-id van het indexveld |
|
values
|
properties.values | array of string |
PropertyType-waarden |
|
ProtectionDomainId
|
protectionDomainId | string |
Id van het beveiligingsdomein |
|
Herinneringen
|
reminders | array of object |
Herinneringen |
|
Description
|
reminders.description | string |
Beschrijving voor herinnering |
|
Tijdsegment
|
reminders.interval | integer |
Interval in dagen tussen herinneringen |
|
ProcessTemplateId
|
reminders.processTemplateId | string |
Processjabloon-id voor deze herinnering |
|
ReminderDate
|
reminders.reminderDate | string |
Datum van de herinnering. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
ReminderId
|
reminders.reminderId | string |
Id van de herinnering |
|
subjectIds
|
reminders.subjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
reminders.useUserFromProcessTemplate | boolean |
Definieert of de gebruikersdefinitie van de processjabloon wordt gebruikt |
|
SigningProfileId
|
signingProfileId | string |
Id van het ondertekeningsprofiel |
|
VersionId
|
versionId | string |
Versie-id van het document |
Document bijwerken (V2)
Document bijwerken (V2)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
DocumentTitle
|
DocumentTitle | string |
Titel van document |
|
|
DocumentProperties
|
DocumentProperties | string |
Update-indeling van documenteigenschappen: Voornaam=Peter|Achternaam=Microsoft|InvoiceNo=4711; 4712; 4713 |
|
|
RemoveDocumentProperties
|
RemoveDocumentProperties | string |
Lijst met door puntkomma's gescheiden eigenschapsnamen of id's die uit het document moeten worden verwijderd, zoals FistName; b9cfbdf7-f6fb-4179-91c8-d9681fb680dd; Afdelingen" |
|
|
Cultuur
|
Culture | string |
De cultuur waarin de tekst wordt gegeven (de, en, fr, ...). Standaard = de |
|
|
DocumentId
|
DocumentId | True | string |
Id van document |
|
ProtectionDomain
|
ProtectionDomain | string |
ProtectionDomain-naam of -id |
|
|
Blog
|
Blog | string |
Een blogtekstitem toevoegen aan een document |
|
|
UploadMethod
|
UploadMethod | string |
De methode die wordt gebruikt voor het uploaden van het document naar InfoShare. Standaard = UploadFileBytesLarge |
|
|
FileContent
|
FileContent | string |
Base64-tekenreeks voor bestandsinhoud |
|
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Het uitchecken van een document ongedaan maken. Standaard = onwaar |
|
|
Segmentgrootte
|
ChunkSize | integer |
Grootte van het segment voor het uploaden van bestanden dat wordt gebruikt met UploadStreamChunks en UploadFileBytesLarge-uploadmethoden, standaard 262144 |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
abonnementen
|
abonnements | array of object |
Abonnementen |
|
OnContentChange
|
abonnements.onContentChange | boolean |
Abonnement is actief bij bestandswijzigingen |
|
OnDelete
|
abonnements.onDelete | boolean |
Abonnement is actief bij verwijderen |
|
OnMetadataChange
|
abonnements.onMetadataChange | boolean |
Abonnement is actief bij indexwijzigingen |
|
UserId
|
abonnements.userId | string |
De gebruikers-id voor dit abonnnement |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Opsommingslijst voor toegangsrechten |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
CreatedDate
|
annotationManager.postItAnnotations.createdDate | string |
Aantekeningsdatum maken vanaf bericht |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
Gebruikers-id van maker van het bericht |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
Is lettertype cursief van berichtaantekening |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
Is font strike out from post it annotation (Is lettertype doorhalen van bericht) |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
Is lettertype onderstrepen na het aantekenen |
|
Naam
|
annotationManager.postItAnnotations.fontInfo.name | string |
De naam van het lettertype na de aantekening. Standaard = Arial |
|
Toonhoogte
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Lettertypepitch van bericht toevoegen |
|
Grootte
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Tekengrootte van bericht aantekening. Voorbeeld: Grootte:12 is 12000. U hebt factor 1000 nodig |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Tekengewicht van bericht toevoegen |
|
Identiteitsbewijs
|
annotationManager.postItAnnotations.id | string |
Aantekening post it id |
|
ModifiedDate
|
annotationManager.postItAnnotations.modifiedDate | string |
Datum van wijziging na aantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.postItAnnotations.pageNumber | integer |
Aantal pagina's na het aantekenen |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Beveiligingsniveau voor het posten van aantekeningen (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Selecteerbaar
|
annotationManager.postItAnnotations.selectable | boolean |
Definieert of een aantekening kan worden geselecteerd door de gebruiker |
|
Tekst
|
annotationManager.postItAnnotations.text | string |
Door de gebruiker gedefinieerde tekst voor het posten van aantekeningen |
|
X
|
annotationManager.postItAnnotations.x | integer |
X-coördinaat in pixel per inch voor 7200 DPI van post-aantekening |
|
Ja
|
annotationManager.postItAnnotations.y | integer |
Y-coördinaat in pixel per inch voor 7200 DPI van berichtaantekening |
|
rechthoekAnnotations
|
annotationManager.rectangleAnnotations | array of object |
rechthoekAnnotations |
|
Kleur
|
annotationManager.rectangleAnnotations.color | integer |
Kleur van rechthoek (32-bits ARGB-waarde) uit rechthoekaantekening Voorbeeld: Zwart: -16777216 Wit: -1 Rood: -65536 Groen: -16744448 Blauw: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Kleur van rechthoek (RGB-hexadecimale code) van rechthoekaantekening. Voorbeeld: Zwart: #000000 Wit: #FFFFFF Rood: #FF0000 Groen: #008000 Blauw: #0000FF |
|
CreatedDate
|
annotationManager.rectangleAnnotations.createdDate | string |
Aantekeningsdatum van rechthoek. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
Maker-id voor rechthoekaantekening |
|
Hoogte
|
annotationManager.rectangleAnnotations.height | integer |
Hoogte van rechthoek in pixel per inch voor 7200 DPI |
|
Identiteitsbewijs
|
annotationManager.rectangleAnnotations.Id | string |
Aantekenings-id rechthoek |
|
ModifiedDate
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Datum van wijziging van rechthoekaantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Aantal pagina's uit rechthoekaantekening |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Beveiligingsniveau voor aantekening van rechthoeken (openbaar beschikbaar, persoonlijk, persoonlijk beveiligd, onlyeditors). Default = PubliclyAvailable |
|
Selecteerbaar
|
annotationManager.rectangleAnnotations.selectable | boolean |
Hiermee wordt gedefinieerd of de aantekening van een rechthoek door de gebruiker kan worden geselecteerd |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
Rechthoek moet transparant zijn (markering) |
|
Breedte
|
annotationManager.rectangleAnnotations.width | integer |
Breedte van rechthoek in pixel per inch voor 7200 DPI |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
X-coördinaat in pixel per inch voor 7200 DPI van rechthoekaantekening |
|
Ja
|
annotationManager.rectangleAnnotations.y | integer |
Y-coördinaat in pixel per inch voor 7200 DPI van rechthoekaantekening |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
Tekstaantekeningen |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Kleur van achtergrond (32-bits ARGB-waarde) van tekstaantekening. Voorbeeld: Zwart: -16777216 Wit: -1 Rood: -65536 Groen: -16744448 Blauw: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Kleur van achtergrond (RGB-hexadecimale code) van tekstaantekening. Voorbeeld: Zwart: #000000 Wit: #FFFFFF Rood: #FF0000 Groen: #008000 Blauw: #0000FF |
|
CreatedDate
|
annotationManager.textAnnotations.createdDate | string |
aanmaakdatum van tekstaantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
Gebruikers-id van maker van tekstaantekening |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
Is lettertype cursief van tekstaantekening |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
Is lettertype doorhalen uit tekstaantekening |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
Is lettertype onderstrepen van tekstaantekening |
|
Naam
|
annotationManager.textAnnotations.fontInfo.name | string |
De naam van het lettertype van tekstaantekening. Standaard = Arial |
|
Toonhoogte
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Tekenhoogte van tekstaantekening |
|
Grootte
|
annotationManager.textAnnotations.fontInfo.size | integer |
Tekengrootte van tekstaantekening. Voorbeeld: Grootte:12 is 12000. U hebt factor 1000 nodig |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Tekstdikte van tekstaantekening |
|
Voorgrondkleur
|
annotationManager.textAnnotations.foregroundColor | integer |
Kleur van de voorgrond (32-bits ARGB-waarde) van tekstaantekening. Voorbeeld: Zwart: -16777216 Wit: -1 Rood: -65536 Groen: -16744448 Blauw: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Kleur van voorgrond (RGB-hexadecimale code) van tekstaantekening. Voorbeeld: Zwart: #000000 Wit: #FFFFFF Rood: #FF0000 Groen: #008000 Blauw: #0000FF |
|
Hoogte
|
annotationManager.textAnnotations.height | integer |
Hoogte van tekst in pixel per inch voor 7200 DPI van tekstaantekening |
|
Identiteitsbewijs
|
annotationManager.textAnnotations.id | string |
Id van tekstaantekening |
|
ModifiedDate
|
annotationManager.textAnnotations.modifiedDate | string |
Datum van wijziging van tekstaantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.textAnnotations.pageNumber | integer |
Aantal pagina's van tekstaantekening |
|
Rotation
|
annotationManager.textAnnotations.rotation | integer |
Draaiing in graden van tekstaantekening |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Beveiligingsniveau voor tekstaantekening (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Selecteerbaar
|
annotationManager.textAnnotations.selectable | boolean |
Definieert of tekstaantekening door de gebruiker kan worden geselecteerd |
|
Tekst
|
annotationManager.textAnnotations.text | string |
Door de gebruiker gedefinieerde tekst van tekstaantekening |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
Tekstaantekening moet transparant zijn |
|
Breedte
|
annotationManager.textAnnotations.width | integer |
Breedte van tekst in pixel per inch voor 7200 DPI van tekstaantekening |
|
X
|
annotationManager.textAnnotations.x | integer |
X coördinaat in pixel per inch voor 7200 DPI van tekstaantekening |
|
Ja
|
annotationManager.textAnnotations.y | integer |
Y-coördinaat in pixel per inch voor 7200 DPI van tekstaantekening |
|
blogs
|
blogs | array of object |
blogs |
|
CreatedDate
|
blogs.createdDate | string |
Datum waarop de blog is gemaakt. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
blogs.creatorId | string |
Gebruikers-id van het maken van een gebruikersblog |
|
Identiteitsbewijs
|
blogs.id | string |
Id van de blog |
|
Tekst
|
blogs.text | string |
Tekst van blogitem |
|
CheckOutStateEnum
|
checkOutStateEnum | string |
Status van het document uitchecken (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Id van de gebruiker waarvoor het document is uitgecheckt |
|
documentData
|
documentData | array of object |
Documentgegevens |
|
Identiteitsbewijs
|
documentData.id | string |
Documentgegevens-id |
|
Naam
|
documentData.name | string |
Documentgegevensnaam |
|
Uitleveringen
|
documentData.renditions | array of |
Uitleveringen |
|
HasOverlay
|
hasOverlay | boolean |
Definieert of het document moet worden weergegeven met een overlay |
|
Identiteitsbewijs
|
id | string |
Id van het document |
|
ImportTemplateId
|
importTemplateId | string |
Id van de importsjabloon voor dit document |
|
InfoStoreId
|
infoStoreId | string |
Id van het gegevensarchief |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Levenscyclusstatus uitchecken |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Berekende einddatum van de levenscyclus. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Begindatum van de levenscyclus. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Id van de LifeCycle-status |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Volgende status van de automatische levenscyclus |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
Volgende levenscyclusstatussen |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Document verwijderen na verloop van beveiliging toestaan |
|
Identiteitsbewijs
|
lifeCycleManager.lifeCycleProtections.id | string |
Id van de statusbeveiliging van de levenscyclus |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Beveiligen tegen wijzigingen in aantekeningen |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Beveiligen tegen uitchecken |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Beveiligen tegen inhoudswijziging |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Beveiligen tegen verwijderen |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Beveiligen tegen eigenschapswijzigingen |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Beveiliging tegen beveiligingswijziging |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Duur van de beveiliging |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Id van de LifeCycle |
|
MainFileLength
|
mainFileLength | integer |
Hoofdbestandsgrootte |
|
Naam
|
name | string |
Naam van het document |
|
PageCount
|
pageCount | integer |
Aantal pagina's van hoofdbestand |
|
properties
|
properties | array of object |
Eigenschappen |
|
globalValues
|
properties.globalValues | array of object |
Globale waarden |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultuur
|
properties.globalValues.values.culture | string |
Cultuur van wereldwijde waarde |
|
Tekst
|
properties.globalValues.values.text | string |
Algemene waardetekst |
|
Eigenschapsnaam
|
properties.propertyName | string |
Naam van eigenschap |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Type-id van het indexveld |
|
values
|
properties.values | array of string |
Eigenschapstypewaarden |
|
ProtectionDomainId
|
protectionDomainId | string |
Id van het beveiligingsdomein |
|
Herinneringen
|
reminders | array of object |
Herinneringen |
|
Description
|
reminders.description | string |
Beschrijving voor herinnering |
|
Tijdsegment
|
reminders.interval | integer |
Interval in dagen tussen herinneringen |
|
ProcessTemplateId
|
reminders.processTemplateId | string |
Processjabloon-id voor deze herinnering |
|
ReminderDate
|
reminders.reminderDate | string |
Datum van de herinnering. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
ReminderId
|
reminders.reminderId | string |
Id van de herinnering |
|
subjectIds
|
reminders.subjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
reminders.useUserFromProcessTemplate | boolean |
Definieert of de gebruikersdefinitie van de processjabloon wordt gebruikt |
|
SigningProfileId
|
signingProfileId | string |
Id van het ondertekeningsprofiel |
|
VersionId
|
versionId | string |
Versie-id van het document |
Document maken (afgeschaft) [AFGESCHAFT]
Document maken (afgeschaft)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
DocumentTitle
|
DocumentTitle | True | string |
Titel van document (incl. extensie) |
|
ImportTemplate
|
ImportTemplate | True | string |
Sjabloon importeren |
|
DocumentProperties
|
DocumentProperties | string |
Indeling documenteigenschappen invoegen: Voornaam=Peter|Achternaam=Microsoft|InvoiceNo=4711; 4712; 4713 |
|
|
Cultuur
|
Culture | string |
De cultuur waarin de eigenschapsnamen worden gegeven (de, en, fr, ...). Standaard = de |
|
|
FileContent
|
FileContent | True | string |
Base64-tekenreeks voor bestandsinhoud |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
abonnementen
|
abonnements | array of string |
abonnementen |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of object |
postItAnnotations |
|
CreatedDate
|
annotationManager.postItAnnotations.createdDate | string |
Aantekeningsdatum maken vanaf bericht |
|
CreatorId
|
annotationManager.postItAnnotations.creatorId | string |
Gebruikers-id van maker van het bericht |
|
IsItalic
|
annotationManager.postItAnnotations.fontInfo.isItalic | boolean |
Is lettertype cursief van berichtaantekening |
|
IsStrikeOut
|
annotationManager.postItAnnotations.fontInfo.isStrikeOut | boolean |
Is font strike out from post it annotation (Is lettertype doorhalen van bericht) |
|
IsUnderline
|
annotationManager.postItAnnotations.fontInfo.isUnderline | boolean |
Is lettertype onderstrepen na het aantekenen |
|
Naam
|
annotationManager.postItAnnotations.fontInfo.name | string |
De naam van het lettertype na de aantekening. Standaard = Arial |
|
Toonhoogte
|
annotationManager.postItAnnotations.fontInfo.pitch | integer |
Lettertypepitch van bericht toevoegen |
|
Grootte
|
annotationManager.postItAnnotations.fontInfo.size | integer |
Tekengrootte van bericht aantekening. Voorbeeld: Grootte:12 is 12000. U hebt factor 1000 nodig |
|
Weight
|
annotationManager.postItAnnotations.fontInfo.weight | integer |
Tekengewicht van bericht toevoegen |
|
Identiteitsbewijs
|
annotationManager.postItAnnotations.id | string |
Id van de berichtaantekening |
|
ModifiedDate
|
annotationManager.postItAnnotations.modifiedDate | string |
Datum van wijziging na aantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.postItAnnotations.pageNumber | integer |
Aantal pagina's na het aantekenen |
|
SecurityLevelEnum
|
annotationManager.postItAnnotations.securityLevelEnum | string |
Beveiligingsniveau voor het posten van aantekeningen (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Selecteerbaar
|
annotationManager.postItAnnotations.selectable | boolean |
Definieert of een aantekening kan worden geselecteerd door de gebruiker |
|
Tekst
|
annotationManager.postItAnnotations.text | string |
Door de gebruiker gedefinieerde tekst voor het posten van aantekeningen |
|
X
|
annotationManager.postItAnnotations.x | integer |
X-coördinaat in pixel per inch voor 7200 DPI van post-aantekening |
|
Ja
|
annotationManager.postItAnnotations.y | integer |
Y-coördinaat in pixel per inch voor 7200 DPI van berichtaantekening |
|
rechthoekAnnotations
|
annotationManager.rectangleAnnotations | array of object |
rechthoekAnnotations |
|
Kleur
|
annotationManager.rectangleAnnotations.color | integer |
Kleur van rechthoek (32-bits ARGB-waarde) uit rechthoekaantekening Voorbeeld: Zwart: -16777216 Wit: -1 Rood: -65536 Groen: -16744448 Blauw: -16776961 |
|
ColorHexCode
|
annotationManager.rectangleAnnotations.colorHexCode | string |
Kleur van rechthoek (RGB-hexadecimale code) van rechthoekaantekening. Voorbeeld: Zwart: #000000 Wit: #FFFFFF Rood: #FF0000 Groen: #008000 Blauw: #0000FF |
|
CreatedDate
|
annotationManager.rectangleAnnotations.createdDate | string |
Aantekeningsdatum van rechthoek. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
creatorId
|
annotationManager.rectangleAnnotations.creatorId | string |
CreatorId |
|
Hoogte
|
annotationManager.rectangleAnnotations.height | integer |
Hoogte van rechthoek in pixel per inch voor 7200 DPI |
|
Identiteitsbewijs
|
annotationManager.rectangleAnnotations.Id | string |
Id van de aantekening van de rechthoek |
|
ModifiedDate
|
annotationManager.rectangleAnnotations.modifiedDate | string |
Datum van wijziging van rechthoekaantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.rectangleAnnotations.pageNumber | integer |
Aantal pagina's uit rechthoekaantekening |
|
SecurityLevelEnum
|
annotationManager.rectangleAnnotations.securityLevelEnum | string |
Beveiligingsniveau voor aantekening van rechthoeken (openbaar beschikbaar, persoonlijk, persoonlijk beveiligd, onlyeditors). Default = PubliclyAvailable |
|
Selecteerbaar
|
annotationManager.rectangleAnnotations.selectable | boolean |
Hiermee wordt gedefinieerd of de aantekening van een rechthoek door de gebruiker kan worden geselecteerd |
|
Transparent
|
annotationManager.rectangleAnnotations.transparent | boolean |
Rechthoek moet transparant zijn (markering) |
|
Breedte
|
annotationManager.rectangleAnnotations.width | integer |
Breedte van rechthoek in pixel per inch voor 7200 DPI |
|
X
|
annotationManager.rectangleAnnotations.x | integer |
X-coördinaat in pixel per inch voor 7200 DPI van rechthoekaantekening |
|
Ja
|
annotationManager.rectangleAnnotations.y | integer |
Y-coördinaat in pixel per inch voor 7200 DPI van rechthoekaantekening |
|
textAnnotations
|
annotationManager.textAnnotations | array of object |
textAnnotations |
|
BackgroundColor
|
annotationManager.textAnnotations.backgroundColor | integer |
Kleur van achtergrond (32-bits ARGB-waarde) uit tekstaantekening Voorbeeld: Zwart: -16777216 Wit: -1 Rood: -65536 Groen: -16744448 Blauw: -16776961 |
|
BackgroundColorHexCode
|
annotationManager.textAnnotations.backgroundColorHexCode | string |
Kleur van achtergrond (RGB-hexadecimale code) uit tekstaantekening Voorbeeld: Zwart: #000000 Wit: #FFFFFF Rood: #FF0000 Groen: #008000 Blauw: #0000FF |
|
CreatedDate
|
annotationManager.textAnnotations.createdDate | string |
aanmaakdatum van tekstaantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
annotationManager.textAnnotations.creatorId | string |
Gebruikers-id van maker van tekstaantekening |
|
IsItalic
|
annotationManager.textAnnotations.fontInfo.isItalic | boolean |
Is lettertype cursief van tekstaantekening |
|
IsStrikeOut
|
annotationManager.textAnnotations.fontInfo.isStrikeOut | boolean |
Is lettertype doorhalen uit tekstaantekening |
|
IsUnderline
|
annotationManager.textAnnotations.fontInfo.isUnderline | boolean |
Is lettertype onderstrepen van tekstaantekening |
|
Naam
|
annotationManager.textAnnotations.fontInfo.name | string |
De naam van het lettertype van tekstaantekening. Standaard = Arial |
|
Toonhoogte
|
annotationManager.textAnnotations.fontInfo.pitch | integer |
Tekenhoogte van tekstaantekening |
|
Grootte
|
annotationManager.textAnnotations.fontInfo.size | integer |
Tekengrootte van tekstaantekening. Voorbeeld: Grootte:12 is 12000. U hebt factor 1000 nodig |
|
Weight
|
annotationManager.textAnnotations.fontInfo.weight | integer |
Tekstdikte van tekstaantekening |
|
Voorgrondkleur
|
annotationManager.textAnnotations.foregroundColor | integer |
Kleur van de voorgrond (32-bits ARGB-waarde) van tekstaantekening. Voorbeeld: Zwart: -16777216 Wit: -1 Rood: -65536 Groen: -16744448 Blauw: -16776961 |
|
ForegroundColorHexCode
|
annotationManager.textAnnotations.foregroundColorHexCode | string |
Kleur van voorgrond (RGB-hexadecimale code) van tekstaantekening. Voorbeeld: Zwart: #000000 Wit: #FFFFFF Rood: #FF0000 Groen: #008000 Blauw: #0000FF |
|
Hoogte
|
annotationManager.textAnnotations.height | integer |
Hoogte van tekst in pixel per inch voor 7200 DPI van tekstaantekening |
|
Identiteitsbewijs
|
annotationManager.textAnnotations.id | string |
Id van tekstaantekening |
|
ModifiedDate
|
annotationManager.textAnnotations.modifiedDate | string |
Datum van wijziging van tekstaantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
PageNumber
|
annotationManager.textAnnotations.pageNumber | integer |
Aantal pagina's van tekstaantekening |
|
Rotation
|
annotationManager.textAnnotations.rotation | integer |
Draaiing in graden van tekstaantekening |
|
SecurityLevelEnum
|
annotationManager.textAnnotations.securityLevelEnum | string |
Beveiligingsniveau voor tekstaantekening (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Selecteerbaar
|
annotationManager.textAnnotations.selectable | boolean |
Definieert of tekstaantekening door de gebruiker kan worden geselecteerd |
|
Tekst
|
annotationManager.textAnnotations.text | string |
Door de gebruiker gedefinieerde tekst van tekstaantekening |
|
Transparent
|
annotationManager.textAnnotations.transparent | boolean |
Tekstaantekening moet transparant zijn |
|
Breedte
|
annotationManager.textAnnotations.width | integer |
Breedte van tekst in pixel per inch voor 7200 DPI van tekstaantekening |
|
X
|
annotationManager.textAnnotations.x | integer |
X coördinaat in pixel per inch voor 7200 DPI van tekstaantekening |
|
Ja
|
annotationManager.textAnnotations.y | integer |
Y-coördinaat in pixel per inch voor 7200 DPI van tekstaantekening |
|
blogs
|
blogs | array of object |
blogs |
|
Blogs
|
blogs | object |
Lijst met alle blogitems |
|
CheckOutState
|
checkOutStateEnum | string |
Status van het document uitchecken (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Id van de gebruiker waarvoor het document is uitgecheckt |
|
documentData
|
documentData | array of object |
documentData |
|
Identiteitsbewijs
|
documentData.id | string |
Id van documentweergave |
|
Naam
|
documentData.name | string |
Documentnaam van weergave |
|
Uitleveringen
|
documentData.renditions | array of |
Uitleveringen |
|
HasOverlay
|
hasOverlay | boolean |
Definieert of het document moet worden weergegeven met een overlay |
|
Identiteitsbewijs
|
id | string |
Id van het document |
|
ImportTemplateId
|
importTemplateId | string |
Id van de importsjabloon voor dit document |
|
InfoStoreId
|
infoStoreId | string |
Id van het gegevensarchief |
|
CheckOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Levenscyclusstatus uitchecken |
|
LifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Berekende einddatum van de levenscyclus. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Begindatum van de levenscyclus. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Id van de LifeCycle-status |
|
NextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Volgende status van de automatische levenscyclus |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of string |
nextLifeCycleStates |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
lifeCycleProtections |
|
DeleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Document verwijderen na verloop van beveiliging toestaan |
|
Identiteitsbewijs
|
lifeCycleManager.lifeCycleProtections.id | string |
Id van de statusbeveiliging van de levenscyclus |
|
ProtectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Beveiligen tegen wijzigingen in aantekeningen |
|
ProtectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Beveiligen tegen uitchecken |
|
ProtectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Beveiligen tegen inhoudswijziging |
|
ProtectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Beveiligen tegen verwijderen |
|
ProtectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Beveiligen tegen eigenschapswijzigingen |
|
ProtectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Beveiliging tegen beveiligingswijziging |
|
ProtectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Duur van de beveiliging |
|
LifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Id van de LifeCycle |
|
MainFileLength
|
mainFileLength | integer |
Hoofdbestandsgrootte |
|
Naam
|
name | string |
Naam van het document |
|
PageCount
|
pageCount | integer |
Aantal pagina's van hoofdbestand |
|
properties
|
properties | array of object |
properties |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultuur
|
properties.globalValues.values.culture | string |
Cultuur |
|
Tekst
|
properties.globalValues.values.text | string |
Tekst |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Type-id van het indexveld |
|
values
|
properties.values | array of string |
PropertyType-waarden |
|
ProtectionDomainId
|
protectionDomainId | string |
Id van het beveiligingsdomein |
|
Herinneringen
|
reminders | array of object |
Herinneringen |
|
Herinneringen
|
reminders | object |
Lijst met alle herinneringen |
|
SessionCount
|
sessionCount | integer |
Aantal sessies |
|
SigningProfileId
|
signingProfileId | string |
Id van het ondertekeningsprofiel |
|
VersionId
|
versionId | string |
Versie-id van het document |
Document maken (V2)
Document maken (V2)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
DocumentTitle
|
DocumentTitle | True | string |
Titel van document (incl. extensie) |
|
ImportTemplate
|
ImportTemplate | string |
De naam of id van de importsjabloon, indien leeg, moeten waarden voor InfoStore en ProtectionDomain worden opgegeven. |
|
|
DocumentProperties
|
DocumentProperties | string |
Indeling documenteigenschappen invoegen: Voornaam=Peter|Achternaam=Microsoft|InvoiceNo=4711; 4712; 4713 |
|
|
Blog
|
Blog | string |
Een blogtekstitem toevoegen aan een document |
|
|
Cultuur
|
Culture | string |
De cultuur waarin de eigenschapsnamen worden gegeven (de, en, fr, ...). Standaard = de |
|
|
InfoStore
|
InfoStore | string |
InfoStore-naam of -id moet worden opgegeven als ImportTemplate leeg is |
|
|
LifeCycle
|
LifeCycle | string |
LifeCycle-naam of -id |
|
|
ProtectionDomain
|
ProtectionDomain | string |
ProtectionDomain Name of Id moet worden opgegeven als ImportTemplate leeg is |
|
|
UploadMethod
|
UploadMethod | string |
De methode die wordt gebruikt voor het uploaden van het document naar InfoShare. Standaard = UploadFileBytesLarge |
|
|
OriginalFileFormat
|
OriginalFileFormat | string |
Oorspronkelijke bestandsindeling voor conversiedoeleinden, bijvoorbeeld 'html'. Geconverteerd naar PDF |
|
|
Segmentgrootte
|
ChunkSize | integer |
Grootte van het segment voor het uploaden van bestanden dat wordt gebruikt met UploadStreamChunks en UploadFileBytesLarge-uploadmethoden, standaard |
|
|
FileContent
|
FileContent | True | string |
Base64-tekenreeks voor bestandsinhoud |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
naam
|
name | string |
naam |
|
identiteitskaart
|
id | string |
Document-id |
|
versionId
|
versionId | string |
Versie-id |
|
currentVersionId
|
currentVersionId | string |
Huidige versie-id |
|
protectionDomainId
|
protectionDomainId | string |
Beveiligingsdomein-id |
|
infoStoreId
|
infoStoreId | string |
InfoStore-id |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Status van het document uitchecken (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
checkOutUserId
|
checkOutUserId | string |
Uitgecheckte gebruikers-id |
|
properties
|
properties | array of object |
Eigenschappen |
|
propertyTypeId
|
properties.propertyTypeId | string |
Eigenschapstype-id |
|
values
|
properties.values | array of string |
PropertyType-waarden |
|
globalValues
|
properties.globalValues | array of object |
Globale waarden |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultuur
|
properties.globalValues.values.culture | string |
Cultuur van wereldwijde waarde |
|
Tekst
|
properties.globalValues.values.text | string |
Algemene waardetekst |
|
propertyTypeName
|
properties.propertyTypeName | string |
PropertyType-naam |
|
eigenschapsnaam
|
properties.propertyName | string |
Naam van de eigenschap |
|
importTemplateId
|
importTemplateId | string |
Sjabloon-id importeren |
|
blogs
|
blogs | array of object |
blogs |
|
aanmaakdatum
|
blogs.createdDate | string |
Blog gemaakt op |
|
creatorId
|
blogs.creatorId | string |
Id van blogmaker |
|
Tekst
|
blogs.text | string |
Blogtekst |
|
identiteitskaart
|
blogs.id | string |
Id van blog |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
Herinneringen
|
reminders | array of |
Herinneringen |
|
pageCount
|
pageCount | integer |
Aantal pagina's |
|
mainFileLength
|
mainFileLength | integer |
Lengte van hoofdbestand |
|
abonnementen
|
abonnements | array of |
Abonnementen |
|
textAnnotations
|
annotationManager.textAnnotations | array of |
Aantekeningentekst |
|
rechthoekAnnotations
|
annotationManager.rectangleAnnotations | array of |
Rechthoek met aantekeningen |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of |
Aantekeningen posten |
|
stampAnnotations
|
annotationManager.stampAnnotations | array of |
Aantekeningenstempel |
|
documentData
|
documentData | array of object |
Documentgegevens |
|
identiteitskaart
|
documentData.id | string |
Documentgegevens-id |
|
naam
|
documentData.name | string |
Documentgegevensnaam |
|
Uitleveringen
|
documentData.renditions | array of object |
Uitleveringen |
|
identiteitskaart
|
documentData.renditions.id | string |
Weergave-id |
|
size
|
documentData.renditions.size | string |
Weergavegrootte |
|
files
|
documentData.renditions.files | array of object |
files |
|
blobStoreId
|
documentData.renditions.files.blobStoreId | string |
Blob Store-id |
|
blobPath
|
documentData.renditions.files.blobPath | string |
Blobpad |
|
pageCount
|
documentData.renditions.pageCount | string |
Aantal weergavepagina's |
|
uitbreiding
|
documentData.renditions.extension | string |
Weergave-extensie |
|
hashValue
|
documentData.renditions.hashValue | array of integer |
Hash-waarde voor weergave |
|
contentProtections
|
documentData.renditions.contentProtections | array of |
Inhoudsbeveiligingen voor weergaven |
|
signingProfileId
|
signingProfileId | string |
Id van handtekeningprofiel |
|
lifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Levenscyclus-id |
|
lifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Status-id van levenscyclus |
|
lifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Begindatum levenscyclus |
|
lifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Einddatum levenscyclus |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of |
Volgende levenscyclusstatussen |
|
checkOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Status-id van levenscyclus uitchecken |
|
nextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Volgende status-id van de automatische levenscyclus |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
Levenscyclusbeveiligingen |
|
identiteitskaart
|
lifeCycleManager.lifeCycleProtections.id | string |
Id van levenscyclusbeveiliging |
|
protectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Duur van levenscyclusbescherming |
|
protectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Levenscyclus beveiligen uitchecken |
|
protectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Levenscyclus: inhoudswijziging beveiligen |
|
protectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Wijziging van eigenschap voor levenscyclus beveiligen |
|
protectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Wijziging van aantekening in levenscyclus beveiligen |
|
protectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Levenscyclusbeschermingsdomeinwijziging beveiligen |
|
protectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Levenscyclus beveiligen verwijderen |
|
deleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Levenscyclus verwijderen na verloop van tijd |
|
hasOverlay
|
hasOverlay | boolean |
Heeft overlay |
|
sessionCount
|
sessionCount | integer |
Aantal sessies |
|
hasSignature
|
hasSignature | boolean |
Heeft handtekening |
|
hasBlog
|
hasBlog | boolean |
Heeft blog |
|
hasAnnotation
|
hasAnnotation | boolean |
Heeft aantekening |
|
hasTempAccess
|
hasTempAccess | boolean |
Heeft tijdelijke toegang |
|
hasReminders
|
hasReminders | boolean |
Heeft herinneringen |
|
hasLinks
|
hasLinks | boolean |
Bevat koppelingen |
|
hasAbonnement
|
hasAbonnement | boolean |
Heeft abonnement |
Document ophalen
Document ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
DocumentId
|
documentId | True | string |
De document-id |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Abonnementen
|
GetDocumentResult.Abonnements | array of object |
Abonnementen |
|
OnContentChange
|
GetDocumentResult.Abonnements.OnContentChange | boolean |
Abonnement is actief bij bestandswijzigingen |
|
OnDelete
|
GetDocumentResult.Abonnements.OnDelete | boolean |
Abonnement is actief bij verwijderen |
|
OnMetadataChange
|
GetDocumentResult.Abonnements.OnMetadataChange | boolean |
Abonnement is actief bij indexwijzigingen |
|
UserId
|
GetDocumentResult.Abonnements.UserId | string |
De gebruikers-id voor dit abonnnement |
|
AccessRightsEnumList
|
GetDocumentResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
PostItAnnotations
|
GetDocumentResult.AnnotationManager.PostItAnnotations | array of object |
PostItAnnotations |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatedDate | string |
Aantekeningsdatum maken vanaf bericht |
|
CreatorId
|
GetDocumentResult.AnnotationManager.PostItAnnotations.CreatorId | string |
Gebruikers-id van maker van het bericht |
|
IsItalic
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsItalic | boolean |
Is lettertype cursief van berichtaantekening |
|
IsStrikeOut
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsStrikeOut | boolean |
Is font strike out from post it annotation (Is lettertype doorhalen van bericht) |
|
IsUnderline
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.IsUnderline | boolean |
Is lettertype onderstrepen na het aantekenen |
|
Naam
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Name | string |
De naam van het lettertype na de aantekening. Standaard = Arial |
|
Toonhoogte
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Pitch | integer |
Lettertypepitch van bericht toevoegen |
|
Grootte
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Size | integer |
Tekengrootte van bericht aantekening. Voorbeeld: Grootte:12 is 12000. U hebt factor 1000 nodig |
|
Weight
|
GetDocumentResult.AnnotationManager.PostItAnnotations.FontInfo.Weight | integer |
Tekengewicht van bericht toevoegen |
|
Identiteitsbewijs
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Id | string |
Id van de berichtaantekening |
|
ModifiedDate
|
GetDocumentResult.AnnotationManager.PostItAnnotations.ModifiedDate | string |
Datum van wijziging na aantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.PostItAnnotations.PageNumber | integer |
Aantal pagina's na het aantekenen |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.PostItAnnotations.SecurityLevelEnum | string |
Beveiligingsniveau voor het posten van aantekeningen (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Selecteerbaar
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Selectable | boolean |
Definieert of een aantekening kan worden geselecteerd door de gebruiker |
|
Tekst
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Text | string |
Door de gebruiker gedefinieerde tekst voor het posten van aantekeningen |
|
X
|
GetDocumentResult.AnnotationManager.PostItAnnotations.X | integer |
X-coördinaat in pixel per inch voor 7200 DPI van post-aantekening |
|
Ja
|
GetDocumentResult.AnnotationManager.PostItAnnotations.Y | integer |
Y-coördinaat in pixel per inch voor 7200 DPI van berichtaantekening |
|
RechthoekAnnotations
|
GetDocumentResult.AnnotationManager.RectangleAnnotations | array of object |
RechthoekAnnotations |
|
Kleur
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Color | integer |
Kleur van rechthoek (32-bits ARGB-waarde) uit rechthoekaantekening. Voorbeeld: Zwart: -16777216 Wit: -1 Rood: -65536 Groen: -16744448 Blauw: -16776961 |
|
ColorHexCode
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.ColorHexCode | string |
Kleur van rechthoek (RGB-hexadecimale code) van rechthoekaantekening. Voorbeeld: Zwart: #000000 Wit: #FFFFFF Rood: #FF0000 Groen: #008000 Blauw: #0000FF |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatedDate | string |
Aantekeningsdatum van rechthoek. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.CreatorId | string |
CreatorId |
|
Hoogte
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Height | integer |
Hoogte van rechthoek in pixel per inch voor 7200 DPI |
|
Identiteitsbewijs
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Id | string |
Id van de aantekening van de rechthoek |
|
ModifiedDate
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.ModifiedDate | string |
Datum van wijziging van rechthoekaantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.PageNumber | integer |
Aantal pagina's uit rechthoekaantekening |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.SecurityLevelEnum | string |
Beveiligingsniveau voor aantekening van rechthoeken (openbaar beschikbaar, persoonlijk, persoonlijk beveiligd, onlyeditors). Default = PubliclyAvailable |
|
Selecteerbaar
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Selectable | boolean |
Hiermee wordt gedefinieerd of de aantekening van een rechthoek door de gebruiker kan worden geselecteerd |
|
Transparent
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Transparent | boolean |
Rechthoek moet transparant zijn (markering) |
|
Breedte
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Width | integer |
Breedte van rechthoek in pixel per inch voor 7200 DPI |
|
X
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.X | integer |
X-coördinaat in pixel per inch voor 7200 DPI van rechthoekaantekening |
|
Ja
|
GetDocumentResult.AnnotationManager.RectangleAnnotations.Y | integer |
Y-coördinaat in pixel per inch voor 7200 DPI van rechthoekaantekening |
|
Tekstannotaties
|
GetDocumentResult.AnnotationManager.TextAnnotations | array of object |
Tekstannotaties |
|
BackgroundColor
|
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColor | integer |
Kleur van achtergrond (32-bits ARGB-waarde) van tekstaantekening. Voorbeeld: Zwart: -16777216 Wit: -1 Rood: -65536 Groen: -16744448 Blauw: -16776961 |
|
BackgroundColorHexCode
|
GetDocumentResult.AnnotationManager.TextAnnotations.BackgroundColorHexCode | string |
Kleur van achtergrond (RGB-hexadecimale code) van tekstaantekening. Voorbeeld: Zwart: #000000 Wit: #FFFFFF Rood: #FF0000 Groen: #008000 Blauw: #0000FF |
|
CreatedDate
|
GetDocumentResult.AnnotationManager.TextAnnotations.CreatedDate | string |
aanmaakdatum van tekstaantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.AnnotationManager.TextAnnotations.CreatorId | string |
Gebruikers-id van maker van tekstaantekening |
|
IsItalic
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsItalic | boolean |
Is lettertype cursief van tekstaantekening |
|
IsStrikeOut
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsStrikeOut | boolean |
Is lettertype doorhalen uit tekstaantekening |
|
IsUnderline
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.IsUnderline | boolean |
Is lettertype onderstrepen van tekstaantekening |
|
Naam
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Name | string |
De naam van het lettertype van tekstaantekening. Standaard = Arial |
|
Toonhoogte
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Pitch | integer |
Tekenhoogte van tekstaantekening |
|
Grootte
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Size | integer |
Tekengrootte van tekstaantekening.. Voorbeeld: Grootte:12 is 12000. U hebt factor 1000 nodig |
|
Weight
|
GetDocumentResult.AnnotationManager.TextAnnotations.FontInfo.Weight | integer |
Tekstdikte van tekstaantekening |
|
Voorgrondkleur
|
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColor | integer |
Kleur van de voorgrond (32-bits ARGB-waarde) van tekstaantekening. Voorbeeld: Zwart: -16777216 Wit: -1 Rood: -65536 Groen: -16744448 Blauw: -16776961 |
|
ForegroundColorHexCode
|
GetDocumentResult.AnnotationManager.TextAnnotations.ForegroundColorHexCode | string |
Kleur van voorgrond (RGB-hexadecimale code) van tekstaantekening. Voorbeeld: Zwart: #000000 Wit: #FFFFFF Rood: #FF0000 Groen: #008000 Blauw: #0000FF |
|
Hoogte
|
GetDocumentResult.AnnotationManager.TextAnnotations.Height | integer |
Hoogte van tekst in pixel per inch voor 7200 DPI van tekstaantekening |
|
Identiteitsbewijs
|
GetDocumentResult.AnnotationManager.TextAnnotations.Id | string |
Id van tekstaantekening |
|
ModifiedDate
|
GetDocumentResult.AnnotationManager.TextAnnotations.ModifiedDate | string |
Datum van wijziging van tekstaantekening. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
PageNumber
|
GetDocumentResult.AnnotationManager.TextAnnotations.PageNumber | integer |
Aantal pagina's van tekstaantekening |
|
Rotation
|
GetDocumentResult.AnnotationManager.TextAnnotations.Rotation | integer |
Draaiing in graden van tekstaantekening |
|
SecurityLevelEnum
|
GetDocumentResult.AnnotationManager.TextAnnotations.SecurityLevelEnum | string |
Beveiligingsniveau voor tekstaantekening (PubliclyAvailable, Personal, PersonalProtected, OnlyEditors). Default = PubliclyAvailable |
|
Selecteerbaar
|
GetDocumentResult.AnnotationManager.TextAnnotations.Selectable | boolean |
Definieert of tekstaantekening door de gebruiker kan worden geselecteerd |
|
Tekst
|
GetDocumentResult.AnnotationManager.TextAnnotations.Text | string |
Door de gebruiker gedefinieerde tekst van tekstaantekening |
|
Transparent
|
GetDocumentResult.AnnotationManager.TextAnnotations.Transparent | boolean |
Tekstaantekening moet transparant zijn |
|
Breedte
|
GetDocumentResult.AnnotationManager.TextAnnotations.Width | integer |
Breedte van tekst in pixel per inch voor 7200 DPI van tekstaantekening |
|
X
|
GetDocumentResult.AnnotationManager.TextAnnotations.X | integer |
X coördinaat in pixel per inch voor 7200 DPI van tekstaantekening |
|
Ja
|
GetDocumentResult.AnnotationManager.TextAnnotations.Y | integer |
Y-coördinaat in pixel per inch voor 7200 DPI van tekstaantekening |
|
Blogs
|
GetDocumentResult.Blogs | array of object |
Blogs |
|
CreatedDate
|
GetDocumentResult.Blogs.CreatedDate | string |
Datum waarop de blog is gemaakt. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
GetDocumentResult.Blogs.CreatorId | string |
Gebruikers-id van het maken van een gebruikersblog |
|
Identiteitsbewijs
|
GetDocumentResult.Blogs.Id | string |
Id van de blog |
|
Tekst
|
GetDocumentResult.Blogs.Text | string |
Tekst van blogitem |
|
CheckOutStateEnum
|
GetDocumentResult.CheckOutStateEnum | string |
Status van het document uitchecken (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
GetDocumentResult.CheckOutUserId | string |
Id van de gebruiker waarvoor het document is uitgecheckt |
|
DocumentData
|
GetDocumentResult.DocumentData | array of object |
DocumentData |
|
Identiteitsbewijs
|
GetDocumentResult.DocumentData.Id | string |
Id van documentweergave |
|
Naam
|
GetDocumentResult.DocumentData.Name | string |
Documentnaam van weergave |
|
Uitleveringen
|
GetDocumentResult.DocumentData.Renditions | array of object |
Uitleveringen |
|
ContentProtections
|
GetDocumentResult.DocumentData.Renditions.ContentProtections | array of |
ContentProtections |
|
Extension
|
GetDocumentResult.DocumentData.Renditions.Extension | string |
Extension |
|
Files
|
GetDocumentResult.DocumentData.Renditions.Files | array of object |
Files |
|
BlobPath
|
GetDocumentResult.DocumentData.Renditions.Files.BlobPath | string |
BlobPath |
|
BlobStoreId
|
GetDocumentResult.DocumentData.Renditions.Files.BlobStoreId | string |
BlobStoreId |
|
HashValue
|
GetDocumentResult.DocumentData.Renditions.HashValue | array of integer |
HashValue |
|
Identiteitsbewijs
|
GetDocumentResult.DocumentData.Renditions.Id | string |
Identiteitsbewijs |
|
PageCount
|
GetDocumentResult.DocumentData.Renditions.PageCount | integer |
PageCount |
|
Grootte
|
GetDocumentResult.DocumentData.Renditions.Size | integer |
Grootte |
|
HasOverlay
|
GetDocumentResult.HasOverlay | boolean |
Definieert of het document moet worden weergegeven met een overlay |
|
Identiteitsbewijs
|
GetDocumentResult.Id | string |
Id van het document |
|
ImportTemplateId
|
GetDocumentResult.ImportTemplateId | string |
Id van de importsjabloon voor dit document |
|
InfoStoreId
|
GetDocumentResult.InfoStoreId | string |
Id van het gegevensarchief |
|
CheckOutLifeCycleStateId
|
GetDocumentResult.LifeCycleManager.CheckOutLifeCycleStateId | string |
Levenscyclusstatus uitchecken |
|
LifeCycleEndDate
|
GetDocumentResult.LifeCycleManager.LifeCycleEndDate | string |
Berekende einddatum van de levenscyclus. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
LifeCycleStartDate
|
GetDocumentResult.LifeCycleManager.LifeCycleStartDate | string |
Begindatum van de levenscyclus. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
LifeCycleStateId
|
GetDocumentResult.LifeCycleManager.LifeCycleStateId | string |
Id van de LifeCycle-status |
|
NextAutomaticLifeCycleStateId
|
GetDocumentResult.LifeCycleManager.NextAutomaticLifeCycleStateId | string |
Volgende status van de automatische levenscyclus |
|
NextLifeCycleStates
|
GetDocumentResult.LifeCycleManager.NextLifeCycleStates | array of string |
NextLifeCycleStates |
|
LifeCycleProtections
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections | array of object |
LifeCycleProtections |
|
DeleteAfterExpiration
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.DeleteAfterExpiration | boolean |
Document verwijderen na verloop van beveiliging toestaan |
|
Identiteitsbewijs
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.Id | string |
Id van de statusbeveiliging van de levenscyclus |
|
ProtectAnnotationChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectAnnotationChange | boolean |
Beveiligen tegen wijzigingen in aantekeningen |
|
ProtectCheckOut
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectCheckOut | boolean |
Beveiligen tegen uitchecken |
|
ProtectContentChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectContentChange | boolean |
Beveiligen tegen inhoudswijziging |
|
ProtectDelete
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectDelete | boolean |
Beveiligen tegen verwijderen |
|
ProtectPropertyChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectPropertyChange | boolean |
Beveiligen tegen eigenschapswijzigingen |
|
ProtectProtectionDomainChange
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectProtectionDomainChange | boolean |
Beveiliging tegen beveiligingswijziging |
|
ProtectionDurationTicks
|
GetDocumentResult.LifeCycleManager.LifeCycleProtections.ProtectionDurationTicks | integer |
Duur van de beveiliging |
|
LifeCycleId
|
GetDocumentResult.LifeCycleManager.LifeCycleId | string |
Id van de LifeCycle |
|
MainFileLength
|
GetDocumentResult.MainFileLength | integer |
Hoofdbestandsgrootte |
|
Naam
|
GetDocumentResult.Name | string |
Naam van het document |
|
PageCount
|
GetDocumentResult.PageCount | integer |
Aantal pagina's van hoofdbestand |
|
Eigenschappen
|
GetDocumentResult.Properties | array of object |
Eigenschappen |
|
GlobalValues
|
GetDocumentResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Waarden
|
GetDocumentResult.Properties.GlobalValues.Values | array of object |
Waarden |
|
Cultuur
|
GetDocumentResult.Properties.GlobalValues.Values.Culture | string |
Cultuur |
|
Tekst
|
GetDocumentResult.Properties.GlobalValues.Values.Text | string |
Tekst |
|
PropertyTypeId
|
GetDocumentResult.Properties.PropertyTypeId | string |
Type-id van het indexveld |
|
Waarden
|
GetDocumentResult.Properties.Values | array of string |
Waarden |
|
ProtectionDomainId
|
GetDocumentResult.ProtectionDomainId | string |
Id van het beveiligingsdomein |
|
Herinneringen
|
GetDocumentResult.Reminders | array of object |
Herinneringen |
|
Description
|
GetDocumentResult.Reminders.Description | string |
Beschrijving voor herinnering |
|
Tijdsegment
|
GetDocumentResult.Reminders.Interval | integer |
Interval in dagen tussen herinneringen |
|
ProcessTemplateId
|
GetDocumentResult.Reminders.ProcessTemplateId | string |
Processjabloon-id voor deze herinnering |
|
ReminderDate
|
GetDocumentResult.Reminders.ReminderDate | string |
Datum van de herinnering. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
ReminderId
|
GetDocumentResult.Reminders.ReminderId | string |
Id van de herinnering |
|
SubjectIds
|
GetDocumentResult.Reminders.SubjectIds | array of |
subjectIds |
|
UseUserFromProcessTemplate
|
GetDocumentResult.Reminders.UseUserFromProcessTemplate | boolean |
Definieert of de gebruikersdefinitie van de processjabloon wordt gebruikt |
|
SessionCount
|
GetDocumentResult.SessionCount | integer |
Aantal sessies |
|
SigningProfileId
|
GetDocumentResult.SigningProfileId | string |
Id van het ondertekeningsprofiel |
|
VersionId
|
GetDocumentResult.VersionId | string |
Versie-id van het document |
Document zoeken (afgeschaft) [AFGESCHAFT]
Document zoeken (afgeschaft)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
Conditions
|
Conditions | string |
Indeling van zoekvoorwaarde: [<PropertyName>|<ComparisonEnum> |<PropertyValue> |<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn" RelationEnums:"And,Or". bijvoorbeeld: [Laatste check in|Minder|2021-12-31|En],[Voornaam|Is gelijk aan|Peter|En] |
|
|
Cultuur
|
Culture | string |
Cultuur (de, en,fr,...). Standaard = de |
|
|
FulltextWords
|
FulltextWords | string |
Woorden die moeten worden doorzocht met volledige tekst |
|
|
FulltextWordRelation
|
FulltextWordRelation | string |
Tekstwoordrelatie (AND, OR). Default = AND |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Maximum aantal zoekresultaten voor documenten. Standaard = 100 |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Documenten
|
documents | array of object |
Documenten |
|
Abonnementen
|
documents.abonnements | string |
Lijst met abonnementen |
|
accessRightsEnumList
|
documents.accessRightsEnumList | array of string |
accessRightsEnumList |
|
AnnotationManager
|
documents.annotationManager | string |
Aantekeningen voor hoofddocumentbestand |
|
Blogs
|
documents.blogs | string |
Lijst met alle blogitems |
|
CheckOutState
|
documents.checkOutStateEnum | string |
Status van het document uitchecken (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
documents.checkOutUserId | string |
Id van de gebruiker waarvoor het document is uitgecheckt |
|
DocumentData
|
documents.documentData | string |
Lijst met documentgegevens |
|
HasOverlay
|
documents.hasOverlay | boolean |
Definieert of het document moet worden weergegeven met een overlay |
|
Identiteitsbewijs
|
documents.id | string |
Id van het document |
|
ImportTemplateId
|
documents.importTemplateId | string |
Id van de importsjabloon voor dit document |
|
InfoStoreId
|
documents.infoStoreId | string |
Id van het gegevensarchief |
|
LifeCycleManager
|
documents.lifeCycleManager | string |
Informatie over levenscyclus |
|
MainFileLength
|
documents.mainFileLength | integer |
Hoofdbestandsgrootte |
|
Naam
|
documents.name | string |
Naam van het document |
|
PageCount
|
documents.pageCount | integer |
Aantal pagina's van hoofdbestand |
|
properties
|
documents.properties | array of |
properties |
|
ProtectionDomainId
|
documents.protectionDomainId | string |
Id van het beveiligingsdomein |
|
Herinneringen
|
documents.reminders | string |
Lijst met alle herinneringen |
|
SessionCount
|
documents.sessionCount | integer |
Aantal sessies |
|
SigningProfileId
|
documents.signingProfileId | string |
Id van het ondertekeningsprofiel |
|
VersionId
|
documents.versionId | string |
Versie-id van het document |
|
HasMore
|
hasMore | boolean |
Geeft aan of er meer resultaten bestaan of niet. De vlag is ingesteld op waar als er meer resultaten beschikbaar zijn |
|
CvPoint
|
resumePoint | string |
Het cv-punt van de vorige zoekbewerking. Null instellen voor de eerste zoekbewerking |
Document zoeken (V2)
Document zoeken (V2)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
Conditions
|
Conditions | string |
Indeling van zoekvoorwaarde: [<PropertyName>|<ComparisonEnum> |<PropertyValue> |<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn,Between" RelationEnums:"And,Or". bijvoorbeeld: [Laatste check in|Minder|2021-12-31|En],[Voornaam|Is gelijk aan|Peter|En],[Datum|Tussen|2021-12-31; 2022-12-31 |En] |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Maximum aantal zoekresultaten voor documenten. Standaard = 100 |
|
|
ResultProperties
|
ResultProperties | string |
Lijst met resultaateigenschappen, gescheiden door komma's. Kan de naam of id van de eigenschap zijn, zoals 'Naam,Laatste check in,68b901cd-4d8f-11e6-aa6f-00ff04d7e62a' |
|
|
Cultuur
|
Culture | string |
De cultuur waarin de tekst wordt gegeven (de, en, fr, ...). Standaard = de |
|
|
Winkels
|
Stores | string |
Door komma's gescheiden lijst met InfoStores om in te zoeken. Kan winkelnaam of id zijn, zoals 'Standard,9cd306e3-7e96-486c-8280-65d9f0239776' |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Documenten
|
documents | array of object |
Resultaat van documentzoekopdracht |
|
naam
|
documents.name | string |
Documentnaam |
|
identiteitskaart
|
documents.id | string |
Document-id |
|
folderElementId
|
documents.folderElementId | string |
Mapelement-id |
|
checkOutStateEnum
|
documents.checkOutStateEnum | string |
Opsomming van status uitchecken |
|
hasSignature
|
documents.hasSignature | boolean |
Heeft handtekening |
|
hasBlog
|
documents.hasBlog | boolean |
Heeft blog |
|
hasAnnotation
|
documents.hasAnnotation | boolean |
Heeft aantekening |
|
hasLinks
|
documents.hasLinks | boolean |
Bevat koppelingen |
|
properties
|
documents.properties | array of object |
Eigenschappen |
|
propertyTypeId
|
documents.properties.propertyTypeId | string |
Eigenschapstype-id |
|
values
|
documents.properties.values | array of string |
Eigenschapstypewaarden |
|
globalValues
|
documents.properties.globalValues | array of object |
Globale waarden |
|
values
|
documents.properties.globalValues.values | array of object |
values |
|
cultuur
|
documents.properties.globalValues.values.culture | string |
Cultuur van globale waarden |
|
Tekst
|
documents.properties.globalValues.values.text | string |
Tekst van globale waarden |
|
propertyTypeName
|
documents.properties.propertyTypeName | string |
PropertyType-naam |
|
eigenschapsnaam
|
documents.properties.propertyName | string |
Naam van de eigenschap |
|
hasTempAccess
|
documents.hasTempAccess | boolean |
Heeft tijdelijke toegang |
|
accessRightsEnumList
|
documents.accessRightsEnumList | array of string |
Opsommingslijst voor toegangsrechten |
|
mainFileLength
|
documents.mainFileLength | integer |
Lengte van hoofdbestand |
|
versionId
|
documents.versionId | string |
Versie-id |
|
hasReminders
|
documents.hasReminders | boolean |
Heeft herinneringen |
|
hasAbonnement
|
documents.hasAbonnement | boolean |
Heeft abonnement |
|
hasOverlay
|
documents.hasOverlay | boolean |
Oas-overlay |
|
hasMore
|
hasMore | boolean |
Heeft meer |
|
cvPoint
|
resumePoint | string |
Cv-punt |
Documenteigenschappen ophalen
Documenteigenschappen ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
DocumentId
|
DocumentId | True | string |
Id van document |
|
Cultuur
|
Culture | string |
De cultuur waarin de eigenschapsnamen worden gegeven (de, en, fr, ...). Standaard = de |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
globalValues
|
globalValues | array of object |
globalValues |
|
values
|
globalValues.values | array of object |
values |
|
cultuur
|
globalValues.values.culture | string |
Cultuur |
|
Tekst
|
globalValues.values.text | string |
Tekst |
|
Eigenschapsnaam
|
propertyName | string |
Naam van eigenschap |
|
PropertyTypeId
|
propertyTypeId | string |
Type-id van het indexveld |
|
values
|
values | array of string |
values |
Een gebruikerstabel maken
Een gebruikerstabel maken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
UserTable
|
UserTable | True | string |
Naam van de gebruikerstabel (bijvoorbeeld: Adres) |
|
ColumnHeaders
|
ColumnHeaders | True | string |
Een lijst met kolomkoppen (bijvoorbeeld: Voornaam, Achternaam, Plaats) |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebruikerstabel
|
userTable | string |
Naam van gebruikerstabel |
Een geopend proces sluiten
Een geopend proces sluiten
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
ProcessId
|
processId | True | string |
Id van proces (GUID) |
|
Comment
|
comment | string |
Opmerking om toe te voegen |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
AccessRightsEnumList
|
CloseProcessResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
CloseProcessResult.CheckOutStateEnum | string |
Status van het document uitchecken (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
CloseProcessResult.CheckOutUserId | string |
Id van de gebruiker waarvoor het proces is uitgecheckt |
|
Comments
|
CloseProcessResult.Comments | array of object |
Comments |
|
Datum
|
CloseProcessResult.Comments.Date | string |
Datum van opmerking |
|
Identiteitsbewijs
|
CloseProcessResult.Comments.Id | string |
Id van opmerking |
|
Tekst
|
CloseProcessResult.Comments.Text | string |
Door de gebruiker gedefinieerde opmerking |
|
UserId
|
CloseProcessResult.Comments.UserId | string |
Gebruikers-id |
|
CompletedDate
|
CloseProcessResult.CompletedDate | string |
Voltooide datum van het proces. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CompletedTasks
|
CloseProcessResult.CompletedTasks | array of object |
CompletedTasks |
|
Handeling
|
CloseProcessResult.CompletedTasks.Action | string |
Actietekst voor de gebruiker |
|
AssignedUserIds
|
CloseProcessResult.CompletedTasks.AssignedUserIds | array of |
AssignedUserIds |
|
Comments
|
CloseProcessResult.CompletedTasks.Comments | array of object |
Comments |
|
Datum
|
CloseProcessResult.CompletedTasks.Comments.Date | string |
Datum van opmerking |
|
Identiteitsbewijs
|
CloseProcessResult.CompletedTasks.Comments.Id | string |
Id van opmerking |
|
Tekst
|
CloseProcessResult.CompletedTasks.Comments.Text | string |
Door de gebruiker gedefinieerde opmerking |
|
UserId
|
CloseProcessResult.CompletedTasks.Comments.UserId | string |
Id van gebruiker, die de opmerking heeft ingesteld |
|
CompletedDate
|
CloseProcessResult.CompletedTasks.CompletedDate | string |
Voltooiingsdatum van voltooide taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
CloseProcessResult.CompletedTasks.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
CloseProcessResult.CompletedTasks.CreatedDate | string |
Aanmaakdatum van voltooide taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
CloseProcessResult.CompletedTasks.CreatorId | string |
Gebruikers-id van de maker van de voltooide taak |
|
Description
|
CloseProcessResult.CompletedTasks.Description | string |
Taakbeschrijving van voltooide taak |
|
DueDate
|
CloseProcessResult.CompletedTasks.DueDate | string |
Einddatum van de taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
Identiteitsbewijs
|
CloseProcessResult.CompletedTasks.Id | string |
Id van de taak |
|
IntendedUserIds
|
CloseProcessResult.CompletedTasks.IntendedUserIds | array of |
IntendedUserIds |
|
ReminderDate
|
CloseProcessResult.CompletedTasks.ReminderDate | string |
Datum voor herinnering aan voltooide taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
VereistAllRecipients
|
CloseProcessResult.CompletedTasks.RequiresAllRecipients | boolean |
Definieert of alle geadresseerden deze taak moeten sluiten |
|
ShowCloseTaskDialog
|
CloseProcessResult.CompletedTasks.ShowCloseTaskDialog | boolean |
Dialoogvenster Taak sluiten weergeven aan taakeinde |
|
StatusEnum
|
CloseProcessResult.CompletedTasks.StatusEnum | string |
Status van taak (Openen, InProcess, Voltooid, PreparedToComplete, Fout) |
|
TaskTemplateId
|
CloseProcessResult.CompletedTasks.TaskTemplateId | string |
Taaksjabloon-id |
|
CreatedDate
|
CloseProcessResult.CreatedDate | string |
Aanmaakdatum van de procesdatumnotatie: jjjj-MM-ddTHH:mm:ss |
|
Handeling
|
CloseProcessResult.CurrentTask.Action | string |
Actietekst voor de gebruiker |
|
AssignedUserIds
|
CloseProcessResult.CurrentTask.AssignedUserIds | array of string |
AssignedUserIds |
|
Comments
|
CloseProcessResult.CurrentTask.Comments | array of object |
Comments |
|
Datum
|
CloseProcessResult.CurrentTask.Comments.Date | string |
Datum van opmerking |
|
Identiteitsbewijs
|
CloseProcessResult.CurrentTask.Comments.Id | string |
Id van opmerking |
|
Tekst
|
CloseProcessResult.CurrentTask.Comments.Text | string |
Door de gebruiker gedefinieerde opmerking |
|
UserId
|
CloseProcessResult.CurrentTask.Comments.UserId | string |
Id van gebruiker, die de opmerking heeft ingesteld |
|
CompletedDate
|
CloseProcessResult.CurrentTask.CompletedDate | string |
Voltooiingsdatum van de huidige taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
CloseProcessResult.CurrentTask.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
CloseProcessResult.CurrentTask.CreatedDate | string |
De aanmaakdatum van de huidige taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
CloseProcessResult.CurrentTask.CreatorId | string |
Gebruikers-id van de maker van de huidige taak |
|
Description
|
CloseProcessResult.CurrentTask.Description | string |
Taakbeschrijving van huidige taak |
|
DueDate
|
CloseProcessResult.CurrentTask.DueDate | string |
Einddatum van de huidige taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
Identiteitsbewijs
|
CloseProcessResult.CurrentTask.Id | string |
Id van de huidige taak |
|
IntendedUserIds
|
CloseProcessResult.CurrentTask.IntendedUserIds | array of string |
IntendedUserIds |
|
ReminderDate
|
CloseProcessResult.CurrentTask.ReminderDate | string |
Datum voor herinnering aan de huidige taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
VereistAllRecipients
|
CloseProcessResult.CurrentTask.RequiresAllRecipients | boolean |
Definieert of alle geadresseerden de huidige taak moeten sluiten |
|
ShowCloseTaskDialog
|
CloseProcessResult.CurrentTask.ShowCloseTaskDialog | boolean |
Dialoogvenster Taak sluiten weergeven bij huidige taak |
|
StatusEnum
|
CloseProcessResult.CurrentTask.StatusEnum | string |
Status van de huidige taak (Openen, InProcess, Voltooid, PreparedToComplete, Fout) |
|
TaskTemplateId
|
CloseProcessResult.CurrentTask.TaskTemplateId | string |
Taaksjabloon-id van huidige taak |
|
CustomProperties
|
CloseProcessResult.CustomProperties | array of object |
CustomProperties |
|
CustomPropertyTypeEnum
|
CloseProcessResult.CustomProperties.CustomPropertyTypeEnum | string |
Aangepast eigenschapstype enumwaarde van aangepaste eigenschap (tekenreeks, datum, getal) |
|
Naam
|
CloseProcessResult.CustomProperties.Name | string |
Naam van de aangepaste eigenschap |
|
Waarde
|
CloseProcessResult.CustomProperties.Value | string |
Waarde van de aangepaste eigenschap |
|
DocumentIds
|
CloseProcessResult.DocumentIds | array of string |
DocumentIds |
|
DueDate
|
CloseProcessResult.DueDate | string |
Einddatum voor het proces. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
Identiteitsbewijs
|
CloseProcessResult.Id | string |
Id van proces |
|
Waarden
|
CloseProcessResult.Name.Values | array of object |
Waarden |
|
Cultuur
|
CloseProcessResult.Name.Values.Culture | string |
De cultuur waarin de tekst wordt gegeven (de, en, fr, ...) |
|
Tekst
|
CloseProcessResult.Name.Values.Text | string |
Naam van proces |
|
PluginStream
|
CloseProcessResult.PluginStream | array of |
PluginStream |
|
PriorityEnum
|
CloseProcessResult.PriorityEnum | string |
Prioriteit van proces (hoog, normaal, laag) |
|
ProcessTemplateId
|
CloseProcessResult.ProcessTemplateId | string |
Processjabloon-id |
|
Eigenschappen
|
CloseProcessResult.Properties | array of object |
Eigenschappen |
|
GlobalValues
|
CloseProcessResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Waarden
|
CloseProcessResult.Properties.GlobalValues.Values | array of object |
Waarden |
|
Cultuur
|
CloseProcessResult.Properties.GlobalValues.Values.Culture | string |
Cultuur |
|
Tekst
|
CloseProcessResult.Properties.GlobalValues.Values.Text | string |
Tekst |
|
PropertyTypeId
|
CloseProcessResult.Properties.PropertyTypeId | string |
Type-id van het indexveld |
|
Waarden
|
CloseProcessResult.Properties.Values | array of string |
Waarden |
|
ProtectionDomainId
|
CloseProcessResult.ProtectionDomainId | string |
Domein-id van beveiliging van proces |
|
SessionCount
|
CloseProcessResult.SessionCount | integer |
Aantal sessies |
|
StatusEnum
|
CloseProcessResult.StatusEnum | string |
Status van proces (Open, InProcess, Complete, PreparedToComplete, Error) |
Een rij in een gebruikerstabel bijwerken
Een rij in een gebruikerstabel bijwerken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
Naam van gebruikerstabel
|
UserTable | True | string |
Naam van gebruikerstabel |
|
RowData
|
RowData | True | string |
Tekenreeks met rijgegevens die moeten worden bijgewerkt, gescheiden door puntkomma's, moet het eerste element de InternalRecord_Id van de rij zijn om bij te werken, '100' in het volgende voorbeeld: 100; John; Voedster; 2024-01-01; 2024-12-31 |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
userTableUpdateRowResult
|
userTableUpdateRowResult | integer |
userTableUpdateRowResult |
Huidige taak sluiten en gebruiker toewijzen aan volgende taak
Huidige taak sluiten en gebruiker toewijzen aan volgende taak
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
ProcessId
|
ProcessId | True | string |
Id van proces (GUID) |
|
TaskId
|
TaskId | string |
Id van taak (Guid) |
|
|
Comment
|
Comment | string |
Comment |
|
|
AssignUserLoginNames
|
AssignUserLoginNames | True | string |
AssignUserLoginNames |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Handeling
|
action | string |
Actietekst voor de gebruiker. Weergegeven aan de eindgebruiker |
|
assignedUserIds
|
assignedUserIds | array of string |
assignedUserIds |
|
comments
|
comments | array of object |
comments |
|
Datum
|
comments.date | string |
Datum van opmerking |
|
Identiteitsbewijs
|
comments.id | string |
Id van opmerking |
|
Tekst
|
comments.text | string |
Door de gebruiker gedefinieerde opmerking |
|
UserId
|
comments.userId | string |
Id van gebruiker, die de opmerking heeft ingesteld |
|
CompletedDate
|
completedDate | string |
Voltooiingsdatum. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
createdDate | string |
Datum van aanmaak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
creatorId | string |
Gebruikers-id van de maker |
|
Description
|
description | string |
Taakbeschrijving |
|
DueDate
|
dueDate | string |
Einddatum van de taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
beoogdeUserIds
|
intendedUserIds | array of string |
beoogdeUserIds |
|
ReminderDate
|
reminderDate | string |
Datum voor herinnering. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
VereistAllRecipients
|
requiresAllRecipients | boolean |
Definieert of alle geadresseerden deze taak moeten sluiten |
|
ShowCloseTaskDialog
|
showCloseTaskDialog | boolean |
Dialoogvenster Taak sluiten weergeven aan taakeinde |
|
Toestand
|
statusEnum | string |
Status van taak (Openen, InProcess, Voltooid, PreparedToComplete, Fout) |
|
TaskTemplateId
|
taskTemplateId | string |
Taaksjabloon-id |
Logoff
Logoff
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
LogoffResult
|
LogoffResult | string |
Resultaat van afmelden |
Logon
Logon
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
Gebruikersnaam
|
Username | True | string |
Gebruikersnaam voor aanmelding |
|
Wachtwoord
|
Password | True | string |
Wachtwoord |
|
Tenantnaam
|
Tenantname | string |
Tenantnaam voor aanmelding bij |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
ConnectionId
|
connectionId | string |
Bevat de verbindings-id als deze is aangemeld |
|
ConnectionTimeoutSeconds
|
connectionTimeoutSeconds | integer |
Time-out voor verbinding |
|
IsApplicationLicence
|
isApplicationLicence | string |
Is toepassingslicentietype |
|
IsConcurrentLicence
|
isConcurrentLicence | string |
Is gelijktijdig licentietype |
|
IsNamedLicence
|
isNamedLicence | string |
Heeft de naam van het type licentie |
|
IsVerificationCodeNeeded
|
isVerificationCodeNeeded | string |
Is verificatiecode vereist |
|
PossibleTwoWayAuthenticationType
|
possibleTwoWayAuthenticationType | string |
Mogelijk verificatietype in twee richtingen (Geen, E-mail, SMS) |
|
TwoWayAuthenticationTargetMail
|
twoWayAuthenticationTargetMail | string |
Het gemaskeerde e-mailadres waarnaar twoWayAuthentication e-mail verzendt |
PDF-documenten samenvoegen
Twee of meer PDF-documenten samenvoegen in één document
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
DocumentId
|
DocumentId | True | string |
Id van het eerste PDF-document, er wordt een nieuwe versie gemaakt met nieuwe samengevoegde inhoud |
|
DocumentIdToAppend
|
DocumentIdToAppend | True | string |
Document-id's die worden toegevoegd (samengevoegd) in de eerste puntkomma, gescheiden door '77b3c69d-7a9a-4083-9d75-83a5e6f3deca; 82514f19-057c-484f-8ee2-c21df811a928' |
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Maak het uitchecken van het eerste PDF-document ongedaan, indien nodig. Standaard = onwaar |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
naam
|
name | string |
Documentnaam |
|
identiteitskaart
|
id | string |
Document-id |
|
versionId
|
versionId | string |
Documentversie-id |
|
currentVersionId
|
currentVersionId | string |
Huidige versie-id document |
|
protectionDomainId
|
protectionDomainId | string |
Domein-id documentbeveiliging |
|
infoStoreId
|
infoStoreId | string |
InfoStore-id |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Opsomming van status uitchecken |
|
checkOutUserId
|
checkOutUserId | string |
Gebruikers-id uitchecken |
|
properties
|
properties | array of object |
Eigenschappen |
|
propertyTypeId
|
properties.propertyTypeId | string |
Eigenschapstype-id |
|
values
|
properties.values | array of string |
PropertyType-waarden |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultuur
|
properties.globalValues.values.culture | string |
Cultuur van globale waarden |
|
Tekst
|
properties.globalValues.values.text | string |
Tekst van globale waarden |
|
propertyTypeName
|
properties.propertyTypeName | string |
PropertyType-naam |
|
eigenschapsnaam
|
properties.propertyName | string |
Naam van de eigenschap |
|
importTemplateId
|
importTemplateId | string |
Sjabloon-id importeren |
|
blogs
|
blogs | array of object |
Blogs |
|
aanmaakdatum
|
blogs.createdDate | string |
Blog gemaakt op |
|
creatorId
|
blogs.creatorId | string |
Id van blogmaker |
|
Tekst
|
blogs.text | string |
Blogtekst |
|
identiteitskaart
|
blogs.id | string |
Blog-id |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Opsommingslijst voor toegangsrechten |
|
Herinneringen
|
reminders | array of |
Herinneringen |
|
pageCount
|
pageCount | integer |
Aantal pagina's |
|
mainFileLength
|
mainFileLength | integer |
Lengte van hoofdbestand |
|
abonnementen
|
abonnements | array of |
Abonnementen |
|
textAnnotations
|
annotationManager.textAnnotations | array of |
Tekstaantekeningen |
|
rechthoekAnnotations
|
annotationManager.rectangleAnnotations | array of |
Aantekeningen in rechthoeken |
|
postItAnnotations
|
annotationManager.postItAnnotations | array of |
PostIt-aantekeningen |
|
stampAnnotations
|
annotationManager.stampAnnotations | array of |
Stempelaantekeningen |
|
documentData
|
documentData | array of object |
Documentgegevens |
|
identiteitskaart
|
documentData.id | string |
Documentgegevens-id |
|
naam
|
documentData.name | string |
Documentgegevensnaam |
|
Uitleveringen
|
documentData.renditions | array of object |
Uitleveringen |
|
identiteitskaart
|
documentData.renditions.id | string |
Weergave-id |
|
size
|
documentData.renditions.size | string |
Weergavegrootte |
|
files
|
documentData.renditions.files | array of object |
Weergavebestanden |
|
blobStoreId
|
documentData.renditions.files.blobStoreId | string |
Id van weergaveblobarchief |
|
blobPath
|
documentData.renditions.files.blobPath | string |
Blobpad voor weergave |
|
pageCount
|
documentData.renditions.pageCount | string |
Aantal weergavepagina's |
|
uitbreiding
|
documentData.renditions.extension | string |
Weergave-extensie |
|
hashValue
|
documentData.renditions.hashValue | array of integer |
Hash-waarde voor weergave |
|
contentProtections
|
documentData.renditions.contentProtections | array of |
Inhoudsbeveiligingen voor weergaven |
|
signingProfileId
|
signingProfileId | string |
Id van handtekeningprofiel |
|
lifeCycleId
|
lifeCycleManager.lifeCycleId | string |
Levenscyclus-id |
|
lifeCycleStateId
|
lifeCycleManager.lifeCycleStateId | string |
Status-id van levenscyclus |
|
lifeCycleStartDate
|
lifeCycleManager.lifeCycleStartDate | string |
Begindatum levenscyclus |
|
lifeCycleEndDate
|
lifeCycleManager.lifeCycleEndDate | string |
Einddatum levenscyclus |
|
nextLifeCycleStates
|
lifeCycleManager.nextLifeCycleStates | array of |
Volgende levenscyclusstatussen |
|
checkOutLifeCycleStateId
|
lifeCycleManager.checkOutLifeCycleStateId | string |
Status-id van levenscyclus uitchecken |
|
nextAutomaticLifeCycleStateId
|
lifeCycleManager.nextAutomaticLifeCycleStateId | string |
Volgende status-id van de automatische levenscyclus |
|
lifeCycleProtections
|
lifeCycleManager.lifeCycleProtections | array of object |
Levenscyclusbeveiligingen |
|
identiteitskaart
|
lifeCycleManager.lifeCycleProtections.id | string |
Id van levenscyclusbeveiliging |
|
protectionDurationTicks
|
lifeCycleManager.lifeCycleProtections.protectionDurationTicks | integer |
Duur van levenscyclusbescherming |
|
protectCheckOut
|
lifeCycleManager.lifeCycleProtections.protectCheckOut | boolean |
Levenscyclusbeveiliging uitchecken |
|
protectContentChange
|
lifeCycleManager.lifeCycleProtections.protectContentChange | boolean |
Inhoudswijziging voor levenscyclusbeveiliging |
|
protectPropertyChange
|
lifeCycleManager.lifeCycleProtections.protectPropertyChange | boolean |
Wijziging van eigenschap levenscyclusbeveiliging |
|
protectAnnotationChange
|
lifeCycleManager.lifeCycleProtections.protectAnnotationChange | boolean |
Wijziging van aantekening in levenscyclusbeveiliging |
|
protectProtectionDomainChange
|
lifeCycleManager.lifeCycleProtections.protectProtectionDomainChange | boolean |
Levenscyclusbeveiligingsdomeinwijziging |
|
protectDelete
|
lifeCycleManager.lifeCycleProtections.protectDelete | boolean |
Levenscyclusbeveiliging verwijderen |
|
deleteAfterExpiration
|
lifeCycleManager.lifeCycleProtections.deleteAfterExpiration | boolean |
Levenscyclusbeveiliging verwijderen na verloop van tijd |
|
hasOverlay
|
hasOverlay | boolean |
Heeft overlay |
|
sessionCount
|
sessionCount | integer |
Aantal sessies |
|
hasSignature
|
hasSignature | boolean |
Heeft handtekening |
|
hasBlog
|
hasBlog | boolean |
Heeft blog |
|
hasAnnotation
|
hasAnnotation | boolean |
Heeft aantekening |
|
hasTempAccess
|
hasTempAccess | boolean |
Heeft tijdelijke toegang |
|
hasReminders
|
hasReminders | boolean |
Heeft herinneringen |
|
hasLinks
|
hasLinks | boolean |
Bevat koppelingen |
|
hasAbonnement
|
hasAbonnement | boolean |
Heeft abonnement |
Proces maken
Proces maken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
ProcessProperties
|
ProcessProperties | string |
Update-indeling van proceseigenschappen: Voornaam=Peter|Achternaam=Microsoft|InvoiceNo=4711; 4712; 4713 |
|
|
CustomProperties
|
CustomProperties | string |
Aangepaste eigenschappen. Notatie: [<PropertyName> |<PropertyValue> |PropertyType] (bijvoorbeeld [Leverancier|Muster |Tekenreeks][InvoiceDate|2021-01-29T13:05:45 |Date][InvoiceNo|4711|Getal]) |
|
|
DocumentIds
|
DocumentIds | string |
Lijst met alle document-id's die u wilt bijvoegen |
|
|
ProcessTemplateName
|
ProcessTemplateName | True | string |
Naam van processjabloon |
|
DueDate
|
DueDate | string |
Einddatum voor het proces. Datumnotatie: jjjj-MM-ddTHH:mm:ss. Standaard = huidige datum |
|
|
Priority
|
Priority | string |
Prioriteit van proces (bijvoorbeeld Laag, Normaal, Hoog). Standaard = Normaal |
|
|
Comment
|
Comment | string |
Opmerking verwerken |
|
|
Cultuur
|
Culture | string |
De cultuur waarin de tekst wordt gegeven (de, en, fr, ...). Standaard = de |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutState
|
checkOutStateEnum | string |
Status van het document uitchecken (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
checkOutUserId | string |
Id van de gebruiker waarvoor het proces is uitgecheckt |
|
comments
|
comments | array of object |
comments |
|
Datum
|
comments.date | string |
Datum van opmerking |
|
Identiteitsbewijs
|
comments.id | string |
Id van opmerking |
|
Tekst
|
comments.text | string |
Door de gebruiker gedefinieerde opmerking |
|
UserId
|
comments.userId | string |
Gebruikersnaam |
|
CompletedDate
|
completedDate | string |
Voltooiingsdatum. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
completedTasks
|
completedTasks | array of string |
completedTasks |
|
CreatedDate
|
createdDate | string |
Datum van aanmaak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
Handeling
|
currentTask.action | string |
Actietekst voor de gebruiker. Weergegeven aan de eindgebruiker |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
assignedUserIds |
|
comments
|
currentTask.comments | array of string |
comments |
|
CompletedDate
|
currentTask.completedDate | string |
Voltooiingsdatum voor huidige taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
currentTask.createdDate | string |
Aanmaakdatum voor huidige taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
currentTask.creatorId | string |
Gebruikers-id van maker voor huidige taak |
|
Description
|
currentTask.description | string |
Beschrijving van de huidige taak |
|
DueDate
|
currentTask.dueDate | string |
Einddatum van de huidige taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
beoogdeUserIds
|
currentTask.intendedUserIds | array of string |
beoogdeUserIds |
|
ReminderDate
|
currentTask.reminderDate | string |
Datum voor herinnering aan de huidige taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
VereistAllRecipients
|
currentTask.requiresAllRecipients | boolean |
Definieert of alle geadresseerden deze taak moeten sluiten |
|
ShowCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
Dialoogvenster Taak sluiten weergeven aan taakeinde |
|
StatusEnum
|
currentTask.statusEnum | string |
Huidige taak status (Openen, InProcess, Voltooid, PreparedToComplete, Fout) |
|
TaskTemplateId
|
currentTask.taskTemplateId | string |
Sjabloon-id van huidige taak |
|
customProperties
|
customProperties | array of object |
customProperties |
|
CustomPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
Aangepast eigenschapstype enumwaarde (tekenreeks, datum, getal) |
|
Naam
|
customProperties.name | string |
Naam van aangepaste eigenschap |
|
Waarde
|
customProperties.value | string |
Waarde van aangepaste eigenschap |
|
documentIds
|
documentIds | array of string |
documentIds |
|
DueDate
|
dueDate | string |
Einddatum voor het proces. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
FolderElementId
|
folderElementId | string |
Id van document als mapelement |
|
HasLinks
|
hasLinks | boolean |
Id van document als mapelement |
|
Identiteitsbewijs
|
id | string |
Proces-id |
|
values
|
name.values | array of object |
values |
|
Cultuur
|
name.values.culture | string |
De cultuur waarin de tekst wordt gegeven (de, en, fr, ...) |
|
Tekst
|
name.values.text | string |
De tekst voor deze taal |
|
PriorityEnum
|
priorityEnum | string |
Prioriteit van proces (hoog, normaal, laag). Standaard = Normaal |
|
PluginStream
|
pluginStream | string | |
|
ProcessTemplateId
|
processTemplateId | string |
Processjabloon-id |
|
properties
|
properties | array of object |
properties |
|
globalValues
|
properties.globalValues | array of object |
globalValues |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultuur
|
properties.globalValues.values.culture | string |
cultuur |
|
Tekst
|
properties.globalValues.values.text | string |
Tekst |
|
Eigenschapsnaam
|
properties.propertyName | string |
Naam van proceseigenschap |
|
PropertyTypeId
|
properties.propertyTypeId | string |
Id van proceseigenschap |
|
values
|
properties.values | array of string |
values |
|
ProtectionDomainId
|
protectionDomainId | string |
Domein-id van beveiliging van proces |
|
StatusEnum
|
statusEnum | string |
Status van proces (Open, InProcess, Complete, PreparedToComplete, Error) |
Proces ophalen
Proces ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
ProcessId
|
processId | True | string |
Id van proces (GUID) |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
AccessRightsEnumList
|
GetProcessResult.AccessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
GetProcessResult.CheckOutStateEnum | string |
Status van het document uitchecken (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
GetProcessResult.CheckOutUserId | string |
Id van de gebruiker waarvoor het proces is uitgecheckt |
|
Comments
|
GetProcessResult.Comments | array of object |
Comments |
|
Datum
|
GetProcessResult.Comments.Date | string |
Datum van opmerking |
|
Identiteitsbewijs
|
GetProcessResult.Comments.Id | string |
Id van opmerking |
|
Tekst
|
GetProcessResult.Comments.Text | string |
Door de gebruiker gedefinieerde opmerking |
|
UserId
|
GetProcessResult.Comments.UserId | string |
Id van gebruiker, die de opmerking heeft ingesteld |
|
CompletedDate
|
GetProcessResult.CompletedDate | string |
Voltooide datum van het proces. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CompletedTasks
|
GetProcessResult.CompletedTasks | array of object |
CompletedTasks |
|
Handeling
|
GetProcessResult.CompletedTasks.Action | string |
Actietekst voor de gebruiker. Weergegeven aan de eindgebruiker |
|
AssignedUserIds
|
GetProcessResult.CompletedTasks.AssignedUserIds | array of |
assignedUserIds |
|
Comments
|
GetProcessResult.CompletedTasks.Comments | array of object |
Comments |
|
Datum
|
GetProcessResult.CompletedTasks.Comments.Date | string |
Datum van opmerking |
|
Identiteitsbewijs
|
GetProcessResult.CompletedTasks.Comments.Id | string |
Id van opmerking |
|
Tekst
|
GetProcessResult.CompletedTasks.Comments.Text | string |
Door de gebruiker gedefinieerde opmerking |
|
UserId
|
GetProcessResult.CompletedTasks.Comments.UserId | string |
Id van gebruiker, die de opmerking heeft ingesteld |
|
CompletedDate
|
GetProcessResult.CompletedTasks.CompletedDate | string |
Voltooiingsdatum. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
GetProcessResult.CompletedTasks.CompletedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
GetProcessResult.CompletedTasks.CreatedDate | string |
Datum van aanmaak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
GetProcessResult.CompletedTasks.CreatorId | string |
Gebruikers-id van de maker |
|
Description
|
GetProcessResult.CompletedTasks.Description | string |
Taakbeschrijving |
|
DueDate
|
GetProcessResult.CompletedTasks.DueDate | string |
Einddatum van de taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
IntendedUserIds
|
GetProcessResult.CompletedTasks.IntendedUserIds | array of |
beoogdeUserIds |
|
ReminderDate
|
GetProcessResult.CompletedTasks.ReminderDate | string |
Datum voor herinnering. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
VereistAllRecipients
|
GetProcessResult.CompletedTasks.RequiresAllRecipients | boolean |
Definieert of alle geadresseerden deze taak moeten sluiten |
|
ShowCloseTaskDialog
|
GetProcessResult.CompletedTasks.ShowCloseTaskDialog | boolean |
Dialoogvenster Taak sluiten weergeven aan taakeinde |
|
Toestand
|
GetProcessResult.CompletedTasks.StatusEnum | string |
Status van taak (Openen, InProcess, Voltooid, PreparedToComplete, Fout) |
|
TaskTemplateId
|
GetProcessResult.CompletedTasks.TaskTemplateId | string |
Taaksjabloon-id |
|
CreatedDate
|
GetProcessResult.CreatedDate | string |
Aanmaakdatum van het proces. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
Handeling
|
GetProcessResult.CurrentTask.Action | string |
Actietekst voor de gebruiker. Weergegeven aan de eindgebruiker |
|
AssignedUserIds
|
GetProcessResult.CurrentTask.AssignedUserIds | array of string |
AssignedUserIds |
|
Comments
|
GetProcessResult.CurrentTask.Comments | array of string |
Comments |
|
CompletedDate
|
GetProcessResult.CurrentTask.CompletedDate | string |
Voltooiingsdatum. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
GetProcessResult.CurrentTask.CompletedUserIds | array of string |
CompletedUserIds |
|
CreatedDate
|
GetProcessResult.CurrentTask.CreatedDate | string |
Datum van aanmaak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
GetProcessResult.CurrentTask.CreatorId | string |
Gebruikers-id van de maker |
|
Description
|
GetProcessResult.CurrentTask.Description | string |
Taakbeschrijving |
|
DueDate
|
GetProcessResult.CurrentTask.DueDate | string |
Einddatum van de taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
Identiteitsbewijs
|
GetProcessResult.CurrentTask.Id | string |
Id van de taak |
|
IntendedUserIds
|
GetProcessResult.CurrentTask.IntendedUserIds | array of string |
IntendedUserIds |
|
ReminderDate
|
GetProcessResult.CurrentTask.ReminderDate | string |
Datum voor herinnering. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
VereistAllRecipients
|
GetProcessResult.CurrentTask.RequiresAllRecipients | boolean |
Definieert of alle geadresseerden deze taak moeten sluiten |
|
ShowCloseTaskDialog
|
GetProcessResult.CurrentTask.ShowCloseTaskDialog | boolean |
Dialoogvenster Taak sluiten weergeven aan taakeinde |
|
StatusEnum
|
GetProcessResult.CurrentTask.StatusEnum | string |
Status van taak (Openen, InProcess, Voltooid, PreparedToComplete, Fout) |
|
TaskTemplateId
|
GetProcessResult.CurrentTask.TaskTemplateId | string |
Taaksjabloon-id |
|
CustomProperties
|
GetProcessResult.CustomProperties | array of object |
CustomProperties |
|
CustomPropertyTypeEnum
|
GetProcessResult.CustomProperties.CustomPropertyTypeEnum | string |
Lijst met aangepaste eigenschapsgegevenstype (tekenreeks, datum, getal) |
|
Naam
|
GetProcessResult.CustomProperties.Name | string |
Naam van aangepast eigenschapstype |
|
Waarde
|
GetProcessResult.CustomProperties.Value | string |
Waarde van aangepast eigenschapstype |
|
DocumentIds
|
GetProcessResult.DocumentIds | array of string |
DocumentIds |
|
DueDate
|
GetProcessResult.DueDate | string |
Einddatum voor het proces. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
Identiteitsbewijs
|
GetProcessResult.Id | string |
Id van proces |
|
Waarden
|
GetProcessResult.Name.Values | array of object |
Waarden |
|
Cultuur
|
GetProcessResult.Name.Values.Culture | string |
De cultuur waarin de tekst wordt gegeven (de, en, fr, ...) |
|
Tekst
|
GetProcessResult.Name.Values.Text | string |
Tekst |
|
PluginStream
|
GetProcessResult.PluginStream | array of |
PluginStream |
|
PriorityEnum
|
GetProcessResult.PriorityEnum | string |
Prioriteit van proces (hoog, normaal, laag) |
|
ProcessTemplateId
|
GetProcessResult.ProcessTemplateId | string |
Processjabloon-id |
|
Eigenschappen
|
GetProcessResult.Properties | array of object |
Eigenschappen |
|
GlobalValues
|
GetProcessResult.Properties.GlobalValues | array of object |
GlobalValues |
|
Waarden
|
GetProcessResult.Properties.GlobalValues.Values | array of object |
Waarden |
|
Cultuur
|
GetProcessResult.Properties.GlobalValues.Values.Culture | string |
Cultuur |
|
Tekst
|
GetProcessResult.Properties.GlobalValues.Values.Text | string |
Tekst |
|
PropertyTypeId
|
GetProcessResult.Properties.PropertyTypeId | string |
Eigenschapstype-id |
|
Waarden
|
GetProcessResult.Properties.Values | array of string |
Waarden |
|
ProtectionDomainId
|
GetProcessResult.ProtectionDomainId | string |
Domein-id van beveiliging van proces |
|
SessionCount
|
GetProcessResult.SessionCount | integer |
Aantal sessies |
|
StatusEnum
|
GetProcessResult.StatusEnum | string |
Status van proces (Open, InProcess, Complete, PreparedToComplete, Error) |
Proceseigenschappen ophalen
Proceseigenschappen ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
ProcessId
|
ProcessId | True | string |
Id van proces (GUID) |
|
Cultuur
|
Culture | string |
De cultuur waarin de eigenschapsnamen worden gegeven (de, en, fr, ...). Standaard = de |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Eigenschapsnaam
|
propertyName | string |
Naam van proceseigenschap |
|
PropertyTypeId
|
propertyTypeId | string |
Eigenschapstype-id |
|
values
|
values | array of string |
values |
Processen weergeven (afgeschaft) [AFGESCHAFT]
Lijstprocessen (afgeschaft)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
Ontvanger
|
Receiver | string |
Aanmeldingsnamen van ontvangers van processen (bijvoorbeeld: john@sample.com|megan@sample.com). Is leeg, aangemelde gebruiker wordt als ontvanger genomen |
|
|
Toestand
|
Status | string |
Status van proces. Standaard = openen |
|
|
IgnoreReceiver
|
IgnoreReceiver | boolean |
Zo ja, worden alle processen die niet afhankelijk zijn van de ontvanger weergegeven. Standaard = onwaar |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Maximum aantal proceszoekresultaten. Standaard = 100 |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
processes
|
processes | array of object |
processes |
|
accessRightsEnumList
|
processes.accessRightsEnumList | array of string |
accessRightsEnumList |
|
CheckOutStateEnum
|
processes.checkOutStateEnum | string |
Status van het proces uitchecken (NotCheckedOut, CheckedOut, CheckedOutExclusive, Null) |
|
CheckOutUserId
|
processes.checkOutUserId | string |
Id van de gebruiker waarvoor het document is uitgecheckt |
|
comments
|
processes.comments | array of object |
comments |
|
Datum
|
processes.comments.date | string |
Datum van opmerking |
|
Identiteitsbewijs
|
processes.comments.id | string |
Id van opmerking |
|
Tekst
|
processes.comments.text | string |
Door de gebruiker gedefinieerde opmerking |
|
UserId
|
processes.comments.userId | string |
Id van gebruiker, die de opmerking heeft ingesteld |
|
CompletedDate
|
processes.completedDate | string |
Voltooide datum van het proces. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
completedTasks
|
processes.completedTasks | array of object |
completedTasks |
|
Handeling
|
processes.completedTasks.action | string |
Actietekst voor de gebruiker. Weergegeven aan de eindgebruiker |
|
assignedUserIds
|
processes.completedTasks.assignedUserIds | array of |
assignedUserIds |
|
comments
|
processes.completedTasks.comments | array of object |
comments |
|
Datum
|
processes.completedTasks.comments.date | string |
Datum van opmerking |
|
Identiteitsbewijs
|
processes.completedTasks.comments.id | string |
Id van opmerking |
|
Tekst
|
processes.completedTasks.comments.text | string |
Door de gebruiker gedefinieerde opmerking |
|
UserId
|
processes.completedTasks.comments.userId | string |
Id van gebruiker, die de opmerking heeft ingesteld |
|
CompletedDate
|
processes.completedTasks.completedDate | string |
Voltooiingsdatum. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
completedUserIds
|
processes.completedTasks.completedUserIds | array of string |
completedUserIds |
|
CreatedDate
|
processes.completedTasks.createdDate | string |
Datum van aanmaak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
processes.completedTasks.creatorId | string |
Gebruikers-id van de maker |
|
Description
|
processes.completedTasks.description | string |
Taakbeschrijving |
|
DueDate
|
processes.completedTasks.dueDate | string |
Einddatum van de taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
beoogdeUserIds
|
processes.completedTasks.intendedUserIds | array of |
beoogdeUserIds |
|
ReminderDate
|
processes.completedTasks.reminderDate | string |
Datum voor herinnering. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
VereistAllRecipients
|
processes.completedTasks.requiresAllRecipients | boolean |
Definieert of alle geadresseerden deze taak moeten sluiten |
|
ShowCloseTaskDialog
|
processes.completedTasks.showCloseTaskDialog | boolean |
Dialoogvenster Taak sluiten weergeven aan taakeinde |
|
Toestand
|
processes.completedTasks.statusEnum | string |
Status van taak (Openen, InProcess, Voltooid, PreparedToComplete, Fout) |
|
TaskTemplateId
|
processes.completedTasks.taskTemplateId | string |
Taaksjabloon-id |
|
CreatedDate
|
processes.createdDate | string |
Aanmaakdatum van het proces. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CurrentTask
|
processes.currentTask | string |
Momenteel actieve taak |
|
CustomProperties
|
processes.customProperties | string |
Lijst met alle aangepaste eigenschappen |
|
DocumentIds
|
processes.documentIds | string |
Lijst met alle gekoppelde document-id's |
|
DueDate
|
processes.dueDate | string |
Einddatum voor de procesdatumnotatie: jjjj-MM-ddTHH:mm:ss |
|
FolderElementId
|
processes.folderElementId | string |
Id van proces als mapelement |
|
HasLinks
|
processes.hasLinks | boolean |
Vlag toevoegen of het proces koppelingen bevat |
|
Identiteitsbewijs
|
processes.id | string |
Id van proces |
|
values
|
processes.name.values | array of object |
values |
|
cultuur
|
processes.name.values.culture | string |
cultuur |
|
Tekst
|
processes.name.values.text | string |
Tekst |
|
PriorityEnum
|
processes.priorityEnum | string |
Prioriteit van proces (hoog, normaal, laag) |
|
PluginStream
|
processes.pluginStream | string |
Gegevenscontainer voor invoegtoepassingen |
|
ProcessTemplateId
|
processes.processTemplateId | string |
Processjabloon-id |
|
properties
|
processes.properties | array of object |
properties |
|
eigenschapsnaam
|
processes.properties.propertyName | string |
eigenschapsnaam |
|
propertyTypeId
|
processes.properties.propertyTypeId | string |
propertyTypeId |
|
values
|
processes.properties.values | array of string |
values |
|
ProtectionDomainId
|
processes.protectionDomainId | string |
Domein-id van beveiliging van proces |
|
StatusEnum
|
processes.statusEnum | string |
Status van proces (Open, InProcess, Complete, PreparedToComplete, Error) |
|
HasMore
|
hasMore | boolean |
Geeft aan of er meer resultaten bestaan of niet. De vlag is ingesteld op waar als er meer resultaten beschikbaar zijn |
|
CvPoint
|
resumePoint | string |
Het cv-punt van vorige zoekbewerkingen. Null instellen voor de eerste zoekbewerking |
Proceszoekopdracht
Proceszoekopdracht
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
Conditions
|
Conditions | string |
Indeling van zoekvoorwaarde: [<PropertyName>|<ComparisonEnum> |<PropertyValue> |<RelationEnum>]. ComparisonEnums: "Equals,NotEquals,Greater,GreaterEquals,Less,LessEquals,Like,Contains,EqualsUndefined,In,None,Soundex,NotIn,Between" RelationEnums:"And,Or". bijvoorbeeld: [Laatste check in|Minder|2021-12-31|En],[Voornaam|Is gelijk aan|Peter|En],[Datum|Tussen|2021-12-31; 2022-12-31 |En] |
|
|
ResultProperties
|
ResultProperties | string |
Lijst met resultaateigenschappen, gescheiden door komma's. Kan de naam of id van de eigenschap zijn, zoals 'Naam,Laatste check in,68b901cd-4d8f-11e6-aa6f-00ff04d7e62a' |
|
|
MaxSerchResults
|
MaxSerchResults | string |
Maximum aantal zoekresultaten voor documenten. Standaard = 100 |
|
|
Cultuur
|
Culture | string |
De cultuur waarin de tekst wordt gegeven (de, en, fr, ...). Standaard = de |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
processes
|
processes | array of object |
Resultaat van proceszoekopdracht |
|
values
|
processes.name.values | array of object |
Vastgoedwaarden |
|
cultuur
|
processes.name.values.culture | string |
Eigenschapscultuur |
|
Tekst
|
processes.name.values.text | string |
Eigenschapstekst |
|
identiteitskaart
|
processes.id | string |
Proces-id |
|
folderElementId
|
processes.folderElementId | string |
Mapelement-id |
|
checkOutStateEnum
|
processes.checkOutStateEnum | string |
Opsomming van status uitchecken |
|
properties
|
processes.properties | array of object |
Eigenschappen |
|
propertyTypeId
|
processes.properties.propertyTypeId | string |
Eigenschapstype-id |
|
values
|
processes.properties.values | array of string |
Vastgoedwaarden |
|
globalValues
|
processes.properties.globalValues | array of object |
Globale waarden |
|
values
|
processes.properties.globalValues.values | array of object |
values |
|
cultuur
|
processes.properties.globalValues.values.culture | string |
Cultuur van wereldwijde waarde |
|
Tekst
|
processes.properties.globalValues.values.text | string |
Algemene waardetekst |
|
propertyTypeName
|
processes.properties.propertyTypeName | string |
PropertyType-naam |
|
eigenschapsnaam
|
processes.properties.propertyName | string |
Naam van de eigenschap |
|
priorityEnum
|
processes.priorityEnum | string |
Opsomming van prioriteit |
|
statusEnum
|
processes.statusEnum | string |
Status enum |
|
vervaldatum
|
processes.dueDate | string |
Vervaldag |
|
hasLinks
|
processes.hasLinks | boolean |
Bevat koppelingen |
|
accessRightsEnumList
|
processes.accessRightsEnumList | array of string |
Opsommingslijst voor toegangsrechten |
|
hasMore
|
hasMore | boolean |
Heeft meer |
|
cvPoint
|
resumePoint | string |
Cv-punt |
Rijen in gebruikerstabellen verwijderen
Rijen in gebruikerstabellen verwijderen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
UserTable
|
UserTable | True | string |
Naam van gebruikerstabel |
|
WhereClause
|
WhereClause | string |
Een lijst met SQL where-componentelementen. Notatie: [<PropertyName> |<ComparisonEnum> |<PropertyValue> |<RelationEnum>]. ComparisonEnums: "Is gelijk aan,NotEquals,Greater,GreaterEquals,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (bijvoorbeeld: [Voornaam|Is gelijk aan|Jon|AND],[Achternaam|Is gelijk aan|Doe|OR]) |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
userTableDeleteRecordsResult
|
userTableDeleteRecordsResult | integer |
userTableDeleteRecordsResult |
Rijen invoegen in een gebruikerstabel
Tabelrijen importeren in een gebruikerstabel
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
UserTable
|
UserTable | True | string |
Naam van de gebruikerstabel |
|
Waarden
|
Values | True | string |
Lijst met rij- en kolomwaarden die moeten worden ingevoegd (bijvoorbeeld: [John; Voedster; New York],[Peter; Monsteren; Bern]) |
|
DeleteAllValues
|
DeleteAllValues | boolean |
Hiermee definieert u of alle waarden in UserTable moeten worden verwijderd (standaard = onwaar) |
|
|
FirstRowContainsColumnHeaders
|
FirstRowContainsColumnHeaders | boolean |
Hiermee definieert u of de eerste rij van de parameter waarden kolomkoppen bevat (standaard = onwaar) |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebruikerstabel
|
userTable | string |
Naam van gebruikerstabel |
|
Ingevoegde rijen
|
insertedRows | integer |
Aantal ingevoegde rijen |
Rijen ophalen uit een gebruikerstabel
Rijen ophalen uit een gebruikerstabel
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
UserTable
|
UserTable | True | string |
Naam van de gebruikerstabel |
|
WhereClause
|
WhereClause | string |
Een lijst met SQL where-componentelementen. Notatie: [<ColumnName> |<ComparisonEnum> |<PropertyValue> |<RelationEnum>]. ComparisonEnums: "Is gelijk aan,NotEquals,Greater,GreaterEquals,LessEquals,Like,NotLike" RelationEnums:"AND,OR" (bijvoorbeeld: [Voornaam|Is gelijk aan|Jon|AND],[Achternaam|Is gelijk aan|Doe|AND]) |
|
|
OrderByClause
|
OrderByClause | string |
Een lijst met SQL-volgorde per componentelementen (bijvoorbeeld: Voornaam[ASC],Plaats[DESC]) |
|
|
AddColumnHeaders
|
AddColumnHeaders | boolean |
Voegt kolomkoppen toe als eerste rij (standaard = onwaar) |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
UserTableGetRecordsResult
|
UserTableGetRecordsResult | array of array |
UserTableGetRecordsResult |
|
items
|
UserTableGetRecordsResult | array of string |
Selectie van documenten en processen ophalen
Documenten en processen ophalen die zijn geselecteerd op Mobile Web Client via aangepaste knopactie
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
SelectionId
|
SelectionId | True | string |
De selectie-id van geselecteerde documenten en processen in de mobiele webclient via aangepaste knopactie |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string |
Selectie-id |
|
identiteitskaart
|
parentObjectId.id | string |
Lijst-id van bovenliggend object in Mobile Web Client |
|
objectId
|
parentObjectId.objectId | string |
Object-id van bovenliggend object (Document, Proces,...) |
|
objectTypeEnum
|
parentObjectId.objectTypeEnum | string |
ObjectTypeEnum van bovenliggend object - bijvoorbeeld Document, Proces, ... |
|
objectIds
|
objectIds | array of object |
Geselecteerde documenten en processen in Mobile Web Client |
|
identiteitskaart
|
objectIds.id | string |
Lijst-id van mobiele webclient |
|
objectId
|
objectIds.objectId | string |
Object-id van geselecteerd document of proces in Mobile Web Client |
|
objectTypeEnum
|
objectIds.objectTypeEnum | string |
ObjectTypeEnum van geselecteerd document of proces in mobiele webclient |
|
allObjectIds
|
allObjectIds | array of object |
Geselecteerde en niet-geselecteerde documenten en processen in Mobile Web Client |
|
identiteitskaart
|
allObjectIds.id | string |
Lijst-id van mobiele webclient |
|
objectId
|
allObjectIds.objectId | string |
Object-id van geselecteerd en niet-geselecteerd document of proces in Mobile Web Client |
|
objectTypeEnum
|
allObjectIds.objectTypeEnum | string |
ObjectTypeEnum van geselecteerd en niet-geselecteerd document of proces in Mobile Web Client |
Taak sluiten en proces voortzetten
Taak sluiten en proces voortzetten
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
connectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
ProcessId
|
processId | True | string |
Id van proces (GUID) |
|
Comment
|
comment | string |
Opmerking om toe te voegen |
|
|
TaskId
|
taskId | string |
Taak-id |
|
|
AssignUsers
|
assignUsers | True | boolean |
Toewijzen aan gebruikers. Als deze optie is ingesteld op nee, wijst u de gebruiker toe met het actie-updateproces |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Handeling
|
action | string |
Actietekst voor de gebruiker. Weergegeven aan de eindgebruiker |
|
AssignedUserIds
|
assignedUserIds | string |
Lijst met toegewezen gebruikers-id's |
|
comments
|
comments | array of object |
comments |
|
Datum
|
comments.date | string |
Datum van opmerking |
|
Identiteitsbewijs
|
comments.id | string |
Id van opmerking |
|
Tekst
|
comments.text | string |
Door de gebruiker gedefinieerde opmerking |
|
UserId
|
comments.userId | string |
Gebruikersnaam |
|
CompletedDate
|
completedDate | string |
Voltooiingsdatum. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CompletedUserIds
|
completedUserIds | string |
Lijst met alle voltooide gebruikers-id's |
|
CreatedDate
|
createdDate | string |
Datum van aanmaak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
CreatorId
|
creatorId | string |
Gebruikers-id van de maker |
|
Description
|
description | string |
Taakbeschrijving |
|
DueDate
|
dueDate | string |
Einddatum van de taak. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
IntendedUserIds
|
intendedUserIds | string |
Beoogde gebruikers voor deze taak |
|
ReminderDate
|
reminderDate | string |
Datum voor herinnering. Datumnotatie: jjjj-MM-ddTHH:mm:ss |
|
VereistAllRecipients
|
requiresAllRecipients | boolean |
Definieert of alle geadresseerden deze taak moeten sluiten |
|
ShowCloseTaskDialog
|
showCloseTaskDialog | boolean |
Dialoogvenster Taak sluiten weergeven aan taakeinde |
|
Toestand
|
statusEnum | string |
Status van taak (Openen, InProcess, Voltooid, PreparedToComplete, Fout) |
|
TaskTemplateId
|
taskTemplateId | string |
Taaksjabloon-id |
Updateproces (afgeschaft) [AFGESCHAFT]
Updateproces (afgeschaft)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
ProcessId
|
ProcessId | True | string |
Id van proces (GUID) |
|
AssignUserLoginNames
|
AssignUserLoginNames | string |
Wijs aanmeldingsnamen van gebruikers toe aan de huidige taak. (bijvoorbeeld: peter.muster@kendox.com;megan.muster@kendox.com) |
|
|
ProcessProperties
|
ProcessProperties | string |
Update-indeling van proceseigenschappen: Voornaam=Peter|Achternaam=Microsoft|InvoiceNo=4711; 4712; 4713 |
|
|
Aangepaste eigenschappen
|
CustomProperties | string |
Aangepaste eigenschappen. Notatie: [<PropertyName> |<PropertyValue> |PropertyType] (bijvoorbeeld [Leverancier|Muster |Tekenreeks][InvoiceDate|2021-01-29T13:05:45 |Date][InvoiceNo|4711|Getal]) |
|
|
Comment
|
Comment | string |
Comment |
|
|
Cultuur
|
Culture | string |
De cultuur waarin de eigenschapsnamen worden gegeven (de, en, fr, ...). Standaard = de |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
values
|
name.values | array of object |
values |
|
cultuur
|
name.values.culture | string |
cultuur |
|
Tekst
|
name.values.text | string |
Tekst |
|
values
|
description.values | array of object |
values |
|
cultuur
|
description.values.culture | string |
cultuur |
|
Tekst
|
description.values.text | string |
Tekst |
|
identiteitskaart
|
id | string |
identiteitskaart |
|
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 |
|
cultuur
|
properties.globalValues.values.culture | string |
cultuur |
|
Tekst
|
properties.globalValues.values.text | string |
Tekst |
|
propertyTypeName
|
properties.propertyTypeName | string |
propertyTypeName |
|
eigenschapsnaam
|
properties.propertyName | string |
eigenschapsnaam |
|
priorityEnum
|
priorityEnum | string |
priorityEnum |
|
pluginStream
|
pluginStream | string |
pluginStream |
|
vervaldatum
|
dueDate | string |
vervaldatum |
|
aanmaakdatum
|
createdDate | string |
aanmaakdatum |
|
completedDate
|
completedDate | string |
completedDate |
|
comments
|
comments | array of object |
comments |
|
identiteitskaart
|
comments.id | string |
identiteitskaart |
|
date
|
comments.date | string |
date |
|
userId
|
comments.userId | string |
userId |
|
Tekst
|
comments.text | string |
Tekst |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
accessRightsEnumList |
|
statusEnum
|
statusEnum | string |
statusEnum |
|
customProperties
|
customProperties | array of object |
customProperties |
|
naam
|
customProperties.name | string |
naam |
|
waarde
|
customProperties.value | string |
waarde |
|
customPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
customPropertyTypeEnum |
|
identiteitskaart
|
currentTask.id | string |
identiteitskaart |
|
action
|
currentTask.action | string |
action |
|
creatorId
|
currentTask.creatorId | string |
creatorId |
|
vervaldatum
|
currentTask.dueDate | string |
vervaldatum |
|
aanmaakdatum
|
currentTask.createdDate | string |
aanmaakdatum |
|
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 |
|
beschrijving
|
currentTask.description | string |
beschrijving |
|
vereistAllRecipients
|
currentTask.requiresAllRecipients | boolean |
vereistAllRecipients |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
assignedUserIds |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
completedUserIds |
|
showCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
showCloseTaskDialog |
|
beoogdeUserIds
|
currentTask.intendedUserIds | array of |
beoogdeUserIds |
|
values
|
currentTask.nameGlobal.values | array of object |
values |
|
cultuur
|
currentTask.nameGlobal.values.culture | string |
cultuur |
|
Tekst
|
currentTask.nameGlobal.values.text | string |
Tekst |
|
values
|
currentTask.descriptionGlobal.values | array of object |
values |
|
cultuur
|
currentTask.descriptionGlobal.values.culture | string |
cultuur |
|
Tekst
|
currentTask.descriptionGlobal.values.text | string |
Tekst |
|
assignedUserCCIds
|
currentTask.assignedUserCCIds | array of |
assignedUserCCIds |
|
putyRepresentations
|
currentTask.deputyRepresentations | array of |
putyRepresentations |
|
taskActionEnum
|
currentTask.taskActionEnum | string |
taskActionEnum |
|
completedTasks
|
completedTasks | array of object |
completedTasks |
|
identiteitskaart
|
completedTasks.id | string |
identiteitskaart |
|
action
|
completedTasks.action | string |
action |
|
creatorId
|
completedTasks.creatorId | string |
creatorId |
|
vervaldatum
|
completedTasks.dueDate | string |
vervaldatum |
|
aanmaakdatum
|
completedTasks.createdDate | string |
aanmaakdatum |
|
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 |
|
beschrijving
|
completedTasks.description | string |
beschrijving |
|
vereistAllRecipients
|
completedTasks.requiresAllRecipients | boolean |
vereistAllRecipients |
|
assignedUserIds
|
completedTasks.assignedUserIds | array of string |
assignedUserIds |
|
completedUserIds
|
completedTasks.completedUserIds | array of string |
completedUserIds |
|
showCloseTaskDialog
|
completedTasks.showCloseTaskDialog | boolean |
showCloseTaskDialog |
|
beoogdeUserIds
|
completedTasks.intendedUserIds | array of |
beoogdeUserIds |
|
values
|
completedTasks.nameGlobal.values | array of object |
values |
|
cultuur
|
completedTasks.nameGlobal.values.culture | string |
cultuur |
|
Tekst
|
completedTasks.nameGlobal.values.text | string |
Tekst |
|
values
|
completedTasks.descriptionGlobal.values | array of object |
values |
|
cultuur
|
completedTasks.descriptionGlobal.values.culture | string |
cultuur |
|
Tekst
|
completedTasks.descriptionGlobal.values.text | string |
Tekst |
|
assignedUserCCIds
|
completedTasks.assignedUserCCIds | array of |
assignedUserCCIds |
|
putyRepresentations
|
completedTasks.deputyRepresentations | array of |
putyRepresentations |
|
taskActionEnum
|
completedTasks.taskActionEnum | string |
taskActionEnum |
|
documentIds
|
documentIds | array of string |
documentIds |
|
checkOutStateEnum
|
checkOutStateEnum | string |
checkOutStateEnum |
|
checkOutUserId
|
checkOutUserId | string |
checkOutUserId |
|
sessionCount
|
sessionCount | integer |
sessionCount |
Updateproces (V2)
Updateproces (V2)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
ArchiveUrl
|
ArchiveUrl | True | string |
URL van archief-API (bijvoorbeeld: https://documentarchive.ch/sdk/wcfJSON) |
|
ConnectionId
|
ConnectionId | True | string |
De verbindings-id om uw verbinding te identificeren |
|
ProcessId
|
ProcessId | True | string |
Id van proces (GUID) |
|
ProcessProperties
|
ProcessProperties | string |
Update-indeling van proceseigenschappen: Voornaam=Peter|Achternaam=Microsoft|InvoiceNo=4711; 4712; 4713 |
|
|
RemoveProcessProperties
|
RemoveProcessProperties | string |
Lijst met door puntkomma's gescheiden eigenschapsnamen of id's die moeten worden verwijderd uit het proces, zoals FistName; b9cfbdf7-f6fb-4179-91c8-d9681fb680dd; Afdelingen" |
|
|
CustomProperties
|
CustomProperties | string |
Aangepaste eigenschappen. Notatie: [<PropertyName> |<PropertyValue> |PropertyType] (bijvoorbeeld [Leverancier|Muster |Tekenreeks][InvoiceDate|2021-01-29T13:05:45 |Date][InvoiceNo|4711|Getal]) |
|
|
Comment
|
Comment | string |
Een tekst voor een procescommentaar toevoegen |
|
|
AssignUserLoginNames
|
AssignUserLoginNames | string |
De toegewezen gebruikersaanmeldingsnamen, gescheiden door puntkomma's, zoals gebruiker1; gebruiker2 |
|
|
AddDocumentIds
|
AddDocumentIds | string |
Door puntkomma's gescheiden lijst met document-id's die aan het proces moeten worden toegevoegd, bijvoorbeeld '1450c90e-2783-419b-b428-6ffa3b7cabe2; 0339a105-e06a-4af4-8fa2-d0b6b837fc16' |
|
|
RemoveDocumentIds
|
RemoveDocumentIds | string |
Door puntkomma's gescheiden lijst met document-id's die moeten worden verwijderd uit het proces, bijvoorbeeld '1450c90e-2783-419b-b428-6ffa3b7cabe2; 0339a105-e06a-4af4-8fa2-d0b6b837fc16' |
|
|
DueDate
|
DueDate | string |
Einddatum voor het proces. Datumnotatie: jjjj-MM-ddTHH:mm:ss. Standaard = huidige datum |
|
|
Priority
|
Priority | string |
Prioriteit van proces (bijvoorbeeld Laag, Normaal, Hoog). Standaard = Normaal |
|
|
Cultuur
|
Culture | string |
De cultuur waarin de tekst wordt gegeven (de, en, fr, ...). Standaard = de |
|
|
ForceUndoCheckout
|
ForceUndoCheckout | boolean |
Het uitchecken van het proces geforceerd ongedaan maken, indien nodig |
|
|
Beveiligingsdomein
|
ProtectionDomain | string |
Beveiligingsdomein-id of -naam |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
values
|
name.values | array of object |
Vastgoedwaarden |
|
cultuur
|
name.values.culture | string |
Eigenschapscultuur |
|
Tekst
|
name.values.text | string |
Eigenschapstekst |
|
values
|
description.values | array of object |
values |
|
cultuur
|
description.values.culture | string |
Eigenschapscultuur |
|
Tekst
|
description.values.text | string |
Eigenschapstekst |
|
identiteitskaart
|
id | string |
Proces-id |
|
protectionDomainId
|
protectionDomainId | string |
Domein-id voor procesbeveiliging |
|
processTemplateId
|
processTemplateId | string |
Processjabloon-id |
|
properties
|
properties | array of object |
Eigenschappen |
|
propertyTypeId
|
properties.propertyTypeId | string |
Eigenschapstype-id |
|
values
|
properties.values | array of string |
Vastgoedwaarden |
|
globalValues
|
properties.globalValues | array of object |
Globale waarden |
|
values
|
properties.globalValues.values | array of object |
values |
|
cultuur
|
properties.globalValues.values.culture | string |
Cultuur van wereldwijde waarde |
|
Tekst
|
properties.globalValues.values.text | string |
Algemene waardetekst |
|
propertyTypeName
|
properties.propertyTypeName | string |
PropertyType-naam |
|
eigenschapsnaam
|
properties.propertyName | string |
Naam van de eigenschap |
|
priorityEnum
|
priorityEnum | string |
Opsomming van procesprioriteit |
|
pluginStream
|
pluginStream | string |
Procesinvoegtoepassingsstroom |
|
vervaldatum
|
dueDate | string |
Einddatum verwerken |
|
aanmaakdatum
|
createdDate | string |
Proces gemaakt op |
|
completedDate
|
completedDate | string |
Voltooide datum van proces |
|
comments
|
comments | array of object |
Comments |
|
identiteitskaart
|
comments.id | string |
Opmerking-id verwerken |
|
date
|
comments.date | string |
Datum van opmerking verwerken |
|
userId
|
comments.userId | string |
Gebruikers-id van opmerking verwerken |
|
Tekst
|
comments.text | string |
Tekst van opmerking verwerken |
|
accessRightsEnumList
|
accessRightsEnumList | array of string |
Opsommingslijst voor toegangsrechten |
|
statusEnum
|
statusEnum | string |
Status enum |
|
customProperties
|
customProperties | array of object |
Aangepaste eigenschappen |
|
naam
|
customProperties.name | string |
Naam van aangepaste eigenschap |
|
waarde
|
customProperties.value | string |
Aangepaste eigenschapswaarde |
|
customPropertyTypeEnum
|
customProperties.customPropertyTypeEnum | string |
Aangepast eigenschapstype enum |
|
identiteitskaart
|
currentTask.id | string |
Huidige taak-id |
|
action
|
currentTask.action | string |
Huidige taakactie |
|
creatorId
|
currentTask.creatorId | string |
Huidige taakmaker-id |
|
vervaldatum
|
currentTask.dueDate | string |
Einddatum van huidige taak |
|
aanmaakdatum
|
currentTask.createdDate | string |
Huidige taak gemaakt op |
|
completedDate
|
currentTask.completedDate | string |
Huidige taak voltooide datum |
|
taskTemplateId
|
currentTask.taskTemplateId | string |
Huidige taaksjabloon-id |
|
comments
|
currentTask.comments | array of |
Huidige taakopmerkingen |
|
reminderDate
|
currentTask.reminderDate | string |
Datum van huidige taakherinnering |
|
statusEnum
|
currentTask.statusEnum | string |
Huidige taakstatussenum |
|
beschrijving
|
currentTask.description | string |
Huidige taakbeschrijving |
|
vereistAllRecipients
|
currentTask.requiresAllRecipients | boolean |
Voor de huidige taak zijn alle geadresseerden vereist |
|
assignedUserIds
|
currentTask.assignedUserIds | array of string |
Huidige taak toegewezen gebruikers-id's |
|
completedUserIds
|
currentTask.completedUserIds | array of string |
Huidige taak voltooide gebruikers-id's |
|
showCloseTaskDialog
|
currentTask.showCloseTaskDialog | boolean |
Dialoogvenster Taak sluiten weergeven huidige taak |
|
beoogdeUserIds
|
currentTask.intendedUserIds | array of |
Huidige taak beoogde gebruikers-id's |
|
values
|
currentTask.nameGlobal.values | array of object |
values |
|
cultuur
|
currentTask.nameGlobal.values.culture | string |
Globale naamcultuur |
|
Tekst
|
currentTask.nameGlobal.values.text | string |
Algemene naamtekst |
|
values
|
currentTask.descriptionGlobal.values | array of object |
values |
|
cultuur
|
currentTask.descriptionGlobal.values.culture | string |
Cultuur voor globale beschrijving |
|
Tekst
|
currentTask.descriptionGlobal.values.text | string |
Algemene beschrijvingstekst |
|
assignedUserCCIds
|
currentTask.assignedUserCCIds | array of |
Toegewezen gebruikers-CC-id's |
|
putyRepresentations
|
currentTask.deputyRepresentations | array of |
Plaatsvervangende vertegenwoordigingen |
|
taskActionEnum
|
currentTask.taskActionEnum | string |
Opsomming van taakactie |
|
completedTasks
|
completedTasks | array of object |
Voltooide taken |
|
identiteitskaart
|
completedTasks.id | string |
Voltooide taak-id |
|
action
|
completedTasks.action | string |
Voltooide taakactie |
|
creatorId
|
completedTasks.creatorId | string |
Voltooide taakmaker-id |
|
vervaldatum
|
completedTasks.dueDate | string |
Einddatum voltooide taak |
|
aanmaakdatum
|
completedTasks.createdDate | string |
Voltooide taak gemaakt op |
|
completedDate
|
completedTasks.completedDate | string |
Voltooide taakdatum |
|
taskTemplateId
|
completedTasks.taskTemplateId | string |
Taaksjabloon-id voltooid |
|
comments
|
completedTasks.comments | array of |
Voltooide taakopmerkingen |
|
reminderDate
|
completedTasks.reminderDate | string |
Datum van voltooide taakherinnering |
|
statusEnum
|
completedTasks.statusEnum | string |
Opsomming voltooide taakstatus |
|
beschrijving
|
completedTasks.description | string |
beschrijving |
|
vereistAllRecipients
|
completedTasks.requiresAllRecipients | boolean |
Voltooide taak vereist alle geadresseerden |
|
assignedUserIds
|
completedTasks.assignedUserIds | array of string |
Voltooide taak toegewezen gebruikers-id's |
|
completedUserIds
|
completedTasks.completedUserIds | array of string |
Voltooide taak voltooide gebruikers-id's |
|
showCloseTaskDialog
|
completedTasks.showCloseTaskDialog | boolean |
Dialoogvenster Voltooide taak weergeven |
|
beoogdeUserIds
|
completedTasks.intendedUserIds | array of |
Voltooide taak met beoogde gebruikers-id's |
|
values
|
completedTasks.nameGlobal.values | array of object |
values |
|
cultuur
|
completedTasks.nameGlobal.values.culture | string |
Globale naamcultuur |
|
Tekst
|
completedTasks.nameGlobal.values.text | string |
Algemene naamtekst |
|
values
|
completedTasks.descriptionGlobal.values | array of object |
values |
|
cultuur
|
completedTasks.descriptionGlobal.values.culture | string |
Cultuur voor globale beschrijving |
|
Tekst
|
completedTasks.descriptionGlobal.values.text | string |
Algemene beschrijvingstekst |
|
assignedUserCCIds
|
completedTasks.assignedUserCCIds | array of |
Voltooide taak waaraan cc-id's van gebruiker zijn toegewezen |
|
putyRepresentations
|
completedTasks.deputyRepresentations | array of |
Voltooide taakdeputy-representaties |
|
taskActionEnum
|
completedTasks.taskActionEnum | string |
Opsomming voltooide taaktaakactie |
|
documentIds
|
documentIds | array of string |
Voltooide taakdocument-id's |
|
checkOutStateEnum
|
checkOutStateEnum | string |
Status van voltooide taak bekijken |
|
checkOutUserId
|
checkOutUserId | string |
Voltooide taak: gebruikers-id uitchecken |
|
sessionCount
|
sessionCount | integer |
Aantal voltooide taaksessies |