Dela via

HighQ (förhandsversion)

Den här anslutningsappen ger säker och autentiserad åtkomst till HighQ-API:er, vilket möjliggör sömlös integrering av samarbets- och innehållshanteringsfunktioner i anpassade arbetsflöden och program. Den stöder dokumentautomatisering, datasynkronisering och arbetsflödesorkestrering – vilket ger juridiska och professionella tjänsteteam möjlighet att effektivisera åtgärder, minska manuella insatser och förbättra produktiviteten.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster Class Regioner
Copilot Studio Premie Alla Power Automate-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Logiska appar Norm Alla Logic Apps-regioner utom följande:
     – Azure Government-regioner
     – Regioner i Azure Kina
     - US Department of Defense (DoD)
Power Apps Premie Alla Power Apps-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Power Automate Premie Alla Power Automate-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Kontakt
Namn Högq
URL https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support
E-postmeddelande highq-support@thomsonreuters.com
Metadata för anslutningsprogram
Utgivare Thomson Reuters Incorporated
Webbplats https://legal.thomsonreuters.com/en/products/highq
Sekretesspolicy https://www.thomsonreuters.com/en/privacy-statement
Kategorier Samarbete; Innehåll och filer

HögQ

Översikt

HighQ ger sömlös, säker och autentiserad åtkomst till HighQ-API:er. Den här anslutningsappen möjliggör sömlös interaktion med olika HighQ-tjänster, inklusive ISheet-modulen, API:er för dokumentresurser, ISheet Admin API och användaråtgärder. Den är utformad för att underlätta integrering med HighQ Collaborate-plattformen och erbjuder funktioner som att hämta och skapa iSheet-objekt, hantera dokumentfiler och administrera användarkonton.

  • Anslutningsversion: 1.0.0
  • Titel: HögQ
  • Beskrivning: Den här anslutningsappen ger sömlös, säker och autentiserad åtkomst till HighQ-API:er.
  • Kontakt:
    • Namn: Högq
    • Webbplats:HighQ-support
    • E-post:highq-support@thomsonreuters.com

Authentication

Anslutningsappen använder dynamiska miljövariabler för säker anslutning:

  • Värd: @environmentVariables("highqt_host")
  • Bassökväg: /@environmentVariables("highqt_instancename")/api
  • Klient-ID:@environmentVariables("highqt_clientid")
  • Klienthemlighet:@environmentVariables("highqt_clientsecret")

Detaljerade autentiseringsprocedurer finns i highq-portalen för teknisk support eller kontakta HighQ-supporten.

Anslutningsåtgärder

ISheet-modul

  • Hämta iSheet-objekt
    GET /{version}/isheet/{isheetid}/items
    Hämtar en lista över objekt i angiven iSheet.

  • Skapa iSheet-objekt
    POST /{version}/isheet/{isheetid}/items
    Infogar nya objekt i en iSheet med stöd för flera iSheets och statusspårning via progressiva nycklar.

API:er för dokumentresurs

  • Hämta filinformation
    GET /{version}/files/{fileid}
    Hämtar detaljerad information om en specifik fil på HighQ Collaborate-plattformen.

  • Ladda upp en fil
    POST /{version}/files/content
    Laddar upp en fil till en angiven mapp med stöd för segmenterade uppladdningar när Content-Range rubriken anges.

  • Hämta mapplista
    GET /{version}/folders/{folderid}/items
    Hämtar en lista över mappar i den angivna mappen med stöd för sortering och sidnumrering.

ISheet Admin API

  • Hämta iSheet-kolumner
    GET /{version}/isheets/admin/{isheetid}/columns
    Hämtar kolumnkonfigurationer för en viss iSheet.

Användaråtgärder

  • Hämta användare
    GET /{version}/users
    Hämtar en lista över användare med stöd för filtrering, sidnumrering och detaljerade användarroller.

  • Lägga till en ny användare
    POST /{version}/users
    Skapar ett nytt användarkonto med utökade attribut och validering.

  • Arkivera en användare
    DELETE /{version}/users/{userid}
    Arkiverar en befintlig användare från systemet.

Dokument- och webbplatshantering

  • Skapa en mapp
    POST /{version}/folders
    Skapar en ny mapp under en angiven överordnad mapp.

  • Flytta dokument
    PUT /{version}/files/move
    Flyttar en eller flera filer från en mapp till en annan på samma plats.

  • Platshanteringsåtgärder:

    • Lägg till befintlig grupp på plats: POST /{version}/sites/{siteid}/groups/{groupid}
    • Uppdatera webbplatsgrupp: PUT /{version}/sites/{siteid}/groups/{groupid}
    • Lägg till en ny webbplats: POST /{version}/sites

Komma igång

  1. Konfiguration:

    • Definiera miljövariablerna highqt_host och highqt_instancename i din Power Platform-miljö.

  2. Autentisering:

    • Följ riktlinjerna från HighQ för att konfigurera säker autentisering för API-begäranden.

  3. Användning:

    • Importera HighQ till din Power Platform-instans.
    • Använd de tillgängliga åtgärderna efter behov. Se åtgärdssammanfattningarna ovan för vägledning.

Parametrar och inställningar

  • Sökvägsparametrar:
    Inkludera obligatoriska parametrar som version, isheetid, fileid, folderidoch userid i förekommande fall.

  • Frågeparametrar:
    Valfria parametrar som sheetviewid, sortcolumnid, limitoch offset är tillgängliga för att förfina API-svar.

  • Brödtextparametrar:
    För åtgärder som kräver en begärandetext (t.ex. att skapa iSheet-objekt eller användare) kontrollerar du att begäran följer de definierade schemana (till exempel isheetDBO, FolderDBOeller IntegrationUserDBO).

Felsökning och begränsningar

  • Felkoder:
    Standard-HTTP-statuskoder används mellan åtgärder:

    • 200 för lyckade åtgärder
    • 401 för obehörig åtkomst
    • 403 för förbjudna fel eller valideringsfel
    • 405 för ogiltiga HTTP-metoder
    • 500 för interna serverfel
      Mer information om felbeskrivningar finns i den enskilda API-dokumentationen.

  • Begränsningar:
    Vissa slutpunkter kan ha standardgränser (t.ex. standardvärdet limit 100 poster). Ytterligare parametrar kan krävas för sortering och filtrering av stora datamängder.

Ytterligare resurser

Mer detaljerad information och utökad dokumentation finns i:

Licensiering och support

För licensinformation och teknisk support:

Begränsningsgränser

Name Anrop Förnyelseperiod
API-anrop per anslutning 100 60 sekunder

Åtgärder

Arkivera användare

Det här API-anropet används för att arkivera en användare i systemet.

Felkoder

Sammanfattning Referenskod (före V4) Referenskod (V4)

Följande användare finns inte i systemet

 110 110

Ett användar-ID krävs

 109 109

Användar-ID är inte i rätt format

 113 113

Användarens ID-längd får inte överstiga 50 tecken

 N/A 304


JIRA-biljett: https://dev.highq.com/jira/browse/COL-67441
Flytta dokument

Det här API:et flyttar flera filer från en mapp till en annan på samma plats.
Hämta användarlista

Hämta en lista över användare Det här API:et hämtar en lista över användare från systemet. ##-nyckelfunktioner – Hämta användarinformation med flera filtreringsalternativ – Stöder sidnumrering med limit och offset – Nya frågeparametrar och fält som introducerats i de senaste versionerna – Strukturerat svar med användarroller och attribut ## Nya frågeparametrar (Version-Specific) – Introducerade i V12: – systemAdminSearch: När värdet är 1returneras endast användare med rollen Systemadministratör. - Introducerades i V18: - userid: Accepterar kommaavgränsade värden (CSV). ## Svarstextuppdateringar – Nya fält har lagts till: - emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate - ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid - systemuserresetpassworddateusertypeidavatarpracticegroup - langcode, publicprofile# dateOfBirth # Ändra adressformat (från V11) – Taggen location har bytt namn till address för konsekvens. – Exempelsvar: 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> ## Användarroller (introducerades i API V11+) – Exempelsvar: 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> ## Gränser och förskjutningar – Gränsbeteende: – Standard: 100 om inget värde anges. - Använd -1 för att returnera alla poster. – Om värdet är mindre än -1, är standardvärdet 100. - Förskjutningsbeteende: – Standard: 0 om inget värde anges. – Om förskjutningen överskrider det totala antalet poster återgår standardvärdet till 0. ## Nya roller introducerade – V12: Basic User, Allow user to bypass XSS protection - V14: Allow user to manage Contract Express system groups ## Felkoder | Sammanfattning | Referenskod (före V4) | Referenskod (V4) | |---------|----------------------|--------------| | | Ogiltiga indata för användarstatus (ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | Organisations-ID är ogiltigt | N/A | 260 | | Ogiltigt neverinvited värde (sant/falskt) | N/A | 387 | | Ogiltigt neverlogin värde (sant/falskt) | N/A | 388 | | Ogiltigt groupids värde | N/A | 214 | | Ogiltigt notingroup värde (sant/falskt) | N/A | 389 | | Ogiltigt ordertype (stöds: namn, organisation, status osv.) | N/A | 289 | | Ogiltigt orderby (stöds: asc, desc) | N/A | 290 | | Ogiltigt offset värde | 138 | 138 | | | Ogiltigt limit värde | 137 | 137 | ## Anteckningar – Från V13 och senare är det här API:et öppet för alla användare (tidigare begränsat till Systemadministratörer). – Från V18 och senare anger fältet userregistered2FA om en användare har registrerat sig för 2FA. --- Den här beskrivningen följer Swagger 2.0-schemaformatering och bör placeras i beskrivningsfältet i schema för anpassad anslutning.
Hämta en lista över iSheet-objekt

Det här API-anropet hämtar en lista över objekt som finns i angiven iSheet.
Hämta en lista över mappar

Det här API-anropet hämtar en lista över mappar som finns i den angivna mappen. Parametern "gräns" anger det maximala antalet objekt som ska returneras och parametern "offset" anger startpositionen för datahämtning. Standardvärden tillämpas om dessa parametrar utelämnas och mapparna returneras i stigande ordning efter skapandedatum.
Hämta filinformation

Det här API-anropet hämtar detaljerad information för en angiven fil från HighQ Collaborate-plattformen.
Hämta iSheet-kolumner

Det här API-anropet hämtar de kolumner som är associerade med angiven iSheet. Den här funktionen stöds i API version 3 och senare.
Hämta mappinformation

Metoden innehåller mappinformation för angivet mapp-ID.

Ladda upp en fil

Det här API-anropet laddar upp en fil till en angiven mapp på HighQ Collaborate-plattformen. Den stöder segmenterade uppladdningar när rubriken Content-Range tillhandahålls.
Lägg till användare

Det här API-anropet används för att lägga till en ny användare i systemet.
Obs!
1. Stöd har lagts till för följande nya fält
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. Adresstaggen har lagts till i API-version 4

1

Sammanfattning Referenskod (före V4) Referenskod (V4)

E-postadress krävs

 101 101

Ogiltig e-postadress

 104 104

Förnamn krävs

 102 102

Maximalt antal tillåtna tecken för förnamnet måste vara mellan 1 och 100

 102 352

Sekreterarens/assistentens e-postadress är inte giltig

 104 353

Status måste vara aktiv eller inaktiv

 116 116

Den angivna avdelningen får inte innehålla fler än 256 tecken

 N/A 354

Det angivna ifpartner-attributet är ogiltigt

 N/A 355

Det angivna systemuser-attributet är ogiltigt

 N/A 356

Det angivna attributet usertypeid är ogiltigt

 N/A 357

Det angivna langcode-attributet är ogiltigt

 N/A 358

Det angivna källtypsattributet är ogiltigt. Giltiga värden är System, Active Directory eller System standard .

 N/A 359

Ange ett giltigt telefonnummer   

 N/A 360

Ange ett giltigt telefonnummer i formatet {countrycode}  ${areacode}${number}.

 N/A 361

Ange ett giltigt mobilnummer i formatet {countrycode}${number}.

 N/A 362

Ange en giltig landskod för office-telefon

 N/A 363

Landskoden för office-telefon kan ha högst 4 siffror

 N/A 364

Ange en giltig kod för office-telefonområdet

 N/A 365

Arbetstelefonens riktnummer kan innehålla högst 5 siffror

 N/A 366

Office-telefonnummer ska ha högst 15 siffror

 N/A 368

Ange en giltig landskod för mobiltelefon

 N/A 369

Mobiltelefonens landskod kan ha högst 4 siffror

 N/A 372

Ange ett giltigt mobilnummer

 N/A 373

Mobiltelefonnumret ska ha högst 20 siffror

 N/A 374

Domänen finns inte

 105 105

E-post finns redan i systemet

 111 111

Ange organisation vid självregistrerad domän   

 187 187

Ange organisation i händelse av undantagsdomäner   

 115 115

Organisations-ID är inte i rätt format   

 112 112

Organisationen finns inte

 106 106

Domän finns i annan organisation

 114 114

Angivet adress-ID är inte giltigt

 N/A 308

Det gick inte att hitta det sociala länknamnet i systemet.

 N/A 375

Namnet på den sociala länken krävs

 N/A 376

Det sociala länkvärdet krävs

 N/A 377

Maximalt antal tecken för socialt länkvärde måste vara mellan 1 och 500

 N/A 378

Ange namnet på den anpassade länken

 N/A 379

Det anpassade länkvärde som krävs

 N/A 380

Maxtecken för anpassat länknamn måste vara mellan 1 och 500

 N/A 381

Maxtecken för anpassat länkvärde måste vara mellan 1 och 500

 N/A 382

Namnet på meddelandelänken som krävs

 N/A 383

Meddelandelänkens namn hittades inte i systemet

 N/A 384

Det meddelandelänkvärde som krävs   

 N/A 385

Maximalt antal tecken för meddelandelänkvärdet måste vara mellan 1 och 500

 N/A 386

Den sociala länken är inaktiverad

 N/A 408

Meddelandelänken är inaktiverad

 N/A 409

Den anpassade länken är inaktiverad

 N/A 410

JIRA-biljett: https://dev.highq.com/jira/browse/COL-65685
Lägg till webbplats

Använd det här API:et för att skapa en ny webbplats. Platsobjektet stöder endast attribut som visas i gränssnittet skapa webbplats.

Det här API:et kräver platsnamn (och obligatoriska fält som konfigurerats på ASP-nivå om det finns några) för att skapa en ny webbplats.

Taggen "module" representerar en annan modul som ska konfigureras på platsen, eftersom den visas i begärandeattribut.
Så här skapar du webbplatsen från mallen genom att skicka taggen "sitetemplateid"
     – För mindre än version 7, Om någon modul inte ges ("modul"-taggen inte skickas) i begäran, kommer konfigurationen av mallmodulen att äga rum. Om modultaggen tillhandahålls med konfiguration respekterar den och konfigurerar den enligt begäran (i stället för att använda konfiguration av mallmoduler)
     – För större än version 7 sker konfigurationen av mallmodulen om någon modul anges ("modul"-taggen skickas) eller inte i begäran.

Den här metoden stöder inte uppladdning av webbplatsavbildningen i det här anropet. Stöd för webbplatsikonen tillhandahålls som ett separat anrop.
Metodanropet förväntar sig ett befintligt kategori-ID. Kategori-ID:t ska hämtas av det anropande programmet genom ett tidigare anrop till gränssnittet Webbplatskategorier. Om inga kategorier anges i begäran läggs ingen kategori (inte faktisk kategori) till som standard.

Start- och slutdatum för webbplatsen ska vara i formatet "dd MMM åååå" och det är INTE UTC. API-klienten begär alltid det faktiska datumet.

