Delen via

HighQ (preview)

Deze connector maakt beveiligde en geverifieerde toegang tot HighQ API's mogelijk, waardoor naadloze integratie van mogelijkheden voor samenwerking en inhoudsbeheer in aangepaste werkstromen en toepassingen mogelijk is. Het ondersteunt documentautomatisering, gegevenssynchronisatie en werkstroomindeling, waardoor juridische en professionele servicesteams bewerkingen kunnen stroomlijnen, handmatige inspanningen kunnen verminderen en de productiviteit kunnen verbeteren.

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 Highq
URL https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support
E-mailen highq-support@thomsonreuters.com
Connectormetagegevens
Uitgever De plaats Van Den 1000
Webpagina https://legal.thomsonreuters.com/en/products/highq
Privacybeleid https://www.thomsonreuters.com/en/privacy-statement
Categorieën Samenwerking; Inhoud en bestanden

HighQ

Overzicht

HighQ biedt naadloze, veilige, geverifieerde toegang tot HighQ-API's. Deze connector maakt naadloze interactie mogelijk met verschillende HighQ-services, waaronder de ISheet-module, documentresource-API's, ISheet-beheer-API en gebruikersbewerkingen. Het is ontworpen om integratie met het HighQ Collaborate-platform te vergemakkelijken, met functies zoals het ophalen en maken van iSheet-items, het beheren van documentbestanden en het beheren van gebruikersaccounts.

  • Connectorversie: 1.0.0
  • Titel: HighQ
  • Beschrijving: Deze connector biedt naadloze, beveiligde en geverifieerde toegang tot HighQ-API's.
  • Contact:

Authenticatie

De connector maakt gebruik van dynamische omgevingsvariabelen voor beveiligde connectiviteit:

  • Host: @environmentVariables("highqt_host")
  • Basispad: /@environmentVariables("highqt_instancename")/api
  • Client-id:@environmentVariables("highqt_clientid")
  • Clientgeheim:@environmentVariables("highqt_clientsecret")

Raadpleeg de HighQ Technical Support-portal of neem contact op met de ondersteuning van HighQ voor gedetailleerde verificatieprocedures.

Connectorbewerkingen

ISheet-module

  • iSheet-items ophalen
    GET /{version}/isheet/{isheetid}/items
    Hiermee wordt een lijst met items in het opgegeven iSheet opgehaald.

  • iSheet-items maken
    POST /{version}/isheet/{isheetid}/items
    Voegt nieuwe items in een iSheet in, met ondersteuning voor meerdere iSheets en statustracering via progressieve sleutels.

Resource-API's voor documenten

  • Bestandsgegevens ophalen
    GET /{version}/files/{fileid}
    Haalt gedetailleerde informatie op over een specifiek bestand op het HighQ Collaborate-platform.

  • Een bestand uploaden
    POST /{version}/files/content
    Uploadt een bestand naar een opgegeven map, met ondersteuning voor gesegmenteerde uploads wanneer de Content-Range header wordt opgegeven.

  • Mappenlijst ophalen
    GET /{version}/folders/{folderid}/items
    Hiermee haalt u een lijst met mappen in de opgegeven map op met ondersteuning voor sorteren en paginering.

ISheet Admin API

  • iSheet-kolommen ophalen
    GET /{version}/isheets/admin/{isheetid}/columns
    Hiermee worden kolomconfiguraties voor een bepaald iSheet opgehaald.

Gebruikersbewerkingen

  • Gebruikers ophalen
    GET /{version}/users
    Hiermee haalt u een lijst met gebruikers op met ondersteuning voor filteren, pagineren en gedetailleerde gebruikersrollen.

  • Een nieuwe gebruiker toevoegen
    POST /{version}/users
    Hiermee maakt u een nieuw gebruikersaccount met uitgebreide kenmerken en validatie.

  • Een gebruiker archiveren
    DELETE /{version}/users/{userid}
    Hiermee wordt een bestaande gebruiker van het systeem gearchiveerd.

Document- en sitebeheer

  • Een map maken
    POST /{version}/folders
    Hiermee maakt u een nieuwe map onder een opgegeven bovenliggende map.

  • Documenten verplaatsen
    PUT /{version}/files/move
    Hiermee verplaatst u een of meer bestanden van de ene map naar de andere binnen dezelfde site.

  • Bewerkingen voor sitebeheer:

    • Bestaande groep toevoegen aan site: POST /{version}/sites/{siteid}/groups/{groupid}
    • Sitegroep bijwerken: PUT /{version}/sites/{siteid}/groups/{groupid}
    • Een nieuwe site toevoegen: POST /{version}/sites

Aan de slag komen

  1. Configuratie:

    • Definieer de omgevingsvariabelen highqt_host en highqt_instancename in uw Power Platform-omgeving.

  2. Verificatie:

    • Volg de richtlijnen van HighQ om beveiligde verificatie voor API-aanvragen te configureren.

  3. Gebruik:

    • Importeer de HighQ in uw Power Platform-exemplaar.
    • Gebruik indien nodig de beschikbare bewerkingen. Raadpleeg de bovenstaande bewerkingssamenvattingen voor richtlijnen.

Parameters en instellingen

  • Padparameters:
    Neem de vereiste parameters op, zoals version, isheetidfileid, , en folderiduserid indien van toepassing.

  • Queryparameters:
    Optionele parameters zoals sheetviewid, sortcolumnid, limiten offset zijn beschikbaar om API-antwoorden te verfijnen.

  • Hoofdtekstparameters:
    Voor bewerkingen waarvoor een aanvraagbody is vereist (bijvoorbeeld het maken van iSheet-items of gebruikers), moet u ervoor zorgen dat de aanvraag voldoet aan de gedefinieerde schema's (zoals isheetDBOFolderDBO, of IntegrationUserDBO).

Problemen oplossen en beperkingen

  • Foutcodes:
    Standaard-HTTP-statuscodes worden gebruikt voor bewerkingen:

    • 200 voor geslaagde bewerkingen
    • 401 voor onbevoegde toegang
    • 403 voor verboden of validatiefouten
    • 405 voor ongeldige HTTP-methoden
    • 500 voor interne serverfouten
      Raadpleeg de afzonderlijke API-documentatie voor gedetailleerde foutbeschrijvingen.

  • Beperkingen:
    Sommige eindpunten hebben mogelijk standaardlimieten (bijvoorbeeld een standaardwaarde limit van 100 records). Er zijn mogelijk extra parameters vereist voor het sorteren en filteren van grote gegevenssets.

Aanvullende informatiebronnen

Raadpleeg voor meer gedetailleerde informatie en uitgebreide documentatie:

Licenties en ondersteuning

Voor licentiegegevens en technische ondersteuning:

Beperkingslimieten

Name Aanroepen Verlengingsperiode
API-aanroepen per verbinding 100 60 seconden

Acties

Archiefgebruiker

Deze API-aanroep wordt gebruikt om een gebruiker in het systeem te archiveren.

Foutcodes

Samenvatting Verw-code (vóór V4) Verw-code (V4)

De volgende gebruikers bestaan niet in het systeem

 110 110

Een gebruikers-id is vereist

 109 109

Gebruikers-id heeft niet de juiste indeling

 113 113

De lengte van de gebruikers-id mag niet langer zijn dan 50 tekens

 N/A 304


JIRA-ticket: https://dev.highq.com/jira/browse/COL-67441
Bestaande groep toevoegen aan site

Met deze API-methode wordt een bestaande systeemgroep aan de site toegevoegd.
Deze API is uitgebreid om bestaande systeemgebruikersgroepen (van systeem-/organisatietype) toe te voegen op de site.

Bestandsgegevens ophalen

Deze API-aanroep haalt gedetailleerde informatie op voor een opgegeven bestand van het HighQ Collaborate-platform.
Documenten verplaatsen

Met deze API worden meerdere bestanden van de ene map naar de andere verplaatst binnen dezelfde site.
Een bestand uploaden

Met deze API-aanroep wordt een bestand geüpload naar een opgegeven map op het HighQ Collaborate-platform. Het ondersteunt gesegmenteerde uploads wanneer de header Content-Range wordt opgegeven.
Een lijst met iSheet-items ophalen

Met deze API-aanroep wordt een lijst met items opgehaald die zijn opgenomen in het opgegeven iSheet.
Een lijst met mappen ophalen

Met deze API-aanroep wordt een lijst met mappen opgehaald die zich in de opgegeven map bevinden. De parameter Limiet stelt het maximum aantal items in dat moet worden geretourneerd en de parameter 'offset' geeft de beginpositie voor het ophalen van gegevens op. Standaardwaarden worden toegepast als deze parameters worden weggelaten en de mappen worden geretourneerd in oplopende volgorde op aanmaakdatum.
Gebruiker toevoegen

Deze API-aanroep wordt gebruikt om een nieuwe gebruiker aan het systeem toe te voegen.
Opmerking:
1. Ondersteuning toegevoegd voor de volgende nieuwe velden
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOf Billing
2. Adrestag is toegevoegd in API-versie 4

1

Samenvatting Verw-code (vóór V4) Verw-code (V4)

E-mailadres is vereist

 101 101

Ongeldig e-mailadres

 104 104

Voornaam is vereist

 102 102

Maximaal toegestane tekens voor de voornaam moeten tussen 1 en 100 zijn

 102 352

Het e-mailadres van de secretaresse/assistent is ongeldig

 104 353

De status moet actief of inactief zijn

 116 116

De opgegeven afdeling mag niet meer dan 256 tekens bevatten

 N/A 354

Het opgegeven ifpartner-kenmerk is ongeldig

 N/A 355

Het opgegeven kenmerk systemuser is ongeldig

 N/A 356

Het opgegeven kenmerk usertypeid is ongeldig

 N/A 357

Het opgegeven langcode-kenmerk is ongeldig

 N/A 358

Het opgegeven brontypekenmerk is ongeldig. Geldige waarden zijn systeem-, Active directory- of systeemstandaard.

 N/A 359

Voer een geldig telefoonnummer in   

 N/A 360

Geef een geldig telefoonnummer op in de notatie {countrycode}  ${areacode}${number}.

 N/A 361

Geef een geldig mobiel nummer op in de notatie {countrycode}${number}.

 N/A 362

Voer een geldige landcode voor kantoortelefoon in

 N/A 363

De landcode van de kantoortelefoon mag maximaal 4 cijfers bevatten

 N/A 364

Voer een geldig telefoonnummer voor kantoortelefoon in

 N/A 365

Het telefoonnummer van het kantoor mag maximaal 5 cijfers bevatten

 N/A 366

Het telefoonnummer van Office mag maximaal 15 cijfers bevatten

 N/A 368

Voer een geldige landcode voor mobiele telefoons in

 N/A 369

De landcode van de mobiele telefoon mag maximaal 4 cijfers bevatten

 N/A 372

Voer een geldig mobiel nummer in

 N/A 373

Het mobiele telefoonnummer mag maximaal 20 cijfers bevatten

 N/A 374

Domein bestaat niet

 105 105

E-mail bestaat al in het systeem

 111 111

Organisatie vermelden in geval van zelf geregistreerd domein   

 187 187

Organisatie vermelden in geval van uitzonderlijk domein   

 115 115

Organisatie-id heeft niet de juiste indeling   

 112 112

Organisatie bestaat niet

 106 106

Domein bestaat in andere organisatie

 114 114

Opgegeven adres-id is ongeldig

 N/A 308

De naam van de sociale koppeling is niet gevonden in het systeem.

 N/A 375

De naam van de sociale koppeling is vereist

 N/A 376

De waarde van de sociale koppeling is vereist

 N/A 377

Maximum aantal tekens voor de waarde voor sociale koppelingen moet tussen 1 en 500 zijn

 N/A 378

Voer de naam in voor de aangepaste koppeling

 N/A 379

De aangepaste koppelingswaarde vereist

 N/A 380

Maximum aantal tekens voor aangepaste koppelingsnaam moet tussen 1 en 500 zijn

 N/A 381

Maximum aantal tekens voor aangepaste koppelingswaarde moet tussen 1 en 500 zijn

 N/A 382

De naam van de berichtkoppeling is vereist

 N/A 383

Naam van berichtkoppeling is niet gevonden in het systeem

 N/A 384

De waarde van de berichtkoppeling is vereist   

 N/A 385

Maximum aantal tekens voor berichtkoppelingswaarde moet tussen 1 en 500 zijn

 N/A 386

De sociale koppeling is uitgeschakeld

 N/A 408

De berichtkoppeling is uitgeschakeld

 N/A 409

De aangepaste koppeling is uitgeschakeld

 N/A 410

JIRA-ticket: https://dev.highq.com/jira/browse/COL-65685
Gebruikerslijst ophalen

Een lijst met gebruikers ophalen met deze API haalt een lijst met gebruikers op uit het systeem. ## Belangrijke functies - Gebruikersdetails ophalen met meerdere filteropties - Ondersteunt paginering met limit en offset - Nieuwe queryparameters en -velden die zijn geïntroduceerd in recente versies - Gestructureerd antwoord met gebruikersrollen en -kenmerken ## Nieuwe queryparameters (Version-Specific) - geïntroduceerd in V12: - systemAdminSearch: Wanneer ingesteld 1op , worden alleen gebruikers geretourneerd met de rol systeembeheerder. - Geïntroduceerd in V18: - : useridAccepteert door komma's gescheiden waarden (CSV). ## Updates van antwoordtekst - Nieuwe velden toegevoegd: - emaildomain, orginvitationsent, createdbycreateddatemodifiedbymodifieddate - ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid - systemuserresetpassworddateusertypeidavatarpracticegroup - langcode, , , # publicprofiledateOfBirth# Adresnotatiewijziging (van V11) - De location tag is hernoemd address voor consistentie. - Voorbeeldantwoord: xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address> ## Gebruikersrollen (geïntroduceerd in API V11+) - Voorbeeldantwoord: xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles> ## Limieten en verschuivingen - Gedrag van limieten: - Standaard: 100 als er geen waarde is opgegeven. - Gebruik -1 deze functie om alle records te retourneren. - Als de waarde kleiner is dan -1, wordt standaard ingesteld op 100. - Verschuivingsgedrag: - Standaard: 0 als er geen waarde wordt opgegeven. - Als de offset groter is dan de totale records, wordt de standaardwaarde weer ingesteld op 0. ## Nieuwe rollen geïntroduceerd - V12: Basic User, Allow user to bypass XSS protection - V14: Allow user to manage Contract Express system groups ## Foutcodes | Samenvatting | Verw-code (vóór V4) | Verwcode (V4) | |---------|----------------------|--------------| | Ongeldige invoer voor gebruikersstatus (ACTIEF, GEARCHIVEERD, INACTIEF) | 147 | 147 | | Organisatie-id is ongeldig | N/B | 260 | | Ongeldige neverinvited waarde (waar/onwaar) | N/B | 387 | | Ongeldige neverlogin waarde (waar/onwaar) | N/B | 388 | | Ongeldige groupids waarde | N/B | 214 | | Ongeldige notingroup waarde (waar/onwaar) | N/B | 389 | | Ongeldig ordertype (ondersteund: naam, organisatie, status, enzovoort) | N/B | 289 | | Ongeldig orderby (ondersteund: asc, desc) | N/B | 290 | | Ongeldige offset waarde | 138 | 138 | | Ongeldige limit waarde | 137 | 137 | ## Notities - Vanaf V13 is deze API geopend voor alle gebruikers (voorheen beperkt tot systeembeheerders). - Vanaf V18 geeft het userregistered2FA veld aan of een gebruiker zich heeft geregistreerd voor 2FA. --- Deze beschrijving volgt de schemaopmaak van Swagger 2.0 en moet worden geplaatst in het beschrijvingsveld in het schema van de aangepaste connector.
Het iSheet-item maken

Deze API-aanroep wordt gebruikt om een iSheet-item in te voegen. Meerdere iSheets kunnen worden ondersteund.

Als u de status van een iSheet-item wilt ophalen op basis van een progressieve sleutel, roept u API POST /api/3/progressivekeystatus/{progressive_key} aan

bijvoorbeeld POST /api/{version}/progressivekeystatus/{progressive_key}

NaamTypologieDescription
progressive_keySnaar / Touwtje Sleutel om de status van uw actie te controleren.

Antwoord

<progressivekeyresponse>
 \t<items>
  \t\t<item>
   \t\t\t<itemid>1232</itemid>
   \t\t\t<status>GESLAAGD</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t-berichtrecord<>toegevoegd</bericht>
  \t\t</item>
  \t\t<item>
   \t\t\t<itemid>1233</itemid>
   \t\t\t<status>GESLAAGD</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t-berichtrecord<>toegevoegd</bericht>
  \t\t</item>
 \t</items>
</progressivekeyresponse>
iSheet-kolommen ophalen

Met deze API-aanroep worden de kolommen opgehaald die zijn gekoppeld aan het opgegeven iSheet. Deze functionaliteit wordt ondersteund in API-versie 3 en hoger.
Map maken

Met deze API maakt u een nieuwe map binnen de opgegeven site. Hiermee kunt u mapdetails opgeven en ervoor zorgen dat de map wordt gemaakt onder de opgegeven bovenliggende map.
Mapgegevens ophalen

De methode bevat mapdetails van de opgegeven map-id.

Site bijwerken

Gebruik dit API-eindpunt om de details van een bestaande site bij te werken. De API ondersteunt dezelfde velden die worden gebruikt in de site-API maken.