"landingpage" har standardvärdet "files (root folder)".
"landingpage" förväntar sig tre olika formuleringar eller identifieringar för filmodulen. Möjliga värden är:
– filer (rotmapp)
– filer (senaste aktivitet)
- filer (avancerad sökning)
Metodimplementeringen stöder nu (från 5.1 och senare) Flerspråkigt webbplatsnamn. API version 6 eller högre <webbplatsnamn> representeras i begärandetexten baserat på användarinställningsordning. API version 5 eller äldre <webbplatsnamn> representerar standardspråket engelska i Storbritannien.
<sitenametranslations> representerar platsnamn på alla språk (som kommer att vara ytterligare tagg i "Object itself API" från 5.1 och senare) API version 6 eller senare, i begärandetexten skickar de båda taggarna, dvs. <webbplatsnamn> och <webbplatsnamntranslationer> , och sedan måste vi verifiera värden, t.ex. <webbplatsnamn> måste matcha med respektive <översättningstagg> när det gäller användarens språkinställningar. API 7 eller senare, webbplatsen som skapas från mallen följer moduler från källmallen och ignorerar modullistan som skickas i begärandetexten.

Metodimplementeringen stöder nu skapa webbplats från mall genom att ange taggen "sitetemplateid" (gammal metod)

Observera att stödet för att skapa en webbplats från en mall med det här API:et kommer att bli inaktuellt i framtiden. Om du vill skapa en webbplats från mallen använder du det nya API:et Skapa webbplats från mall (/webbplatser/mallar/{templateid}/site) som är ett långt avsöknings-API (har stöd för tidskrävande begäranden)

Den här metoden stöder flera ärendenummer som ska läggas till på webbplatsen med api-version 10 och senare. Taggen "matternos" anger flera materianummer med skrivskyddat eller inte. Äldre version (mindre än version 10) ett ärendenummer "matterno" återspeglar det första ärendenumret som fanns flera nummer på webbplatsen.

Version 18 och senare: en kategori (webbplatssyfte) krävs. Om webbplatssyftet är dolt visas ett meddelande. Annars läggs inte dolda webbplatsändamål till på webbplatsen.

Upp till version 17: webbplatsägaren är den inloggade användaren. inga andra användare kan läggas till.

Version 18 och senare: Webbplatsägaren kan lägga till andra användare på webbplatsen.

Från API version 19 och senare introduceras en ny modul med namnet "customPages" som är nära kopplad till hemmodulen. Om värdet för hemmodulen är Sant är customPages sant och vice versa.
Lägga till befintlig grupp på webbplatsen

Den här API-metoden lägger till en befintlig systemgrupp på platsen.
Det här API:et har utökats för att lägga till befintliga system grundläggande användargrupper (av system-/organisationstyp) på webbplatsen.

Skapa iSheet-objektet

Det här API-anropet används för att infoga iSheet-objekt. Flera iSheets kan stödjas.

Om du vill hämta status för ett iSheet-objekt baserat på en progressiv nyckel anropar du API POST /api/3/progressivekeystatus/{progressive_key}

t.ex. POST /api/{version}/progressivekeystatus/{progressive_key}

NamnTypDescription
progressive_keyString Nyckel för att kontrollera status för åtgärden.

Svar

<progressivekeyresponse>
 \t-objekt<>
  \t\t-objekt<>
   \t\t\t<itemid>1232</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuskod>200</statuskod>
   \t\t\t<meddelandepost>har lagts till/meddelandet har lagts till<>
  \t\t</item>
  \t\t-objekt<>
   \t\t\t<itemid>1233</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuskod>200</statuskod>
   \t\t\t<meddelandepost>har lagts till/meddelandet har lagts till<>
  \t\t</item>
 \t</items>
</progressivekeyresponse>
Skapa mapp

Det här API:et skapar en ny mapp på den angivna platsen. Du kan ange mappinformation och se till att mappen skapas under den angivna överordnade mappen.
Uppdatera webbplats

Använd den här API-slutpunkten för att uppdatera informationen om en befintlig webbplats. API:et stöder samma fält som används i Skapa webbplats-API.

Den här metoden stöder flera ärendenummer som ska läggas till på webbplatsen med api-version 10 och senare. Taggen "matternos" anger flera materianummer med skrivskyddat eller inte.

Version 18 och senare: en kategori (webbplatssyfte) krävs. Om webbplatssyftet är dolt visas ett meddelande. Annars läggs inte dolda webbplatsändamål till på webbplatsen.

Nu kan webbplatsägaren även tilldelas andra användare, men de måste vara webbplatsdeltagare och ha en roll som är högre än webbplatsadministratören.

Version 18 och senare: Webbplatsägaren kan lägga till andra användare på webbplatsen.

Från API version 19 och senare introduceras en ny modul med namnet customPages, som är nära kopplad till hemmodulen. Om värdet för hemmodulen är Sant måste customPages vara sant och vice versa.

Observera att alla egenskaper/element i hämta webbplatssvar inte är uppdaterbara/infogbara. Se tabellen nedan för att veta vilka som är skrivskyddade, uppdaterbara eller infogbara.
Uppdatera webbplatsgrupp

Den här API-metoden uppdaterar namnet på en befintlig grupp på en webbplats.
Det här API:et har utökats för att uppdatera namnet på en befintlig grundläggande användargrupp på en webbplats.

Arkivera användare

Åtgärds-ID:
deleteUser

Det här API-anropet används för att arkivera en användare i systemet.

Felkoder

Sammanfattning Referenskod (före V4) Referenskod (V4)

Följande användare finns inte i systemet

 110 110

Ett användar-ID krävs

 109 109

Användar-ID är inte i rätt format

 113 113

Användarens ID-längd får inte överstiga 50 tecken

 N/A 304


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

Parametrar

Name Nyckel Obligatorisk Typ Description
API-version
 version True string

version av API
Användar-ID
 userid True string

användar-ID

Flytta dokument

Åtgärds-ID:
moveDocuments

Det här API:et flyttar flera filer från en mapp till en annan på samma plats.

Parametrar

Name Nyckel Obligatorisk Typ Description
API-version
 version True string

Anger API-versionen.
Målmapps-ID
 targetfolder True string

Den unika identifieraren för målmappen där filerna ska flyttas.
fileidCSV
 fileidCSV string

Kommaavgränsad lista över fil-ID:t som ska flyttas.

Hämta användarlista

Åtgärds-ID:
getAllSystemUsers

Hämta en lista över användare Det här API:et hämtar en lista över användare från systemet. ##-nyckelfunktioner – Hämta användarinformation med flera filtreringsalternativ – Stöder sidnumrering med limit och offset – Nya frågeparametrar och fält som introducerats i de senaste versionerna – Strukturerat svar med användarroller och attribut ## Nya frågeparametrar (Version-Specific) – Introducerade i V12: – systemAdminSearch: När värdet är 1returneras endast användare med rollen Systemadministratör. - Introducerades i V18: - userid: Accepterar kommaavgränsade värden (CSV). ## Svarstextuppdateringar – Nya fält har lagts till: - emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate - ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid - systemuserresetpassworddateusertypeidavatarpracticegroup - langcode, publicprofile# dateOfBirth # Ändra adressformat (från V11) – Taggen location har bytt namn till address för konsekvens. – Exempelsvar: 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> ## Användarroller (introducerades i API V11+) – Exempelsvar: 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> ## Gränser och förskjutningar – Gränsbeteende: – Standard: 100 om inget värde anges. - Använd -1 för att returnera alla poster. – Om värdet är mindre än -1, är standardvärdet 100. - Förskjutningsbeteende: – Standard: 0 om inget värde anges. – Om förskjutningen överskrider det totala antalet poster återgår standardvärdet till 0. ## Nya roller introducerade – V12: Basic User, Allow user to bypass XSS protection - V14: Allow user to manage Contract Express system groups ## Felkoder | Sammanfattning | Referenskod (före V4) | Referenskod (V4) | |---------|----------------------|--------------| | | Ogiltiga indata för användarstatus (ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | Organisations-ID är ogiltigt | N/A | 260 | | Ogiltigt neverinvited värde (sant/falskt) | N/A | 387 | | Ogiltigt neverlogin värde (sant/falskt) | N/A | 388 | | Ogiltigt groupids värde | N/A | 214 | | Ogiltigt notingroup värde (sant/falskt) | N/A | 389 | | Ogiltigt ordertype (stöds: namn, organisation, status osv.) | N/A | 289 | | Ogiltigt orderby (stöds: asc, desc) | N/A | 290 | | Ogiltigt offset värde | 138 | 138 | | | Ogiltigt limit värde | 137 | 137 | ## Anteckningar – Från V13 och senare är det här API:et öppet för alla användare (tidigare begränsat till Systemadministratörer). – Från V18 och senare anger fältet userregistered2FA om en användare har registrerat sig för 2FA. --- Den här beskrivningen följer Swagger 2.0-schemaformatering och bör placeras i beskrivningsfältet i schema för anpassad anslutning.

Parametrar

Name Nyckel Obligatorisk Typ Description
API-version
 version True string

Version av API:et.
Användarstatus
 status string

Filtrera användare efter status: Aktiv, Arkiverad, Inaktiv eller Låst.
Sidnumreringsförskjutning
 offset string

Startposition för sidnumrering.
Resultatgräns
 limit string

Antal objekt som ska returneras per begäran.
Organisations-ID
 orgid string

Filtrera användare efter organisations-ID.
Aldrig inbjudna användare
 neverinvited string

Hämta användare som aldrig har bjudits in.
Aldrig inloggade användare
 neverlogin string

Hämta användare som aldrig har loggat in.
Användar-ID
 userid string

Filtrera användare efter deras unika användar-ID:n.
grupp-id
 groupid string

Filtrera användare efter grupp-ID:t.
Användare som inte finns i grupper
 notingroup string

Hämta användare som inte finns i någon grupp.
Sorteringsordningstyp
 ordertype string

Sortera användare efter ett angivet fält, till exempel namn, organisation eller status.
Sorteringsordning
 orderby string

Sortering resulterar i stigande eller fallande ordning.
Externt ID
 externalid string

Filtrera användare efter externt ID.
Förnamn
 firstname string

Filtrera användare efter förnamn.
Efternamn
 lastname string

Filtrera användare efter efternamn.
E-postadress
 email string

Filtrera användare efter e-postadress.
Användarsökning
 search string

Sök efter användare efter olika attribut, inklusive namn, e-post och jobbtitel.
Alfabetfilter
 alphabets string

Filtrera användare vars efternamn börjar med en specifik bokstav.
Befattning
 jobtitle string

Filtrera användare efter befattning.
Plats
 locations string

Filtrera användare efter stad.
Avdelning
 departments string

Filtrera användare efter avdelning.
Organisationsnamn
 organisations string

Filtrera användare efter organisationsnamn.
Specialiteter
 specialities string

Filtrera användarna efter deras specialiteter.
Systemadministratörssökning
 systemAdminSearch string

Hämta användare med rollen Systemadministratör.

Returer

Body
users

Hämta en lista över iSheet-objekt

Åtgärds-ID:
getISheetItems

Det här API-anropet hämtar en lista över objekt som finns i angiven iSheet.

Parametrar

Name Nyckel Obligatorisk Typ Description
API-version
 version True string

Anger vilken version av API:et som används.
iSheet-ID
 isheetid True integer

Anger det unika ID:t för iSheet.
ID för iSheet-vy
 sheetviewid integer

Anger ID för iSheet-vyn. Om den utelämnas returneras standardvyn.
Sortera kolumn-ID
 sortcolumnid integer

Anger ID för kolumnen som används för att sortera resultaten.
Sorteringsordning
 sortorder integer

Anger sorteringsordningen. Använd till exempel 0 för stigande ordning eller ett annat värde för fallande ordning.
Postgräns
 limit integer

Anger det maximala antalet poster som ska returneras. standardvärdet är 100 om det inte anges.
Postförskjutning
 offset integer

Anger startpositionen för posthämtning. standardvärdet är 0 om det inte anges.
Inkludera alla kolumner
 allColumnRequired boolean

En flagga som anger om alla kolumndata ska inkluderas oavsett aktuell vy.
Ignorera vybegränsningar
 isIgnoreView boolean

En flagga som anger om du vill ignorera visningsbegränsningar när objektdata hämtas.

Returer

Name Sökväg Typ Description
isheet
 isheet array of object

En lista över iSheet-objekt.
Artikel-ID
 isheet.itemId string

Objektets unika ID.
data
 isheet.data array of object

Detaljerade data för objektet.
sekvens
 isheet.data.sequence string

Sekvensnumret som är associerat med data.
columnDisplayName
 isheet.data.columnDisplayName string

Kolumnens visningsnamn.
värde
 isheet.data.value string

Värdet som finns i kolumnen.

Hämta en lista över mappar

Åtgärds-ID:
getFolderList

Det här API-anropet hämtar en lista över mappar som finns i den angivna mappen. Parametern "gräns" anger det maximala antalet objekt som ska returneras och parametern "offset" anger startpositionen för datahämtning. Standardvärden tillämpas om dessa parametrar utelämnas och mapparna returneras i stigande ordning efter skapandedatum.

Parametrar

Name Nyckel Obligatorisk Typ Description
API-version
 version True string

Anger vilken version av API:et som används.
Mapp-ID
 folderid True string

Anger mappens unika ID.
Objektgräns
 limit string

Anger det maximala antalet objekt som ska returneras.
Förskjutning av objekt
 offset string

Anger startpositionen för de returnerade objekten.
Sorteringsordningsriktning
 orderby string

Anger orderriktningen för sortering av objekt. Använd "asc" för stigande ordning eller "desc" för fallande ordning.
Sorteringsvillkor
 ordertype string

Anger kriteriet för sortering av objekt, till exempel namn, författare eller senast ändrat datum.
Inkludera mappstatusinformation
 statusinfo boolean

Anger om ytterligare mappstatusinformation ska inkluderas. Standardvärdet är falskt.
Inkludera smarta mappar
 includesmartfolder boolean

Anger om du vill inkludera smarta mappar i den returnerade listan. Standardvärdet är falskt.

Returer

Name Sökväg Typ Description
pärm
 folder array of object
items
 folder object

Hämta filinformation

Åtgärds-ID:
getDocumentInfo

Det här API-anropet hämtar detaljerad information för en angiven fil från HighQ Collaborate-plattformen.

Parametrar

Name Nyckel Obligatorisk Typ Description
API-version
 version True string

Anger vilken version av API:et som används.
Fil-ID
 fileid True string

Anger filens unika ID.
Senaste DMS-informationsflaggan
 lastdmsinfo boolean

Anger om du vill hämta den senaste informationen från dokumenthanteringssystemet.
Mapptyp
 foldertype string

Anger typ av mapp om tillämpligt.
Inkludera filstatusinformation
 statusinfo boolean

Anger om ytterligare information om filstatus ska inkluderas, till exempel delad status, favoritstatus, antal aktiviteter och status som gillad. Standardvärdet är falskt.
Inkludera e-postmetadata
 emailmetadata boolean

Anger om e-postmetadata ska inkluderas, till exempel avsändare, mottagare och tidsstämplar. Standardvärdet är falskt.

Returer

Body
DocumentDBO

Hämta iSheet-kolumner

Åtgärds-ID:
getIsheetColumns

Det här API-anropet hämtar de kolumner som är associerade med angiven iSheet. Den här funktionen stöds i API version 3 och senare.

Parametrar

Name Nyckel Obligatorisk Typ Description
iSheet-ID
 isheetid True integer

Anger det unika ID för iSheet som kolumner krävs för.
API-version
 version True string

Anger vilken version av API:et som används.
ID för iSheet-vy
 sheetviewid string

Anger ID för iSheet-vyn. Om det utelämnas returneras alla kolumner.
Ta med borttagna iSheet-kolumner
 onlyForDeletedIsheet boolean

Anger om kolumner ska tas med från en borttagen iSheet. Standardvärdet är falskt.

Returer

Body
columns

Hämta mappinformation

Åtgärds-ID:
getFolderInfo

Metoden innehåller mappinformation för angivet mapp-ID.

Parametrar

Name Nyckel Obligatorisk Typ Description
API-version
 version True string

version av API
Mapp-ID
 folderid True string

folderID
Statusinformation
 statusinfo boolean

Med parametern statusinfo kan du komma åt ytterligare information om mappen. Den tillgängliga informationen omfattar delad status, favoritstatus för inloggad användare

Returer

Body
FolderDBOV2

Ladda upp en fil

Åtgärds-ID:
insertDocument