Deze methode ondersteunt meerdere materienummers die aan de site kunnen worden toegevoegd met API-versie 10 en hoger. De tag 'matternos' geeft meerdere materienummers aan met alleen-lezen of niet.

Versie 18 en hoger: een categorie (sitedoel) is vereist. Als het doel van de site verborgen is, wordt er een bericht weergegeven; anders worden verborgen sitedoeleinden niet toegevoegd aan de site.

Site-eigenaar kan nu ook andere gebruikers worden toegewezen, maar ze moeten sitedeelnemers zijn en een rol hebben die hoger is dan de sitebeheerder.

Versie 18 en hoger: de site-eigenaar kan andere gebruikers toevoegen aan de site.

Vanaf API-versie 19 wordt een nieuwe module met de naam customPages geïntroduceerd, die nauw is gekoppeld aan de basismodule. Als de waarde van de basismodule True is, moet customPages waar zijn en omgekeerd.

Houd er rekening mee dat alle eigenschappen/elementen in het ophalen van een siteantwoord niet kunnen worden bijgewerkt of ingevoegd. Zie de onderstaande tabel om te weten welke alleen-lezen, kan worden bijgewerkt of ingevoegd.
Site toevoegen

Gebruik deze API om een nieuwe site te maken. Het siteobject ondersteunt alleen kenmerken die zichtbaar zijn in de interface voor het maken van een site.

Deze API vereist sitenaam (en verplichte velden die zijn geconfigureerd op ASP-niveau indien aanwezig) om een nieuwe site te maken.

De tag module vertegenwoordigt een andere module die moet worden geconfigureerd op de site, zoals deze wordt weergegeven in aanvraagkenmerken.
Site maken op sjabloon door de tag 'sitetemplateid' door te geven
     - Voor minder dan versie 7 vindt de configuratie van de sjabloonmodule plaats als er geen module ('module'-tag wordt doorgegeven) in de aanvraag. Als de moduletag wordt geleverd met configuratie, respecteert en configureert deze zoals opgegeven in de aanvraag (in plaats van de configuratie van de sjabloonmodule te gebruiken)
     - Voor meer dan versie 7 vindt de configuratie van de sjabloonmodule plaats als er een module ('module'-tag wordt doorgegeven) of niet in de aanvraag.

Deze methode biedt geen ondersteuning voor het uploaden van site-installatiekopieën in deze aanroep. De ondersteuning voor het sitepictogram wordt aangeboden als een afzonderlijk gesprek.
In de methodeaanroep wordt een bestaande categorie-id verwacht. De categorie-id moet worden verkregen door de aanroepende toepassing door een eerdere aanroep naar de interface sitecategorieën. Als er geen categorieën in de aanvraag worden gegeven, wordt standaard geen categorie (geen werkelijke categorie) toegevoegd.

De begin- en einddatum van de site moeten de notatie dd MMM jjjj hebben en is NIET UTC. API-client vraagt altijd de werkelijke datum aan.

'landingpage' heeft de standaardwaarde 'bestanden (hoofdmap)'.
'landingpage' verwacht drie verschillende formuleringen of identificaties voor de bestandsmodule. Mogelijke waarden zijn:
- bestanden (hoofdmap)
- bestanden (recente activiteit)
- bestanden (geavanceerd zoeken)
De implementatie van de methode ondersteunt nu (vanaf 5.1) Meertalige sitenaam. Api-versie 6 of hoger <vertegenwoordigt de sitenaam> in de aanvraagtekst op basis van de volgorde van de gebruikersvoorkeur. API-versie 5 of oudere <sitenaam> vertegenwoordigt standaard Engels in het Vk.
<sitenametranslations vertegenwoordigen> sitenamen in elke taal (die vanaf 5.1 extra tag in 'Object zelf API' wordt genoemd) API-versie 6 of hoger, in de aanvraagtekst worden beide tags verzonden, zoals <sitenaam> en <sitenaamtranslations> . Vervolgens moeten we waarden valideren, bijvoorbeeld <sitenaam> moet overeenkomen met de respectieve <vertaaltag> in termen van de taalvoorkeur van de gebruiker. API 7 of hoger, de site die op basis van de sjabloon is gemaakt, volgt modules uit de bronsjabloon en negeert de modulelijst die wordt verzonden in de aanvraagbody.

De methode-implementatie biedt nu ondersteuning voor het maken van een site op basis van een sjabloon door de tag 'sitetemplateid' op te geven (oude benadering)

Houd er rekening mee dat de ondersteuning voor het maken van een site op basis van een sjabloon met deze API in de toekomst wordt afgeschaft. Als u een site op basis van een sjabloon wilt maken, gebruikt u de nieuwe API Create-site op basis van sjabloon (/sites/sjablonen/{templateid}/site) die een lange polling-API is (met ondersteuning voor langlopende aanvragen)

Deze methode ondersteunt meerdere materienummers die aan de site kunnen worden toegevoegd met API-versie 10 en hoger. De tag 'matternos' geeft meerdere materienummers aan met alleen-lezen of niet. Oudere versie (kleiner dan versie 10) single matterno geeft het eerste kwestienummer van het bestaan van meerdere materienummers in de site weer.

Versie 18 en hoger: een categorie (sitedoel) is vereist. Als het doel van de site verborgen is, wordt er een bericht weergegeven; anders worden verborgen sitedoeleinden niet toegevoegd aan de site.

Tot versie 17: de site-eigenaar is de aangemelde gebruiker; er kunnen geen andere gebruikers worden toegevoegd.

Versie 18 en hoger: de site-eigenaar kan andere gebruikers toevoegen aan de site.

Vanaf API-versie 19 wordt een nieuwe module geïntroduceerd met de naam 'customPages' die nauw is gekoppeld aan de basismodule. Dus als de waarde van de basismodule Waar is, is customPages waar en omgekeerd.
Sitegroep bijwerken

Met deze API-methode wordt de naam van een bestaande groep op een site bijgewerkt.
Deze API is uitgebreid om de naam van een bestaande basisgebruikersgroep op een site bij te werken.

Archiefgebruiker

Bewerkings-id:
deleteUser

Deze API-aanroep wordt gebruikt om een gebruiker in het systeem te archiveren.

Foutcodes

Samenvatting Verw-code (vóór V4) Verw-code (V4)

De volgende gebruikers bestaan niet in het systeem

 110 110

Een gebruikers-id is vereist

 109 109

Gebruikers-id heeft niet de juiste indeling

 113 113

De lengte van de gebruikers-id mag niet langer zijn dan 50 tekens

 N/A 304


JIRA-ticket: https://dev.highq.com/jira/browse/COL-67441

Parameters

Name Sleutel Vereist Type Description
API-versie
 version True string

versie van api
Gebruikersnaam
 userid True string

gebruikersnaam

Bestaande groep toevoegen aan site

Bewerkings-id:
addExistingGroupToSite

Met deze API-methode wordt een bestaande systeemgroep aan de site toegevoegd.
Deze API is uitgebreid om bestaande systeemgebruikersgroepen (van systeem-/organisatietype) toe te voegen op de site.

Parameters

Name Sleutel Vereist Type Description
API-versie
 version True string

version
De id van de site
 siteid True string

De id van de site.
De id van de systeemgroep
 groupid True string

De id van de systeemgroep die moet worden toegevoegd aan de site.

Retouren

Body
sitegroup

Bestandsgegevens ophalen

Bewerkings-id:
getDocumentInfo

Deze API-aanroep haalt gedetailleerde informatie op voor een opgegeven bestand van het HighQ Collaborate-platform.

Parameters

Name Sleutel Vereist Type Description
API-versie
 version True string

Hiermee geeft u de versie op van de API die wordt gebruikt.
Bestands-id
 fileid True string

Hiermee geeft u de unieke id van het bestand.
Meest recente DMS-infovlag
 lastdmsinfo boolean

Geeft aan of de meest recente informatie moet worden opgehaald uit het documentbeheersysteem.
Maptype
 foldertype string

Hiermee geeft u het type map op, indien van toepassing.
Informatie over bestandsstatus opnemen
 statusinfo boolean

Hiermee wordt aangegeven of er aanvullende informatie over de bestandsstatus moet worden opgenomen, zoals gedeelde status, favoriete status, aantal taken en leuk gevonden status. De standaardwaarde is onwaar.
Metagegevens van e-mail opnemen
 emailmetadata boolean

Hiermee wordt aangegeven of e-mailmetagegevens, zoals afzender, geadresseerden en tijdstempels, moeten worden opgenomen. De standaardwaarde is onwaar.

Retouren

Body
DocumentDBO

Documenten verplaatsen

Bewerkings-id:
moveDocuments

Met deze API worden meerdere bestanden van de ene map naar de andere verplaatst binnen dezelfde site.

Parameters

Name Sleutel Vereist Type Description
API-versie
 version True string

Hiermee geeft u de API-versie.
Doelmap-id
 targetfolder True string

De unieke id van de doelmap waar de bestanden worden verplaatst.
fileidCSV
 fileidCSV string

De door komma's gescheiden lijst met bestands-id's die moeten worden verplaatst.

Een bestand uploaden

Bewerkings-id:
insertDocument

Met deze API-aanroep wordt een bestand geüpload naar een opgegeven map op het HighQ Collaborate-platform. Het ondersteunt gesegmenteerde uploads wanneer de header Content-Range wordt opgegeven.

Parameters

Name Sleutel Vereist Type Description
API-versie
 version True string

Hiermee geeft u de versie op van de API die wordt gebruikt.
Te uploaden bestand
 file True file

Hiermee geeft u het bestand dat moet worden geüpload.
Id van bovenliggende map
 parentfolderid True string

Hiermee geeft u de unieke id op van de bovenliggende map waar het bestand wordt geüpload.
Dubbele vlag overschrijven
 overrideduplicate boolean

Geeft aan of dubbele bestandsuploads moeten worden overschreven.
Documentnaam
 filename True string

Hiermee geeft u de naam van het document.
Versienotitie
 versionnote string

Bevat een notitie met een beschrijving van de versie van het bestand.
Progressieve bewerkingssleutel
 progressiveoperkey string

Hiermee geeft u de sleutel op die wordt gebruikt voor progressieve bewerkingen tijdens het uploaden van bestanden.
NAAM VAN DMS-database
 dmsdatabasename string

Hiermee geeft u de naam van de documentbeheersysteemdatabase.
Datum van DMS-bewerking
 dmseditdate string

Hiermee geeft u de bewerkingsdatum op die is vastgelegd in het documentbeheersysteem.
Id van bovenliggende DMS-map
 dmsparentfolderid string

Hiermee geeft u de unieke id van de bovenliggende map in het documentbeheersysteem.
DMS-document-id
 dmsdocid string

Hiermee geeft u de unieke id van het document in het documentbeheersysteem.
DMS-documentversie
 dmsversion string

Hiermee geeft u de versie op van het document dat is vastgelegd in het documentbeheersysteem.
Meldingsgegevens
 notification string

Bevat details over meldingen die moeten worden verzonden bij het uploaden van bestanden.
Batch-id
 batchid string

Hiermee geeft u de unieke id van de batchbewerking.
Hoofdmap-id
 rootfolderid string

Hiermee geeft u de unieke id van de hoofdmap.

Een lijst met iSheet-items ophalen

Bewerkings-id:
getISheetItems

Met deze API-aanroep wordt een lijst met items opgehaald die zijn opgenomen in het opgegeven iSheet.

Parameters

Name Sleutel Vereist Type Description
API-versie
 version True string

Hiermee geeft u de versie op van de API die wordt gebruikt.
iSheet-id
 isheetid True integer

Hiermee geeft u de unieke id van het iSheet.
iSheet-weergave-id
 sheetviewid integer

Hiermee geeft u de id van de iSheet-weergave. Als u dit weglaat, wordt de standaardweergave geretourneerd.
Kolom-id sorteren
 sortcolumnid integer

Hiermee geeft u de id op van de kolom die wordt gebruikt voor het sorteren van de resultaten.
Sorteervolgorde
 sortorder integer

Hiermee geeft u de sorteervolgorde op. Gebruik bijvoorbeeld 0 voor oplopende volgorde of een andere waarde voor aflopende volgorde.
Recordlimiet
 limit integer

Hiermee geeft u het maximum aantal records dat moet worden geretourneerd; de standaardwaarde is 100 als deze niet is opgegeven.
Recordverschil
 offset integer

Hiermee geeft u de beginpositie voor het ophalen van records; de standaardwaarde is 0 als deze niet is opgegeven.
Alle kolommen opnemen
 allColumnRequired boolean

Een vlag die aangeeft of alle kolomgegevens moeten worden opgenomen, ongeacht de huidige weergave.
Weergavebeperkingen negeren
 isIgnoreView boolean

Een vlag die aangeeft of weergavebeperkingen moeten worden genegeerd bij het ophalen van itemgegevens.

Retouren

Name Pad Type Description
isheet
 isheet array of object

Een lijst met iSheet-items.
artikelID
 isheet.itemId string

De unieke id van het item.
gegevens
 isheet.data array of object

Gedetailleerde gegevens van het item.
volgorde
 isheet.data.sequence string

Het volgnummer dat aan de gegevens is gekoppeld.
columnDisplayName
 isheet.data.columnDisplayName string

De weergavenaam van de kolom.
waarde
 isheet.data.value string

De waarde in de kolom.

Een lijst met mappen ophalen

Bewerkings-id:
getFolderList

Met deze API-aanroep wordt een lijst met mappen opgehaald die zich in de opgegeven map bevinden. De parameter Limiet stelt het maximum aantal items in dat moet worden geretourneerd en de parameter 'offset' geeft de beginpositie voor het ophalen van gegevens op. Standaardwaarden worden toegepast als deze parameters worden weggelaten en de mappen worden geretourneerd in oplopende volgorde op aanmaakdatum.

Parameters

Name Sleutel Vereist Type Description
API-versie
 version True string

Hiermee geeft u de versie op van de API die wordt gebruikt.
Map-id
 folderid True string

Hiermee geeft u de unieke id van de map.
Limiet voor items
 limit string

Hiermee geeft u het maximum aantal items dat moet worden geretourneerd.
Verschuiving van items
 offset string

Hiermee geeft u de beginpositie voor de geretourneerde items.
Sorteervolgorderichting
 orderby string

Hiermee geeft u de volgorderichting voor het sorteren van items. Gebruik 'asc' voor oplopende volgorde of 'desc' voor aflopende volgorde.
Sorteercriterium
 ordertype string

Hiermee geeft u het criterium voor het sorteren van items, zoals naam, auteur of datum van laatste wijziging.
Mapstatusgegevens opnemen
 statusinfo boolean

Geeft aan of er aanvullende informatie over de mapstatus moet worden opgenomen. De standaardwaarde is onwaar.
Slimme mappen opnemen
 includesmartfolder boolean

Geeft aan of slimme mappen moeten worden opgenomen in de geretourneerde lijst. De standaardwaarde is onwaar.

Retouren

Name Pad Type Description
map
 folder array of object
items
 folder object

Gebruiker toevoegen

Bewerkings-id:
createUser

Deze API-aanroep wordt gebruikt om een nieuwe gebruiker aan het systeem toe te voegen.
Opmerking:
1. Ondersteuning toegevoegd voor de volgende nieuwe velden
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOf Billing
2. Adrestag is toegevoegd in API-versie 4

1

Samenvatting Verw-code (vóór V4) Verw-code (V4)

E-mailadres is vereist

 101 101

Ongeldig e-mailadres

 104 104

Voornaam is vereist

 102 102

Maximaal toegestane tekens voor de voornaam moeten tussen 1 en 100 zijn

 102 352

Het e-mailadres van de secretaresse/assistent is ongeldig

 104 353

De status moet actief of inactief zijn

 116 116

De opgegeven afdeling mag niet meer dan 256 tekens bevatten

 N/A 354

Het opgegeven ifpartner-kenmerk is ongeldig

 N/A 355

Het opgegeven kenmerk systemuser is ongeldig

 N/A 356

Het opgegeven kenmerk usertypeid is ongeldig

 N/A 357

Het opgegeven langcode-kenmerk is ongeldig

 N/A 358

Het opgegeven brontypekenmerk is ongeldig. Geldige waarden zijn systeem-, Active directory- of systeemstandaard.

 N/A 359

Voer een geldig telefoonnummer in   

 N/A 360

Geef een geldig telefoonnummer op in de notatie {countrycode}  ${areacode}${number}.

 N/A 361

Geef een geldig mobiel nummer op in de notatie {countrycode}${number}.

 N/A 362

Voer een geldige landcode voor kantoortelefoon in

 N/A 363

De landcode van de kantoortelefoon mag maximaal 4 cijfers bevatten

 N/A 364

Voer een geldig telefoonnummer voor kantoortelefoon in

 N/A 365

Het telefoonnummer van het kantoor mag maximaal 5 cijfers bevatten

 N/A 366

Het telefoonnummer van Office mag maximaal 15 cijfers bevatten

 N/A 368

Voer een geldige landcode voor mobiele telefoons in

 N/A 369

De landcode van de mobiele telefoon mag maximaal 4 cijfers bevatten

 N/A 372

Voer een geldig mobiel nummer in

 N/A 373

Het mobiele telefoonnummer mag maximaal 20 cijfers bevatten

 N/A 374

Domein bestaat niet

 105 105

E-mail bestaat al in het systeem

 111 111

Organisatie vermelden in geval van zelf geregistreerd domein   

 187 187

Organisatie vermelden in geval van uitzonderlijk domein   

 115 115

Organisatie-id heeft niet de juiste indeling   

 112 112

Organisatie bestaat niet

 106 106

Domein bestaat in andere organisatie

 114 114

Opgegeven adres-id is ongeldig

 N/A 308

De naam van de sociale koppeling is niet gevonden in het systeem.

 N/A 375

De naam van de sociale koppeling is vereist

 N/A 376

De waarde van de sociale koppeling is vereist

 N/A 377

Maximum aantal tekens voor de waarde voor sociale koppelingen moet tussen 1 en 500 zijn

 N/A 378

Voer de naam in voor de aangepaste koppeling

 N/A 379

De aangepaste koppelingswaarde vereist

 N/A 380

Maximum aantal tekens voor aangepaste koppelingsnaam moet tussen 1 en 500 zijn

 N/A 381

Maximum aantal tekens voor aangepaste koppelingswaarde moet tussen 1 en 500 zijn

 N/A 382

De naam van de berichtkoppeling is vereist

 N/A 383

Naam van berichtkoppeling is niet gevonden in het systeem

 N/A 384

De waarde van de berichtkoppeling is vereist   

 N/A 385

Maximum aantal tekens voor berichtkoppelingswaarde moet tussen 1 en 500 zijn

 N/A 386

De sociale koppeling is uitgeschakeld

 N/A 408

De berichtkoppeling is uitgeschakeld

 N/A 409

De aangepaste koppeling is uitgeschakeld

 N/A 410

JIRA-ticket: https://dev.highq.com/jira/browse/COL-65685

Parameters

Name Sleutel Vereist Type Description
API-versie
 version True string

versie van api
index
 index integer

Unieke index voor de gebruiker.
userid
 userid integer

Unieke id voor de gebruiker.
voornaam
 firstname string

Voornaam van de gebruiker.
achternaam
 lastname string

Achternaam van de gebruiker.
oefengroep
 practicegroup string

Oefengroep waartoe de gebruiker behoort.
langcode
 langcode string

Taalcode van de gebruiker.
localeID
 localeID string

Landinstellings-id van de gebruiker.
publicprofile
 publicprofile string

Openbaar profiel van de gebruiker.
pwpid
 pwpid string

PWP-id van de gebruiker.
usertypeid
 usertypeid string

Gebruikerstype-id.
systemuser
 systemuser string

Systeemgebruikervlag.
e-mailadres
 email string

Email adres van de gebruiker.
phone
 phone string

Telefoonnummer van de gebruiker.
mobile
 mobile string

Mobiel nummer van de gebruiker.
afdeling
 department string

Afdeling van de gebruiker.
ORG
 org string

Organisatie waartoe de gebruiker behoort.
adreslijn1
 addressline1 string

Eerste regel van het adres.
adreslijn2
 addressline2 string

Tweede regel van het adres.
adreslijn3
 addressline3 string

Derde regel van het adres.
city
 city string

Stad van het adres.
state
 state string

Status van het adres.
country
 country string

Land van het adres.
postcode
 postcode string

Postcode van het adres.
addressid
 addressid string

Unieke id voor het adres.
adreslijn1
 addressline1 string

Eerste regel van het adres.
adreslijn2
 addressline2 string

Tweede regel van het adres.
adreslijn3
 addressline3 string

Derde regel van het adres.
city
 city string

Stad van het adres.
state
 state string

Status van het adres.
country
 country string

Land van het adres.
postCode
 postCode string

Postcode van het adres.
knownas
 knownas string

Alternatieve naam of bijnaam voor het adres.
ervaring
 experience array of string
identiteitskaart
 id string

Koppelings-id
naam
 name string

Koppelingsnaam.
waarde
 value string

Koppelingswaarde.
identiteitskaart
 id string

Koppelings-id
naam
 name string

Koppelingsnaam.
waarde
 value string

Koppelingswaarde.
identiteitskaart
 id string

Koppelings-id
naam
 name string

Koppelingsnaam.
waarde
 value string

Koppelingswaarde.
img
 img string
reportsto
 reportsto string
metagegevensnaam
 metadataname array of string
metadatavalue
 metadatavalue array of string
group
 group array of string
externalid
 externalid string

Externe id van de gebruiker.
jobtitle
 jobtitle string

Functie van de gebruiker.
secretaressenaam
 secretaryname string

Naam van de secretaresse van de gebruiker.
secretaressemail
 secretarymail string

E-mail van de secretaresse van de gebruiker.
Specialiteiten
 specialities string

Specialiteiten van de gebruiker.
title
 title string

Titel van de gebruiker.
goesby
 goesby string

voorkeursnaam van de gebruiker.
achtervoegsel
 suffix string

Achtervoegsel van de naam van de gebruiker.
atomlink
 atomlink string

Atom-koppeling die is gekoppeld aan de gebruiker.
bio
 bio string

Biografie van de gebruiker.
dateOfBirth
 dateOfBirth string

Geboortedatum van de gebruiker.
verbinden
 link string

Koppeling die is gekoppeld aan de gebruiker.
status
 status string

Status van de gebruiker.
statuscode
 statuscode string

Statuscode van de gebruiker.
message
 message string

Bericht dat is gekoppeld aan de gebruiker.
brontype
 sourcetype string

Brontype van de gebruiker.
orgid
 orgid string

Organisatie-id.
ifpartner
 ifpartner string

Partnervlag.
e-maildomein
 emaildomain string

E-maildomein van de gebruiker.
uitnodigingenent
 invitationsent string

Vlag verzonden uitnodiging.
Gemaakt door
 createdby string

Gebruiker die de record heeft gemaakt.
createddate
 createddate string

De datum waarop de record is gemaakt.
gewijzigd door
 modifiedby string

Gebruiker die de record heeft gewijzigd.
modifieddate
 modifieddate string

De datum waarop de record is gewijzigd.
lastlogindate
 lastlogindate string

Datum van de laatste aanmelding.
invalidlogins
 invalidlogins string

Aantal ongeldige aanmeldingspogingen.
publicwebsiteprofileid
 publicwebsiteprofileid string

Profiel-id van openbare website.
resetpassworddate
 resetpassworddate string

De datum waarop het wachtwoord opnieuw is ingesteld.
avatar
 avatar string

Url van avatarafbeelding.
followingcount
 followingcount integer

Het aantal gevolgde gebruikers.
aantal volgers
 followercount integer

Aantal volgers.
volgend
 following boolean

Volgende vlag.
rol
 role string

Rol van de gebruiker.
isbasicuser
 isbasicuser string

Eenvoudige gebruikersvlag.
encryptedUserId
 encryptedUserId string

Versleutelde gebruikers-id.
zelfregister
 selfregistered integer

Zelf geregistreerde vlag.
registeredWith2FA
 registeredWith2FA string

Registratievlag voor tweeledige verificatie.
isIntern
 isInternal integer

Interne gebruikersvlag.
orgName
 orgName string

Naam van de organisatie.

Retouren

Body
IntegrationUserDBO

Gebruikerslijst ophalen

Bewerkings-id:
getAllSystemUsers

Een lijst met gebruikers ophalen met deze API haalt een lijst met gebruikers op uit het systeem. ## Belangrijke functies - Gebruikersdetails ophalen met meerdere filteropties - Ondersteunt paginering met limit en offset - Nieuwe queryparameters en -velden die zijn geïntroduceerd in recente versies - Gestructureerd antwoord met gebruikersrollen en -kenmerken ## Nieuwe queryparameters (Version-Specific) - geïntroduceerd in V12: - systemAdminSearch: Wanneer ingesteld 1op , worden alleen gebruikers geretourneerd met de rol systeembeheerder. - Geïntroduceerd in V18: - : useridAccepteert door komma's gescheiden waarden (CSV). ## Updates van antwoordtekst - Nieuwe velden toegevoegd: - emaildomain, orginvitationsent, createdbycreateddatemodifiedbymodifieddate - ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid - systemuserresetpassworddateusertypeidavatarpracticegroup - langcode, , , # publicprofiledateOfBirth# Adresnotatiewijziging (van V11) - De location tag is hernoemd address voor consistentie. - Voorbeeldantwoord: xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address> ## Gebruikersrollen (geïntroduceerd in API V11+) - Voorbeeldantwoord: xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles> ## Limieten en verschuivingen - Gedrag van limieten: - Standaard: 100 als er geen waarde is opgegeven. - Gebruik -1 deze functie om alle records te retourneren. - Als de waarde kleiner is dan -1, wordt standaard ingesteld op 100. - Verschuivingsgedrag: - Standaard: 0 als er geen waarde wordt opgegeven. - Als de offset groter is dan de totale records, wordt de standaardwaarde weer ingesteld op 0. ## Nieuwe rollen geïntroduceerd - V12: Basic User, Allow user to bypass XSS protection - V14: Allow user to manage Contract Express system groups ## Foutcodes | Samenvatting | Verw-code (vóór V4) | Verwcode (V4) | |---------|----------------------|--------------| | Ongeldige invoer voor gebruikersstatus (ACTIEF, GEARCHIVEERD, INACTIEF) | 147 | 147 | | Organisatie-id is ongeldig | N/B | 260 | | Ongeldige neverinvited waarde (waar/onwaar) | N/B | 387 | | Ongeldige neverlogin waarde (waar/onwaar) | N/B | 388 | | Ongeldige groupids waarde | N/B | 214 | | Ongeldige notingroup waarde (waar/onwaar) | N/B | 389 | | Ongeldig ordertype (ondersteund: naam, organisatie, status, enzovoort) | N/B | 289 | | Ongeldig orderby (ondersteund: asc, desc) | N/B | 290 | | Ongeldige offset waarde | 138 | 138 | | Ongeldige limit waarde | 137 | 137 | ## Notities - Vanaf V13 is deze API geopend voor alle gebruikers (voorheen beperkt tot systeembeheerders). - Vanaf V18 geeft het userregistered2FA veld aan of een gebruiker zich heeft geregistreerd voor 2FA. --- Deze beschrijving volgt de schemaopmaak van Swagger 2.0 en moet worden geplaatst in het beschrijvingsveld in het schema van de aangepaste connector.

Parameters

Name Sleutel Vereist Type Description
API-versie
 version True string

Versie van de API.
Gebruikersstatus
 status string

Gebruikers filteren op status: Actief, Gearchiveerd, Inactief of Vergrendeld.
Verschuiving van paginering
 offset string

Beginpositie voor paginering.
Resultatenlimiet
 limit string

Aantal items dat per aanvraag moet worden geretourneerd.
Organisatie-id
 orgid string

Gebruikers filteren op organisatie-id.
Nooit uitgenodigde gebruikers
 neverinvited string

Gebruikers ophalen die nog nooit zijn uitgenodigd.
Nooit aangemelde gebruikers
 neverlogin string

Gebruikers ophalen die zich nooit hebben aangemeld.
Gebruikers-ID
 userid string

Filter gebruikers op hun unieke gebruikers-id(s).
Groeps-id
 groupid string

Gebruikers filteren op groeps-id(s).
Gebruikers niet in groepen
 notingroup string

Gebruikers ophalen die zich niet in een groep bevinden.
Sorteervolgordetype
 ordertype string

Gebruikers sorteren op een opgegeven veld, zoals naam, organisatie of status.
Sorteervolgorde
 orderby string

Sorteer resultaten in oplopende of aflopende volgorde.
Externe ID
 externalid string

Gebruikers filteren op externe id.
Voornaam
 firstname string

Filter gebruikers op voornaam.
Achternaam
 lastname string

Filter gebruikers op achternaam.
E-mailadres
 email string

Gebruikers filteren op e-mailadres.
Gebruikers zoeken
 search string

Zoek gebruikers op verschillende kenmerken, waaronder naam, e-mail en functie.
Alfabetfilter
 alphabets string

Filter gebruikers waarvan de achternaam begint met een specifieke letter.
Functietitel
 jobtitle string

Gebruikers filteren op functie.
Locatie
 locations string

Gebruikers filteren op plaats.
Afdeling
 departments string

Gebruikers filteren op afdeling.
Organisatienaam
 organisations string

Filter gebruikers op organisatienaam.
Specialiteiten
 specialities string

Filter gebruikers op hun specialiteiten.
Zoekfunctie voor systeembeheerders
 systemAdminSearch string

Gebruikers ophalen met de rol Systeembeheerder.

Retouren

Body
users

Het iSheet-item maken

Bewerkings-id:
insertISheetItems

Deze API-aanroep wordt gebruikt om een iSheet-item in te voegen. Meerdere iSheets kunnen worden ondersteund.

Als u de status van een iSheet-item wilt ophalen op basis van een progressieve sleutel, roept u API POST /api/3/progressivekeystatus/{progressive_key} aan

bijvoorbeeld POST /api/{version}/progressivekeystatus/{progressive_key}

NaamTypologieDescription
progressive_keySnaar / Touwtje Sleutel om de status van uw actie te controleren.

Antwoord

<progressivekeyresponse>
 \t<items>
  \t\t<item>
   \t\t\t<itemid>1232</itemid>
   \t\t\t<status>GESLAAGD</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t-berichtrecord<>toegevoegd</bericht>
  \t\t</item>
  \t\t<item>
   \t\t\t<itemid>1233</itemid>
   \t\t\t<status>GESLAAGD</status>
   \t\t\t<statuscode>200</statuscode>
   \t\t\t-berichtrecord<>toegevoegd</bericht>
  \t\t</item>
 \t</items>
</progressivekeyresponse>

Parameters

Name Sleutel Vereist Type Description
API-versie
 version True string

Versie van de API
iSheet-id
 isheetid True integer

Id van het iSheet
Bladweergave-id
 sheetviewid integer

Id van de iSheet-weergave (optioneel)
identiteitskaart
 id integer

Isheet-id.
title
 title string

Titel van het blad.
beschrijving
 description string

Beschrijving van het blad.
status
 status string

Status van het blad.
toegangstype
 accesstype string

Toegangstype van het blad.
type
 type string

Type van het blad.
viewlink
 viewlink string

URL-koppeling om het blad weer te geven.
allowsections
 allowsections string

Geeft aan of secties zijn toegestaan.
allowlookup
 allowlookup string

Geeft aan of opzoeken is toegestaan.
displayisheet
 displayisheet string

Isheet weergeven.
searchasdefaultview
 searchasdefaultview string

Hiermee stelt u zoeken in als standaardweergave.
enableversion
 enableversion string

Versie inschakelen.
enablesheetalerter
 enablesheetalerter string

Hiermee activeert u de waarschuwingsfunctie voor werkbladen.
alertercondition
 alertercondition string

Voorwaarde voor het activeren van waarschuwingen.
overrideitemmodifieddate
 overrideitemmodifieddate string

Over de rit is de gewijzigde datum van het item.
enablebulkinsertupdate
 enablebulkinsertupdate string

Update bulksgewijs invoegen toestaan.
fielddescriptions
 fielddescriptions string

beschrijving voor velden.
enablerowlocking
 enablerowlocking string

Hiermee schakelt u rijvergrendeling in.
setcharlimittruncatemultilinetextenabled
 setcharlimittruncatemultilinetextenabled string

Hiermee schakelt u het afkappen van tekenlimieten voor tekst met meerdere regels in.
setcharlimittruncatemultilinetextval
 setcharlimittruncatemultilinetextval string

stelt de tekenlimiet voor afkapping in.
allowchoicelistvaluesforreuse
 allowchoicelistvaluesforreuse string

Staat hergebruik van keuzelijstwaarden toe.
allowscorelistvaluesforreuse
 allowscorelistvaluesforreuse string

Staat hergebruik van scorelijstwaarden toe.
allowIsheetComments
 allowIsheetComments string

Hiermee staat u opmerkingen toe op het werkblad.
shareRecordsLimit
 shareRecordsLimit integer

Limiet voor gedeelde records.
shareRecordsLimitEnabled
 shareRecordsLimitEnabled integer

Schakel de limiet voor het delen van records in.
enableIsheetAddRecordFormSharing
 enableIsheetAddRecordFormSharing string

Hiermee kunt u het delen van een recordformulier toevoegen.
allowViewBaseRendering
 allowViewBaseRendering string

Hiermee staat u basisweergave van weergaven toe.
kolom
 column object
recordcount
 recordcount string

Totaal aantal records.
viewId
 viewId integer

Unieke id voor de weergave.
siteId
 siteId integer

Id voor de gekoppelde site.
sitenaam
 siteName string

Naam van de site.
sheetName
 sheetName string

Naam van het blad.
viewName
 viewName string

Naam van de weergave.
sheetId
 sheetId integer

Id voor het blad.
volgorde
 sequence string

Volgnummer van de koptekstkolom.
columnValue
 columnValue string

Waarde van de koptekstkolom.
columnTypeId
 columnTypeId string

Id voor het kolomtype.
columnId
 columnId string

Unieke id voor de kolom.
columnTypeAlias
 columnTypeAlias string

Aliasnaam voor het kolomtype.
itemsequence
 itemsequence string

Volgnummer van het item.
itemid
 itemid string

Unieke id voor het item.
externalid
 externalid string

Externe id die is gekoppeld aan het item.
columnid
 columnid integer

Unieke id voor de kolom
naam
 name string

Naam van de kolom
type
 type integer

Gegevenstype van de kolom.
systeemgeneratedtype
 systemgeneratedtype string

Door het systeem gegenereerde typegegevens.
section
 section integer

Sectienummer waar de kolom zich bevindt.
beschrijving
 description string

Gedetailleerde beschrijving van de kolom.
addtodefaultview
 addtodefaultview string