Det här API-anropet laddar upp en fil till en angiven mapp på HighQ Collaborate-plattformen. Den stöder segmenterade uppladdningar när rubriken Content-Range tillhandahålls.

Parametrar

Name Nyckel Obligatorisk Typ Description
API-version
 version True string

Anger vilken version av API:et som används.
Fil att ladda upp
 file True file

Anger vilken fil som ska laddas upp.
Överordnat mapp-ID
 parentfolderid True string

Anger det unika ID för den överordnade mappen där filen ska laddas upp.
Åsidosätt dubblettflagga
 overrideduplicate boolean

Anger om dubbletter av filuppladdningar ska åsidosättas.
Dokumentnamn
 filename True string

Anger namnet på dokumentet.
Versionsanteckning
 versionnote string

Innehåller en anteckning som beskriver versionen av filen.
Progressiv åtgärdsnyckel
 progressiveoperkey string

Anger nyckeln som används för progressiva åtgärder under filuppladdningen.
DMS-databasnamn
 dmsdatabasename string

Anger namnet på databasen för dokumenthanteringssystemet.
DMS-redigeringsdatum
 dmseditdate string

Anger det redigeringsdatum som registrerats i dokumenthanteringssystemet.
DMS-överordnat mapp-ID
 dmsparentfolderid string

Anger det unika ID:t för den överordnade mappen i dokumenthanteringssystemet.
DMS-dokument-ID
 dmsdocid string

Anger dokumentets unika ID i dokumenthanteringssystemet.
DMS-dokumentversion
 dmsversion string

Anger versionen av dokumentet som registrerats i dokumenthanteringssystemet.
Meddelandeinformation
 notification string

Innehåller information om meddelanden som ska skickas vid filuppladdning.
Batch-ID
 batchid string

Anger batchåtgärdens unika ID.
Rotmapps-ID
 rootfolderid string

Anger rotmappens unika ID.

Lägg till användare

Åtgärds-ID:
createUser

Det här API-anropet används för att lägga till en ny användare i systemet.
Obs!
1. Stöd har lagts till för följande nya fält
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. Adresstaggen har lagts till i API-version 4

1

Sammanfattning Referenskod (före V4) Referenskod (V4)

E-postadress krävs

 101 101

Ogiltig e-postadress

 104 104

Förnamn krävs

 102 102

Maximalt antal tillåtna tecken för förnamnet måste vara mellan 1 och 100

 102 352

Sekreterarens/assistentens e-postadress är inte giltig

 104 353

Status måste vara aktiv eller inaktiv

 116 116

Den angivna avdelningen får inte innehålla fler än 256 tecken

 N/A 354

Det angivna ifpartner-attributet är ogiltigt

 N/A 355

Det angivna systemuser-attributet är ogiltigt

 N/A 356

Det angivna attributet usertypeid är ogiltigt

 N/A 357

Det angivna langcode-attributet är ogiltigt

 N/A 358

Det angivna källtypsattributet är ogiltigt. Giltiga värden är System, Active Directory eller System standard .

 N/A 359

Ange ett giltigt telefonnummer   

 N/A 360

Ange ett giltigt telefonnummer i formatet {countrycode}  ${areacode}${number}.

 N/A 361

Ange ett giltigt mobilnummer i formatet {countrycode}${number}.

 N/A 362

Ange en giltig landskod för office-telefon

 N/A 363

Landskoden för office-telefon kan ha högst 4 siffror

 N/A 364

Ange en giltig kod för office-telefonområdet

 N/A 365

Arbetstelefonens riktnummer kan innehålla högst 5 siffror

 N/A 366

Office-telefonnummer ska ha högst 15 siffror

 N/A 368

Ange en giltig landskod för mobiltelefon

 N/A 369

Mobiltelefonens landskod kan ha högst 4 siffror

 N/A 372

Ange ett giltigt mobilnummer

 N/A 373

Mobiltelefonnumret ska ha högst 20 siffror

 N/A 374

Domänen finns inte

 105 105

E-post finns redan i systemet

 111 111

Ange organisation vid självregistrerad domän   

 187 187

Ange organisation i händelse av undantagsdomäner   

 115 115

Organisations-ID är inte i rätt format   

 112 112

Organisationen finns inte

 106 106

Domän finns i annan organisation

 114 114

Angivet adress-ID är inte giltigt

 N/A 308

Det gick inte att hitta det sociala länknamnet i systemet.

 N/A 375

Namnet på den sociala länken krävs

 N/A 376

Det sociala länkvärdet krävs

 N/A 377

Maximalt antal tecken för socialt länkvärde måste vara mellan 1 och 500

 N/A 378

Ange namnet på den anpassade länken

 N/A 379

Det anpassade länkvärde som krävs

 N/A 380

Maxtecken för anpassat länknamn måste vara mellan 1 och 500

 N/A 381

Maxtecken för anpassat länkvärde måste vara mellan 1 och 500

 N/A 382

Namnet på meddelandelänken som krävs

 N/A 383

Meddelandelänkens namn hittades inte i systemet

 N/A 384

Det meddelandelänkvärde som krävs   

 N/A 385

Maximalt antal tecken för meddelandelänkvärdet måste vara mellan 1 och 500

 N/A 386

Den sociala länken är inaktiverad

 N/A 408

Meddelandelänken är inaktiverad

 N/A 409

Den anpassade länken är inaktiverad

 N/A 410

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

Parametrar

Name Nyckel Obligatorisk Typ Description
API-version
 version True string

version av API
index
 index integer

Unikt index för användaren.
userid
 userid integer

Unik identifierare för användaren.
förnamn
 firstname string

Användarens förnamn.
efternamn
 lastname string

Användarens efternamn.
practicegroup
 practicegroup string

Övningsgrupp som användaren tillhör.
langcode
 langcode string

Användarens språkkod.
localeID
 localeID string

Språkvariant-ID för användaren.
publicprofile
 publicprofile string

Användarens offentliga profil.
pwpid
 pwpid string

PWP-ID för användaren.
usertypeid
 usertypeid string

Användartyp-ID.
systemuser
 systemuser string

Systemanvändarflagga.
Mejladress
 email string

Email användarens adress.
phone
 phone string

Användarens telefonnummer.
mobile
 mobile string

Användarens mobilnummer.
Avdelning
 department string

Användarens avdelning.
Org
 org string

Organisation som användaren tillhör.
addressline1
 addressline1 string

Första raden i adressen.
addressline2
 addressline2 string

Andra raden i adressen.
addressline3
 addressline3 string

Tredje raden i adressen.
city
 city string

Staden där adressen finns.
state
 state string

Adresstillstånd.
country
 country string

Adresslandet.
Postnummer
 postcode string

Adressens postnummer.
addressid
 addressid string

Unik identifierare för adressen.
addressline1
 addressline1 string

Första raden i adressen.
addressline2
 addressline2 string

Andra raden i adressen.
addressline3
 addressline3 string

Tredje raden i adressen.
city
 city string

Staden där adressen finns.
state
 state string

Adresstillstånd.
country
 country string

Adresslandet.
Postnummer
 postCode string

Adressens postnummer.
kända
 knownas string

Alternativt namn eller smeknamn för adressen.
uppleva
 experience array of string
Id-nummer
 id string

Länk-ID
name
 name string

Länknamn.
värde
 value string

Länkvärde.
Id-nummer
 id string

Länk-ID
name
 name string

Länknamn.
värde
 value string

Länkvärde.
Id-nummer
 id string

Länk-ID
name
 name string

Länknamn.
värde
 value string

Länkvärde.
img
 img string
reportsto
 reportsto string
metadataname
 metadataname array of string
metadatavalue
 metadatavalue array of string
group
 group array of string
externalid
 externalid string

Användarens externa ID.
jobtitle
 jobtitle string

Användarens befattning.
secretaryname
 secretaryname string

Namnet på användarens sekreterare.
secretarymail
 secretarymail string

E-post till användarens sekreterare.
Specialiteter
 specialities string

Specialiteter för användaren.
title
 title string

Användarens rubrik.
goesby
 goesby string

användarens föredragna namn.
suffix
 suffix string

Suffix för användarens namn.
atomlänk
 atomlink string

Atomlänk som är associerad med användaren.
bio
 bio string

Biografi över användaren.
dateOfBirth
 dateOfBirth string

Användarens födelsedatum.
link
 link string

Länk som är associerad med användaren.
status
 status string

Status för användaren.
statuskod
 statuscode string

Statuskod för användaren.
meddelande
 message string

Meddelande som är associerat med användaren.
sourcetype
 sourcetype string

Användarens källtyp.
orgid
 orgid string

Organisations-ID.
ifpartner
 ifpartner string

Partnerflagga.
emaildomain
 emaildomain string

Användarens e-postdomän.
invitationsent
 invitationsent string

Flagga för skickad inbjudan.
createdby
 createdby string

Användare som skapade posten.
createddate
 createddate string

Datum då posten skapades.
modifierad av
 modifiedby string

Användare som ändrade posten.
modifieddate
 modifieddate string

Datum då posten ändrades.
lastlogindate
 lastlogindate string

Datum för den senaste inloggningen.
invalidlogins
 invalidlogins string

Antal ogiltiga inloggningsförsök.
publicwebsiteprofileid
 publicwebsiteprofileid string

Profil-ID för offentlig webbplats.
resetpassworddate
 resetpassworddate string

Datum då lösenordet återställdes.
avatar
 avatar string

Url för avatarbild.
followingcount
 followingcount integer

Antal användare som följs.
followercount
 followercount integer

Antal följare.
följande
 following boolean

Följande flagga.
None needed, as the translation is already accurate and fluent.
 role string

Användarens roll.
isbasicuser
 isbasicuser string

Grundläggande användarflagga.
encryptedUserId
 encryptedUserId string

Krypterat användar-ID.
självregistrerad
 selfregistered integer

Självregistrerad flagga.
registeredWith2FA
 registeredWith2FA string

Registreringsflagga för tvåfaktorautentisering.
isInternal
 isInternal integer

Intern användarflagga.
orgName
 orgName string

Namn på organisationen.

Returer

Body
IntegrationUserDBO

Lägg till webbplats

Åtgärds-ID:
createSite

Använd det här API:et för att skapa en ny webbplats. Platsobjektet stöder endast attribut som visas i gränssnittet skapa webbplats.

Det här API:et kräver platsnamn (och obligatoriska fält som konfigurerats på ASP-nivå om det finns några) för att skapa en ny webbplats.

Taggen "module" representerar en annan modul som ska konfigureras på platsen, eftersom den visas i begärandeattribut.
Så här skapar du webbplatsen från mallen genom att skicka taggen "sitetemplateid"
     – För mindre än version 7, Om någon modul inte ges ("modul"-taggen inte skickas) i begäran, kommer konfigurationen av mallmodulen att äga rum. Om modultaggen tillhandahålls med konfiguration respekterar den och konfigurerar den enligt begäran (i stället för att använda konfiguration av mallmoduler)
     – För större än version 7 sker konfigurationen av mallmodulen om någon modul anges ("modul"-taggen skickas) eller inte i begäran.

Den här metoden stöder inte uppladdning av webbplatsavbildningen i det här anropet. Stöd för webbplatsikonen tillhandahålls som ett separat anrop.
Metodanropet förväntar sig ett befintligt kategori-ID. Kategori-ID:t ska hämtas av det anropande programmet genom ett tidigare anrop till gränssnittet Webbplatskategorier. Om inga kategorier anges i begäran läggs ingen kategori (inte faktisk kategori) till som standard.

Start- och slutdatum för webbplatsen ska vara i formatet "dd MMM åååå" och det är INTE UTC. API-klienten begär alltid det faktiska datumet.

"landingpage" har standardvärdet "files (root folder)".
"landingpage" förväntar sig tre olika formuleringar eller identifieringar för filmodulen. Möjliga värden är:
– filer (rotmapp)
– filer (senaste aktivitet)
- filer (avancerad sökning)
Metodimplementeringen stöder nu (från 5.1 och senare) Flerspråkigt webbplatsnamn. API version 6 eller högre <webbplatsnamn> representeras i begärandetexten baserat på användarinställningsordning. API version 5 eller äldre <webbplatsnamn> representerar standardspråket engelska i Storbritannien.
<sitenametranslations> representerar platsnamn på alla språk (som kommer att vara ytterligare tagg i "Object itself API" från 5.1 och senare) API version 6 eller senare, i begärandetexten skickar de båda taggarna, dvs. <webbplatsnamn> och <webbplatsnamntranslationer> , och sedan måste vi verifiera värden, t.ex. <webbplatsnamn> måste matcha med respektive <översättningstagg> när det gäller användarens språkinställningar. API 7 eller senare, webbplatsen som skapas från mallen följer moduler från källmallen och ignorerar modullistan som skickas i begärandetexten.

Metodimplementeringen stöder nu skapa webbplats från mall genom att ange taggen "sitetemplateid" (gammal metod)

Observera att stödet för att skapa en webbplats från en mall med det här API:et kommer att bli inaktuellt i framtiden. Om du vill skapa en webbplats från mallen använder du det nya API:et Skapa webbplats från mall (/webbplatser/mallar/{templateid}/site) som är ett långt avsöknings-API (har stöd för tidskrävande begäranden)

Den här metoden stöder flera ärendenummer som ska läggas till på webbplatsen med api-version 10 och senare. Taggen "matternos" anger flera materianummer med skrivskyddat eller inte. Äldre version (mindre än version 10) ett ärendenummer "matterno" återspeglar det första ärendenumret som fanns flera nummer på webbplatsen.

Version 18 och senare: en kategori (webbplatssyfte) krävs. Om webbplatssyftet är dolt visas ett meddelande. Annars läggs inte dolda webbplatsändamål till på webbplatsen.

Upp till version 17: webbplatsägaren är den inloggade användaren. inga andra användare kan läggas till.

Version 18 och senare: Webbplatsägaren kan lägga till andra användare på webbplatsen.

Från API version 19 och senare introduceras en ny modul med namnet "customPages" som är nära kopplad till hemmodulen. Om värdet för hemmodulen är Sant är customPages sant och vice versa.

Parametrar

Name Nyckel Obligatorisk Typ Description
Den version av API:et som begärs
 version True string

version av API
Id-nummer
 id integer

Platsidentifieraren.
sitename
 sitename string

Namnet på webbplatsen.
None needed, as the translation is already accurate and fluent.
 role string

Webbplatsens roll.
sitedescription
 sitedescription string

Beskrivningen av webbplatsen.
enabledmodules
 enabledmodules string

En lista över moduler som är aktiverade för webbplatsen.
sitefolderID
 sitefolderID string

Identifieraren för webbplatsens mapp.
sitefolderpermission
 sitefolderpermission string

Behörighetsnivån för webbplatsens mapp.
enable
 enable string

Aktivera status för HomeDBO.
enable
 enable string

Aktivera status för ActivityDBO.
microblog
 microblog string

Mikroblogginnehåll som är associerat med ActivityDBO.
docid
 docid string

Dokument-ID.
blogTitle
 blogTitle string

Rubrik för blogginlägget.
blogContent
 blogContent string

Innehållet i blogginlägget.
showComment
 showComment integer

visa kommentaren.
tagList
 tagList array of string

Lista över taggar som är associerade med bloggen.
status
 status integer

status för blogginlägget.
siteID
 siteID integer

Identifierare för den associerade webbplatsen.
författare
 author string

Författare till bloggen.
categoryList
 categoryList array of string

Kategorier som tilldelats blogginlägget.
notificationTypeID
 notificationTypeID integer

Identifierare för meddelandetypen.
meddelande
 message string

Meddelandeinnehåll som är relaterat till bloggen.
messageCode
 messageCode integer

Kod som är associerad med meddelandet.
externalID
 externalID string

Extern identifierare som är länkad till bloggen.
publiceraDatum
 publishDate string

Publiceringsdatum för bloggen.
processtyp
 processtype string

Processtyp som är associerad med bloggen.
enable
 enable string

Aktivera status för BlogDBO.
wikiid
 wikiid integer

Unik identifierare för wikin.
currentversionid
 currentversionid integer

Identifierare för den aktuella versionen av wikin
parentwikiid
 parentwikiid integer