Geeft aan of de kolom is toegevoegd aan de standaardweergave.
columnconditionstate
 columnconditionstate string

Status van de kolomvoorwaarde.
rowid
 rowid integer

Id voor de rij.
columnid
 columnid integer

Id voor de kolom.
operatorid
 operatorid integer

Id voor de operator.
oprand
 oprand string

Operand-waarde voor het filter.
logisch type
 logicaltype string

Logisch type van het filter.
sheetfiltervaluetypeid
 sheetfiltervaluetypeid string

Id voor het waardetype bladfilter.
displaytype
 displaytype string

Weergavetype van het filter.
sourceColumnId
 sourceColumnId integer

Bronkolom-id voor het filter.
scoreConditionTypeid
 scoreConditionTypeid integer

Id voor het type scorevoorwaarde.
defaultvalue
 defaultvalue string

Standaardwaarde voor de kolom.
kolomwidth
 columnwidth string

Breedte van de kolom.
bladnaam
 sheetname string

Naam van het gekoppelde blad.
sitenaam
 sitename string

Naam van de site.
verplicht
 mandatory string

Geeft aan of de kolom verplicht is.
allowsearch
 allowsearch string

Hiermee geeft u op of zoeken is toegestaan.
maxchars
 maxchars integer

Maximum aantal tekens.
allowfieldfmoederotherisheet
 allowfieldfromanotherisheet string

Hiermee staat u het veld van een ander blad toe.
allowrichhtmltext
 allowrichhtmltext string

Hiermee geeft u op of RTF-tekst is toegestaan.
numberoflines
 numberoflines integer

Aantal regels in de kolom.
displaymethod
 displaymethod string

De methode die wordt gebruikt om de kolom weer te geven.
includeotheroption
 includeotheroption string

Bevat een optie 'Overig'.
singleormultileselectioninsearch
 singleormultileselectioninsearch string

Hiermee geeft u het selectietype in de zoekopdracht.
identiteitskaart
 id string

Unieke id voor de keuze."
label
 label string

Label voor de keuze.
partituur
 score string

Score gekoppeld aan de keuze.
color
 color string

Kleurcode voor de keuze.
imageid
 imageid integer

Id van de gekoppelde afbeelding.
includeinalertpreferences
 includeinalertpreferences string

Omvat in waarschuwingsvoorkeuren.
min
 min string

Minimumwaarde voor de kolom.
max
 max string

Maximumwaarde voor de kolom.
decimalen
 decimalplaces integer

Aantal decimalen.
showthousandseparators
 showthousandseparators string

Geeft scheidingstekens voor duizendtallen weer.
showaspercentage
 showaspercentage string

Geeft de waarde weer als percentage.
formattype
 formattype string

Hiermee geeft u het indelingstype van de kolom.
datumnotatie
 dateformat string

Hiermee definieert u de datumnotatie voor de kolom.
defaultdateandtime
 defaultdateandtime string

Hiermee stelt u de standaardwaarde voor datum en tijd voor de kolom in.
bladlookup
 sheetlookup string

Geeft aan of de kolom een zoekactie naar een ander blad is.
fielddisplay
 fielddisplay string

Bepaalt hoe het veld wordt weergegeven.
allowmultipleusers
 allowmultipleusers string

Hiermee geeft u op of meerdere gebruikers toegang hebben tot het veld.
methodtype
 methodtype string

Hiermee definieert u het methodetype voor de kolom.
blad-id's
 sheetids string

Een lijst met de id's van de bladen die aan de kolom zijn gekoppeld.
allowuserstorenamelinks
 allowuserstorenamelinks string

Geeft aan of gebruikers de naam van koppelingen in de kolom kunnen wijzigen.
blad-id
 sheetid integer

Hiermee geeft u de id van het blad.
columnids
 columnids string

Hiermee worden de id's van de kolommen weergegeven.
viewid
 viewid integer

Hiermee geeft u de id van de weergave.
allowmultiplevalues
 allowmultiplevalues string

Geeft aan of er meerdere waarden zijn toegestaan in de kolom.
restrictdelete
 restrictdelete string

Hiermee geeft u op of verwijdering is beperkt voor de kolom.
displaycolumnnameprefix
 displaycolumnnameprefix string

Hiermee stelt u het voorvoegsel voor de weergave van de kolomnaam in.
koppelingsnaam
 linkname string

Hiermee definieert u de naam van de koppeling die aan de kolom is gekoppeld.
donotcountweekendsonlycountmontofri
 donotcountweekendsonlycountmontofri string

Hiermee geeft u op of weekenden worden uitgesloten bij het tellen.
currentsheetcolumnid
 currentsheetcolumnid integer

Id van de huidige bladkolom.
targetsheetcolumnid
 targetsheetcolumnid integer

Id van de kolom van het doelblad.
formule
 formula string

Hiermee geeft u de formule die op de kolom wordt toegepast.
startvalue
 startvalue integer

Hiermee stelt u de beginwaarde voor de kolom in.
prefix
 prefix string

Hiermee definieert u het voorvoegsel voor de kolomwaarden.
Postfix
 postfix string

Hiermee definieert u het voorvoegsel voor de kolomwaarden.
minlength
 minlength integer

Hiermee geeft u de minimale lengte van de kolomwaarden.
lookupglossarysheetid
 lookupglossarysheetid integer

Hiermee geeft u de id van het opzoekwoordblad op.
lookupglossarysheetviewid
 lookupglossarysheetviewid integer

Hiermee geeft u de weergave-id van het opzoekwoordblad op.
width
 width integer

Hiermee stelt u de breedte van de kolom in.
otherscorevalue
 otherscorevalue string

Hiermee definieert u de andere scorewaarde voor de kolom.
importdatafromexternalsource
 importdatafromexternalsource string

Geeft aan of gegevens worden geïmporteerd uit een externe bron.
analysisengine
 analysisengine string

Hiermee geeft u de analyse-engine die wordt gebruikt voor de kolom.
attachmentcustomfolderid
 attachmentcustomfolderid integer

Hiermee geeft u de aangepaste map-id voor bijlagen.
isattachmentfoldercurrentsite
 isattachmentfoldercurrentsite integer

Geeft aan of de bijlagemap zich op de huidige site bevindt.
singleLineEmailValidation
 singleLineEmailValidation string

Hiermee geeft u op of validatie van e-mail met één regel wordt toegepast.
alleen lezen
 readonly string

Geeft aan of de kolom het kenmerk Alleen-lezen heeft.
virtualColumn
 virtualColumn integer

Hiermee geeft u op of de kolom virtueel is.
allowInlineEditing
 allowInlineEditing string

Geeft aan of inlinebewerking is toegestaan voor de kolom.
volgorde
 sequence string

Volgnummer van de kolom.
attributecolumnid
 attributecolumnid string

Kenmerkkolom-id.
waarde
 value string

Waarde van onbewerkte gegevens.
date
 date string

datum van onbewerkte gegevens.
time
 time string

Tijd van onbewerkte gegevens.
linkdisplayname
 linkdisplayname string

Naam van koppeling weergeven.
linkdisplayurl
 linkdisplayurl string

URL-koppeling weergeven.
identiteitskaart
 id string

Opzoek-id
e-mailadres
 email string

E-mailadres.
userlookuptype
 userlookuptype string

Type gebruikerszoekactie.
folderid
 folderid string

Map-id.
docid
 docid string

Document-id.
fromdate
 fromdate string

Vanaf datum.
todate
 todate string

Tot heden.
bestand
 file string

De bestandsinhoud.
naam
 name string

De naam van de bijlage.
order
 order string

De volgorde van de bijlage.
identiteitskaart
 id integer

Unieke id voor de bijlage.
uitbreiding
 extension string

Bestandsextensie.
parentfolderid
 parentfolderid integer

Id van de bovenliggende map.
filehttplink
 filehttplink string

HTTP-koppeling voor toegang tot het bestand.
mappad
 folderpath string

Pad naar de map met het bestand.
maphttplink
 folderhttplink string

HTTP-koppeling naar de map.
filesize
 filesize integer

Grootte van het bestand in bytes.
redactionStatus
 redactionStatus boolean

Geeft aan of het bestand is bewerkt.
displayname
 displayname string

Weergavenaam van de bijlage.
siteid
 siteid integer

Id van de site die is gekoppeld aan de bijlage.
Geregistreerde ID
 recordid string

Record-id.
koppelingsnaam
 linkname string

Koppelingsnaam.
apilink
 apilink string

API-koppeling.
httplink
 httplink string

HTTP-koppeling.
colViewPosition
 colViewPosition integer

Positie van de kolom in de weergave.
columntype
 columntype string

Type van de kolom.
aanmaakdatum
 createdDate date-time

Datum en tijd waarop de kolom is gemaakt.
modifiedDate
 modifiedDate date-time

Datum en tijd waarop de kolom voor het laatst is gewijzigd.
injectReferenceColumn
 injectReferenceColumn integer

Verwijzing naar een geïnjecteerde kolom
parentColumnID
 parentColumnID integer

Id van de bovenliggende kolom.
reusecolumnidfromisheet
 reusecolumnidfromisheet integer

Kolom-id die opnieuw wordt gebruikt vanuit een invoerblad.
keuzelijst-id
 choicelistid integer

Id voor de keuzelijst die aan de kolom is gekoppeld.
alerteroption
 alerteroption string

Instelling voor waarschuwingsopties voor het item.
bladtype-id
 sheettypeid integer

Id voor het bladtype.
enableSmartForm
 enableSmartForm string

Hiermee worden slimme formulierfuncties geactiveerd.
allowDeletedItemsView
 allowDeletedItemsView string

Hiermee kunt u verwijderde items weergeven.
allowAllColumnsInCustomView
 allowAllColumnsInCustomView string

Hiermee staat u alle kolommen in aangepaste weergaven toe.

Retouren

Body
ProgressiveKeyDBO

iSheet-kolommen ophalen

Bewerkings-id:
getIsheetColumns

Met deze API-aanroep worden de kolommen opgehaald die zijn gekoppeld aan het opgegeven iSheet. Deze functionaliteit wordt ondersteund in API-versie 3 en hoger.

Parameters

Name Sleutel Vereist Type Description
iSheet-id
 isheetid True integer

Hiermee geeft u de unieke id van het iSheet waarvoor kolommen vereist zijn.
API-versie
 version True string

Hiermee geeft u de versie op van de API die wordt gebruikt.
iSheet-weergave-id
 sheetviewid string

Hiermee geeft u de id van de iSheet-weergave. Als u dit weglaat, worden alle kolommen geretourneerd.
Verwijderde iSheet-kolommen opnemen
 onlyForDeletedIsheet boolean

Hiermee wordt aangegeven of kolommen uit een verwijderd iSheet moeten worden opgenomen. De standaardwaarde is onwaar.

Retouren

Body
columns

Map maken

Bewerkings-id:
addFolder

Met deze API maakt u een nieuwe map binnen de opgegeven site. Hiermee kunt u mapdetails opgeven en ervoor zorgen dat de map wordt gemaakt onder de opgegeven bovenliggende map.

Parameters

Name Sleutel Vereist Type Description
API-versie
 version True string

Hiermee geeft u de API-versie.
Batch-id
 batchid string

Een unieke id voor de batchbewerking.
Hoofdmap-id
 rootfolderid string

De unieke id van de hoofdmap.
Id van bovenliggende map
 parentfolderid True string

De unieke id van de bovenliggende map waar de nieuwe map wordt gemaakt.
Dubbele map toestaan
 allowduplicatefolder boolean

Geeft aan of dubbele mappen zijn toegestaan in de opgegeven bovenliggende map.
naam
 name True string

De naam van de map.
beschrijving
 description string

Een beschrijving van de map.
accessInherited
 accessInherited integer

Geeft aan of de maptoegang is overgenomen.
batchID
 batchID string

De batch-id voor de bewerking.
dmsfolderid
 dmsfolderid string

De DMS-map-id.
dmsParentFolderID
 dmsParentFolderID string

De bovenliggende DMS-map-id.
dmscreateddate
 dmscreateddate date-time

De datum waarop de DMS-map is gemaakt.
dmsmodifiedBy
 dmsmodifiedBy string

De gebruiker die de DMS-map voor het laatst heeft gewijzigd.
dmsdatabasename
 dmsdatabasename string

De naam van de DMS-database.
dmslink
 dmslink boolean

Geeft aan of er een DMS-koppeling beschikbaar is.
dmslinkby
 dmslinkby string

De gebruiker die de DMS-map heeft gekoppeld.
emailmetadata
 emailmetadata string

E-mailmetagegevens die aan de map zijn gekoppeld.

Retouren

Body
FolderDBOV1

Mapgegevens ophalen

Bewerkings-id:
getFolderInfo

De methode bevat mapdetails van de opgegeven map-id.

Parameters

Name Sleutel Vereist Type Description
API-versie
 version True string

versie van api
Map-id
 folderid True string

folderID
Statusinformatie
 statusinfo boolean

Met de parameter statusinfo hebt u toegang tot aanvullende informatie over de map. De beschikbare informatie omvat Gedeelde status, Favoriete status voor aangemelde gebruiker

Retouren

Body
FolderDBOV2

Site bijwerken

Bewerkings-id:
updateSite

Gebruik dit API-eindpunt om de details van een bestaande site bij te werken. De API ondersteunt dezelfde velden die worden gebruikt in de site-API maken.

Deze methode ondersteunt meerdere materienummers die aan de site kunnen worden toegevoegd met API-versie 10 en hoger. De tag 'matternos' geeft meerdere materienummers aan met alleen-lezen of niet.

Versie 18 en hoger: een categorie (sitedoel) is vereist. Als het doel van de site verborgen is, wordt er een bericht weergegeven; anders worden verborgen sitedoeleinden niet toegevoegd aan de site.

Site-eigenaar kan nu ook andere gebruikers worden toegewezen, maar ze moeten sitedeelnemers zijn en een rol hebben die hoger is dan de sitebeheerder.

Versie 18 en hoger: de site-eigenaar kan andere gebruikers toevoegen aan de site.

Vanaf API-versie 19 wordt een nieuwe module met de naam customPages geïntroduceerd, die nauw is gekoppeld aan de basismodule. Als de waarde van de basismodule True is, moet customPages waar zijn en omgekeerd.

Houd er rekening mee dat alle eigenschappen/elementen in het ophalen van een siteantwoord niet kunnen worden bijgewerkt of ingevoegd. Zie de onderstaande tabel om te weten welke alleen-lezen, kan worden bijgewerkt of ingevoegd.

Parameters

Name Sleutel Vereist Type Description
De versie van de API die wordt aangevraagd
 version True string

versie van api
De unieke id voor de site
 siteid True string

De id voor de site
identiteitskaart
 id integer

De site-id.
sitenaam
 sitename string

De naam van de site.
rol
 role string

De rol van de site.
sitedescriptie
 sitedescription string

De beschrijving van de site.
enabledmodules
 enabledmodules string

Een lijst met modules die zijn ingeschakeld voor de site.
sitefolderID
 sitefolderID string

De id voor de map van de site.
sitefolderpermission
 sitefolderpermission string

Het machtigingsniveau voor de map van de site.
enable
 enable string

Schakel de status in voor HomeDBO.
enable
 enable string

Schakel de status in voor ActivityDBO.
microblog
 microblog string

Microblog-inhoud die is gekoppeld aan ActivityDBO.
docid
 docid string

Document-id.
blogTitle
 blogTitle string

Titel van het blogbericht.
blogContent
 blogContent string

Inhoud van het blogbericht.
showComment
 showComment integer

de opmerking weergeven.
tagList
 tagList array of string

Lijst met tags die zijn gekoppeld aan de blog.
status
 status integer

status van het blogbericht.
siteID
 siteID integer

Id voor de gekoppelde site.
auteur
 author string

Auteur van het blog.
categoryList
 categoryList array of string

Categorieën die zijn toegewezen aan het blogbericht.
notificationTypeID
 notificationTypeID integer

Id voor het meldingstype.
message
 message string

Berichtinhoud met betrekking tot de blog.
messageCode
 messageCode integer

Code die is gekoppeld aan het bericht.
externe-ID
 externalID string

Externe id gekoppeld aan de blog.
publiceerdatum
 publishDate string

Publicatiedatum van het blog.
processtype
 processtype string

Procestype dat is gekoppeld aan de blog.
enable
 enable string

Schakel de status in voor BlogDBO.
wikiid
 wikiid integer

Unieke id voor de wiki.
currentversionid
 currentversionid integer

Id voor de huidige versie van de wiki
parentwikiid
 parentwikiid integer

Id voor de bovenliggende wiki.
wikititel
 wikititle string

Titel van de wiki.
wikicontent
 wikicontent string

Inhoud van de wiki.
opmerkingen weergeven
 showcomment integer

Geeft aan of opmerkingen zijn ingeschakeld.
createddate
 createddate string

Aanmaakdatum van de wiki.
modifieddate
 modifieddate string

Datum van laatste wijziging van de wiki.
taglist
 taglist string

Door komma's gescheiden lijst met tags die aan de wiki zijn gekoppeld.
wikipath
 wikipath string

Pad naar toegang tot de wiki.
wikidraftid
 wikidraftid integer

Id voor de conceptversie van de wiki.
concepttype
 drafttype string

Type concept dat is gekoppeld aan de wiki.
status
 status integer

Huidige status van de wiki.
wikiversionid
 wikiversionid integer

Versie-id van de wiki.
index
 index string

Index of id voor de taak.
parenttaskid
 parenttaskid integer

Id voor de bovenliggende taak.
taskid
 taskid integer

Unieke id voor de taak.
title
 title string

Titel van de taak.
beschrijving
 description string

Gedetailleerde beschrijving van de taak.
duedate
 duedate string

Einddatum voor de voltooiing van de taak.
startdate
 startdate string

Begindatum waarop de taak is gestart.
mattermaptaskid
 mattermaptaskid string

Id die is gekoppeld aan de toewijzingstaak van de kwestie.
type
 type string

Type of categorie van de taak.
dependenton
 dependenton string

Taken waarop deze taak afhankelijk is.
daysfromdependent
 daysfromdependent string

Aantal dagen vanaf de afhankelijke taak.
ignoreweekend
 ignoreweekend integer

Geeft aan of weekenden worden genegeerd in de planning.
duration
 duration integer

Duur om de taak te voltooien.
resource
 resource string

Resources die aan de taak zijn toegewezen.
eventTitle
 eventTitle string

Titel van de gebeurtenis.
eventContent
 eventContent string

Inhoud van de gebeurtenis.
showComment
 showComment integer

Hiermee wordt aangegeven of opmerkingen zijn ingeschakeld voor de gebeurtenis.
tagList
 tagList array of string

Lijst met tags die zijn gekoppeld aan de gebeurtenis.
status
 status integer

Huidige status van de gebeurtenis.
siteID
 siteID integer

Id voor de site.
contactpersoon
 contact string

Contactgegevens voor de gebeurtenis.
categoryList
 categoryList array of string

Categorieën waaronder de gebeurtenis wordt vermeld.
notificationTypeID
 notificationTypeID integer

Het meldingstype dat is gerelateerd aan de gebeurtenis.
message
 message string

Het bericht van de gebeurtenis.
messageCode
 messageCode integer

De berichtcode van de gebeurtenis.
externe-ID
 externalID string

De externe id.
startDate
 startDate string

De begindatum van de gebeurtenis.
einddatum
 endDate string

De einddatum van de gebeurtenis.
startTime
 startTime string

De begintijd van de gebeurtenis.
endTime
 endTime string

De eindtijd van de gebeurtenis.
location
 location string

De locatie van de gebeurtenis.
auteur
 author string

De auteur van de gebeurtenis.
processtype
 processtype string

De procestijd van de gebeurtenis.
enable
 enable string

Schakel de gebeurtenis in.
identiteitskaart
 id integer

Unieke id voor het iSheet.
title
 title string

Titel van het iSheet.
beschrijving
 description string

Beschrijving van het isheet.
status
 status string

Status van het isheet.
toegangstype
 accesstype string

Toegangstype van het isheet.
type
 type string

Type van het isheet.
viewlink
 viewlink string

Koppeling om het iSheet weer te geven.
allowsections
 allowsections string

Of secties zijn toegestaan.
allowlookup
 allowlookup string

Of opzoekvelden zijn ingeschakeld.
displayisheet
 displayisheet string

Weergaveopties voor het iSheet.
searchasdefaultview
 searchasdefaultview string

Geeft aan of zoeken de standaardweergave is.
enableversion
 enableversion string

Vlag versiebeheer ingeschakeld.
enablesheetalerter
 enablesheetalerter string

Vlag om bladwaarschuwingen in te schakelen.
alertercondition
 alertercondition string

Voorwaarden voor het activeren van waarschuwingen.
overrideitemmodifieddate
 overrideitemmodifieddate string

Wijzigingsdatumvlag negeren.
enablebulkinsertupdate
 enablebulkinsertupdate string

Schakel bulksgewijs invoegen/bijwerken in.
fielddescriptions
 fielddescriptions string

Veldbeschrijvingen voor het iSheet.
enablerowlocking
 enablerowlocking string

Schakel vergrendeling op rijniveau in.
setcharlimittruncatemultilinetextenabled
 setcharlimittruncatemultilinetextenabled string

Tekstvlag met meerdere regels afkappen.
setcharlimittruncatemultilinetextval
 setcharlimittruncatemultilinetextval string

Tekenlimiet voor afkapping van meerdere regels.
allowchoicelistvaluesforreuse
 allowchoicelistvaluesforreuse string

Het opnieuw gebruiken van keuzelijstwaarden toestaan.
allowscorelistvaluesforreuse
 allowscorelistvaluesforreuse string

Het opnieuw gebruiken van scorelijstwaarden toestaan.
allowIsheetComments
 allowIsheetComments string

Opmerkingen toestaan in iSheet.
shareRecordsLimit
 shareRecordsLimit integer

Limiet van records die mogen worden gedeeld.
shareRecordsLimitEnabled
 shareRecordsLimitEnabled integer

Limiet voor het delen van records is ingeschakeld.
enableIsheetAddRecordFormSharing
 enableIsheetAddRecordFormSharing string

Schakel het delen van formulieren in voor het toevoegen van records.
recordcount
 recordcount string

Huidige recordaantal.
bladtype-id
 sheettypeid integer

Type-id van het iSheet
enable
 enable string

Qa-functionaliteit inschakelen.
userid
 userid integer

Gebruikers-id.
e-mailadres
 email string

e-mailadres.
httpavatar
 httpavatar string

HTTP-URL van avatar.
avatar
 avatar string

Avatarafbeelding.
userlink
 userlink string

Koppeling naar gebruikersprofiel.
httplink
 httplink string

HTTP-koppeling naar gebruikersprofiel.
phone
 phone string

Telefoonnummer.
mobile
 mobile string

Mobiel nummer.
afdeling
 department string

Afdeling van de gebruiker.
enable
 enable string

Schakel Contract Express-integratie in.
adminnote
 adminnote string

Beheernotities met betrekking tot de site.
startdate
 startdate string

De begindatum van de bewerking van de site.
einddatum
 enddate string

De einddatum van de bewerking van de site.
createddate
 createddate string

De datum waarop de site is gemaakt.
archiveddate
 archiveddate string

De datum waarop de site is gearchiveerd.
clientno
 clientno string

Het clientnummer dat aan de site is gekoppeld.
matterno
 matterno string

Het nummer van de materie dat aan de site is gekoppeld.
landingspagina
 landingpage string

De URL van de landingspagina voor de site.
verbinden
 link string

Een koppeling met betrekking tot de site.
status
 status string

De huidige status van de site.
statusid
 statusid integer

De id voor de status van de site.
size
 size string

De grootte van de site.
billingnotes
 billingnotes string

Notities met betrekking tot facturering voor de site.
billingnextinvoicedate
 billingnextinvoicedate string

De datum van de volgende factuur voor de site.
billinglastinvoicedate
 billinglastinvoicedate string

De datum van de laatste factuur voor de site.
filepagecount
 filepagecount string

Het totale aantal pagina's van bestanden op de site.
maxpagecount
 maxpagecount string

Het maximaal toegestane aantal pagina's voor bestanden op de site.
sitehttplink
 sitehttplink string

De HTTP-koppeling naar de site.
isSyncable
 isSyncable integer

Geeft aan of de site kan worden gesynchroniseerd.
enforceusergroups
 enforceusergroups string

De gebruikersgroepen die zijn afgedwongen voor de site.
csvSiteCategory
 csvSiteCategory string

De categorie van de site in CSV-indeling.
siteNameInDefaultLanguage
 siteNameInDefaultLanguage string

De naam van de site in de standaardtaal.
zichtbaar
 visible integer

Geeft aan of de site zichtbaar is.
siteLogoName
 siteLogoName string

De naam van het logobestand van de site.
siteLogoFileSize
 siteLogoFileSize integer

De bestandsgrootte van het logo van de site.
siteLogoHeight
 siteLogoHeight integer

De hoogte van het logo van de site.
siteLogoWidth
 siteLogoWidth integer

De breedte van het logo van de site.
siteStatus
 siteStatus integer

De statuscode van de site.
applySiteTerms
 applySiteTerms integer

Geeft aan of sitetermen worden toegepast.
siteTerm
 siteTerm string

De voorwaarden die op de site worden toegepast.
termType
 termType integer

Het type termen dat op de site wordt toegepast.
nextLoginSiteTerms
 nextLoginSiteTerms integer

Geeft aan of sitevoorwaarden vereist zijn voor de volgende aanmelding.
defaultSiteTermsEnable
 defaultSiteTermsEnable integer

Geeft aan of standaardsitetermen zijn ingeschakeld.
advancedQAPermission
 advancedQAPermission integer

Het geavanceerde QA-machtigingsniveau voor de site.
isIntern
 isInternal integer

Geeft aan of de site intern is.
Psm
 psm integer

De Product Service Manager-id.
siteLabelDisplay
 siteLabelDisplay string

Het weergavelabel voor de site.
allowSiteAdministration
 allowSiteAdministration integer

Geeft aan of sitebeheer is toegestaan.
siteLevelPasswordEnable
 siteLevelPasswordEnable integer

Wachtwoordbeveiliging op siteniveau inschakelen.
siteLevelPasscodeEnable
 siteLevelPasscodeEnable integer

Wachtwoordcodebeveiliging op siteniveau inschakelen.
passcodeUsingAuthApp
 passcodeUsingAuthApp integer

Geeft aan of wachtwoordcodeverificatie gebruikmaakt van een verificatie-app.
sitePassword
 sitePassword string

Het wachtwoord dat aan de site is gekoppeld.
ipRestrictionEnable
 ipRestrictionEnable integer

IP-beperkingen voor sitetoegang inschakelen.
beschikbareIP
 availableIP string

Door komma's gescheiden lijst met IP-adressen die toegang hebben tot de site.
highqDrive
 highqDrive integer

Geeft aan of HighQ Drive-integratie is ingeschakeld.
applySiteHomePage
 applySiteHomePage integer

Een aangepaste startpagina voor de site toepassen.
siteHomePage
 siteHomePage string

URL van de aangepaste startpagina voor de site.
siteHomePageType
 siteHomePageType integer

Type van de startpagina.
nextLoginSiteHomePage
 nextLoginSiteHomePage integer

Als u de volgende aanmelding wilt instellen op de startpagina van de site.
applyDisplayContent
 applyDisplayContent integer

Weergave-inhoudsinstellingen toepassen.
displayContent
 displayContent string

Inhoud die op de site moet worden weergegeven.
rssSecurity
 rssSecurity integer

Beveiligingsniveau van RSS-feed.
versleuteld wachtwoord
 encryptedPassword integer

Geeft aan of het sitewachtwoord is versleuteld.
beschikbareIPRangeCSV
 availableIPRangeCSV string

Door komma's gescheiden lijst met IP-adresbereiken die toegang hebben tot de site.
siteModuleID
 siteModuleID integer

Id voor de sitemodule.
icalSecurity
 icalSecurity integer

Beveiligingsniveau voor iCal-feed.
defaultDisplayContent
 defaultDisplayContent string

Standaardinhoud die op de site wordt weergegeven.
defaultEmailAlert
 defaultEmailAlert integer

Standaardwaarschuwingen voor e-mail inschakelen.
excelReportFooter
 excelReportFooter integer

Bevat een voettekst in Excel-rapporten.
excelReportFooterText
 excelReportFooterText string

Tekst die moet worden weergegeven in de voettekst van Excel-rapporten.
aankondigingMLJSON
 announcementMLJSON string

Aankondigingen met JSON-indeling voor de site.
sjabloonType
 templateType integer

Het type sjabloon dat wordt gebruikt voor de site.
templateLicence
 templateLicence integer

Licentietype voor de sitesjabloon.
openChannelAppID
 openChannelAppID string

Toepassings-id voor de integratie van het open kanaal.
itemid
 itemid integer

Id voor het item dat is gekoppeld aan de site.
sitemetadatasheetid
 sitemetadatasheetid integer

Id van het metagegevensblad dat is gekoppeld aan de site.
mijn site
 mysite boolean

Geeft aan of dit de persoonlijke site van de gebruiker is.
lastaccesseddate
 lastaccesseddate string

De datum en tijd waarop de site voor het laatst is geopend.
defaultViewerMetaDataTab
 defaultViewerMetaDataTab integer

Het tabblad Standaardmetagegevens voor de siteviewer.
documentMetadataViewId
 documentMetadataViewId integer

documentmetagegevens voor weergave-id.
folderMetadataViewId
 folderMetadataViewId integer

mapmetagegevens voor weergave-id.
docSort
 docSort integer

De sorteervolgorde van documenten.
folderSort
 folderSort integer

De sorteervolgorde van mappen.
defaultFolderRenderView
 defaultFolderRenderView integer

Bepaalt de standaardweergavemodus voor mappen.
isTaskAttachmentDefault
 isTaskAttachmentDefault integer

De standaardlocatie voor taakbijlagen.
taskAttachmentDefaultFolderId
 taskAttachmentDefaultFolderId integer

De unieke id van de map die is aangewezen als de standaardlocatie voor taakbijlagen.
favoriet
 favourite string

favoriete status.
enabledocumentredaction
 enabledocumentredaction boolean

Hiermee geeft u op of documentredactie is ingeschakeld voor de site.
vermeldingsgroepen
 mentiongroups integer

De genoemde groepen.
enablefilerelationships
 enablefilerelationships boolean

Geeft aan of bestandsrelaties zijn ingeschakeld.
filerelationshipsitepermissionlevel
 filerelationshipsitepermissionlevel integer

Het machtigingsniveau dat is vereist voor het beheren van bestandsrelaties.

Site toevoegen

Bewerkings-id:
createSite

Gebruik deze API om een nieuwe site te maken. Het siteobject ondersteunt alleen kenmerken die zichtbaar zijn in de interface voor het maken van een site.

Deze API vereist sitenaam (en verplichte velden die zijn geconfigureerd op ASP-niveau indien aanwezig) om een nieuwe site te maken.

De tag module vertegenwoordigt een andere module die moet worden geconfigureerd op de site, zoals deze wordt weergegeven in aanvraagkenmerken.
Site maken op sjabloon door de tag 'sitetemplateid' door te geven
     - Voor minder dan versie 7 vindt de configuratie van de sjabloonmodule plaats als er geen module ('module'-tag wordt doorgegeven) in de aanvraag. Als de moduletag wordt geleverd met configuratie, respecteert en configureert deze zoals opgegeven in de aanvraag (in plaats van de configuratie van de sjabloonmodule te gebruiken)
     - Voor meer dan versie 7 vindt de configuratie van de sjabloonmodule plaats als er een module ('module'-tag wordt doorgegeven) of niet in de aanvraag.

Deze methode biedt geen ondersteuning voor het uploaden van site-installatiekopieën in deze aanroep. De ondersteuning voor het sitepictogram wordt aangeboden als een afzonderlijk gesprek.
In de methodeaanroep wordt een bestaande categorie-id verwacht. De categorie-id moet worden verkregen door de aanroepende toepassing door een eerdere aanroep naar de interface sitecategorieën. Als er geen categorieën in de aanvraag worden gegeven, wordt standaard geen categorie (geen werkelijke categorie) toegevoegd.

De begin- en einddatum van de site moeten de notatie dd MMM jjjj hebben en is NIET UTC. API-client vraagt altijd de werkelijke datum aan.

'landingpage' heeft de standaardwaarde 'bestanden (hoofdmap)'.
'landingpage' verwacht drie verschillende formuleringen of identificaties voor de bestandsmodule. Mogelijke waarden zijn:
- bestanden (hoofdmap)
- bestanden (recente activiteit)
- bestanden (geavanceerd zoeken)
De implementatie van de methode ondersteunt nu (vanaf 5.1) Meertalige sitenaam. Api-versie 6 of hoger <vertegenwoordigt de sitenaam> in de aanvraagtekst op basis van de volgorde van de gebruikersvoorkeur. API-versie 5 of oudere <sitenaam> vertegenwoordigt standaard Engels in het Vk.
<sitenametranslations vertegenwoordigen> sitenamen in elke taal (die vanaf 5.1 extra tag in 'Object zelf API' wordt genoemd) API-versie 6 of hoger, in de aanvraagtekst worden beide tags verzonden, zoals <sitenaam> en <sitenaamtranslations> . Vervolgens moeten we waarden valideren, bijvoorbeeld <sitenaam> moet overeenkomen met de respectieve <vertaaltag> in termen van de taalvoorkeur van de gebruiker. API 7 of hoger, de site die op basis van de sjabloon is gemaakt, volgt modules uit de bronsjabloon en negeert de modulelijst die wordt verzonden in de aanvraagbody.

De methode-implementatie biedt nu ondersteuning voor het maken van een site op basis van een sjabloon door de tag 'sitetemplateid' op te geven (oude benadering)

Houd er rekening mee dat de ondersteuning voor het maken van een site op basis van een sjabloon met deze API in de toekomst wordt afgeschaft. Als u een site op basis van een sjabloon wilt maken, gebruikt u de nieuwe API Create-site op basis van sjabloon (/sites/sjablonen/{templateid}/site) die een lange polling-API is (met ondersteuning voor langlopende aanvragen)

Deze methode ondersteunt meerdere materienummers die aan de site kunnen worden toegevoegd met API-versie 10 en hoger. De tag 'matternos' geeft meerdere materienummers aan met alleen-lezen of niet. Oudere versie (kleiner dan versie 10) single matterno geeft het eerste kwestienummer van het bestaan van meerdere materienummers in de site weer.

Versie 18 en hoger: een categorie (sitedoel) is vereist. Als het doel van de site verborgen is, wordt er een bericht weergegeven; anders worden verborgen sitedoeleinden niet toegevoegd aan de site.