Identifierare för den överordnade wikin.
wikititle
 wikititle string

Wikins titel.
wikicontent
 wikicontent string

Innehållet i wikin.
showcomment
 showcomment integer

Anger om kommentarer är aktiverade.
createddate
 createddate string

Skapandedatum för wikin.
modifieddate
 modifieddate string

Senaste ändringsdatum för wikin.
taglist
 taglist string

Kommaavgränsad lista över taggar som är associerade med wikin.
wikipath
 wikipath string

Sökväg för att komma åt wikin.
wikidraftid
 wikidraftid integer

Identifierare för utkastversionen av wikin.
drafttype
 drafttype string

Typ av utkast som är associerat med wikin.
status
 status integer

Aktuell status för wikin.
wikiversionid
 wikiversionid integer

Versionsidentifierare för wikin.
index
 index string

Index eller identifierare för aktiviteten.
parenttaskid
 parenttaskid integer

Identifierare för den överordnade aktiviteten.
taskid
 taskid integer

Unik identifierare för aktiviteten.
title
 title string

Uppgiftsrubrik.
beskrivning
 description string

Detaljerad beskrivning av uppgiften.
duedate
 duedate string

Förfallodatum för uppgiftens slutförande.
startdate
 startdate string

Startdatum när aktiviteten initierades.
mattermaptaskid
 mattermaptaskid string

Identifierarlänkning till ärendemappningsaktiviteten.
type
 type string

Typ eller kategori för uppgiften.
dependenton
 dependenton string

Uppgifter som den här uppgiften är beroende av.
daysfromdependent
 daysfromdependent string

Antal dagar från den beroende aktiviteten.
ignoreweekend
 ignoreweekend integer

Anger om helger ignoreras i schemaläggningen.
duration
 duration integer

Varaktighet för att slutföra uppgiften.
resource
 resource string

Resurser som tilldelats uppgiften.
eventTitle
 eventTitle string

Rubriken på händelsen.
eventContent
 eventContent string

Innehållet i händelsen.
showComment
 showComment integer

Anger om kommentarer är aktiverade för händelsen.
tagList
 tagList array of string

Lista över taggar som är associerade med händelsen.
status
 status integer

Aktuell status för händelsen.
siteID
 siteID integer

Identifierare för webbplatsen.
kontakta
 contact string

Kontaktuppgifter för händelsen.
categoryList
 categoryList array of string

Kategorier under vilka händelsen visas.
notificationTypeID
 notificationTypeID integer

Meddelandetypen som är relaterad till händelsen.
meddelande
 message string

Meddelandet om händelsen.
messageCode
 messageCode integer

Meddelandekoden för händelsen.
externalID
 externalID string

Den externa identifieraren.
startDate
 startDate string

Händelsens startdatum.
slutdatum
 endDate string

Slutdatum för händelsen.
startTime
 startTime string

Starttiden för händelsen.
endTime
 endTime string

Sluttiden för händelsen.
location
 location string

Platsen för händelsen.
författare
 author string

Författaren till händelsen.
processtyp
 processtype string

Processtiden för händelsen.
enable
 enable string

Aktivera är händelsen.
Id-nummer
 id integer

Unik identifierare för iSheet.
title
 title string

Rubrik för iSheet.
beskrivning
 description string

Beskrivning av isheeten.
status
 status string

Status för isheeten.
accesstype
 accesstype string

Åtkomsttyp för isheeten.
type
 type string

Typ av isheet.
viewlink
 viewlink string

Länka för att visa iSheet.
allowsections
 allowsections string

Om avsnitt är tillåtna.
allowlookup
 allowlookup string

Om uppslagsfält är aktiverade.
displayisheet
 displayisheet string

Visningsalternativ för iSheet.
searchasdefaultview
 searchasdefaultview string

Anger om sökningen är standardvyn.
enableversion
 enableversion string

Flaggan Versionsaktiverad.
enablesheetalerter
 enablesheetalerter string

Flagga för att aktivera bladaviseringar.
alertercondition
 alertercondition string

Villkor för utlösande av aviseringar.
overrideitemmodifieddate
 overrideitemmodifieddate string

Åsidosätt ändrad datumflagga.
enablebulkinsertupdate
 enablebulkinsertupdate string

Aktivera massinfogning/uppdatering.
fielddescriptions
 fielddescriptions string

Fältbeskrivningar för iSheet.
enablerowlocking
 enablerowlocking string

Aktivera låsning på radnivå.
setcharlimittruncatemultilinetextenabled
 setcharlimittruncatemultilinetextenabled string

Trunkera textflagga för flera rutor.
setcharlimittruncatemultilinetextval
 setcharlimittruncatemultilinetextval string

Teckengräns för trunkering med flera rader.
allowchoicelistvaluesforreuse
 allowchoicelistvaluesforreuse string

Tillåt återanvändning av alternativlistvärden.
allowscorelistvaluesforreuse
 allowscorelistvaluesforreuse string

Tillåt återanvändning av poänglistevärden.
allowIsheetComments
 allowIsheetComments string

Tillåt kommentarer i iSheet.
shareRecordsLimit
 shareRecordsLimit integer

Gräns för poster som tillåts att dela.
shareRecordsLimitEnabled
 shareRecordsLimitEnabled integer

Resursgräns för aktiverade poster.
enableIsheetAddRecordFormSharing
 enableIsheetAddRecordFormSharing string

Aktivera formulärdelning för att lägga till poster.
recordcount
 recordcount string

Aktuellt antal poster.
sheettypeid
 sheettypeid integer

Typ-ID för iSheet
enable
 enable string

Aktivera QA-funktioner.
userid
 userid integer

Användar-ID.
Mejladress
 email string

e-postadress.
httpavatar
 httpavatar string

HTTP-URL för avatar.
avatar
 avatar string

Avatarbild.
userlink
 userlink string

Länk till användarprofil.
httplink
 httplink string

HTTP-länk till användarprofil.
phone
 phone string

Telefonnummer.
mobile
 mobile string

Mobilnummer.
Avdelning
 department string

Användarens avdelning.
enable
 enable string

Aktivera Contract Express-integrering.
adminnote
 adminnote string

Administrativa anteckningar som rör webbplatsen.
startdate
 startdate string

Startdatumet för webbplatsens åtgärd.
enddate
 enddate string

Slutdatumet för webbplatsens åtgärd.
createddate
 createddate string

Det datum då webbplatsen skapades.
archiveddate
 archiveddate string

Datumet då webbplatsen arkiverades.
clientno
 clientno string

Det klientnummer som är associerat med platsen.
matterno
 matterno string

Det ärendenummer som är associerat med webbplatsen.
landningssida
 landingpage string

Webbadressen till landningssidan för webbplatsen.
link
 link string

En länk som är relaterad till webbplatsen.
status
 status string

Webbplatsens aktuella status.
statusid
 statusid integer

Identifieraren för webbplatsens status.
size
 size string

Webbplatsens storlek.
billingnotes
 billingnotes string

Anteckningar som rör fakturering för webbplatsen.
billingnextinvoicedate
 billingnextinvoicedate string

Datumet för nästa faktura för webbplatsen.
billinglastinvoicedate
 billinglastinvoicedate string

Datumet för den senaste fakturan för webbplatsen.
filepagecount
 filepagecount string

Det totala antalet filer på webbplatsen.
maxpagecount
 maxpagecount string

Maximalt antal tillåtna sidor för filer på webbplatsen.
sitehttplink
 sitehttplink string

HTTP-länken till webbplatsen.
isSyncable
 isSyncable integer

Anger om webbplatsen kan synkroniseras.
enforceusergroups
 enforceusergroups string

Användargrupperna som tillämpas för webbplatsen.
csvSiteCategory
 csvSiteCategory string

Kategorin för webbplatsen i CSV-format.
siteNameInDefaultLanguage
 siteNameInDefaultLanguage string

Namnet på webbplatsen på standardspråket.
synlig
 visible integer

Anger om webbplatsen är synlig.
siteLogoName
 siteLogoName string

Namnet på webbplatsens logotypfil.
siteLogoFileSize
 siteLogoFileSize integer

Filstorleken för webbplatsens logotyp.
siteLogoHeight
 siteLogoHeight integer

Höjden på webbplatsens logotyp.
siteLogoWidth
 siteLogoWidth integer

Bredden på webbplatsens logotyp.
siteStatus
 siteStatus integer

Platsens statuskod.
applySiteTerms
 applySiteTerms integer

Anger om webbplatsvillkoren tillämpas.
siteTerm
 siteTerm string

De villkor som tillämpas på webbplatsen.
termType
 termType integer

Den typ av termer som tillämpas på webbplatsen.
nextLoginSiteTerms
 nextLoginSiteTerms integer

Anger om webbplatsvillkoren krävs vid nästa inloggning.
defaultSiteTermsEnable
 defaultSiteTermsEnable integer

Anger om standardvillkor för webbplatsen är aktiverade.
advancedQAPermission
 advancedQAPermission integer

Den avancerade qa-behörighetsnivån för webbplatsen.
isInternal
 isInternal integer

Anger om platsen är intern.
Psm
 psm integer

Product Service Manager-identifieraren.
siteLabelDisplay
 siteLabelDisplay string

Visningsetiketten för webbplatsen.
allowSiteAdministration
 allowSiteAdministration integer

Anger om webbplatsadministration tillåts.
siteLevelPasswordEnable
 siteLevelPasswordEnable integer

Aktivera lösenordsskydd på platsnivå.
siteLevelPasscodeEnable
 siteLevelPasscodeEnable integer

Aktivera lösenordsskydd på platsnivå.
lösenordUsingAuthApp
 passcodeUsingAuthApp integer

Anger om lösenordsautentisering använder en autentiseringsapp.
sitePassword
 sitePassword string

Lösenordet som är kopplat till webbplatsen.
ipRestrictionEnable
 ipRestrictionEnable integer

Aktivera IP-begränsningar för webbplatsåtkomst.
availableIP
 availableIP string

Kommaavgränsad lista över IP-adresser som tillåts komma åt webbplatsen.
highqDrive
 highqDrive integer

Anger om HighQ Drive-integrering är aktiverat.
applySiteHomePage
 applySiteHomePage integer

Så här använder du en anpassad startsida för webbplatsen.
siteHomePage
 siteHomePage string

URL för webbplatsens anpassade startsida.
siteHomePageType
 siteHomePageType integer

Typ av startsida.
nextLoginSiteHomePage
 nextLoginSiteHomePage integer

Ange nästa inloggning till webbplatsens startsida.
applyDisplayContent
 applyDisplayContent integer

Så här använder du inställningar för visningsinnehåll.
displayContent
 displayContent string

Innehåll som ska visas på webbplatsen.
rssSecurity
 rssSecurity integer

RSS-feedsäkerhetsnivå.
krypterat lösenord
 encryptedPassword integer

Anger om webbplatslösenordet är krypterat.
availableIPRangeCSV
 availableIPRangeCSV string

Kommaavgränsad lista över IP-adressintervall som tillåts komma åt webbplatsen.
siteModuleID
 siteModuleID integer

Identifierare för platsmodulen.
icalSecurity
 icalSecurity integer

säkerhetsnivå för iCal-feed.
defaultDisplayContent
 defaultDisplayContent string

Standardinnehåll som ska visas på webbplatsen.
defaultEmailAlert
 defaultEmailAlert integer

Aktivera standardaviseringar för e-post.
excelReportFooter
 excelReportFooter integer

Innehåller en sidfot i Excel-rapporter.
excelReportFooterText
 excelReportFooterText string

Text som ska visas i sidfoten för Excel-rapporter.
announcementMLJSON
 announcementMLJSON string

JSON-formaterade meddelanden för webbplatsen.
templateType (på engelska)
 templateType integer

Typ av mall som används för webbplatsen.
templateLicence
 templateLicence integer

Licenstyp för webbplatsmallen.
openChannelAppID
 openChannelAppID string

Program-ID för integrering med öppen kanal.
itemid
 itemid integer

Identifierare för det objekt som är associerat med webbplatsen.
sitemetadatasheetid
 sitemetadatasheetid integer

ID för metadatabladet som är associerat med webbplatsen.
mysite
 mysite boolean

Anger om det här är användarens personliga webbplats.
lastaccesseddate
 lastaccesseddate string

Datum och tid då webbplatsen senast användes.
defaultViewerMetaDataTab
 defaultViewerMetaDataTab integer

Standardmetadatafliken för webbplatsvisningsprogrammet.
documentMetadataViewId
 documentMetadataViewId integer

dokumentmetadata för visningsidentifierare.
folderMetadataViewId
 folderMetadataViewId integer

mappmetadata för visningsidentifierare.
docSort
 docSort integer

Sorteringsordningen för dokument.
folderSort
 folderSort integer

Sorteringsordningen för mappar.
defaultFolderRenderView
 defaultFolderRenderView integer

Avgör standardläget för vyn för mappar.
isTaskAttachmentDefault
 isTaskAttachmentDefault integer

Standardplatsen för aktivitetsbilagor.
taskAttachmentDefaultFolderId
 taskAttachmentDefaultFolderId integer

Den unika identifieraren för den mapp som har angetts som standardplats för aktivitetsbilagor.
favorit
 favourite string

favoritstatus.
enabledocumentredaction
 enabledocumentredaction boolean

Anger om dokumentredigering är aktiverat för webbplatsen.
mentiongroups
 mentiongroups integer

De nämnda grupperna.
enablefilerelationships
 enablefilerelationships boolean

Anger om filrelationer är aktiverade.
filerelationshipsitepermissionlevel
 filerelationshipsitepermissionlevel integer

Behörighetsnivån som krävs för att hantera filrelationer.

Returer

Body
site

Lägga till befintlig grupp på webbplatsen

Åtgärds-ID:
addExistingGroupToSite

Den här API-metoden lägger till en befintlig systemgrupp på platsen.
Det här API:et har utökats för att lägga till befintliga system grundläggande användargrupper (av system-/organisationstyp) på webbplatsen.

Parametrar

Name Nyckel Obligatorisk Typ Description
API-version
 version True string

version
Webbplatsens ID
 siteid True string

Webbplatsens ID.
Systemgruppens ID
 groupid True string

ID:t för den systemgrupp som ska läggas till på platsen.

Returer

Body
sitegroup

Skapa iSheet-objektet

Åtgärds-ID:
insertISheetItems

Det här API-anropet används för att infoga iSheet-objekt. Flera iSheets kan stödjas.

Om du vill hämta status för ett iSheet-objekt baserat på en progressiv nyckel anropar du API POST /api/3/progressivekeystatus/{progressive_key}

t.ex. POST /api/{version}/progressivekeystatus/{progressive_key}

NamnTypDescription
progressive_keyString Nyckel för att kontrollera status för åtgärden.

Svar

<progressivekeyresponse>
 \t-objekt<>
  \t\t-objekt<>
   \t\t\t<itemid>1232</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuskod>200</statuskod>
   \t\t\t<meddelandepost>har lagts till/meddelandet har lagts till<>
  \t\t</item>
  \t\t-objekt<>
   \t\t\t<itemid>1233</itemid>
   \t\t\t<status>SUCCESS</status>
   \t\t\t<statuskod>200</statuskod>
   \t\t\t<meddelandepost>har lagts till/meddelandet har lagts till<>
  \t\t</item>
 \t</items>
</progressivekeyresponse>

Parametrar

Name Nyckel Obligatorisk Typ Description
API-version
 version True string

Version av API:et
iSheet-identifierare
 isheetid True integer

ID för iSheet
Bladvyidentifierare
 sheetviewid integer

ID för iSheet-vyn (valfritt)
Id-nummer
 id integer

Isheet-identifierare.
title
 title string

Rubrik på bladet.
beskrivning
 description string

Beskrivning av bladet.
status
 status string

Bladets status.
accesstype
 accesstype string

Åtkomsttyp för bladet.
type
 type string

Typ av blad.
viewlink
 viewlink string

URL-länk för att visa bladet.
allowsections
 allowsections string

Anger om avsnitt tillåts.
allowlookup
 allowlookup string

Anger om sökning tillåts.
displayisheet
 displayisheet string