Tot versie 17: de site-eigenaar is de aangemelde gebruiker; er kunnen geen andere gebruikers worden toegevoegd.

Versie 18 en hoger: de site-eigenaar kan andere gebruikers toevoegen aan de site.

Vanaf API-versie 19 wordt een nieuwe module geïntroduceerd met de naam 'customPages' die nauw is gekoppeld aan de basismodule. Dus als de waarde van de basismodule Waar is, is customPages waar en omgekeerd.

Parameters

Name Sleutel Vereist Type Description
De versie van de API die wordt aangevraagd
 version True string

versie van api
identiteitskaart
 id integer

De site-id.
sitenaam
 sitename string

De naam van de site.
rol
 role string

De rol van de site.
sitedescriptie
 sitedescription string

De beschrijving van de site.
enabledmodules
 enabledmodules string

Een lijst met modules die zijn ingeschakeld voor de site.
sitefolderID
 sitefolderID string

De id voor de map van de site.
sitefolderpermission
 sitefolderpermission string

Het machtigingsniveau voor de map van de site.
enable
 enable string

Schakel de status in voor HomeDBO.
enable
 enable string

Schakel de status in voor ActivityDBO.
microblog
 microblog string

Microblog-inhoud die is gekoppeld aan ActivityDBO.
docid
 docid string

Document-id.
blogTitle
 blogTitle string

Titel van het blogbericht.
blogContent
 blogContent string

Inhoud van het blogbericht.
showComment
 showComment integer

de opmerking weergeven.
tagList
 tagList array of string

Lijst met tags die zijn gekoppeld aan de blog.
status
 status integer

status van het blogbericht.
siteID
 siteID integer

Id voor de gekoppelde site.
auteur
 author string

Auteur van het blog.
categoryList
 categoryList array of string

Categorieën die zijn toegewezen aan het blogbericht.
notificationTypeID
 notificationTypeID integer

Id voor het meldingstype.
message
 message string

Berichtinhoud met betrekking tot de blog.
messageCode
 messageCode integer

Code die is gekoppeld aan het bericht.
externe-ID
 externalID string

Externe id gekoppeld aan de blog.
publiceerdatum
 publishDate string

Publicatiedatum van het blog.
processtype
 processtype string

Procestype dat is gekoppeld aan de blog.
enable
 enable string

Schakel de status in voor BlogDBO.
wikiid
 wikiid integer

Unieke id voor de wiki.
currentversionid
 currentversionid integer

Id voor de huidige versie van de wiki
parentwikiid
 parentwikiid integer

Id voor de bovenliggende wiki.
wikititel
 wikititle string

Titel van de wiki.
wikicontent
 wikicontent string

Inhoud van de wiki.
opmerkingen weergeven
 showcomment integer

Geeft aan of opmerkingen zijn ingeschakeld.
createddate
 createddate string

Aanmaakdatum van de wiki.
modifieddate
 modifieddate string

Datum van laatste wijziging van de wiki.
taglist
 taglist string

Door komma's gescheiden lijst met tags die aan de wiki zijn gekoppeld.
wikipath
 wikipath string

Pad naar toegang tot de wiki.
wikidraftid
 wikidraftid integer

Id voor de conceptversie van de wiki.
concepttype
 drafttype string

Type concept dat is gekoppeld aan de wiki.
status
 status integer

Huidige status van de wiki.
wikiversionid
 wikiversionid integer

Versie-id van de wiki.
index
 index string

Index of id voor de taak.
parenttaskid
 parenttaskid integer

Id voor de bovenliggende taak.
taskid
 taskid integer

Unieke id voor de taak.
title
 title string

Titel van de taak.
beschrijving
 description string

Gedetailleerde beschrijving van de taak.
duedate
 duedate string

Einddatum voor de voltooiing van de taak.
startdate
 startdate string

Begindatum waarop de taak is gestart.
mattermaptaskid
 mattermaptaskid string

Id die is gekoppeld aan de toewijzingstaak van de kwestie.
type
 type string

Type of categorie van de taak.
dependenton
 dependenton string

Taken waarop deze taak afhankelijk is.
daysfromdependent
 daysfromdependent string

Aantal dagen vanaf de afhankelijke taak.
ignoreweekend
 ignoreweekend integer

Geeft aan of weekenden worden genegeerd in de planning.
duration
 duration integer

Duur om de taak te voltooien.
resource
 resource string

Resources die aan de taak zijn toegewezen.
eventTitle
 eventTitle string

Titel van de gebeurtenis.
eventContent
 eventContent string

Inhoud van de gebeurtenis.
showComment
 showComment integer

Hiermee wordt aangegeven of opmerkingen zijn ingeschakeld voor de gebeurtenis.
tagList
 tagList array of string

Lijst met tags die zijn gekoppeld aan de gebeurtenis.
status
 status integer

Huidige status van de gebeurtenis.
siteID
 siteID integer

Id voor de site.
contactpersoon
 contact string

Contactgegevens voor de gebeurtenis.
categoryList
 categoryList array of string

Categorieën waaronder de gebeurtenis wordt vermeld.
notificationTypeID
 notificationTypeID integer

Het meldingstype dat is gerelateerd aan de gebeurtenis.
message
 message string

Het bericht van de gebeurtenis.
messageCode
 messageCode integer

De berichtcode van de gebeurtenis.
externe-ID
 externalID string

De externe id.
startDate
 startDate string

De begindatum van de gebeurtenis.
einddatum
 endDate string

De einddatum van de gebeurtenis.
startTime
 startTime string

De begintijd van de gebeurtenis.
endTime
 endTime string

De eindtijd van de gebeurtenis.
location
 location string

De locatie van de gebeurtenis.
auteur
 author string

De auteur van de gebeurtenis.
processtype
 processtype string

De procestijd van de gebeurtenis.
enable
 enable string

Schakel de gebeurtenis in.
identiteitskaart
 id integer

Unieke id voor het iSheet.
title
 title string

Titel van het iSheet.
beschrijving
 description string

Beschrijving van het isheet.
status
 status string

Status van het isheet.
toegangstype
 accesstype string

Toegangstype van het isheet.
type
 type string

Type van het isheet.
viewlink
 viewlink string

Koppeling om het iSheet weer te geven.
allowsections
 allowsections string

Of secties zijn toegestaan.
allowlookup
 allowlookup string

Of opzoekvelden zijn ingeschakeld.
displayisheet
 displayisheet string

Weergaveopties voor het iSheet.
searchasdefaultview
 searchasdefaultview string

Geeft aan of zoeken de standaardweergave is.
enableversion
 enableversion string

Vlag versiebeheer ingeschakeld.
enablesheetalerter
 enablesheetalerter string

Vlag om bladwaarschuwingen in te schakelen.
alertercondition
 alertercondition string

Voorwaarden voor het activeren van waarschuwingen.
overrideitemmodifieddate
 overrideitemmodifieddate string

Wijzigingsdatumvlag negeren.
enablebulkinsertupdate
 enablebulkinsertupdate string

Schakel bulksgewijs invoegen/bijwerken in.
fielddescriptions
 fielddescriptions string

Veldbeschrijvingen voor het iSheet.
enablerowlocking
 enablerowlocking string

Schakel vergrendeling op rijniveau in.
setcharlimittruncatemultilinetextenabled
 setcharlimittruncatemultilinetextenabled string

Tekstvlag met meerdere regels afkappen.
setcharlimittruncatemultilinetextval
 setcharlimittruncatemultilinetextval string

Tekenlimiet voor afkapping van meerdere regels.
allowchoicelistvaluesforreuse
 allowchoicelistvaluesforreuse string

Het opnieuw gebruiken van keuzelijstwaarden toestaan.
allowscorelistvaluesforreuse
 allowscorelistvaluesforreuse string

Het opnieuw gebruiken van scorelijstwaarden toestaan.
allowIsheetComments
 allowIsheetComments string

Opmerkingen toestaan in iSheet.
shareRecordsLimit
 shareRecordsLimit integer

Limiet van records die mogen worden gedeeld.
shareRecordsLimitEnabled
 shareRecordsLimitEnabled integer

Limiet voor het delen van records is ingeschakeld.
enableIsheetAddRecordFormSharing
 enableIsheetAddRecordFormSharing string

Schakel het delen van formulieren in voor het toevoegen van records.
recordcount
 recordcount string

Huidige recordaantal.
bladtype-id
 sheettypeid integer

Type-id van het iSheet
enable
 enable string

Qa-functionaliteit inschakelen.
userid
 userid integer

Gebruikers-id.
e-mailadres
 email string

e-mailadres.
httpavatar
 httpavatar string

HTTP-URL van avatar.
avatar
 avatar string

Avatarafbeelding.
userlink
 userlink string

Koppeling naar gebruikersprofiel.
httplink
 httplink string

HTTP-koppeling naar gebruikersprofiel.
phone
 phone string

Telefoonnummer.
mobile
 mobile string

Mobiel nummer.
afdeling
 department string

Afdeling van de gebruiker.
enable
 enable string

Schakel Contract Express-integratie in.
adminnote
 adminnote string

Beheernotities met betrekking tot de site.
startdate
 startdate string

De begindatum van de bewerking van de site.
einddatum
 enddate string

De einddatum van de bewerking van de site.
createddate
 createddate string

De datum waarop de site is gemaakt.
archiveddate
 archiveddate string

De datum waarop de site is gearchiveerd.
clientno
 clientno string

Het clientnummer dat aan de site is gekoppeld.
matterno
 matterno string

Het nummer van de materie dat aan de site is gekoppeld.
landingspagina
 landingpage string

De URL van de landingspagina voor de site.
verbinden
 link string

Een koppeling met betrekking tot de site.
status
 status string

De huidige status van de site.
statusid
 statusid integer

De id voor de status van de site.
size
 size string

De grootte van de site.
billingnotes
 billingnotes string

Notities met betrekking tot facturering voor de site.
billingnextinvoicedate
 billingnextinvoicedate string

De datum van de volgende factuur voor de site.
billinglastinvoicedate
 billinglastinvoicedate string

De datum van de laatste factuur voor de site.
filepagecount
 filepagecount string

Het totale aantal pagina's van bestanden op de site.
maxpagecount
 maxpagecount string

Het maximaal toegestane aantal pagina's voor bestanden op de site.
sitehttplink
 sitehttplink string

De HTTP-koppeling naar de site.
isSyncable
 isSyncable integer

Geeft aan of de site kan worden gesynchroniseerd.
enforceusergroups
 enforceusergroups string

De gebruikersgroepen die zijn afgedwongen voor de site.
csvSiteCategory
 csvSiteCategory string

De categorie van de site in CSV-indeling.
siteNameInDefaultLanguage
 siteNameInDefaultLanguage string

De naam van de site in de standaardtaal.
zichtbaar
 visible integer

Geeft aan of de site zichtbaar is.
siteLogoName
 siteLogoName string

De naam van het logobestand van de site.
siteLogoFileSize
 siteLogoFileSize integer

De bestandsgrootte van het logo van de site.
siteLogoHeight
 siteLogoHeight integer

De hoogte van het logo van de site.
siteLogoWidth
 siteLogoWidth integer

De breedte van het logo van de site.
siteStatus
 siteStatus integer

De statuscode van de site.
applySiteTerms
 applySiteTerms integer

Geeft aan of sitetermen worden toegepast.
siteTerm
 siteTerm string

De voorwaarden die op de site worden toegepast.
termType
 termType integer

Het type termen dat op de site wordt toegepast.
nextLoginSiteTerms
 nextLoginSiteTerms integer

Geeft aan of sitevoorwaarden vereist zijn voor de volgende aanmelding.
defaultSiteTermsEnable
 defaultSiteTermsEnable integer

Geeft aan of standaardsitetermen zijn ingeschakeld.
advancedQAPermission
 advancedQAPermission integer

Het geavanceerde QA-machtigingsniveau voor de site.
isIntern
 isInternal integer

Geeft aan of de site intern is.
Psm
 psm integer

De Product Service Manager-id.
siteLabelDisplay
 siteLabelDisplay string

Het weergavelabel voor de site.
allowSiteAdministration
 allowSiteAdministration integer

Geeft aan of sitebeheer is toegestaan.
siteLevelPasswordEnable
 siteLevelPasswordEnable integer

Wachtwoordbeveiliging op siteniveau inschakelen.
siteLevelPasscodeEnable
 siteLevelPasscodeEnable integer

Wachtwoordcodebeveiliging op siteniveau inschakelen.
passcodeUsingAuthApp
 passcodeUsingAuthApp integer

Geeft aan of wachtwoordcodeverificatie gebruikmaakt van een verificatie-app.
sitePassword
 sitePassword string

Het wachtwoord dat aan de site is gekoppeld.
ipRestrictionEnable
 ipRestrictionEnable integer

IP-beperkingen voor sitetoegang inschakelen.
beschikbareIP
 availableIP string

Door komma's gescheiden lijst met IP-adressen die toegang hebben tot de site.
highqDrive
 highqDrive integer

Geeft aan of HighQ Drive-integratie is ingeschakeld.
applySiteHomePage
 applySiteHomePage integer

Een aangepaste startpagina voor de site toepassen.
siteHomePage
 siteHomePage string

URL van de aangepaste startpagina voor de site.
siteHomePageType
 siteHomePageType integer

Type van de startpagina.
nextLoginSiteHomePage
 nextLoginSiteHomePage integer

Als u de volgende aanmelding wilt instellen op de startpagina van de site.
applyDisplayContent
 applyDisplayContent integer

Weergave-inhoudsinstellingen toepassen.
displayContent
 displayContent string

Inhoud die op de site moet worden weergegeven.
rssSecurity
 rssSecurity integer

Beveiligingsniveau van RSS-feed.
versleuteld wachtwoord
 encryptedPassword integer

Geeft aan of het sitewachtwoord is versleuteld.
beschikbareIPRangeCSV
 availableIPRangeCSV string

Door komma's gescheiden lijst met IP-adresbereiken die toegang hebben tot de site.
siteModuleID
 siteModuleID integer

Id voor de sitemodule.
icalSecurity
 icalSecurity integer

Beveiligingsniveau voor iCal-feed.
defaultDisplayContent
 defaultDisplayContent string

Standaardinhoud die op de site wordt weergegeven.
defaultEmailAlert
 defaultEmailAlert integer

Standaardwaarschuwingen voor e-mail inschakelen.
excelReportFooter
 excelReportFooter integer

Bevat een voettekst in Excel-rapporten.
excelReportFooterText
 excelReportFooterText string

Tekst die moet worden weergegeven in de voettekst van Excel-rapporten.
aankondigingMLJSON
 announcementMLJSON string

Aankondigingen met JSON-indeling voor de site.
sjabloonType
 templateType integer

Het type sjabloon dat wordt gebruikt voor de site.
templateLicence
 templateLicence integer

Licentietype voor de sitesjabloon.
openChannelAppID
 openChannelAppID string

Toepassings-id voor de integratie van het open kanaal.
itemid
 itemid integer

Id voor het item dat is gekoppeld aan de site.
sitemetadatasheetid
 sitemetadatasheetid integer

Id van het metagegevensblad dat is gekoppeld aan de site.
mijn site
 mysite boolean

Geeft aan of dit de persoonlijke site van de gebruiker is.
lastaccesseddate
 lastaccesseddate string

De datum en tijd waarop de site voor het laatst is geopend.
defaultViewerMetaDataTab
 defaultViewerMetaDataTab integer

Het tabblad Standaardmetagegevens voor de siteviewer.
documentMetadataViewId
 documentMetadataViewId integer

documentmetagegevens voor weergave-id.
folderMetadataViewId
 folderMetadataViewId integer

mapmetagegevens voor weergave-id.
docSort
 docSort integer

De sorteervolgorde van documenten.
folderSort
 folderSort integer

De sorteervolgorde van mappen.
defaultFolderRenderView
 defaultFolderRenderView integer

Bepaalt de standaardweergavemodus voor mappen.
isTaskAttachmentDefault
 isTaskAttachmentDefault integer

De standaardlocatie voor taakbijlagen.
taskAttachmentDefaultFolderId
 taskAttachmentDefaultFolderId integer

De unieke id van de map die is aangewezen als de standaardlocatie voor taakbijlagen.
favoriet
 favourite string

favoriete status.
enabledocumentredaction
 enabledocumentredaction boolean

Hiermee geeft u op of documentredactie is ingeschakeld voor de site.
vermeldingsgroepen
 mentiongroups integer

De genoemde groepen.
enablefilerelationships
 enablefilerelationships boolean

Geeft aan of bestandsrelaties zijn ingeschakeld.
filerelationshipsitepermissionlevel
 filerelationshipsitepermissionlevel integer

Het machtigingsniveau dat is vereist voor het beheren van bestandsrelaties.

Retouren

Body
site

Sitegroep bijwerken

Bewerkings-id:
updateSiteGroup

Met deze API-methode wordt de naam van een bestaande groep op een site bijgewerkt.
Deze API is uitgebreid om de naam van een bestaande basisgebruikersgroep op een site bij te werken.

Parameters

Name Sleutel Vereist Type Description
API-versie
 version True string

version
De id van de site
 siteid True string

De id van de site.
API-versie
 groupid True string 
The ID of the site group.
naam
 name string
identiteitskaart
 id integer
copypermissionsfrom
 copypermissionsfrom string
message
 message string
typeID
 typeID integer
type
 type string
aantal gebruikers
 numberofusers string
geschapen
 created string