Visa isheet.
searchasdefaultview
 searchasdefaultview string

Anger sökning som standardvy.
enableversion
 enableversion string

Aktivera version.
enablesheetalerter
 enablesheetalerter string

Aktiverar bladaviseringar.
alertercondition
 alertercondition string

Villkor för att utlösa aviseringar.
overrideitemmodifieddate
 overrideitemmodifieddate string

Över åkturen ändras objektets datum.
enablebulkinsertupdate
 enablebulkinsertupdate string

Tillåt massinfogningsuppdatering.
fielddescriptions
 fielddescriptions string

beskrivning för fält.
enablerowlocking
 enablerowlocking string

Aktiverar radlåsning.
setcharlimittruncatemultilinetextenabled
 setcharlimittruncatemultilinetextenabled string

Aktiverar trunkering av teckengräns för text med flera rader.
setcharlimittruncatemultilinetextval
 setcharlimittruncatemultilinetextval string

anger teckengräns för trunkering.
allowchoicelistvaluesforreuse
 allowchoicelistvaluesforreuse string

Tillåter återanvändning av alternativlistvärden.
allowscorelistvaluesforreuse
 allowscorelistvaluesforreuse string

Tillåter återanvändning av poänglistevärden.
allowIsheetComments
 allowIsheetComments string

Tillåter kommentarer på bladet.
shareRecordsLimit
 shareRecordsLimit integer

Gräns för delade poster.
shareRecordsLimitEnabled
 shareRecordsLimitEnabled integer

Aktivera delningspostgräns.
enableIsheetAddRecordFormSharing
 enableIsheetAddRecordFormSharing string

Möjliggör delning av lägg till postformulär.
allowViewBaseRendering
 allowViewBaseRendering string

Tillåter basåtergivning av vyer.
kolumn
 column object
recordcount
 recordcount string

Totalt antal poster.
viewId
 viewId integer

Unik identifierare för vyn.
siteId
 siteId integer

Identifierare för den associerade webbplatsen.
platsnamn
 siteName string

Namnet på webbplatsen.
sheetName
 sheetName string

Bladets namn.
viewName
 viewName string

Namnet på vyn.
sheetId
 sheetId integer

Identifierare för bladet.
sekvens
 sequence string

Sekvensnummer för rubrikkolumnen.
columnValue
 columnValue string

Värdet för rubrikkolumnen.
columnTypeId
 columnTypeId string

Identifierare för kolumntypen.
columnId
 columnId string

Unik identifierare för kolumnen.
columnTypeAlias
 columnTypeAlias string

Aliasnamn för kolumntypen.
itemsequence
 itemsequence string

Sekvensnummer för objektet.
itemid
 itemid string

Unik identifierare för objektet.
externalid
 externalid string

Extern identifierare som är associerad med objektet.
columnid
 columnid integer

Unik identifierare för kolumnen
name
 name string

Namnet på kolumnen
type
 type integer

Datatyp för kolumnen.
systemgeneratedtype
 systemgeneratedtype string

Systemgenererad typinformation.
section
 section integer

Avsnittsnummer där kolumnen finns.
beskrivning
 description string

Detaljerad beskrivning av kolumnen.
addtodefaultview
 addtodefaultview string

Anger om kolumnen läggs till i standardvyn.
columnconditionstate
 columnconditionstate string

Status för kolumnens villkor.
rowid
 rowid integer

Identifierare för raden.
columnid
 columnid integer

Identifierare för kolumnen.
operatorid
 operatorid integer

Identifierare för operatorn.
oprand
 oprand string

Operand-värde för filtret.
logisk typ
 logicaltype string

Filtrets logiska typ.
sheetfiltervaluetypeid
 sheetfiltervaluetypeid string

ID för bladets filtervärdetyp.
displaytype
 displaytype string

Visningstyp för filtret.
sourceColumnId
 sourceColumnId integer

Källkolumn-ID för filtret.
scoreConditionTypeid
 scoreConditionTypeid integer

ID för typ av poängvillkor.
defaultvalue
 defaultvalue string

Standardvärde för kolumnen.
columnwidth
 columnwidth string

Kolumnens bredd.
bladnamn
 sheetname string

Namnet på det associerade bladet.
sitename
 sitename string

Namnet på webbplatsen.
obligatorisk
 mandatory string

Anger om kolumnen är obligatorisk.
allowsearch
 allowsearch string

Anger om sökning tillåts.
maxchars
 maxchars integer

Maximalt antal tecken.
allowfieldfromanotherisheet
 allowfieldfromanotherisheet string

Tillåter fält från ett annat blad.
allowrichhtmltext
 allowrichhtmltext string

Anger om RTF-text tillåts.
numberoflines
 numberoflines integer

Antal rader i kolumnen.
displaymethod
 displaymethod string

Metod som används för att visa kolumnen.
includeotheroption
 includeotheroption string

Innehåller alternativet "Övrigt".
singleormultileselectioninsearch
 singleormultileselectioninsearch string

Anger markeringstyp i sökningen.
Id-nummer
 id string

Unik identifierare för valet."
label
 label string

Etikett för valet.
poäng
 score string

Poäng som är associerad med valet.
color
 color string

Färgkod för valet.
imageid
 imageid integer

ID för den associerade avbildningen.
includeinalertpreferences
 includeinalertpreferences string

Innehåller i aviseringsinställningar.
min
 min string

Minsta värde för kolumnen.
max
 max string

Maximalt värde för kolumnen.
decimaler
 decimalplaces integer

Antal decimaler.
showthousandseparators
 showthousandseparators string

Visar tusentals avgränsare.
showaspercentage
 showaspercentage string

Visar värdet som procent.
formattyp
 formattype string

Anger formattypen för kolumnen.
dateformat
 dateformat string

Definierar datumformatet för kolumnen.
defaultdateandtime
 defaultdateandtime string

Anger standardvärdet för datum och tid för kolumnen.
sheetlookup
 sheetlookup string

Anger om kolumnen är en sökning till ett annat blad.
fielddisplay
 fielddisplay string

Avgör hur fältet visas.
allowmultipleusers
 allowmultipleusers string

Anger om flera användare kan komma åt fältet.
methodtype
 methodtype string

Definierar metodtypen för kolumnen.
sheetids
 sheetids string

Visar en lista över ID:erna för de blad som är associerade med kolumnen.
allowuserstorenamelinks
 allowuserstorenamelinks string

Anger om användare kan byta namn på länkar i kolumnen.
sheetid
 sheetid integer

Anger bladets ID.
columnids
 columnids string

Visar kolumnernas ID:t.
viewid
 viewid integer

Anger vyns ID.
allowmultiplevalues
 allowmultiplevalues string

Anger om flera värden tillåts i kolumnen.
restrictdelete
 restrictdelete string

Anger om borttagningen är begränsad för kolumnen.
displaycolumnnameprefix
 displaycolumnnameprefix string

Anger prefixet för visning av kolumnnamn.
linkname
 linkname string

Definierar namnet på länken som är associerad med kolumnen.
donotcountweekendsonlycountmontofri
 donotcountweekendsonlycountmontofri string

Anger om helger undantas i inventeringen.
currentsheetcolumnid
 currentsheetcolumnid integer

ID för den aktuella bladkolumnen.
targetsheetcolumnid
 targetsheetcolumnid integer

ID för målbladskolumnen.
formel
 formula string

Anger formeln som tillämpas på kolumnen.
startvärde
 startvalue integer

Anger startvärdet för kolumnen.
prefix
 prefix string

Definierar prefixet för kolumnvärdena.
Postfix
 postfix string

Definierar postfixet för kolumnvärdena.
minlength
 minlength integer

Anger den minsta längden på kolumnvärdena.
lookupglossarysheetid
 lookupglossarysheetid integer

Anger ID för uppslagsordlistan.
lookupglossarysheetviewid
 lookupglossarysheetviewid integer

Anger visnings-ID för uppslagsordlistan.
bredd
 width integer

Anger kolumnens bredd.
otherscorevalue
 otherscorevalue string

Definierar det andra poängvärdet för kolumnen.
importdatafromexternalsource
 importdatafromexternalsource string

Anger om data importeras från en extern källa.
analysisengine
 analysisengine string

Anger den analysmotor som används för kolumnen.
attachmentcustomfolderid
 attachmentcustomfolderid integer

Anger det anpassade mapp-ID:t för bifogade filer.
isattachmentfoldercurrentsite
 isattachmentfoldercurrentsite integer

Anger om mappen för den bifogade filen finns på den aktuella webbplatsen.
singleLineEmailValidation
 singleLineEmailValidation string

Anger om e-postvalidering med en rad tillämpas.
ReadOnly
 readonly string

Anger om kolumnen är skrivskyddad.
virtualColumn
 virtualColumn integer

Anger om kolumnen är virtuell.
allowInlineEditing
 allowInlineEditing string

Anger om infogad redigering tillåts för kolumnen.
sekvens
 sequence string

Sekvensnummer för kolumnen.
attributecolumnid
 attributecolumnid string

Attributkolumnidentifierare.
värde
 value string

Värdet för rådata.
date
 date string

datum för rådata.
time
 time string

Tid för rådata.
linkdisplayname
 linkdisplayname string

Visa länknamn.
linkdisplayurl
 linkdisplayurl string

Visa URL-länk.
Id-nummer
 id string

Uppslags-ID
Mejladress
 email string

E-postadress.
userlookuptype
 userlookuptype string

Användarsökningstyp.
folderid
 folderid string

Mapp-ID.
docid
 docid string

Dokument-ID.
fromdate
 fromdate string

Från datum.
todate
 todate string

Hittills.
fil
 file string

Filinnehållet.
name
 name string

Namnet på den bifogade filen.
order
 order string

Ordningen på den bifogade filen.
Id-nummer
 id integer

Unik identifierare för den bifogade filen.
utbyggnad
 extension string

Filnamnstillägg.
parentfolderid
 parentfolderid integer

ID för den överordnade mappen.
filehttplink
 filehttplink string

HTTP-länk för att komma åt filen.
mappväg
 folderpath string

Sökväg till mappen som innehåller filen.
folderhttplink
 folderhttplink string

HTTP-länk till mappen.
filesize
 filesize integer

Filens storlek i byte.
redactionStatus
 redactionStatus boolean

Anger om filen har redigerats.
displayname
 displayname string

Visningsnamn för den bifogade filen.
siteid
 siteid integer

ID för den webbplats som är associerad med den bifogade filen.
recordid
 recordid string

Post-ID.
linkname
 linkname string

Länknamn.
apilink
 apilink string

API Link.
httplink
 httplink string

HTTP-länk.
colViewPosition
 colViewPosition integer

Positionen för kolumnen i vyn.
columntype
 columntype string

Typ av kolumn.
skapadDatum
 createdDate date-time

Datum och tid när kolumnen skapades.
modifiedDate
 modifiedDate date-time

Datum och tid då kolumnen senast ändrades.
injectReferenceColumn
 injectReferenceColumn integer

Referens till en inmatad kolumn
parentColumnID
 parentColumnID integer

Identifierare för den överordnade kolumnen.
reusecolumnidfromisheet
 reusecolumnidfromisheet integer

Kolumn-ID som återanvänds från ett indatablad.
choicelistid
 choicelistid integer

Identifierare för vallistan som är associerad med kolumnen.
alerteroption
 alerteroption string

Inställning för aviseringsalternativ för objektet.
sheettypeid
 sheettypeid integer

Identifierare för bladtypen.
enableSmartForm
 enableSmartForm string

Aktiverar funktioner för smarta formulär.
allowDeletedItemsView
 allowDeletedItemsView string

Tillåter visning av borttagna objekt.
allowAllColumnsInCustomView
 allowAllColumnsInCustomView string

Tillåter alla kolumner i anpassade vyer.

Returer

Body
ProgressiveKeyDBO

Skapa mapp

Åtgärds-ID:
addFolder

Det här API:et skapar en ny mapp på den angivna platsen. Du kan ange mappinformation och se till att mappen skapas under den angivna överordnade mappen.

Parametrar

Name Nyckel Obligatorisk Typ Description
API-version
 version True string

Anger API-versionen.
Batch-identifierare
 batchid string

En unik identifierare för batchåtgärden.
Rotmapps-ID
 rootfolderid string

Den unika identifieraren för rotmappen.
Överordnat mapp-ID
 parentfolderid True string

Den unika identifieraren för den överordnade mappen där den nya mappen skapas.
Tillåt duplicerad mapp
 allowduplicatefolder boolean

Anger om dubblettmappar tillåts i den angivna överordnade mappen.
name
 name True string

Namnet på mappen.
beskrivning
 description string

En beskrivning av mappen.
accessInherited
 accessInherited integer

Anger om mappåtkomsten ärvs.
batchID
 batchID string

Batchidentifieraren för åtgärden.
dmsfolderid
 dmsfolderid string

DMS-mappidentifieraren.
dmsParentFolderID
 dmsParentFolderID string

ID:t för den överordnade MAPPEN DMS.
dmscreateddate
 dmscreateddate date-time

Det datum då DMS-mappen skapades.
dmsmodifiedBy
 dmsmodifiedBy string

Användaren som senast ändrade DMS-mappen.
dmsdatabasename
 dmsdatabasename string

Namnet på DMS-databasen.
dmslink
 dmslink boolean

Anger om en DMS-länk är tillgänglig.
dmslinkby
 dmslinkby string

Användaren som länkade DMS-mappen.
emailmetadata
 emailmetadata string

E-postmetadata som är associerade med mappen.

Returer

Body
FolderDBOV1

Uppdatera webbplats

Åtgärds-ID:
updateSite

Använd den här API-slutpunkten för att uppdatera informationen om en befintlig webbplats. API:et stöder samma fält som används i Skapa webbplats-API.

Den här metoden stöder flera ärendenummer som ska läggas till på webbplatsen med api-version 10 och senare. Taggen "matternos" anger flera materianummer med skrivskyddat eller inte.

Version 18 och senare: en kategori (webbplatssyfte) krävs. Om webbplatssyftet är dolt visas ett meddelande. Annars läggs inte dolda webbplatsändamål till på webbplatsen.

Nu kan webbplatsägaren även tilldelas andra användare, men de måste vara webbplatsdeltagare och ha en roll som är högre än webbplatsadministratören.

Version 18 och senare: Webbplatsägaren kan lägga till andra användare på webbplatsen.

Från API version 19 och senare introduceras en ny modul med namnet customPages, som är nära kopplad till hemmodulen. Om värdet för hemmodulen är Sant måste customPages vara sant och vice versa.

Observera att alla egenskaper/element i hämta webbplatssvar inte är uppdaterbara/infogbara. Se tabellen nedan för att veta vilka som är skrivskyddade, uppdaterbara eller infogbara.

Parametrar

Name Nyckel Obligatorisk Typ Description
Den version av API:et som begärs
 version True string

version av API
Den unika identifieraren för webbplatsen
 siteid True string

ID:t för webbplatsen
Id-nummer
 id integer

Platsidentifieraren.
sitename
 sitename string

Namnet på webbplatsen.
None needed, as the translation is already accurate and fluent.
 role string

Webbplatsens roll.
sitedescription
 sitedescription string

Beskrivningen av webbplatsen.
enabledmodules
 enabledmodules string

En lista över moduler som är aktiverade för webbplatsen.
sitefolderID
 sitefolderID string

Identifieraren för webbplatsens mapp.
sitefolderpermission
 sitefolderpermission string

Behörighetsnivån för webbplatsens mapp.
enable
 enable string

Aktivera status för HomeDBO.
enable
 enable string

Aktivera status för ActivityDBO.
microblog
 microblog string

Mikroblogginnehåll som är associerat med ActivityDBO.
docid
 docid string

Dokument-ID.
blogTitle
 blogTitle string

Rubrik för blogginlägget.
blogContent
 blogContent string

Innehållet i blogginlägget.
showComment
 showComment integer

visa kommentaren.
tagList
 tagList array of string

Lista över taggar som är associerade med bloggen.
status
 status integer

status för blogginlägget.
siteID
 siteID integer

Identifierare för den associerade webbplatsen.
författare
 author string

Författare till bloggen.
categoryList
 categoryList array of string

Kategorier som tilldelats blogginlägget.
notificationTypeID
 notificationTypeID integer

Identifierare för meddelandetypen.
meddelande
 message string

Meddelandeinnehåll som är relaterat till bloggen.
messageCode
 messageCode integer

Kod som är associerad med meddelandet.
externalID
 externalID string

Extern identifierare som är länkad till bloggen.
publiceraDatum
 publishDate string

Publiceringsdatum för bloggen.
processtyp
 processtype string

Processtyp som är associerad med bloggen.
enable
 enable string

Aktivera status för BlogDBO.
wikiid
 wikiid integer

Unik identifierare för wikin.
currentversionid
 currentversionid integer

Identifierare för den aktuella versionen av wikin
parentwikiid
 parentwikiid integer

Identifierare för den överordnade wikin.
wikititle
 wikititle string

Wikins titel.
wikicontent
 wikicontent string

Innehållet i wikin.
showcomment
 showcomment integer

Anger om kommentarer är aktiverade.
createddate
 createddate string

Skapandedatum för wikin.
modifieddate
 modifieddate string

Senaste ändringsdatum för wikin.
taglist
 taglist string

Kommaavgränsad lista över taggar som är associerade med wikin.
wikipath
 wikipath string

Sökväg för att komma åt wikin.
wikidraftid
 wikidraftid integer

Identifierare för utkastversionen av wikin.
drafttype
 drafttype string

Typ av utkast som är associerat med wikin.
status
 status integer

Aktuell status för wikin.
wikiversionid
 wikiversionid integer

Versionsidentifierare för wikin.
index
 index string

Index eller identifierare för aktiviteten.
parenttaskid
 parenttaskid integer

Identifierare för den överordnade aktiviteten.
taskid
 taskid integer

Unik identifierare för aktiviteten.
title
 title string

Uppgiftsrubrik.
beskrivning
 description string

Detaljerad beskrivning av uppgiften.
duedate
 duedate string

Förfallodatum för uppgiftens slutförande.
startdate
 startdate string

Startdatum när aktiviteten initierades.
mattermaptaskid
 mattermaptaskid string

Identifierarlänkning till ärendemappningsaktiviteten.
type
 type string

Typ eller kategori för uppgiften.
dependenton
 dependenton string

Uppgifter som den här uppgiften är beroende av.
daysfromdependent
 daysfromdependent string

Antal dagar från den beroende aktiviteten.
ignoreweekend
 ignoreweekend integer

Anger om helger ignoreras i schemaläggningen.
duration
 duration integer

Varaktighet för att slutföra uppgiften.
resource
 resource string

Resurser som tilldelats uppgiften.
eventTitle
 eventTitle string

Rubriken på händelsen.
eventContent
 eventContent string

Innehållet i händelsen.
showComment
 showComment integer

Anger om kommentarer är aktiverade för händelsen.
tagList
 tagList array of string

Lista över taggar som är associerade med händelsen.
status
 status integer

Aktuell status för händelsen.
siteID
 siteID integer

Identifierare för webbplatsen.
kontakta
 contact string

Kontaktuppgifter för händelsen.
categoryList
 categoryList array of string

Kategorier under vilka händelsen visas.
notificationTypeID
 notificationTypeID integer

Meddelandetypen som är relaterad till händelsen.
meddelande
 message string

Meddelandet om händelsen.
messageCode
 messageCode integer

Meddelandekoden för händelsen.
externalID
 externalID string

Den externa identifieraren.
startDate
 startDate string

Händelsens startdatum.
slutdatum
 endDate string

Slutdatum för händelsen.
startTime
 startTime string

Starttiden för händelsen.
endTime
 endTime string

Sluttiden för händelsen.
location
 location string

Platsen för händelsen.
författare
 author string

Författaren till händelsen.
processtyp
 processtype string

Processtiden för händelsen.
enable
 enable string

Aktivera är händelsen.
Id-nummer
 id integer

Unik identifierare för iSheet.
title
 title string

Rubrik för iSheet.
beskrivning
 description string

Beskrivning av isheeten.
status
 status string

Status för isheeten.
accesstype
 accesstype string

Åtkomsttyp för isheeten.
type
 type string

Typ av isheet.
viewlink
 viewlink string

Länka för att visa iSheet.
allowsections
 allowsections string

Om avsnitt är tillåtna.
allowlookup
 allowlookup string

Om uppslagsfält är aktiverade.
displayisheet
 displayisheet string

Visningsalternativ för iSheet.
searchasdefaultview
 searchasdefaultview string

Anger om sökningen är standardvyn.
enableversion
 enableversion string

Flaggan Versionsaktiverad.
enablesheetalerter
 enablesheetalerter string

Flagga för att aktivera bladaviseringar.
alertercondition
 alertercondition string

Villkor för utlösande av aviseringar.
overrideitemmodifieddate
 overrideitemmodifieddate string

Åsidosätt ändrad datumflagga.
enablebulkinsertupdate
 enablebulkinsertupdate string

Aktivera massinfogning/uppdatering.
fielddescriptions
 fielddescriptions string

Fältbeskrivningar för iSheet.
enablerowlocking
 enablerowlocking string

Aktivera låsning på radnivå.
setcharlimittruncatemultilinetextenabled
 setcharlimittruncatemultilinetextenabled string

Trunkera textflagga för flera rutor.
setcharlimittruncatemultilinetextval
 setcharlimittruncatemultilinetextval string

Teckengräns för trunkering med flera rader.
allowchoicelistvaluesforreuse
 allowchoicelistvaluesforreuse string

Tillåt återanvändning av alternativlistvärden.
allowscorelistvaluesforreuse
 allowscorelistvaluesforreuse string

Tillåt återanvändning av poänglistevärden.
allowIsheetComments
 allowIsheetComments string

Tillåt kommentarer i iSheet.
shareRecordsLimit
 shareRecordsLimit integer

Gräns för poster som tillåts att dela.
shareRecordsLimitEnabled
 shareRecordsLimitEnabled integer

Resursgräns för aktiverade poster.
enableIsheetAddRecordFormSharing
 enableIsheetAddRecordFormSharing string

Aktivera formulärdelning för att lägga till poster.
recordcount
 recordcount string

Aktuellt antal poster.
sheettypeid
 sheettypeid integer

Typ-ID för iSheet
enable
 enable string

Aktivera QA-funktioner.
userid
 userid integer

Användar-ID.
Mejladress
 email string

e-postadress.
httpavatar
 httpavatar string

HTTP-URL för avatar.
avatar
 avatar string

Avatarbild.
userlink
 userlink string

Länk till användarprofil.
httplink
 httplink string

HTTP-länk till användarprofil.
phone
 phone string

Telefonnummer.
mobile
 mobile string

Mobilnummer.
Avdelning
 department string

Användarens avdelning.
enable
 enable string

Aktivera Contract Express-integrering.
adminnote
 adminnote string

Administrativa anteckningar som rör webbplatsen.
startdate
 startdate string

Startdatumet för webbplatsens åtgärd.
enddate
 enddate string

Slutdatumet för webbplatsens åtgärd.
createddate
 createddate string

Det datum då webbplatsen skapades.
archiveddate
 archiveddate string

Datumet då webbplatsen arkiverades.
clientno
 clientno string

Det klientnummer som är associerat med platsen.
matterno
 matterno string

Det ärendenummer som är associerat med webbplatsen.
landningssida
 landingpage string

Webbadressen till landningssidan för webbplatsen.
link
 link string

En länk som är relaterad till webbplatsen.
status
 status string

Webbplatsens aktuella status.
statusid
 statusid integer

Identifieraren för webbplatsens status.
size
 size string

Webbplatsens storlek.
billingnotes
 billingnotes string

Anteckningar som rör fakturering för webbplatsen.
billingnextinvoicedate
 billingnextinvoicedate string

Datumet för nästa faktura för webbplatsen.
billinglastinvoicedate
 billinglastinvoicedate string

Datumet för den senaste fakturan för webbplatsen.
filepagecount
 filepagecount string

Det totala antalet filer på webbplatsen.
maxpagecount
 maxpagecount string

Maximalt antal tillåtna sidor för filer på webbplatsen.
sitehttplink
 sitehttplink string

HTTP-länken till webbplatsen.
isSyncable
 isSyncable integer

Anger om webbplatsen kan synkroniseras.
enforceusergroups
 enforceusergroups string

Användargrupperna som tillämpas för webbplatsen.
csvSiteCategory
 csvSiteCategory string

Kategorin för webbplatsen i CSV-format.
siteNameInDefaultLanguage
 siteNameInDefaultLanguage string

Namnet på webbplatsen på standardspråket.
synlig
 visible integer

Anger om webbplatsen är synlig.
siteLogoName
 siteLogoName string

Namnet på webbplatsens logotypfil.
siteLogoFileSize
 siteLogoFileSize integer

Filstorleken för webbplatsens logotyp.
siteLogoHeight
 siteLogoHeight integer

Höjden på webbplatsens logotyp.
siteLogoWidth
 siteLogoWidth integer

Bredden på webbplatsens logotyp.
siteStatus
 siteStatus integer

Platsens statuskod.
applySiteTerms
 applySiteTerms integer

Anger om webbplatsvillkoren tillämpas.
siteTerm
 siteTerm string

De villkor som tillämpas på webbplatsen.
termType
 termType integer

Den typ av termer som tillämpas på webbplatsen.
nextLoginSiteTerms
 nextLoginSiteTerms integer

Anger om webbplatsvillkoren krävs vid nästa inloggning.
defaultSiteTermsEnable
 defaultSiteTermsEnable integer

Anger om standardvillkor för webbplatsen är aktiverade.
advancedQAPermission
 advancedQAPermission integer

Den avancerade qa-behörighetsnivån för webbplatsen.
isInternal
 isInternal integer

Anger om platsen är intern.
Psm
 psm integer

Product Service Manager-identifieraren.
siteLabelDisplay
 siteLabelDisplay string

Visningsetiketten för webbplatsen.
allowSiteAdministration
 allowSiteAdministration integer

Anger om webbplatsadministration tillåts.
siteLevelPasswordEnable
 siteLevelPasswordEnable integer

Aktivera lösenordsskydd på platsnivå.
siteLevelPasscodeEnable
 siteLevelPasscodeEnable integer

Aktivera lösenordsskydd på platsnivå.
lösenordUsingAuthApp
 passcodeUsingAuthApp integer

Anger om lösenordsautentisering använder en autentiseringsapp.
sitePassword
 sitePassword string

Lösenordet som är kopplat till webbplatsen.
ipRestrictionEnable
 ipRestrictionEnable integer

Aktivera IP-begränsningar för webbplatsåtkomst.
availableIP
 availableIP string

Kommaavgränsad lista över IP-adresser som tillåts komma åt webbplatsen.
highqDrive
 highqDrive integer

Anger om HighQ Drive-integrering är aktiverat.
applySiteHomePage
 applySiteHomePage integer

Så här använder du en anpassad startsida för webbplatsen.
siteHomePage
 siteHomePage string

URL för webbplatsens anpassade startsida.
siteHomePageType
 siteHomePageType integer

Typ av startsida.
nextLoginSiteHomePage
 nextLoginSiteHomePage integer

Ange nästa inloggning till webbplatsens startsida.
applyDisplayContent
 applyDisplayContent integer

Så här använder du inställningar för visningsinnehåll.
displayContent
 displayContent string

Innehåll som ska visas på webbplatsen.
rssSecurity
 rssSecurity integer

RSS-feedsäkerhetsnivå.
krypterat lösenord
 encryptedPassword integer

Anger om webbplatslösenordet är krypterat.
availableIPRangeCSV
 availableIPRangeCSV string

Kommaavgränsad lista över IP-adressintervall som tillåts komma åt webbplatsen.
siteModuleID
 siteModuleID integer

Identifierare för platsmodulen.
icalSecurity
 icalSecurity integer

säkerhetsnivå för iCal-feed.
defaultDisplayContent
 defaultDisplayContent string

Standardinnehåll som ska visas på webbplatsen.
defaultEmailAlert
 defaultEmailAlert integer

Aktivera standardaviseringar för e-post.
excelReportFooter
 excelReportFooter integer

Innehåller en sidfot i Excel-rapporter.
excelReportFooterText
 excelReportFooterText string

Text som ska visas i sidfoten för Excel-rapporter.
announcementMLJSON
 announcementMLJSON string

JSON-formaterade meddelanden för webbplatsen.
templateType (på engelska)
 templateType integer

Typ av mall som används för webbplatsen.
templateLicence
 templateLicence integer

Licenstyp för webbplatsmallen.
openChannelAppID
 openChannelAppID string

Program-ID för integrering med öppen kanal.
itemid
 itemid integer

Identifierare för det objekt som är associerat med webbplatsen.
sitemetadatasheetid
 sitemetadatasheetid integer

ID för metadatabladet som är associerat med webbplatsen.
mysite
 mysite boolean

Anger om det här är användarens personliga webbplats.
lastaccesseddate
 lastaccesseddate string

Datum och tid då webbplatsen senast användes.
defaultViewerMetaDataTab
 defaultViewerMetaDataTab integer

Standardmetadatafliken för webbplatsvisningsprogrammet.
documentMetadataViewId
 documentMetadataViewId integer

dokumentmetadata för visningsidentifierare.
folderMetadataViewId
 folderMetadataViewId integer

mappmetadata för visningsidentifierare.
docSort
 docSort integer

Sorteringsordningen för dokument.
folderSort
 folderSort integer

Sorteringsordningen för mappar.
defaultFolderRenderView
 defaultFolderRenderView integer

Avgör standardläget för vyn för mappar.
isTaskAttachmentDefault
 isTaskAttachmentDefault integer

Standardplatsen för aktivitetsbilagor.
taskAttachmentDefaultFolderId
 taskAttachmentDefaultFolderId integer

Den unika identifieraren för den mapp som har angetts som standardplats för aktivitetsbilagor.
favorit
 favourite string

favoritstatus.
enabledocumentredaction
 enabledocumentredaction boolean

Anger om dokumentredigering är aktiverat för webbplatsen.
mentiongroups
 mentiongroups integer

De nämnda grupperna.
enablefilerelationships
 enablefilerelationships boolean

Anger om filrelationer är aktiverade.
filerelationshipsitepermissionlevel
 filerelationshipsitepermissionlevel integer

Behörighetsnivån som krävs för att hantera filrelationer.

Uppdatera webbplatsgrupp

Åtgärds-ID:
updateSiteGroup

Den här API-metoden uppdaterar namnet på en befintlig grupp på en webbplats.
Det här API:et har utökats för att uppdatera namnet på en befintlig grundläggande användargrupp på en webbplats.

Parametrar

Name Nyckel Obligatorisk Typ Description
API-version
 version True string

version
Webbplatsens ID
 siteid True string

Webbplatsens ID.
API-version
 groupid True string 
The ID of the site group.
name
 name string
Id-nummer
 id integer
copypermissionsfrån
 copypermissionsfrom string
meddelande
 message string
typeID
 typeID integer
type
 type string
numberofusers
 numberofusers string
skapad
 created string
modified
 modified string
systemGroupID
 systemGroupID integer
beskrivning
 description string
basicusergroup
 basicusergroup integer

Returer

Body
sitegroup

Definitioner

ErrorDBO

Name Sökväg Typ Description
summary
 summary string
Ref
 ref string
link
 link string

DocumentDBO

Name Sökväg Typ Description
docid
 docid string

Dokument-ID.

columns

Name Sökväg Typ Description
kolumn
 column array of object
items
 column object

LocationDBO

Name Sökväg Typ Description
addressline1
 addressline1 string

Första raden i adressen.
addressline2
 addressline2 string

Andra raden i adressen.
addressline3
 addressline3 string

Tredje raden i adressen.
city
 city string

Staden där adressen finns.
state
 state string

Adresstillstånd.
country
 country string

Adresslandet.
Postnummer
 postcode string

Adressens postnummer.

Användarnamn

Name Sökväg Typ Description
title
 title string

Användarens rubrik.
förnamn
 firstname string

Användarens förnamn.
efternamn
 lastname string