modified
 modified string
systemGroupID
 systemGroupID integer
beschrijving
 description string
basicusergroup
 basicusergroup integer

Retouren

Body
sitegroup

Definities

ErrorDBO

Name Pad Type Description
summary
 summary string
Ref
 ref string
verbinden
 link string

DocumentDBO

Name Pad Type Description
docid
 docid string

Document-id.

columns

Name Pad Type Description
kolom
 column array of object
items
 column object

LocationDBO

Name Pad Type Description
adreslijn1
 addressline1 string

Eerste regel van het adres.
adreslijn2
 addressline2 string

Tweede regel van het adres.
adreslijn3
 addressline3 string

Derde regel van het adres.
city
 city string

Stad van het adres.
state
 state string

Status van het adres.
country
 country string

Land van het adres.
postcode
 postcode string

Postcode van het adres.

Gebruikersnaam

Name Pad Type Description
title
 title string

Titel van de gebruiker.
voornaam
 firstname string

Voornaam van de gebruiker.
achternaam
 lastname string

Achternaam van de gebruiker.
goesby
 goesby string

voorkeursnaam van de gebruiker.

MetadataListDBO

Name Pad Type Description
metagegevensnaam
 metadataname array of string
metadatavalue
 metadatavalue array of string
Name Pad Type Description
identiteitskaart
 id string

Koppelings-id
naam
 name string

Koppelingsnaam.
waarde
 value string

Koppelingswaarde.
Name Pad Type Description
verbinden
 link array of NameValueLink

ExperiencesDBO

Name Pad Type Description
ervaring
 experience array of string

GroupsDBO

Name Pad Type Description
group
 group array of string

user

Name Pad Type Description
userid
 userid integer

Gebruikers-id.
volgend
 following boolean

Volgend.
e-mailadres
 email string

E-mailadres.
naam
 name UserName
userlink
 userlink string

Gebruikerskoppeling.
httplink
 httplink string

HTTP-koppeling.
httpavatar
 httpavatar string

HTTP Avatar.
avatar
 avatar integer

Avatar van gebruiker.
externalid
 externalid string

Externe id.
datumvangeboorte
 dateofbirth string

Geboortedatum.
phone
 phone string

Telefoonnummer.
jobtitle
 jobtitle string

Functie.
mobile
 mobile string

Mobiel nummer.
afdeling
 department string

Ontparing.
status
 status string

Toestand.
ORG
 org string

Organisatie.
orgName
 orgName string

Organisatienaam.
location
 location LocationDBO
img
 img string

Beeld.
Ervaringen
 experiences ExperiencesDBO
sociallinks
 sociallinks Link
customlink
 customlink Link
messaginglink
 messaginglink Link
secretaressenaam
 secretaryname string

Naam van secretaresse.
secretaressemail
 secretarymail string

Secretaresse Mail.
bio
 bio string

Biografie van de gebruiker.
brontype
 sourcetype string

Brontype.
Specialiteiten
 specialities string

Specialiteiten.
reportsto
 reportsto string

Gebruiker waaraan de huidige gebruiker rapporteert.
metadata
 metadata MetadataListDBO
groups
 groups GroupsDBO
achtervoegsel
 suffix string

Achtervoegsel van de naam van de gebruiker.
atomlink
 atomlink string

Atom-koppeling die is gekoppeld aan de gebruiker.
verbinden
 link string

Koppeling die is gekoppeld aan de gebruiker.
loggeduserlike
 loggeduserlike integer

Aantal vind-ik-leuks van de aangemelde gebruiker.
gebruikersnaam
 userName string

Gebruikersnaam.

users

Name Pad Type Description
user
 user array of user

FolderDBOV1

Name Pad Type Description
folderid
 folderid string

De unieke id van de gemaakte map.

DmsDBO

Name Pad Type Description
dmsfolderid
 dmsfolderid string

De DMS-map-id.
dmsParentFolderID
 dmsParentFolderID string

De bovenliggende DMS-map-id.
dmscreateddate
 dmscreateddate date-time

De datum waarop de DMS-map is gemaakt.
dmsmodifiedBy
 dmsmodifiedBy string

De gebruiker die de DMS-map voor het laatst heeft gewijzigd.
dmsdatabasename
 dmsdatabasename string

De naam van de DMS-database.
dmslink
 dmslink boolean

Geeft aan of er een DMS-koppeling beschikbaar is.
dmslinkby
 dmslinkby string

De gebruiker die de DMS-map heeft gekoppeld.

sitegroep

Name Pad Type Description
naam
 name string
identiteitskaart
 id integer
copypermissionsfrom
 copypermissionsfrom string
message
 message string
typeID
 typeID integer
type
 type string
aantal gebruikers
 numberofusers string
geschapen
 created string
modified
 modified string
systemGroupID
 systemGroupID integer
beschrijving
 description string
basicusergroup
 basicusergroup integer

Adres

Name Pad Type Description
addressid
 addressid string

Unieke id voor het adres.
adreslijn1
 addressline1 string

Eerste regel van het adres.
adreslijn2
 addressline2 string

Tweede regel van het adres.
adreslijn3
 addressline3 string

Derde regel van het adres.
city
 city string

Stad van het adres.
state
 state string

Status van het adres.
country
 country string

Land van het adres.
postCode
 postCode string

Postcode van het adres.
knownas
 knownas string

Alternatieve naam of bijnaam voor het adres.

IntegrationUserDBO

Name Pad Type Description
index
 index integer

Unieke index voor de gebruiker.
userid
 userid integer

Unieke id voor de gebruiker.
voornaam
 firstname string

Voornaam van de gebruiker.
achternaam
 lastname string

Achternaam van de gebruiker.
oefengroep
 practicegroup string

Oefengroep waartoe de gebruiker behoort.
langcode
 langcode string

Taalcode van de gebruiker.
localeID
 localeID string

Landinstellings-id van de gebruiker.
publicprofile
 publicprofile string

Openbaar profiel van de gebruiker.
pwpid
 pwpid string

PWP-id van de gebruiker.
usertypeid
 usertypeid string

Gebruikerstype-id.
systemuser
 systemuser string

Systeemgebruikervlag.
e-mailadres
 email string

Email adres van de gebruiker.
phone
 phone string

Telefoonnummer van de gebruiker.
mobile
 mobile string

Mobiel nummer van de gebruiker.
afdeling
 department string

Afdeling van de gebruiker.
ORG
 org string

Organisatie waartoe de gebruiker behoort.
location
 location LocationDBO
address
 address Address
Ervaringen
 experiences ExperiencesDBO
sociallinks
 sociallinks Link
messaginglink
 messaginglink Link
customlink
 customlink Link
img
 img string
reportsto
 reportsto string
metadata
 metadata MetadataListDBO
groups
 groups GroupsDBO
externalid
 externalid string

Externe id van de gebruiker.
jobtitle
 jobtitle string

Functie van de gebruiker.
secretaressenaam
 secretaryname string

Naam van de secretaresse van de gebruiker.
secretaressemail
 secretarymail string

E-mail van de secretaresse van de gebruiker.
Specialiteiten
 specialities string

Specialiteiten van de gebruiker.
title
 title string

Titel van de gebruiker.
goesby
 goesby string

voorkeursnaam van de gebruiker.
achtervoegsel
 suffix string

Achtervoegsel van de naam van de gebruiker.
atomlink
 atomlink string

Atom-koppeling die is gekoppeld aan de gebruiker.
bio
 bio string

Biografie van de gebruiker.
dateOfBirth
 dateOfBirth string

Geboortedatum van de gebruiker.
verbinden
 link string

Koppeling die is gekoppeld aan de gebruiker.
status
 status string

Status van de gebruiker.
statuscode
 statuscode string

Statuscode van de gebruiker.
message
 message string

Bericht dat is gekoppeld aan de gebruiker.
brontype
 sourcetype string

Brontype van de gebruiker.
orgid
 orgid string

Organisatie-id.
ifpartner
 ifpartner string

Partnervlag.
e-maildomein
 emaildomain string

E-maildomein van de gebruiker.
uitnodigingenent
 invitationsent string

Vlag verzonden uitnodiging.
Gemaakt door
 createdby string

Gebruiker die de record heeft gemaakt.
createddate
 createddate string

De datum waarop de record is gemaakt.
gewijzigd door
 modifiedby string

Gebruiker die de record heeft gewijzigd.
modifieddate
 modifieddate string

De datum waarop de record is gewijzigd.
lastlogindate
 lastlogindate string

Datum van de laatste aanmelding.
invalidlogins
 invalidlogins string

Aantal ongeldige aanmeldingspogingen.
publicwebsiteprofileid
 publicwebsiteprofileid string

Profiel-id van openbare website.
resetpassworddate
 resetpassworddate string

De datum waarop het wachtwoord opnieuw is ingesteld.
avatar
 avatar string

Url van avatarafbeelding.
followingcount
 followingcount integer

Het aantal gevolgde gebruikers.
aantal volgers
 followercount integer

Aantal volgers.
volgend
 following boolean

Volgende vlag.
rol
 role string

Rol van de gebruiker.
isbasicuser
 isbasicuser string

Eenvoudige gebruikersvlag.
encryptedUserId
 encryptedUserId string

Versleutelde gebruikers-id.
zelfregister
 selfregistered integer

Zelf geregistreerde vlag.
registeredWith2FA
 registeredWith2FA string

Registratievlag voor tweeledige verificatie.
isIntern
 isInternal integer

Interne gebruikersvlag.
orgName
 orgName string

Naam van de organisatie.

locatie

Name Pad Type Description
identiteitskaart
 id integer

De site-id.
sitenaam
 sitename string

De naam van de site.
rol
 role string

De rol van de site.
sitedescriptie
 sitedescription string

De beschrijving van de site.
enabledmodules
 enabledmodules string

Een lijst met modules die zijn ingeschakeld voor de site.
sitefolderID
 sitefolderID string

De id voor de map van de site.
sitefolderpermission
 sitefolderpermission string

Het machtigingsniveau voor de map van de site.
module
 module ModuleDBO
adminnote
 adminnote string

Beheernotities met betrekking tot de site.
startdate
 startdate string

De begindatum van de bewerking van de site.
einddatum
 enddate string

De einddatum van de bewerking van de site.
createddate
 createddate string

De datum waarop de site is gemaakt.
archiveddate
 archiveddate string

De datum waarop de site is gearchiveerd.
clientno
 clientno string

Het clientnummer dat aan de site is gekoppeld.
matterno
 matterno string

Het nummer van de materie dat aan de site is gekoppeld.
landingspagina
 landingpage string

De URL van de landingspagina voor de site.
verbinden
 link string

Een koppeling met betrekking tot de site.
status
 status string

De huidige status van de site.
statusid
 statusid integer

De id voor de status van de site.
size
 size string

De grootte van de site.
billingnotes
 billingnotes string

Notities met betrekking tot facturering voor de site.
billingnextinvoicedate
 billingnextinvoicedate string

De datum van de volgende factuur voor de site.
billinglastinvoicedate
 billinglastinvoicedate string

De datum van de laatste factuur voor de site.
filepagecount
 filepagecount string

Het totale aantal pagina's van bestanden op de site.
maxpagecount
 maxpagecount string

Het maximaal toegestane aantal pagina's voor bestanden op de site.
sitehttplink
 sitehttplink string

De HTTP-koppeling naar de site.
isSyncable
 isSyncable integer

Geeft aan of de site kan worden gesynchroniseerd.
enforceusergroups
 enforceusergroups string

De gebruikersgroepen die zijn afgedwongen voor de site.
csvSiteCategory
 csvSiteCategory string

De categorie van de site in CSV-indeling.
siteNameInDefaultLanguage
 siteNameInDefaultLanguage string

De naam van de site in de standaardtaal.
zichtbaar
 visible integer

Geeft aan of de site zichtbaar is.
siteLogoName
 siteLogoName string

De naam van het logobestand van de site.
siteLogoFileSize
 siteLogoFileSize integer

De bestandsgrootte van het logo van de site.
siteLogoHeight
 siteLogoHeight integer

De hoogte van het logo van de site.
siteLogoWidth
 siteLogoWidth integer

De breedte van het logo van de site.
siteStatus
 siteStatus integer

De statuscode van de site.
applySiteTerms
 applySiteTerms integer

Geeft aan of sitetermen worden toegepast.
siteTerm
 siteTerm string

De voorwaarden die op de site worden toegepast.
termType
 termType integer

Het type termen dat op de site wordt toegepast.
nextLoginSiteTerms
 nextLoginSiteTerms integer

Geeft aan of sitevoorwaarden vereist zijn voor de volgende aanmelding.
defaultSiteTermsEnable
 defaultSiteTermsEnable integer

Geeft aan of standaardsitetermen zijn ingeschakeld.
advancedQAPermission
 advancedQAPermission integer

Het geavanceerde QA-machtigingsniveau voor de site.
isIntern
 isInternal integer

Geeft aan of de site intern is.
Psm
 psm integer

De Product Service Manager-id.
siteLabelDisplay
 siteLabelDisplay string

Het weergavelabel voor de site.
allowSiteAdministration
 allowSiteAdministration integer

Geeft aan of sitebeheer is toegestaan.
siteLevelPasswordEnable
 siteLevelPasswordEnable integer

Wachtwoordbeveiliging op siteniveau inschakelen.
siteLevelPasscodeEnable
 siteLevelPasscodeEnable integer

Wachtwoordcodebeveiliging op siteniveau inschakelen.
passcodeUsingAuthApp
 passcodeUsingAuthApp integer

Geeft aan of wachtwoordcodeverificatie gebruikmaakt van een verificatie-app.
sitePassword
 sitePassword string

Het wachtwoord dat aan de site is gekoppeld.
ipRestrictionEnable
 ipRestrictionEnable integer

IP-beperkingen voor sitetoegang inschakelen.
beschikbareIP
 availableIP string

Door komma's gescheiden lijst met IP-adressen die toegang hebben tot de site.
highqDrive
 highqDrive integer

Geeft aan of HighQ Drive-integratie is ingeschakeld.
applySiteHomePage
 applySiteHomePage integer

Een aangepaste startpagina voor de site toepassen.
siteHomePage
 siteHomePage string

URL van de aangepaste startpagina voor de site.
siteHomePageType
 siteHomePageType integer

Type van de startpagina.
nextLoginSiteHomePage
 nextLoginSiteHomePage integer

Als u de volgende aanmelding wilt instellen op de startpagina van de site.
applyDisplayContent
 applyDisplayContent integer

Weergave-inhoudsinstellingen toepassen.
displayContent
 displayContent string

Inhoud die op de site moet worden weergegeven.
rssSecurity
 rssSecurity integer

Beveiligingsniveau van RSS-feed.
versleuteld wachtwoord
 encryptedPassword integer

Geeft aan of het sitewachtwoord is versleuteld.
beschikbareIPRangeCSV
 availableIPRangeCSV string

Door komma's gescheiden lijst met IP-adresbereiken die toegang hebben tot de site.
siteModuleID
 siteModuleID integer

Id voor de sitemodule.
icalSecurity
 icalSecurity integer

Beveiligingsniveau voor iCal-feed.
defaultDisplayContent
 defaultDisplayContent string

Standaardinhoud die op de site wordt weergegeven.
defaultEmailAlert
 defaultEmailAlert integer

Standaardwaarschuwingen voor e-mail inschakelen.
excelReportFooter
 excelReportFooter integer

Bevat een voettekst in Excel-rapporten.
excelReportFooterText
 excelReportFooterText string

Tekst die moet worden weergegeven in de voettekst van Excel-rapporten.
aankondigingMLJSON
 announcementMLJSON string

Aankondigingen met JSON-indeling voor de site.
sjabloonType
 templateType integer

Het type sjabloon dat wordt gebruikt voor de site.
templateLicence
 templateLicence integer

Licentietype voor de sitesjabloon.
openChannelAppID
 openChannelAppID string

Toepassings-id voor de integratie van het open kanaal.
itemid
 itemid integer

Id voor het item dat is gekoppeld aan de site.
sitemetadatasheetid
 sitemetadatasheetid integer

Id van het metagegevensblad dat is gekoppeld aan de site.
mijn site
 mysite boolean

Geeft aan of dit de persoonlijke site van de gebruiker is.
lastaccesseddate
 lastaccesseddate string

De datum en tijd waarop de site voor het laatst is geopend.
defaultViewerMetaDataTab
 defaultViewerMetaDataTab integer

Het tabblad Standaardmetagegevens voor de siteviewer.
documentMetadataViewId
 documentMetadataViewId integer

documentmetagegevens voor weergave-id.
folderMetadataViewId
 folderMetadataViewId integer

mapmetagegevens voor weergave-id.
docSort
 docSort integer

De sorteervolgorde van documenten.
folderSort
 folderSort integer

De sorteervolgorde van mappen.
defaultFolderRenderView
 defaultFolderRenderView integer

Bepaalt de standaardweergavemodus voor mappen.
isTaskAttachmentDefault
 isTaskAttachmentDefault integer

De standaardlocatie voor taakbijlagen.
taskAttachmentDefaultFolderId
 taskAttachmentDefaultFolderId integer

De unieke id van de map die is aangewezen als de standaardlocatie voor taakbijlagen.
favoriet
 favourite string

favoriete status.
enabledocumentredaction
 enabledocumentredaction boolean

Hiermee geeft u op of documentredactie is ingeschakeld voor de site.
vermeldingsgroepen
 mentiongroups integer

De genoemde groepen.
enablefilerelationships
 enablefilerelationships boolean