Användarens efternamn.
goesby
 goesby string

användarens föredragna namn.

MetadataListDBO

Name Sökväg Typ Description
metadataname
 metadataname array of string
metadatavalue
 metadatavalue array of string
Name Sökväg Typ Description
Id-nummer
 id string

Länk-ID
name
 name string

Länknamn.
värde
 value string

Länkvärde.

Länk

Name Sökväg Typ Description
link
 link array of NameValueLink

ExperiencesDBO

Name Sökväg Typ Description
uppleva
 experience array of string

GroupsDBO

Name Sökväg Typ Description
group
 group array of string

user

Name Sökväg Typ Description
userid
 userid integer

Användar-ID.
följande
 following boolean

Följande.
Mejladress
 email string

E-postadress.
name
 name UserName
userlink
 userlink string

Användarlänk.
httplink
 httplink string

HTTP-länk.
httpavatar
 httpavatar string

HTTP Avatar.
avatar
 avatar integer

Avatar av användaren.
externalid
 externalid string

Externt ID.
dateofbirth
 dateofbirth string

Födelsedatum.
phone
 phone string

Telefonnummer.
jobtitle
 jobtitle string

Befattning.
mobile
 mobile string

Mobilnummer.
Avdelning
 department string

Deparment.
status
 status string

Status.
Org
 org string

Organisation.
orgName
 orgName string

Organisationsnamn.
location
 location LocationDBO
img
 img string

Bild.
Erfarenheter
 experiences ExperiencesDBO
sociallinks
 sociallinks Link
customlink
 customlink Link
messaginglink
 messaginglink Link
secretaryname
 secretaryname string

Sekreterarenamn.
secretarymail
 secretarymail string

Sekreterare Mail.
bio
 bio string

Biografi över användaren.
sourcetype
 sourcetype string

Källtyp.
Specialiteter
 specialities string

Specialiteter.
reportsto
 reportsto string

Användaren som den aktuella användaren rapporterar till.
metadata
 metadata MetadataListDBO
groups
 groups GroupsDBO
suffix
 suffix string

Suffix för användarens namn.
atomlänk
 atomlink string

Atomlänk som är associerad med användaren.
link
 link string

Länk som är associerad med användaren.
loggeduserlike
 loggeduserlike integer

Antal likes från den inloggade användaren.
användarnamn
 userName string

Användarnamn.

users

Name Sökväg Typ Description
user
 user array of user

MappDBOV1

Name Sökväg Typ Description
folderid
 folderid string

Den unika identifieraren för den skapade mappen.

DmsDBO

Name Sökväg Typ Description
dmsfolderid
 dmsfolderid string

DMS-mappidentifieraren.
dmsParentFolderID
 dmsParentFolderID string

ID:t för den överordnade MAPPEN DMS.
dmscreateddate
 dmscreateddate date-time

Det datum då DMS-mappen skapades.
dmsmodifiedBy
 dmsmodifiedBy string

Användaren som senast ändrade DMS-mappen.
dmsdatabasename
 dmsdatabasename string

Namnet på DMS-databasen.
dmslink
 dmslink boolean

Anger om en DMS-länk är tillgänglig.
dmslinkby
 dmslinkby string

Användaren som länkade DMS-mappen.

sitegroup

Name Sökväg Typ Description
name
 name string
Id-nummer
 id integer
copypermissionsfrån
 copypermissionsfrom string
meddelande
 message string
typeID
 typeID integer
type
 type string
numberofusers
 numberofusers string
skapad
 created string
modified
 modified string
systemGroupID
 systemGroupID integer
beskrivning
 description string
basicusergroup
 basicusergroup integer

Address

Name Sökväg Typ Description
addressid
 addressid string

Unik identifierare för adressen.
addressline1
 addressline1 string

Första raden i adressen.
addressline2
 addressline2 string

Andra raden i adressen.
addressline3
 addressline3 string

Tredje raden i adressen.
city
 city string

Staden där adressen finns.
state
 state string

Adresstillstånd.
country
 country string

Adresslandet.
Postnummer
 postCode string

Adressens postnummer.
kända
 knownas string

Alternativt namn eller smeknamn för adressen.

IntegrationUserDBO

Name Sökväg Typ Description
index
 index integer

Unikt index för användaren.
userid
 userid integer

Unik identifierare för användaren.
förnamn
 firstname string

Användarens förnamn.
efternamn
 lastname string

Användarens efternamn.
practicegroup
 practicegroup string

Övningsgrupp som användaren tillhör.
langcode
 langcode string

Användarens språkkod.
localeID
 localeID string

Språkvariant-ID för användaren.
publicprofile
 publicprofile string

Användarens offentliga profil.
pwpid
 pwpid string

PWP-ID för användaren.
usertypeid
 usertypeid string

Användartyp-ID.
systemuser
 systemuser string

Systemanvändarflagga.
Mejladress
 email string

Email användarens adress.
phone
 phone string

Användarens telefonnummer.
mobile
 mobile string

Användarens mobilnummer.
Avdelning
 department string

Användarens avdelning.
Org
 org string

Organisation som användaren tillhör.
location
 location LocationDBO
address
 address Address
Erfarenheter
 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

Användarens externa ID.
jobtitle
 jobtitle string

Användarens befattning.
secretaryname
 secretaryname string

Namnet på användarens sekreterare.
secretarymail
 secretarymail string

E-post till användarens sekreterare.
Specialiteter
 specialities string

Specialiteter för användaren.
title
 title string

Användarens rubrik.
goesby
 goesby string

användarens föredragna namn.
suffix
 suffix string

Suffix för användarens namn.
atomlänk
 atomlink string

Atomlänk som är associerad med användaren.
bio
 bio string

Biografi över användaren.
dateOfBirth
 dateOfBirth string

Användarens födelsedatum.
link
 link string

Länk som är associerad med användaren.
status
 status string

Status för användaren.
statuskod
 statuscode string

Statuskod för användaren.
meddelande
 message string

Meddelande som är associerat med användaren.
sourcetype
 sourcetype string

Användarens källtyp.
orgid
 orgid string

Organisations-ID.
ifpartner
 ifpartner string

Partnerflagga.
emaildomain
 emaildomain string

Användarens e-postdomän.
invitationsent
 invitationsent string

Flagga för skickad inbjudan.
createdby
 createdby string

Användare som skapade posten.
createddate
 createddate string

Datum då posten skapades.
modifierad av
 modifiedby string

Användare som ändrade posten.
modifieddate
 modifieddate string

Datum då posten ändrades.
lastlogindate
 lastlogindate string

Datum för den senaste inloggningen.
invalidlogins
 invalidlogins string

Antal ogiltiga inloggningsförsök.
publicwebsiteprofileid
 publicwebsiteprofileid string

Profil-ID för offentlig webbplats.
resetpassworddate
 resetpassworddate string

Datum då lösenordet återställdes.
avatar
 avatar string

Url för avatarbild.
followingcount
 followingcount integer

Antal användare som följs.
followercount
 followercount integer

Antal följare.
följande
 following boolean

Följande flagga.
None needed, as the translation is already accurate and fluent.
 role string

Användarens roll.
isbasicuser
 isbasicuser string

Grundläggande användarflagga.
encryptedUserId
 encryptedUserId string

Krypterat användar-ID.
självregistrerad
 selfregistered integer

Självregistrerad flagga.
registeredWith2FA
 registeredWith2FA string

Registreringsflagga för tvåfaktorautentisering.
isInternal
 isInternal integer

Intern användarflagga.
orgName
 orgName string

Namn på organisationen.

webbplats

Name Sökväg Typ Description
Id-nummer
 id integer

Platsidentifieraren.
sitename
 sitename string

Namnet på webbplatsen.
None needed, as the translation is already accurate and fluent.
 role string

Webbplatsens roll.
sitedescription
 sitedescription string

Beskrivningen av webbplatsen.
enabledmodules
 enabledmodules string

En lista över moduler som är aktiverade för webbplatsen.
sitefolderID
 sitefolderID string

Identifieraren för webbplatsens mapp.
sitefolderpermission
 sitefolderpermission string

Behörighetsnivån för webbplatsens mapp.
modul
 module ModuleDBO
adminnote
 adminnote string

Administrativa anteckningar som rör webbplatsen.
startdate
 startdate string

Startdatumet för webbplatsens åtgärd.
enddate
 enddate string

Slutdatumet för webbplatsens åtgärd.
createddate
 createddate string

Det datum då webbplatsen skapades.
archiveddate
 archiveddate string

Datumet då webbplatsen arkiverades.
clientno
 clientno string

Det klientnummer som är associerat med platsen.
matterno
 matterno string

Det ärendenummer som är associerat med webbplatsen.
landningssida
 landingpage string

Webbadressen till landningssidan för webbplatsen.
link
 link string

En länk som är relaterad till webbplatsen.
status
 status string

Webbplatsens aktuella status.
statusid
 statusid integer

Identifieraren för webbplatsens status.
size
 size string

Webbplatsens storlek.
billingnotes
 billingnotes string

Anteckningar som rör fakturering för webbplatsen.
billingnextinvoicedate
 billingnextinvoicedate string

Datumet för nästa faktura för webbplatsen.
billinglastinvoicedate
 billinglastinvoicedate string

Datumet för den senaste fakturan för webbplatsen.
filepagecount
 filepagecount string

Det totala antalet filer på webbplatsen.
maxpagecount
 maxpagecount string

Maximalt antal tillåtna sidor för filer på webbplatsen.
sitehttplink
 sitehttplink string

HTTP-länken till webbplatsen.
isSyncable
 isSyncable integer

Anger om webbplatsen kan synkroniseras.
enforceusergroups
 enforceusergroups string

Användargrupperna som tillämpas för webbplatsen.
csvSiteCategory
 csvSiteCategory string

Kategorin för webbplatsen i CSV-format.
siteNameInDefaultLanguage
 siteNameInDefaultLanguage string

Namnet på webbplatsen på standardspråket.
synlig
 visible integer

Anger om webbplatsen är synlig.
siteLogoName
 siteLogoName string

Namnet på webbplatsens logotypfil.
siteLogoFileSize
 siteLogoFileSize integer

Filstorleken för webbplatsens logotyp.
siteLogoHeight
 siteLogoHeight integer

Höjden på webbplatsens logotyp.
siteLogoWidth
 siteLogoWidth integer

Bredden på webbplatsens logotyp.
siteStatus
 siteStatus integer

Platsens statuskod.
applySiteTerms
 applySiteTerms integer

Anger om webbplatsvillkoren tillämpas.
siteTerm
 siteTerm string

De villkor som tillämpas på webbplatsen.
termType
 termType integer

Den typ av termer som tillämpas på webbplatsen.
nextLoginSiteTerms
 nextLoginSiteTerms integer

Anger om webbplatsvillkoren krävs vid nästa inloggning.
defaultSiteTermsEnable
 defaultSiteTermsEnable integer

Anger om standardvillkor för webbplatsen är aktiverade.
advancedQAPermission
 advancedQAPermission integer

Den avancerade qa-behörighetsnivån för webbplatsen.
isInternal
 isInternal integer

Anger om platsen är intern.
Psm
 psm integer

Product Service Manager-identifieraren.
siteLabelDisplay
 siteLabelDisplay string

Visningsetiketten för webbplatsen.
allowSiteAdministration
 allowSiteAdministration integer

Anger om webbplatsadministration tillåts.
siteLevelPasswordEnable
 siteLevelPasswordEnable integer

Aktivera lösenordsskydd på platsnivå.
siteLevelPasscodeEnable
 siteLevelPasscodeEnable integer

Aktivera lösenordsskydd på platsnivå.
lösenordUsingAuthApp
 passcodeUsingAuthApp integer

Anger om lösenordsautentisering använder en autentiseringsapp.
sitePassword
 sitePassword string

Lösenordet som är kopplat till webbplatsen.
ipRestrictionEnable
 ipRestrictionEnable integer

Aktivera IP-begränsningar för webbplatsåtkomst.
availableIP
 availableIP string

Kommaavgränsad lista över IP-adresser som tillåts komma åt webbplatsen.
highqDrive
 highqDrive integer

Anger om HighQ Drive-integrering är aktiverat.
applySiteHomePage
 applySiteHomePage integer

Så här använder du en anpassad startsida för webbplatsen.
siteHomePage
 siteHomePage string

URL för webbplatsens anpassade startsida.
siteHomePageType
 siteHomePageType integer

Typ av startsida.
nextLoginSiteHomePage
 nextLoginSiteHomePage integer

Ange nästa inloggning till webbplatsens startsida.
applyDisplayContent
 applyDisplayContent integer

Så här använder du inställningar för visningsinnehåll.
displayContent
 displayContent string

Innehåll som ska visas på webbplatsen.
rssSecurity
 rssSecurity integer

RSS-feedsäkerhetsnivå.
krypterat lösenord
 encryptedPassword integer

Anger om webbplatslösenordet är krypterat.
availableIPRangeCSV
 availableIPRangeCSV string

Kommaavgränsad lista över IP-adressintervall som tillåts komma åt webbplatsen.
siteModuleID
 siteModuleID integer

Identifierare för platsmodulen.
icalSecurity
 icalSecurity integer

säkerhetsnivå för iCal-feed.
defaultDisplayContent
 defaultDisplayContent string

Standardinnehåll som ska visas på webbplatsen.
defaultEmailAlert
 defaultEmailAlert integer

Aktivera standardaviseringar för e-post.
excelReportFooter
 excelReportFooter integer

Innehåller en sidfot i Excel-rapporter.
excelReportFooterText
 excelReportFooterText string

Text som ska visas i sidfoten för Excel-rapporter.
announcementMLJSON
 announcementMLJSON string

JSON-formaterade meddelanden för webbplatsen.
templateType (på engelska)
 templateType integer

Typ av mall som används för webbplatsen.
templateLicence
 templateLicence integer

Licenstyp för webbplatsmallen.
openChannelAppID
 openChannelAppID string

Program-ID för integrering med öppen kanal.
itemid
 itemid integer

Identifierare för det objekt som är associerat med webbplatsen.
sitemetadatasheetid
 sitemetadatasheetid integer

ID för metadatabladet som är associerat med webbplatsen.
mysite
 mysite boolean

Anger om det här är användarens personliga webbplats.
lastaccesseddate
 lastaccesseddate string

Datum och tid då webbplatsen senast användes.
defaultViewerMetaDataTab
 defaultViewerMetaDataTab integer

Standardmetadatafliken för webbplatsvisningsprogrammet.
documentMetadataViewId
 documentMetadataViewId integer

dokumentmetadata för visningsidentifierare.
folderMetadataViewId
 folderMetadataViewId integer

mappmetadata för visningsidentifierare.
docSort
 docSort integer

Sorteringsordningen för dokument.
folderSort
 folderSort integer

Sorteringsordningen för mappar.
defaultFolderRenderView
 defaultFolderRenderView integer

Avgör standardläget för vyn för mappar.
isTaskAttachmentDefault
 isTaskAttachmentDefault integer

Standardplatsen för aktivitetsbilagor.
taskAttachmentDefaultFolderId
 taskAttachmentDefaultFolderId integer

Den unika identifieraren för den mapp som har angetts som standardplats för aktivitetsbilagor.
favorit
 favourite string

favoritstatus.
enabledocumentredaction
 enabledocumentredaction boolean

Anger om dokumentredigering är aktiverat för webbplatsen.
mentiongroups
 mentiongroups integer

De nämnda grupperna.
enablefilerelationships
 enablefilerelationships boolean

Anger om filrelationer är aktiverade.
filerelationshipsitepermissionlevel
 filerelationshipsitepermissionlevel integer

Behörighetsnivån som krävs för att hantera filrelationer.

ModuleDBO

Name Sökväg Typ Description
hem
 home HomeDBO
aktivitet
 activity ActivityDBO
dokument
 document DocumentDBO
blogg
 blog BlogDBO
wiki
 wiki WikiDBO
uppgift
 task TaskDBO
händelse
 event EventDBO
isheet
 isheet ISheetDBO
Qa
 qa QaDBO
folk
 people PeopleDBO
contractexpress
 contractexpress ContractExpressDBO

HomeDBO