Geeft aan of bestandsrelaties zijn ingeschakeld.
filerelationshipsitepermissionlevel
 filerelationshipsitepermissionlevel integer

Het machtigingsniveau dat is vereist voor het beheren van bestandsrelaties.

ModuleDBO

Name Pad Type Description
thuis
 home HomeDBO
activiteit
 activity ActivityDBO
document
 document DocumentDBO
blog
 blog BlogDBO
wiki
 wiki WikiDBO
taak
 task TaskDBO
gebeurtenis
 event EventDBO
isheet
 isheet ISheetDBO
Qa
 qa QaDBO
volk
 people PeopleDBO
contractexpress
 contractexpress ContractExpressDBO

HomeDBO

Name Pad Type Description
enable
 enable string

Schakel de status in voor HomeDBO.

ActivityDBO

Name Pad Type Description
enable
 enable string

Schakel de status in voor ActivityDBO.
microblog
 microblog string

Microblog-inhoud die is gekoppeld aan ActivityDBO.

BlogDBO

Name Pad Type Description
blogTitle
 blogTitle string

Titel van het blogbericht.
blogContent
 blogContent string

Inhoud van het blogbericht.
showComment
 showComment integer

de opmerking weergeven.
tagList
 tagList array of string

Lijst met tags die zijn gekoppeld aan de blog.
status
 status integer

status van het blogbericht.
siteID
 siteID integer

Id voor de gekoppelde site.
auteur
 author string

Auteur van het blog.
categoryList
 categoryList array of string

Categorieën die zijn toegewezen aan het blogbericht.
notificationTypeID
 notificationTypeID integer

Id voor het meldingstype.
message
 message string

Berichtinhoud met betrekking tot de blog.
messageCode
 messageCode integer

Code die is gekoppeld aan het bericht.
externe-ID
 externalID string

Externe id gekoppeld aan de blog.
publiceerdatum
 publishDate string

Publicatiedatum van het blog.
processtype
 processtype string

Procestype dat is gekoppeld aan de blog.
enable
 enable string

Schakel de status in voor BlogDBO.

WikiDBO

Name Pad Type Description
wikiid
 wikiid integer

Unieke id voor de wiki.
currentversionid
 currentversionid integer

Id voor de huidige versie van de wiki
parentwikiid
 parentwikiid integer

Id voor de bovenliggende wiki.
wikititel
 wikititle string

Titel van de wiki.
wikicontent
 wikicontent string

Inhoud van de wiki.
opmerkingen weergeven
 showcomment integer

Geeft aan of opmerkingen zijn ingeschakeld.
createddate
 createddate string

Aanmaakdatum van de wiki.
modifieddate
 modifieddate string

Datum van laatste wijziging van de wiki.
taglist
 taglist string

Door komma's gescheiden lijst met tags die aan de wiki zijn gekoppeld.
wikipath
 wikipath string

Pad naar toegang tot de wiki.
wikidraftid
 wikidraftid integer

Id voor de conceptversie van de wiki.
concepttype
 drafttype string

Type concept dat is gekoppeld aan de wiki.
status
 status integer

Huidige status van de wiki.
wikiversionid
 wikiversionid integer

Versie-id van de wiki.

TaskDBO

Name Pad Type Description
index
 index string

Index of id voor de taak.
parenttaskid
 parenttaskid integer

Id voor de bovenliggende taak.
taskid
 taskid integer

Unieke id voor de taak.
title
 title string

Titel van de taak.
beschrijving
 description string

Gedetailleerde beschrijving van de taak.
duedate
 duedate string

Einddatum voor de voltooiing van de taak.
startdate
 startdate string

Begindatum waarop de taak is gestart.
mattermaptaskid
 mattermaptaskid string

Id die is gekoppeld aan de toewijzingstaak van de kwestie.
type
 type string

Type of categorie van de taak.
dependenton
 dependenton string

Taken waarop deze taak afhankelijk is.
daysfromdependent
 daysfromdependent string

Aantal dagen vanaf de afhankelijke taak.
ignoreweekend
 ignoreweekend integer

Geeft aan of weekenden worden genegeerd in de planning.
duration
 duration integer

Duur om de taak te voltooien.
resource
 resource string

Resources die aan de taak zijn toegewezen.

EventDBO

Name Pad Type Description
eventTitle
 eventTitle string

Titel van de gebeurtenis.
eventContent
 eventContent string

Inhoud van de gebeurtenis.
showComment
 showComment integer

Hiermee wordt aangegeven of opmerkingen zijn ingeschakeld voor de gebeurtenis.
tagList
 tagList array of string

Lijst met tags die zijn gekoppeld aan de gebeurtenis.
status
 status integer

Huidige status van de gebeurtenis.
siteID
 siteID integer

Id voor de site.
contactpersoon
 contact string

Contactgegevens voor de gebeurtenis.
categoryList
 categoryList array of string

Categorieën waaronder de gebeurtenis wordt vermeld.
notificationTypeID
 notificationTypeID integer

Het meldingstype dat is gerelateerd aan de gebeurtenis.
message
 message string

Het bericht van de gebeurtenis.
messageCode
 messageCode integer

De berichtcode van de gebeurtenis.
externe-ID
 externalID string

De externe id.
startDate
 startDate string

De begindatum van de gebeurtenis.
einddatum
 endDate string

De einddatum van de gebeurtenis.
startTime
 startTime string

De begintijd van de gebeurtenis.
endTime
 endTime string

De eindtijd van de gebeurtenis.
location
 location string

De locatie van de gebeurtenis.
auteur
 author string

De auteur van de gebeurtenis.
processtype
 processtype string

De procestijd van de gebeurtenis.
enable
 enable string

Schakel de gebeurtenis in.

ISheetDBO

Name Pad Type Description
identiteitskaart
 id integer

Unieke id voor het iSheet.
title
 title string

Titel van het iSheet.
beschrijving
 description string

Beschrijving van het isheet.
status
 status string

Status van het isheet.
toegangstype
 accesstype string

Toegangstype van het isheet.
type
 type string

Type van het isheet.
viewlink
 viewlink string

Koppeling om het iSheet weer te geven.
allowsections
 allowsections string

Of secties zijn toegestaan.
allowlookup
 allowlookup string

Of opzoekvelden zijn ingeschakeld.
displayisheet
 displayisheet string

Weergaveopties voor het iSheet.
searchasdefaultview
 searchasdefaultview string

Geeft aan of zoeken de standaardweergave is.
enableversion
 enableversion string

Vlag versiebeheer ingeschakeld.
enablesheetalerter
 enablesheetalerter string

Vlag om bladwaarschuwingen in te schakelen.
alertercondition
 alertercondition string

Voorwaarden voor het activeren van waarschuwingen.
overrideitemmodifieddate
 overrideitemmodifieddate string

Wijzigingsdatumvlag negeren.
enablebulkinsertupdate
 enablebulkinsertupdate string

Schakel bulksgewijs invoegen/bijwerken in.
fielddescriptions
 fielddescriptions string

Veldbeschrijvingen voor het iSheet.
enablerowlocking
 enablerowlocking string

Schakel vergrendeling op rijniveau in.
setcharlimittruncatemultilinetextenabled
 setcharlimittruncatemultilinetextenabled string

Tekstvlag met meerdere regels afkappen.
setcharlimittruncatemultilinetextval
 setcharlimittruncatemultilinetextval string

Tekenlimiet voor afkapping van meerdere regels.
allowchoicelistvaluesforreuse
 allowchoicelistvaluesforreuse string

Het opnieuw gebruiken van keuzelijstwaarden toestaan.
allowscorelistvaluesforreuse
 allowscorelistvaluesforreuse string

Het opnieuw gebruiken van scorelijstwaarden toestaan.
allowIsheetComments
 allowIsheetComments string

Opmerkingen toestaan in iSheet.
shareRecordsLimit
 shareRecordsLimit integer

Limiet van records die mogen worden gedeeld.
shareRecordsLimitEnabled
 shareRecordsLimitEnabled integer

Limiet voor het delen van records is ingeschakeld.
enableIsheetAddRecordFormSharing
 enableIsheetAddRecordFormSharing string

Schakel het delen van formulieren in voor het toevoegen van records.
recordcount
 recordcount string

Huidige recordaantal.
bladtype-id
 sheettypeid integer

Type-id van het iSheet

QaDBO

Name Pad Type Description
enable
 enable string

Qa-functionaliteit inschakelen.

PeopleDBO

Name Pad Type Description
persoon
 person array of PersonDBO

PersonDBO

Name Pad Type Description
userid
 userid integer

Gebruikers-id.
e-mailadres
 email string

e-mailadres.
httpavatar
 httpavatar string

HTTP-URL van avatar.
avatar
 avatar string

Avatarafbeelding.
userlink
 userlink string

Koppeling naar gebruikersprofiel.
httplink
 httplink string

HTTP-koppeling naar gebruikersprofiel.
phone
 phone string

Telefoonnummer.
mobile
 mobile string

Mobiel nummer.
afdeling
 department string

Afdeling van de gebruiker.

ContractExpressDBO

Name Pad Type Description
enable
 enable string

Schakel Contract Express-integratie in.

FolderDBOV2

Name Pad Type Description
naam
 name string

Mapnaam.
beschrijving
 description string

Beschrijving van map.
parentFolderID
 parentFolderID integer

Id van bovenliggende map.
accessInherited
 accessInherited integer

Status van overname van toegang.
batchID
 batchID string

Batch-id
DMS
 dms DmsDBO
identiteitskaart
 id integer

Map-id.
verbinden
 link string

Mapkoppeling.
createddate
 createddate string

Datum van aanmaak.
modifieddate
 modifieddate string

Wijzigingsdatum.
kind
 child integer

Onderliggende mappen.
bestandsaantal
 filecount integer

Aantal bestanden.
Gemaakt door
 createdby UserDBO
gewijzigd door
 modifiedby UserDBO
folderid
 folderid integer

Map-id.
dmsfolderid
 dmsfolderid string

DMS-map-id.
siteid
 siteid integer

Site-id
location
 location string

Maplocatie.
toestemming
 permission PermissionDBO
contentstatus
 contentstatus integer

Status van inhoud.
autonummering
 autonumbering string

Configuratie van automatische nummering.
mappen maken
 foldersize string

Mapgrootte.
sharedstatus
 sharedstatus integer

Deelstatus.
favoriete status
 favouritestatus integer

Favoriete status.
foldertype
 foldertype string

Maptype.
artikelID
 itemId integer

Item-id.
folderMetadataSheetId
 folderMetadataSheetId integer

Mapmetagegevens van blad-id.

UserDBO

Name Pad Type Description
voornaam
 firstname string

Voornaam.
achternaam
 lastname string

Achternaam.
e-mailadres
 email string

E-mailadres.
userid
 userid integer

Gebruikers-id.

PermissionDBO

Name Pad Type Description
view
 view integer

Machtiging weergeven.
edit
 edit integer

Machtiging bewerken.
delete
 delete integer

Machtiging verwijderen.
addEditAllFiles
 addEditAllFiles integer

Alle bestandsmachtigingen toevoegen/bewerken.
beheerder
 admin integer

Beheerdersmachtiging.
viewAllFiles
 viewAllFiles integer

Alle bestandsmachtigingen weergeven.
disableSave
 disableSave integer

slamachtiging uit.
uploadFile
 uploadFile integer

Bestandsmachtiging uploaden.
updateFile
 updateFile integer

Bestandsmachtiging bijwerken.
deleteFile
 deleteFile integer

Bestandsmachtiging verwijderen.

ProgressiveKeyDBO

Name Pad Type Description
progressivekey
 progressivekey string

Sleutel voor progressieve bewerkingen.
siteid
 siteid integer

Id voor de site.
progressivekeystatus
 progressivekeystatus string

Status van de progressieve sleutel.
userid
 userid integer

Id voor de gebruiker.
antwoordbody
 responsebody string

Hoofdtekst van het antwoord.
message
 message string

Berichtinhoud.
messagecode
 messagecode string

Code die is gekoppeld aan het bericht.
integrationResponseDBO
 integrationResponseDBO IntegrationResponseDBO
columns
 columns ColumnErrorsDBO
items
 items ItemErrorsDBO
importisheettemplate
 importisheettemplate importISheetTemplateDBO
fout
 error ErrorDBO
inhoudstype
 contentType string

Type inhoud.
mislukte entiteiten
 failedEntities integer

Aantal mislukte entiteiten.
downloadlink
 downloadlink string

Koppeling om inhoud te downloaden.
bijlage
 attachment Attachment
verbinden
 link string

Gekoppelde koppeling.
documentid
 documentid integer

Id voor het document.
progresskey
 progresskey string

Voortgangssleutel voor het bijhouden.
progresskeystatus
 progresskeystatus string

Status van de voortgangssleutel.

IntegrationResponseDBO

Name Pad Type Description
integrationResponseUsersObject
 integrationResponseUsersObject IntegrationResponseUsersObject
mislukte entiteiten
 failedEntities integer

Aantal entiteiten dat de verwerking is mislukt.
successEntities
 successEntities integer

Aantal entiteiten dat is verwerkt.

IntegrationResponseUsersObject

Name Pad Type Description
user
 user array of IntegrationUserDBO

ColumnErrorsDBO

Name Pad Type Description
kolom
 column array of ColumnErrorDBO
mislukte entiteiten
 failedEntities integer

Aantal entiteiten dat is mislukt vanwege kolomfouten.
successEntities
 successEntities integer

Aantal entiteiten dat is verwerkt.

ColumnErrorDBO

Name Pad Type Description
index
 index integer

Indexpositie van de kolom met een fout.
columnid
 columnid integer

De unieke id van de kolom met een fout.
naam
 name string

Naam van de kolom met een fout.
status
 status string

Status die de foutvoorwaarde aangeeft.
statuscode
 statuscode string

Code die de foutstatus aangeeft.
message
 message string

Gedetailleerd foutbericht.

ItemErrorsDBO

Name Pad Type Description
item
 item array of ItemErrorDBO
mislukte entiteiten
 failedEntities integer

Aantal entiteiten dat is mislukt vanwege itemfouten.
successEntities
 successEntities integer

Aantal entiteiten dat is verwerkt ondanks itemfouten.

ItemErrorDBO

Name Pad Type Description
index
 index integer

Indexpositie van het item met een fout.
columns
 columns ColumnErrorsDBO
itemid
 itemid string

Unieke id van het item met een fout.
externalid
 externalid string

Externe id die is gekoppeld aan het item.
identiteitskaart
 id string

Interne id van het item.
naam
 name string

De naam van het item met een fout.
status
 status string

Status die de foutvoorwaarde aangeeft.
statuscode
 statuscode string

Code die de foutstatus aangeeft.
message
 message string

Gedetailleerd foutbericht.
successdeletedcount
 successdeletedcount integer

Het aantal verwijderde entiteiten.
failurecount
 failurecount integer

Aantal entiteiten waarvoor de verwerking is mislukt.
mislukte entiteiten
 failedEntities integer

Aantal entiteiten dat is mislukt vanwege itemfouten.
successEntities
 successEntities integer

Aantal entiteiten dat is verwerkt.

importISheetTemplateDBO

Name Pad Type Description
linkedtemplateid
 linkedtemplateid integer

Id van de gekoppelde sjabloon.
aliasnaam
 aliasname string

Aliasnaam voor de sjabloon.
linkedisheet
 linkedisheet string

Id van het gekoppelde invoerblad.
importdata
 importdata string

Gegevens die uit de sjabloon moeten worden geïmporteerd.
appendisheetname
 appendisheetname string

De naam van het blad waaraan gegevens moeten worden toegevoegd.
templateparametergroups
 templateparametergroups ISheetTemplateParameterGroups
templateSheetIdMap
 templateSheetIdMap object
templateId
 templateId integer

Id van de sjabloon.
templateTitle
 templateTitle string

Titel van de sjabloon.
weergave-id's
 viewIDs string

Door komma's gescheiden lijst met weergave-id's.

ISheetTemplateParameterGroups

Name Pad Type Description
templateparametergroup
 templateparametergroup array of ISheetTemplateParameterGroup

ISheetTemplateParameterGroup

Name Pad Type Description
templateruleid
 templateruleid integer

Parametergroep voor Isheet-sjablonen.
templateparameter
 templateparameter array of ISheetTemplateParameter

ISheetTemplateParameter

Name Pad Type Description
identiteitskaart
 id integer

Id van de sjabloonparameter isheet.
naam
 name string

Naam van de sjabloonparameter isheet.
gegevens
 data string

gegevens van de sjabloonparameter isheet.

Attachment

Name Pad Type Description
bestand
 file string

De bestandsinhoud.
naam
 name string

De naam van de bijlage.
order
 order string

De volgorde van de bijlage.
identiteitskaart
 id integer

Unieke id voor de bijlage.
uitbreiding
 extension string

Bestandsextensie.
parentfolderid
 parentfolderid integer

Id van de bovenliggende map.
filehttplink
 filehttplink string

HTTP-koppeling voor toegang tot het bestand.
mappad
 folderpath string

Pad naar de map met het bestand.
maphttplink
 folderhttplink string

HTTP-koppeling naar de map.
filesize
 filesize integer

Grootte van het bestand in bytes.
redactionStatus
 redactionStatus boolean

Geeft aan of het bestand is bewerkt.
displayname
 displayname string

Weergavenaam van de bijlage.
siteid
 siteid integer

Id van de site die is gekoppeld aan de bijlage.