Name Sökväg Typ Description
enable
 enable string

Aktivera status för HomeDBO.

ActivityDBO

Name Sökväg Typ Description
enable
 enable string

Aktivera status för ActivityDBO.
microblog
 microblog string

Mikroblogginnehåll som är associerat med ActivityDBO.

BlogDBO

Name Sökväg Typ Description
blogTitle
 blogTitle string

Rubrik för blogginlägget.
blogContent
 blogContent string

Innehållet i blogginlägget.
showComment
 showComment integer

visa kommentaren.
tagList
 tagList array of string

Lista över taggar som är associerade med bloggen.
status
 status integer

status för blogginlägget.
siteID
 siteID integer

Identifierare för den associerade webbplatsen.
författare
 author string

Författare till bloggen.
categoryList
 categoryList array of string

Kategorier som tilldelats blogginlägget.
notificationTypeID
 notificationTypeID integer

Identifierare för meddelandetypen.
meddelande
 message string

Meddelandeinnehåll som är relaterat till bloggen.
messageCode
 messageCode integer

Kod som är associerad med meddelandet.
externalID
 externalID string

Extern identifierare som är länkad till bloggen.
publiceraDatum
 publishDate string

Publiceringsdatum för bloggen.
processtyp
 processtype string

Processtyp som är associerad med bloggen.
enable
 enable string

Aktivera status för BlogDBO.

WikiDBO

Name Sökväg Typ Description
wikiid
 wikiid integer

Unik identifierare för wikin.
currentversionid
 currentversionid integer

Identifierare för den aktuella versionen av wikin
parentwikiid
 parentwikiid integer

Identifierare för den överordnade wikin.
wikititle
 wikititle string

Wikins titel.
wikicontent
 wikicontent string

Innehållet i wikin.
showcomment
 showcomment integer

Anger om kommentarer är aktiverade.
createddate
 createddate string

Skapandedatum för wikin.
modifieddate
 modifieddate string

Senaste ändringsdatum för wikin.
taglist
 taglist string

Kommaavgränsad lista över taggar som är associerade med wikin.
wikipath
 wikipath string

Sökväg för att komma åt wikin.
wikidraftid
 wikidraftid integer

Identifierare för utkastversionen av wikin.
drafttype
 drafttype string

Typ av utkast som är associerat med wikin.
status
 status integer

Aktuell status för wikin.
wikiversionid
 wikiversionid integer

Versionsidentifierare för wikin.

TaskDBO

Name Sökväg Typ Description
index
 index string

Index eller identifierare för aktiviteten.
parenttaskid
 parenttaskid integer

Identifierare för den överordnade aktiviteten.
taskid
 taskid integer

Unik identifierare för aktiviteten.
title
 title string

Uppgiftsrubrik.
beskrivning
 description string

Detaljerad beskrivning av uppgiften.
duedate
 duedate string

Förfallodatum för uppgiftens slutförande.
startdate
 startdate string

Startdatum när aktiviteten initierades.
mattermaptaskid
 mattermaptaskid string

Identifierarlänkning till ärendemappningsaktiviteten.
type
 type string

Typ eller kategori för uppgiften.
dependenton
 dependenton string

Uppgifter som den här uppgiften är beroende av.
daysfromdependent
 daysfromdependent string

Antal dagar från den beroende aktiviteten.
ignoreweekend
 ignoreweekend integer

Anger om helger ignoreras i schemaläggningen.
duration
 duration integer

Varaktighet för att slutföra uppgiften.
resource
 resource string

Resurser som tilldelats uppgiften.

EventDBO

Name Sökväg Typ Description
eventTitle
 eventTitle string

Rubriken på händelsen.
eventContent
 eventContent string

Innehållet i händelsen.
showComment
 showComment integer

Anger om kommentarer är aktiverade för händelsen.
tagList
 tagList array of string

Lista över taggar som är associerade med händelsen.
status
 status integer

Aktuell status för händelsen.
siteID
 siteID integer

Identifierare för webbplatsen.
kontakta
 contact string

Kontaktuppgifter för händelsen.
categoryList
 categoryList array of string

Kategorier under vilka händelsen visas.
notificationTypeID
 notificationTypeID integer

Meddelandetypen som är relaterad till händelsen.
meddelande
 message string

Meddelandet om händelsen.
messageCode
 messageCode integer

Meddelandekoden för händelsen.
externalID
 externalID string

Den externa identifieraren.
startDate
 startDate string

Händelsens startdatum.
slutdatum
 endDate string

Slutdatum för händelsen.
startTime
 startTime string

Starttiden för händelsen.
endTime
 endTime string

Sluttiden för händelsen.
location
 location string

Platsen för händelsen.
författare
 author string

Författaren till händelsen.
processtyp
 processtype string

Processtiden för händelsen.
enable
 enable string

Aktivera är händelsen.

ISheetDBO

Name Sökväg Typ Description
Id-nummer
 id integer

Unik identifierare för iSheet.
title
 title string

Rubrik för iSheet.
beskrivning
 description string

Beskrivning av isheeten.
status
 status string

Status för isheeten.
accesstype
 accesstype string

Åtkomsttyp för isheeten.
type
 type string

Typ av isheet.
viewlink
 viewlink string

Länka för att visa iSheet.
allowsections
 allowsections string

Om avsnitt är tillåtna.
allowlookup
 allowlookup string

Om uppslagsfält är aktiverade.
displayisheet
 displayisheet string

Visningsalternativ för iSheet.
searchasdefaultview
 searchasdefaultview string

Anger om sökningen är standardvyn.
enableversion
 enableversion string

Flaggan Versionsaktiverad.
enablesheetalerter
 enablesheetalerter string

Flagga för att aktivera bladaviseringar.
alertercondition
 alertercondition string

Villkor för utlösande av aviseringar.
overrideitemmodifieddate
 overrideitemmodifieddate string

Åsidosätt ändrad datumflagga.
enablebulkinsertupdate
 enablebulkinsertupdate string

Aktivera massinfogning/uppdatering.
fielddescriptions
 fielddescriptions string

Fältbeskrivningar för iSheet.
enablerowlocking
 enablerowlocking string

Aktivera låsning på radnivå.
setcharlimittruncatemultilinetextenabled
 setcharlimittruncatemultilinetextenabled string

Trunkera textflagga för flera rutor.
setcharlimittruncatemultilinetextval
 setcharlimittruncatemultilinetextval string

Teckengräns för trunkering med flera rader.
allowchoicelistvaluesforreuse
 allowchoicelistvaluesforreuse string

Tillåt återanvändning av alternativlistvärden.
allowscorelistvaluesforreuse
 allowscorelistvaluesforreuse string

Tillåt återanvändning av poänglistevärden.
allowIsheetComments
 allowIsheetComments string

Tillåt kommentarer i iSheet.
shareRecordsLimit
 shareRecordsLimit integer

Gräns för poster som tillåts att dela.
shareRecordsLimitEnabled
 shareRecordsLimitEnabled integer

Resursgräns för aktiverade poster.
enableIsheetAddRecordFormSharing
 enableIsheetAddRecordFormSharing string

Aktivera formulärdelning för att lägga till poster.
recordcount
 recordcount string

Aktuellt antal poster.
sheettypeid
 sheettypeid integer

Typ-ID för iSheet

QaDBO

Name Sökväg Typ Description
enable
 enable string

Aktivera QA-funktioner.

PeopleDBO

Name Sökväg Typ Description
person
 person array of PersonDBO

PersonDBO

Name Sökväg Typ Description
userid
 userid integer

Användar-ID.
Mejladress
 email string

e-postadress.
httpavatar
 httpavatar string

HTTP-URL för avatar.
avatar
 avatar string

Avatarbild.
userlink
 userlink string

Länk till användarprofil.
httplink
 httplink string

HTTP-länk till användarprofil.
phone
 phone string

Telefonnummer.
mobile
 mobile string

Mobilnummer.
Avdelning
 department string

Användarens avdelning.

ContractExpressDBO

Name Sökväg Typ Description
enable
 enable string

Aktivera Contract Express-integrering.

MappDBOV2

Name Sökväg Typ Description
name
 name string

Mappnamn.
beskrivning
 description string

Mappbeskrivning.
parentFolderID
 parentFolderID integer

Överordnat mapp-ID.
accessInherited
 accessInherited integer

Åtkomst till arvsstatus.
batchID
 batchID string

Batch-identifierare
DMS
 dms DmsDBO
Id-nummer
 id integer

Mapp-ID.
link
 link string

Mapplänk.
createddate
 createddate string

Skapad den.
modifieddate
 modifieddate string

Ändrat datum.
barn
 child integer

Underordnade mappar.
filecount
 filecount integer

Antal filer.
createdby
 createdby UserDBO
modifierad av
 modifiedby UserDBO
folderid
 folderid integer

Mapp-ID.
dmsfolderid
 dmsfolderid string

DMS-mappidentifierare.
siteid
 siteid integer

Webbplats-ID
location
 location string

Mappplats.
tillåtelse
 permission PermissionDBO
contentstatus
 contentstatus integer

Innehållsstatus.
automatisk numrering
 autonumbering string

Automatisk numreringskonfiguration.
mappar
 foldersize string

Mappstorlek.
sharedstatus
 sharedstatus integer

Delningsstatus.
favoritestatus
 favouritestatus integer

Favoritstatus.
mapptyp
 foldertype string

Mapptyp.
Artikel-ID
 itemId integer

Objekt-ID.
folderMetadataSheetId
 folderMetadataSheetId integer

Mappmetadata för blad-ID.

UserDBO

Name Sökväg Typ Description
förnamn
 firstname string

Förnamn.
efternamn
 lastname string

Efternamn.
Mejladress
 email string

E-postadress.
userid
 userid integer

Användar-ID.

PermissionDBO

Name Sökväg Typ Description
view
 view integer

Visa behörighet.
edit
 edit integer

Redigera behörighet.
delete
 delete integer

Ta bort behörighet.
addEditAllFiles
 addEditAllFiles integer

Lägg till/redigera behörigheten Alla filer.
Admin
 admin integer

Administratörsbehörighet.
viewAllFiles
 viewAllFiles integer

Visa alla filer Behörighet.
disableSave
 disableSave integer

inaktivera spara behörighet.
uploadFile
 uploadFile integer

ladda upp filbehörighet.
updateFile
 updateFile integer

uppdatera filbehörighet.
deleteFile
 deleteFile integer

Ta bort filbehörighet.

ProgressiveKeyDBO

Name Sökväg Typ Description
progressivekey
 progressivekey string

Nyckel för progressiva åtgärder.
siteid
 siteid integer

Identifierare för webbplatsen.
progressivekeystatus
 progressivekeystatus string

Status för den progressiva nyckeln.
userid
 userid integer

Identifierare för användaren.
responsebody
 responsebody string

Svarets brödtext.
meddelande
 message string

Meddelandeinnehåll.
messagecode
 messagecode string

Kod som är associerad med meddelandet.
integrationResponseDBO
 integrationResponseDBO IntegrationResponseDBO
columns
 columns ColumnErrorsDBO
items
 items ItemErrorsDBO
importisheettemplate
 importisheettemplate importISheetTemplateDBO
fel
 error ErrorDBO
innehållstyp
 contentType string

Typ av innehåll.
failedEntities
 failedEntities integer

Antal misslyckade entiteter.
downloadlink
 downloadlink string

Länk för att ladda ned innehåll.
bifogad fil
 attachment Attachment
link
 link string

Associerad länk.
documentid
 documentid integer

Identifierare för dokumentet.
progresskey
 progresskey string

Förloppsnyckel för spårning.
progresskeystatus
 progresskeystatus string

Status för förloppsnyckeln.

IntegrationResponseDBO

Name Sökväg Typ Description
integrationResponseUsersObject
 integrationResponseUsersObject IntegrationResponseUsersObject
failedEntities
 failedEntities integer

Antal entiteter som inte bearbetats.
successEntiteter
 successEntities integer

Antal entiteter som har bearbetats.

IntegrationResponseUsersObject

Name Sökväg Typ Description
user
 user array of IntegrationUserDBO

ColumnErrorsDBO

Name Sökväg Typ Description
kolumn
 column array of ColumnErrorDBO
failedEntities
 failedEntities integer

Antal entiteter som misslyckades på grund av kolumnfel.
successEntiteter
 successEntities integer

Antal entiteter som har bearbetats.

ColumnErrorDBO

Name Sökväg Typ Description
index
 index integer

Indexposition för kolumnen med fel.
columnid
 columnid integer

Unik identifierare för kolumnen med fel.
name
 name string

Namnet på kolumnen med fel.
status
 status string

Status som anger felvillkoret.
statuskod
 statuscode string

Kod som representerar felstatusen.
meddelande
 message string

Detaljerat felmeddelande.

ItemErrorsDBO

Name Sökväg Typ Description
item
 item array of ItemErrorDBO
failedEntities
 failedEntities integer

Antal entiteter som misslyckades på grund av objektfel.
successEntiteter
 successEntities integer

Antal entiteter som har bearbetats trots objektfel.

ItemErrorDBO

Name Sökväg Typ Description
index
 index integer

Indexposition för objektet med fel.
columns
 columns ColumnErrorsDBO
itemid
 itemid string

Unik identifierare för objektet med fel.
externalid
 externalid string

Extern identifierare som är associerad med objektet.
Id-nummer
 id string

Intern identifierare för objektet.
name
 name string

Namnet på objektet med fel.
status
 status string

Status som anger felvillkoret.
statuskod
 statuscode string

Kod som representerar felstatusen.
meddelande
 message string

Detaljerat felmeddelande.
successdeletedcount
 successdeletedcount integer

Antal borttagna entiteter.
failurecount
 failurecount integer

Antal entiteter som inte bearbetats.
failedEntities
 failedEntities integer

Antal entiteter som misslyckades på grund av objektfel.
successEntiteter
 successEntities integer

Antal entiteter som har bearbetats.

importISheetTemplateDBO

Name Sökväg Typ Description
linkedtemplateid
 linkedtemplateid integer

Identifierare för den länkade mallen.
aliasname
 aliasname string

Aliasnamn för mallen.
linkedisheet
 linkedisheet string

Identifierare för det länkade indatabladet.
importdata
 importdata string

Data som ska importeras från mallen.
appendisheetname
 appendisheetname string

Namnet på bladet som data ska läggas till i.
templateparametergroups
 templateparametergroups ISheetTemplateParameterGroups
templateSheetIdMap
 templateSheetIdMap object
templateId
 templateId integer

Identifierare för mallen.
templateTitle
 templateTitle string

Mallens rubrik.
viewIDs
 viewIDs string

Kommaavgränsad lista över visnings-ID:t.

ISheetTemplateParameterGroups

Name Sökväg Typ Description
templateparametergroup
 templateparametergroup array of ISheetTemplateParameterGroup

ISheetTemplateParameterGroup

Name Sökväg Typ Description
templateruleid
 templateruleid integer

Parametergrupp för isheetmall.
templateparameter
 templateparameter array of ISheetTemplateParameter

ISheetTemplateParameter

Name Sökväg Typ Description
Id-nummer
 id integer

Identifierare för isheet-mallparametern.
name
 name string

Namnet på parametern isheet-mall.
data
 data string

data för isheet-mallparametern.

Attachment

Name Sökväg Typ Description
fil
 file string

Filinnehållet.
name
 name string

Namnet på den bifogade filen.
order
 order string

Ordningen på den bifogade filen.
Id-nummer
 id integer

Unik identifierare för den bifogade filen.
utbyggnad
 extension string

Filnamnstillägg.
parentfolderid
 parentfolderid integer

ID för den överordnade mappen.
filehttplink
 filehttplink string

HTTP-länk för att komma åt filen.
mappväg
 folderpath string

Sökväg till mappen som innehåller filen.
folderhttplink
 folderhttplink string

HTTP-länk till mappen.
filesize
 filesize integer

Filens storlek i byte.
redactionStatus
 redactionStatus boolean

Anger om filen har redigerats.
displayname
 displayname string

Visningsnamn för den bifogade filen.
siteid
 siteid integer

ID för den webbplats som är associerad med den bifogade filen.