HighQ (anteprima)
Questo connettore consente l'accesso sicuro e autenticato alle API HighQ, consentendo una perfetta integrazione delle funzionalità di collaborazione e gestione dei contenuti in flussi di lavoro e applicazioni personalizzati. Supporta l'automazione dei documenti, la sincronizzazione dei dati e l'orchestrazione del flusso di lavoro, consentendo ai team di servizi legali e professionali di semplificare le operazioni, ridurre il lavoro manuale e migliorare la produttività.
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Servizio | Class | Regions |
|---|---|---|
| Copilot Studio | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| App per la logica | Normale | Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure per enti pubblici - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Di alta qualità | Tutte le aree di Power Apps , ad eccezione dei seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Automate | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Contatto | |
|---|---|
| Nome | Highq |
| URL | https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support |
| highq-support@thomsonreuters.com |
| Metadati del connettore | |
|---|---|
| Editore | Thomson Reuters Incorporated |
| Sito Web | https://legal.thomsonreuters.com/en/products/highq |
| Informativa sulla privacy | https://www.thomsonreuters.com/en/privacy-statement |
| Categorie | Collaborazione; Contenuto e file |
HighQ
Informazioni generali
HighQ offre accesso facile, sicuro e autenticato alle API HighQ. Questo connettore consente un'interazione senza problemi con vari servizi HighQ, tra cui il modulo ISheet, le API risorsa documento, l'API di amministrazione di ISheet e le operazioni utente. È progettato per facilitare l'integrazione con la piattaforma HighQ Collaborate, offrendo funzionalità come il recupero e la creazione di elementi iSheet, la gestione dei file di documento e l'amministrazione degli account utente.
- Versione connettore: 1.0.0
- Titolo: HighQ
- Descrizione: Questo connettore offre accesso facile, sicuro e autenticato alle API HighQ.
-
Contatto:
- Nome: Highq
- Sito Web:Supporto di HighQ
- E-mail:highq-support@thomsonreuters.com
Authentication
Il connettore sfrutta le variabili di ambiente dinamiche per la connettività sicura:
-
Host:
@environmentVariables("highqt_host") -
Percorso di base:
/@environmentVariables("highqt_instancename")/api -
ID client:
@environmentVariables("highqt_clientid") -
Segreto client:
@environmentVariables("highqt_clientsecret")
Per procedure di autenticazione dettagliate, vedere il portale di supporto tecnico HighQ o contattare il supporto tecnico di HighQ.
Operazioni del connettore
Modulo ISheet
Recuperare gli elementi di iSheet
GET /{version}/isheet/{isheetid}/items
Recupera un elenco di elementi all'interno del foglio iSheet specificato.Creare elementi iSheet
POST /{version}/isheet/{isheetid}/items
Inserisce nuovi elementi in un iSheet, con supporto per più iSheet e rilevamento dello stato tramite chiavi progressive.
API risorsa documento
Recuperare informazioni sui file
GET /{version}/files/{fileid}
Recupera informazioni dettagliate su un file specifico nella piattaforma HighQ Collaborate.Caricare un file
POST /{version}/files/content
Carica un file in una cartella specificata, supportando i caricamenti in blocchi quando viene specificata l'intestazioneContent-Range.Recupera elenco cartelle
GET /{version}/folders/{folderid}/items
Recupera un elenco di cartelle all'interno della cartella specificata con il supporto per l'ordinamento e la paginazione.
API di amministrazione di ISheet
-
Recuperare le colonne di iSheet
GET /{version}/isheets/admin/{isheetid}/columns
Recupera le configurazioni delle colonne per un determinato iSheet.
Operazioni relative agli utenti
Recuperare gli utenti
GET /{version}/users
Recupera un elenco di utenti con supporto per il filtro, la paginazione e i ruoli utente dettagliati.Aggiungere un nuovo utente
POST /{version}/users
Crea un nuovo account utente con attributi estesi e convalida.Archiviare un utente
DELETE /{version}/users/{userid}
Archivia un utente esistente dal sistema.
Gestione di documenti e siti
Creare una cartella
POST /{version}/folders
Crea una nuova cartella in una cartella padre specificata.Spostare documenti
PUT /{version}/files/move
Sposta uno o più file da una cartella a un'altra all'interno dello stesso sito.Operazioni di gestione del sito:
-
Aggiungere un gruppo esistente al sito:
POST /{version}/sites/{siteid}/groups/{groupid} -
Aggiornare il gruppo di siti:
PUT /{version}/sites/{siteid}/groups/{groupid} -
Aggiungere un nuovo sito:
POST /{version}/sites
-
Aggiungere un gruppo esistente al sito:
Come iniziare
Configurazione:
- Definire le variabili
highqt_hostdi ambiente ehighqt_instancenamenell'ambiente Power Platform.
- Definire le variabili
Autenticazione:
- Seguire le linee guida fornite da HighQ per configurare l'autenticazione sicura per le richieste API.
Utilizzo:
- Importare HighQ nell'istanza di Power Platform.
- Utilizzare le operazioni disponibili in base alle esigenze. Per indicazioni, vedere i riepiloghi dell'operazione forniti in precedenza.
Parametri e impostazioni
Parametri di percorso:
Includere i parametri obbligatori, adversionesempio ,isheetidfileid,folderid, euseridin base alle esigenze.Parametri di query:
I parametri facoltativi, ad esempiosheetviewid,sortcolumnidlimit, eoffsetsono disponibili per perfezionare le risposte api.Parametri corpo:
Per le operazioni che richiedono un corpo della richiesta (ad esempio, la creazione di elementi o utenti di iSheet), assicurarsi che la richiesta rispetti gli schemi definiti (ad esempioisheetDBO,FolderDBOoIntegrationUserDBO).
Risoluzione dei problemi e limitazioni
Codici di errore:
I codici di stato HTTP standard vengono usati tra le operazioni:-
200per operazioni riuscite -
401per l'accesso non autorizzato -
403errori di convalida o non consentiti -
405per metodi HTTP non validi -
500per gli errori interni del server
Per una descrizione dettagliata degli errori, vedere la documentazione delle singole API.
-
Limitazioni:
Alcuni endpoint possono avere limiti predefiniti (ad esempio, un valore predefinitolimitdi 100 record). È possibile che siano necessari parametri aggiuntivi per l'ordinamento e il filtro di set di dati di grandi dimensioni.
Risorse aggiuntive
Per informazioni più dettagliate e documentazione estesa, consultare:
- Supporto tecnico HighQ
- Documentazione interna associata al pacchetto del connettore HighQ.
Licenze e supporto
Per informazioni dettagliate sulle licenze e supporto tecnico:
- Contatto: Highq
- URL di supporto: Supporto tecnico HighQ
- Messaggio di posta elettronica di supporto: highq-support@thomsonreuters.com
Limiti per la limitazione delle richieste
| Nome | Chiamate | Periodo di rinnovo |
|---|---|---|
| Chiamate API per connessione | 100 | 60 secondi |
Azioni
| Aggiornare il gruppo di siti |
Questo metodo API aggiorna il nome di un gruppo esistente in un sito. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Aggiornare il sito |
Usare questo endpoint API per aggiornare i dettagli di un sito esistente. L'API supporta gli stessi campi usati nell'API Crea sito. Questo metodo supporta più numeri di materia da aggiungere al sito usando l'API versione 10 e successive. Il tag "matternos" indica più numeri di materia con sola lettura o meno. Versione 18 e successive: è necessaria una categoria (scopo del sito). Se lo scopo del sito è nascosto, viene visualizzato un messaggio; in caso contrario, gli scopi nascosti del sito non vengono aggiunti al sito. Ora il proprietario del sito può essere assegnato anche ad altri utenti, ma devono essere partecipanti al sito e avere un ruolo superiore all'amministratore del sito. Versione 18 successiva: il proprietario del sito può aggiungere altri utenti al sito. A partire dalla versione 19 dell'API, viene introdotto un nuovo modulo denominato customPages, strettamente associato al modulo home. Se il valore del modulo home è True, customPages deve essere true e viceversa. Si noti che tutte le proprietà/elementi nella risposta del sito get non sono aggiornabili/inseriti. Vedere la tabella seguente per sapere quali sono di sola lettura, aggiornabili o inseriscibili. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Aggiungere un gruppo esistente al sito |
Questo metodo API aggiunge un gruppo di sistema esistente al sito. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Aggiungi sito |
Usare questa API per creare un nuovo sito. L'oggetto sito supporta solo gli attributi visibili nell'interfaccia del sito di creazione.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Aggiungi utente |
Questa chiamata API viene usata per aggiungere un nuovo utente al sistema.
Ticket JIRA : https://dev.highq.com/jira/browse/COL-65685 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Archivio utente |
Questa chiamata API viene usata per archiviare un utente all'interno del sistema.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Caricare un file |
Questa chiamata API carica un file in una cartella specificata nella piattaforma HighQ Collaborate. Supporta i caricamenti in blocchi quando viene fornita l'intestazione Content-Range. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Crea cartella |
Questa API crea una nuova cartella all'interno del sito specificato. Consente di specificare i dettagli della cartella e di assicurarsi che la cartella venga creata nella cartella padre specificata. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Ottenere informazioni sulla cartella |
Il metodo fornisce i dettagli della cartella dell'ID cartella specificato. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Per creare l'elemento i |
Questa chiamata API viene usata per inserire l'elemento iSheet. È possibile supportare più iSheet. Per ottenere lo stato di un elemento iSheet basato su una chiave progressiva, chiamare API POST /api/3/progressivekeystatus/{progressive_key} ad esempio POST /api/{version}/progressivekeystatus/{progressive_key}
risposta
<progressivekeyresponse>
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Recuperare informazioni sui file |
Questa chiamata API recupera informazioni dettagliate per un file specificato dalla piattaforma HighQ Collaborate. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Recuperare l'elenco utenti |
Recuperare un elenco di utenti Questa API recupera un elenco di utenti dal sistema. Funzionalità principali di ## - Recuperare i dettagli dell'utente con più opzioni di filtro - Supporta la paginazione con
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Recuperare le colonne di i |
Questa chiamata API recupera le colonne associate all'iSheet specificato. Questa funzionalità è supportata nell'API versione 3 e successive. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Recuperare un elenco di cartelle |
Questa chiamata API recupera un elenco di cartelle contenute nella cartella specificata. Il parametro 'limit' imposta il numero massimo di elementi da restituire e il parametro 'offset' specifica la posizione iniziale per il recupero dei dati. I valori predefiniti vengono applicati se questi parametri vengono omessi e le cartelle vengono restituite in ordine crescente in base alla data di creazione. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Recuperare un elenco di elementi di i |
Questa chiamata API recupera un elenco di elementi contenuti nell'iSheet specificato. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Spostare documenti |
Questa API sposta più file da una cartella a un'altra all'interno dello stesso sito. |
Aggiornare il gruppo di siti
Questo metodo API aggiorna il nome di un gruppo esistente in un sito.
Questa API è stata estesa per aggiornare il nome di un gruppo di utenti di base esistente in un sito.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API
|
version | True | string |
version |
|
ID del sito
|
siteid | True | string |
ID del sito. |
|
Versione dell'API
|
groupid | True | string |
|
|
nome
|
name | string | ||
|
id
|
id | integer | ||
|
copypermissionsfrom
|
copypermissionsfrom | string | ||
|
message
|
message | string | ||
|
typeID
|
typeID | integer | ||
|
type
|
type | string | ||
|
numberofusers
|
numberofusers | string | ||
|
creato
|
created | string | ||
|
modified
|
modified | string | ||
|
systemGroupID
|
systemGroupID | integer | ||
|
descrizione
|
description | string | ||
|
basicusergroup
|
basicusergroup | integer |
Restituisce
- Corpo
- sitegroup
Aggiornare il sito
Usare questo endpoint API per aggiornare i dettagli di un sito esistente. L'API supporta gli stessi campi usati nell'API Crea sito.
Questo metodo supporta più numeri di materia da aggiungere al sito usando l'API versione 10 e successive. Il tag "matternos" indica più numeri di materia con sola lettura o meno.
Versione 18 e successive: è necessaria una categoria (scopo del sito). Se lo scopo del sito è nascosto, viene visualizzato un messaggio; in caso contrario, gli scopi nascosti del sito non vengono aggiunti al sito.
Ora il proprietario del sito può essere assegnato anche ad altri utenti, ma devono essere partecipanti al sito e avere un ruolo superiore all'amministratore del sito.
Versione 18 successiva: il proprietario del sito può aggiungere altri utenti al sito.
A partire dalla versione 19 dell'API, viene introdotto un nuovo modulo denominato customPages, strettamente associato al modulo home. Se il valore del modulo home è True, customPages deve essere true e viceversa.
Si noti che tutte le proprietà/elementi nella risposta del sito get non sono aggiornabili/inseriti. Vedere la tabella seguente per sapere quali sono di sola lettura, aggiornabili o inseriscibili.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API richiesta
|
version | True | string |
versione dell'API |
|
Identificatore univoco per il sito
|
siteid | True | string |
ID del sito |
|
id
|
id | integer |
Identificatore del sito. |
|
|
sitename
|
sitename | string |
Il nome del sito. |
|
|
ruolo
|
role | string |
Ruolo del sito. |
|
|
sitedescription
|
sitedescription | string |
Descrizione del sito. |
|
|
enabledmodules
|
enabledmodules | string |
Elenco di moduli abilitati per il sito. |
|
|
sitefolderID
|
sitefolderID | string |
Identificatore della cartella del sito. |
|
|
sitefolderpermission
|
sitefolderpermission | string |
Livello di autorizzazione per la cartella del sito. |
|
|
abilitare
|
enable | string |
Abilitare lo stato per HomeDBO. |
|
|
abilitare
|
enable | string |
Abilitare lo stato per ActivityDBO. |
|
|
microblog
|
microblog | string |
Contenuto del microblog associato a ActivityDBO. |
|
|
docid
|
docid | string |
ID documento. |
|
|
blogTitle
|
blogTitle | string |
Titolo del post di blog. |
|
|
blogContent
|
blogContent | string |
Contenuto del post di blog. |
|
|
showComment
|
showComment | integer |
visualizzare il commento. |
|
|
tagList
|
tagList | array of string |
Elenco di tag associati al blog. |
|
|
status
|
status | integer |
stato del post di blog. |
|
|
siteID
|
siteID | integer |
Identificatore del sito associato. |
|
|
autore
|
author | string |
Autore del blog. |
|
|
categoryList
|
categoryList | array of string |
Categorie assegnate al post di blog. |
|
|
notificationTypeID
|
notificationTypeID | integer |
Identificatore per il tipo di notifica. |
|
|
message
|
message | string |
Contenuto del messaggio correlato al blog. |
|
|
messageCode
|
messageCode | integer |
Codice associato al messaggio. |
|
|
ID esterno
|
externalID | string |
Identificatore esterno collegato al blog. |
|
|
data di pubblicazione
|
publishDate | string |
Data di pubblicazione del blog. |
|
|
processtype
|
processtype | string |
Tipo di processo associato al blog. |
|
|
abilitare
|
enable | string |
Abilitare lo stato per BlogDBO. |
|
|
wikiid
|
wikiid | integer |
Identificatore univoco per il wiki. |
|
|
currentversionid
|
currentversionid | integer |
Identificatore per la versione corrente del wiki |
|
|
parentwikiid
|
parentwikiid | integer |
Identificatore per il wiki padre. |
|
|
wikititle
|
wikititle | string |
Titolo del wiki. |
|
|
wikicontent
|
wikicontent | string |
Contenuto del wiki. |
|
|
showcomment
|
showcomment | integer |
Indica se i commenti sono abilitati. |
|
|
createddate
|
createddate | string |
Data di creazione del wiki. |
|
|
modifieddate
|
modifieddate | string |
Data ultima modifica del wiki. |
|
|
taglist
|
taglist | string |
Elenco delimitato da virgole di tag associati al wiki. |
|
|
Wikipath
|
wikipath | string |
Percorso per accedere al wiki. |
|
|
wikidraftid
|
wikidraftid | integer |
Identificatore per la versione bozza del wiki. |
|
|
drafttype
|
drafttype | string |
Tipo di bozza associata al wiki. |
|
|
status
|
status | integer |
Stato corrente del wiki. |
|
|
wikiversionid
|
wikiversionid | integer |
Identificatore della versione del wiki. |
|
|
index
|
index | string |
Indice o identificatore per l'attività. |
|
|
parenttaskid
|
parenttaskid | integer |
Identificatore per l'attività padre. |
|
|
taskid
|
taskid | integer |
Identificatore univoco per l'attività. |
|
|
title
|
title | string |
Titolo dell'attività. |
|
|
descrizione
|
description | string |
Descrizione dettagliata dell'attività. |
|
|
scadenza
|
duedate | string |
Scadenza per il completamento dell'attività. |
|
|
startdate
|
startdate | string |
Data di inizio dell'avvio dell'attività. |
|
|
mattermaptaskid
|
mattermaptaskid | string |
Identificatore collegato all'attività di mapping della materia. |
|
|
type
|
type | string |
Digitare o categoria dell'attività. |
|
|
dependenton
|
dependenton | string |
Attività da cui dipende questa attività. |
|
|
daysfromdependent
|
daysfromdependent | string |
Numero di giorni dall'attività dipendente. |
|
|
ignoreweekend
|
ignoreweekend | integer |
Indica se i fine settimana vengono ignorati nella pianificazione. |
|
|
duration
|
duration | integer |
Durata per completare l'attività. |
|
|
resource
|
resource | string |
Risorse assegnate all'attività. |
|
|
eventTitle
|
eventTitle | string |
Titolo dell'evento. |
|
|
eventContent
|
eventContent | string |
Contenuto dell'evento. |
|
|
showComment
|
showComment | integer |
Indica se i commenti sono abilitati per l'evento. |
|
|
tagList
|
tagList | array of string |
Elenco di tag associati all'evento. |
|
|
status
|
status | integer |
Stato corrente dell'evento. |
|
|
siteID
|
siteID | integer |
Identificatore del sito. |
|
|
contatto
|
contact | string |
Informazioni di contatto per l'evento. |
|
|
categoryList
|
categoryList | array of string |
Categorie in cui viene elencato l'evento. |
|
|
notificationTypeID
|
notificationTypeID | integer |
Tipo di notifica correlato all'evento. |
|
|
message
|
message | string |
Messaggio dell'evento. |
|
|
messageCode
|
messageCode | integer |
Codice del messaggio dell'evento. |
|
|
ID esterno
|
externalID | string |
Identificatore esterno. |
|
|
startDate
|
startDate | string |
Data di inizio dell'evento. |
|
|
Data di fine
|
endDate | string |
Data di fine dell'evento. |
|
|
startTime
|
startTime | string |
Ora di inizio dell'evento. |
|
|
endTime
|
endTime | string |
Ora di fine dell'evento. |
|
|
ubicazione
|
location | string |
Posizione dell'evento. |
|
|
autore
|
author | string |
Autore dell'evento. |
|
|
processtype
|
processtype | string |
Ora del processo dell'evento. |
|
|
abilitare
|
enable | string |
Abilitare l'evento. |
|
|
id
|
id | integer |
Identificatore univoco per iSheet. |
|
|
title
|
title | string |
Titolo del foglio iSheet. |
|
|
descrizione
|
description | string |
Descrizione del foglio isheet. |
|
|
status
|
status | string |
Stato del foglio isheet. |
|
|
accesstype
|
accesstype | string |
Tipo di accesso del foglio isheet. |
|
|
type
|
type | string |
Tipo del foglio isheet. |
|
|
viewlink
|
viewlink | string |
Collegamento per visualizzare iSheet. |
|
|
consentiszioni
|
allowsections | string |
Indica se le sezioni sono consentite. |
|
|
allowlookup
|
allowlookup | string |
Indica se i campi di ricerca sono abilitati. |
|
|
displayisheet
|
displayisheet | string |
Opzioni di visualizzazione per iSheet. |
|
|
searchasdefaultview
|
searchasdefaultview | string |
Indica se la ricerca è la visualizzazione predefinita. |
|
|
enableversion
|
enableversion | string |
Flag abilitato per il controllo delle versioni. |
|
|
enablesheetalerter
|
enablesheetalerter | string |
Contrassegno per abilitare gli avvisi del foglio. |
|
|
alertercondition
|
alertercondition | string |
Condizioni per l'attivazione degli avvisi. |
|
|
overrideitemmodifieddate
|
overrideitemmodifieddate | string |
Eseguire l'override del flag di data modificato. |
|
|
enablebulkinsertupdate
|
enablebulkinsertupdate | string |
Abilitare l'inserimento/aggiornamento bulk. |
|
|
fielddescriptions
|
fielddescriptions | string |
Descrizioni dei campi per iSheet. |
|
|
enablerowlocking
|
enablerowlocking | string |
Abilitare il blocco a livello di riga. |
|
|
setcharlimittruncatemultilinetextenabled
|
setcharlimittruncatemultilinetextenabled | string |
Tronca il flag di testo su più righe. |
|
|
setcharlimittruncatemultilinetextval
|
setcharlimittruncatemultilinetextval | string |
Limite di caratteri per il troncamento su più righe. |
|
|
allowchoicelistvaluesforreuse
|
allowchoicelistvaluesforreuse | string |
Consenti riutilizzo dei valori dell'elenco di scelte. |
|
|
allowscorelistvaluesforreuse
|
allowscorelistvaluesforreuse | string |
Consenti riutilizzo dei valori dell'elenco dei punteggi. |
|
|
allowIsheetComments
|
allowIsheetComments | string |
Consenti commenti in iSheet. |
|
|
shareRecordsLimit
|
shareRecordsLimit | integer |
Limite di record consentiti per la condivisione. |
|
|
shareRecordsLimitEnabled
|
shareRecordsLimitEnabled | integer |
Limite di condivisione record abilitati. |
|
|
enableIsheetAddRecordFormSharing
|
enableIsheetAddRecordFormSharing | string |
Abilitare la condivisione dei moduli per l'aggiunta di record. |
|
|
recordcount
|
recordcount | string |
Conteggio record corrente. |
|
|
sheettypeid
|
sheettypeid | integer |
ID di tipo del foglio iSheet |
|
|
abilitare
|
enable | string |
Abilitare la funzionalità di controllo di qualità. |
|
|
userid
|
userid | integer |
ID utente. |
|
|
posta elettronica
|
string |
indirizzo email. |
||
|
httpavatar
|
httpavatar | string |
URL HTTP dell'avatar. |
|
|
avatar
|
avatar | string |
Immagine avatar. |
|
|
userlink
|
userlink | string |
Collegamento al profilo utente. |
|
|
httplink
|
httplink | string |
Collegamento HTTP al profilo utente. |
|
|
phone
|
phone | string |
Numero di telefono. |
|
|
mobile
|
mobile | string |
Numero di cellulare. |
|
|
dipartimento
|
department | string |
Reparto dell'utente. |
|
|
abilitare
|
enable | string |
Abilitare l'integrazione di Contract Express. |
|
|
adminnote
|
adminnote | string |
Note amministrative relative al sito. |
|
|
startdate
|
startdate | string |
Data di inizio dell'operazione del sito. |
|
|
enddate
|
enddate | string |
Data di fine dell'operazione del sito. |
|
|
createddate
|
createddate | string |
Data di creazione del sito. |
|
|
archiveddate
|
archiveddate | string |
Data di archiviazione del sito. |
|
|
clientno
|
clientno | string |
Numero client associato al sito. |
|
|
matterno
|
matterno | string |
Numero di materia associato al sito. |
|
|
pagina di destinazione
|
landingpage | string |
URL della pagina di destinazione per il sito. |
|
|
link
|
link | string |
Collegamento correlato al sito. |
|
|
status
|
status | string |
Stato corrente del sito. |
|
|
statusid
|
statusid | integer |
Identificatore dello stato del sito. |
|
|
size
|
size | string |
Dimensioni del sito. |
|
|
billingnotes
|
billingnotes | string |
Note relative alla fatturazione per il sito. |
|
|
billingnextinvoicedate
|
billingnextinvoicedate | string |
Data della fattura successiva per il sito. |
|
|
billinglastinvoicedate
|
billinglastinvoicedate | string |
Data dell'ultima fattura per il sito. |
|
|
filepagecount
|
filepagecount | string |
Numero totale di pagine dei file nel sito. |
|
|
maxpagecount
|
maxpagecount | string |
Numero massimo di pagine consentite per i file nel sito. |
|
|
sitehttplink
|
sitehttplink | string |
Collegamento HTTP al sito. |
|
|
isSyncable
|
isSyncable | integer |
Indica se il sito è sincronizzabile. |
|
|
enforceusergroups
|
enforceusergroups | string |
I gruppi di utenti applicati per il sito. |
|
|
csvSiteCategory
|
csvSiteCategory | string |
Categoria del sito in formato CSV. |
|
|
siteNameInDefaultLanguage
|
siteNameInDefaultLanguage | string |
Nome del sito nella lingua predefinita. |
|
|
visibile
|
visible | integer |
Indica se il sito è visibile. |
|
|
siteLogoName
|
siteLogoName | string |
Nome del file logo del sito. |
|
|
siteLogoFileSize
|
siteLogoFileSize | integer |
Dimensioni del file del logo del sito. |
|
|
siteLogoHeight
|
siteLogoHeight | integer |
Altezza del logo del sito. |
|
|
siteLogoWidth
|
siteLogoWidth | integer |
Larghezza del logo del sito. |
|
|
siteStatus
|
siteStatus | integer |
Codice di stato del sito. |
|
|
applySiteTerms
|
applySiteTerms | integer |
Indica se vengono applicate le condizioni del sito. |
|
|
siteTerm
|
siteTerm | string |
Termini applicati al sito. |
|
|
termType
|
termType | integer |
Tipo di termini applicati al sito. |
|
|
nextLoginSiteTerms
|
nextLoginSiteTerms | integer |
Indica se i termini del sito sono necessari all'accesso successivo. |
|
|
defaultSiteTermsEnable
|
defaultSiteTermsEnable | integer |
Indica se i termini predefiniti del sito sono abilitati. |
|
|
advancedQAPermission
|
advancedQAPermission | integer |
Livello di autorizzazione di controllo di qualità avanzato per il sito. |
|
|
isInternal
|
isInternal | integer |
Indica se il sito è interno. |
|
|
Psm
|
psm | integer |
Identificatore di Product Service Manager. |
|
|
siteLabelDisplay
|
siteLabelDisplay | string |
Etichetta di visualizzazione per il sito. |
|
|
allowSiteAdministration
|
allowSiteAdministration | integer |
Indica se l'amministrazione del sito è consentita. |
|
|
siteLevelPasswordEnable
|
siteLevelPasswordEnable | integer |
Per abilitare la protezione password a livello di sito. |
|
|
siteLevelPasscodeEnable
|
siteLevelPasscodeEnable | integer |
Per abilitare la protezione passcode a livello di sito. |
|
|
passcodeUsingAuthApp
|
passcodeUsingAuthApp | integer |
Indica se l'autenticazione passcode usa un'app di autenticazione. |
|
|
sitePassword
|
sitePassword | string |
Password associata al sito. |
|
|
ipRestrictionEnable
|
ipRestrictionEnable | integer |
Per abilitare le restrizioni IP per l'accesso al sito. |
|
|
availableIP
|
availableIP | string |
Elenco delimitato da virgole di indirizzi IP autorizzati ad accedere al sito. |
|
|
highqDrive
|
highqDrive | integer |
Indica se l'integrazione di HighQ Drive è abilitata. |
|
|
applySiteHomePage
|
applySiteHomePage | integer |
Per applicare una home page personalizzata per il sito. |
|
|
siteHomePage
|
siteHomePage | string |
URL della home page personalizzata per il sito. |
|
|
siteHomePageType
|
siteHomePageType | integer |
Tipo della home page. |
|
|
nextLoginSiteHomePage
|
nextLoginSiteHomePage | integer |
Per impostare l'account di accesso successivo alla home page del sito. |
|
|
applyDisplayContent
|
applyDisplayContent | integer |
Per applicare le impostazioni del contenuto di visualizzazione. |
|
|
displayContent
|
displayContent | string |
Contenuto da visualizzare nel sito. |
|
|
rssSecurity
|
rssSecurity | integer |
Livello di sicurezza del feed RSS. |
|
|
encryptedPassword
|
encryptedPassword | integer |
Indica se la password del sito è crittografata. |
|
|
availableIPRangeCSV
|
availableIPRangeCSV | string |
Elenco delimitato da virgole di intervalli di indirizzi IP autorizzati ad accedere al sito. |
|
|
siteModuleID
|
siteModuleID | integer |
Identificatore del modulo del sito. |
|
|
icalSecurity
|
icalSecurity | integer |
Livello di sicurezza del feed iCal. |
|
|
defaultDisplayContent
|
defaultDisplayContent | string |
Contenuto predefinito da visualizzare nel sito. |
|
|
defaultEmailAlert
|
defaultEmailAlert | integer |
Per abilitare gli avvisi di posta elettronica predefiniti. |
|
|
excelReportFooter
|
excelReportFooter | integer |
Include un piè di pagina nei report di Excel. |
|
|
excelReportFooterText
|
excelReportFooterText | string |
Testo da visualizzare nel piè di pagina dei report di Excel. |
|
|
announcementMLJSON
|
announcementMLJSON | string |
Annunci in formato JSON per il sito. |
|
|
templateType
|
templateType | integer |
Tipo di modello usato per il sito. |
|
|
templateLicence
|
templateLicence | integer |
Tipo di licenza per il modello di sito. |
|
|
openChannelAppID
|
openChannelAppID | string |
ID applicazione per l'integrazione del canale aperto. |
|
|
itemid
|
itemid | integer |
Identificatore per l'elemento associato al sito. |
|
|
sitemetadatasheetid
|
sitemetadatasheetid | integer |
ID del foglio di metadati associato al sito. |
|
|
sito personale
|
mysite | boolean |
Indica se si tratta del sito personale dell'utente. |
|
|
lastaccesseddate
|
lastaccesseddate | string |
Data e ora dell'ultimo accesso al sito. |
|
|
defaultViewerMetaDataTab
|
defaultViewerMetaDataTab | integer |
Scheda dei metadati predefinita per il visualizzatore del sito. |
|
|
documentMetadataViewId
|
documentMetadataViewId | integer |
metadati del documento per l'identificatore di visualizzazione. |
|
|
folderMetadataViewId
|
folderMetadataViewId | integer |
metadati della cartella per l'identificatore di visualizzazione. |
|
|
docSort
|
docSort | integer |
Ordinamento dei documenti. |
|
|
folderSort
|
folderSort | integer |
Ordinamento delle cartelle. |
|
|
defaultFolderRenderView
|
defaultFolderRenderView | integer |
Determina la modalità di visualizzazione predefinita per le cartelle. |
|
|
isTaskAttachmentDefault
|
isTaskAttachmentDefault | integer |
Percorso predefinito per gli allegati delle attività. |
|
|
taskAttachmentDefaultFolderId
|
taskAttachmentDefaultFolderId | integer |
Identificatore univoco della cartella designata come percorso predefinito per gli allegati delle attività. |
|
|
favorito
|
favourite | string |
stato preferito. |
|
|
enabledocumentredaction
|
enabledocumentredaction | boolean |
Specifica se la ridistribuzione del documento è abilitata per il sito. |
|
|
menzionigroup
|
mentiongroups | integer |
Gruppi menzionati. |
|
|
enablefilerelationships
|
enablefilerelationships | boolean |
Indica se le relazioni tra file sono abilitate. |
|
|
filerelationshipsitepermissionlevel
|
filerelationshipsitepermissionlevel | integer |
Livello di autorizzazione necessario per gestire le relazioni tra file. |
Aggiungere un gruppo esistente al sito
Questo metodo API aggiunge un gruppo di sistema esistente al sito.
Questa API è stata estesa per aggiungere gruppi di utenti di base di sistema esistenti (di tipo system/org) nel sito.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API
|
version | True | string |
version |
|
ID del sito
|
siteid | True | string |
ID del sito. |
|
ID del gruppo di sistema
|
groupid | True | string |
ID del gruppo di sistema da aggiungere al sito. |
Restituisce
- Corpo
- sitegroup
Aggiungi sito
Usare questa API per creare un nuovo sito. L'oggetto sito supporta solo gli attributi visibili nell'interfaccia del sito di creazione.
Questa API richiede il nome del sito e i campi obbligatori configurati a livello asp, se presenti, per creare un nuovo sito.
Il tag "module" rappresenta un modulo diverso da configurare nel sito, come illustrato negli attributi della richiesta.
Per creare un sito dal modello passando il tag "sitetemplateid"
- Per meno della versione 7, se non viene assegnato alcun modulo ("tag module" non viene passato) nella richiesta, verrà eseguita la configurazione del modulo modello. Se il tag del modulo viene fornito con la configurazione, rispetterà tale valore e verrà configurato come indicato nella richiesta (anziché usare la configurazione del modulo modello)
- Per maggiore della versione 7, se viene assegnato un modulo ("tag module") o meno nella richiesta, verrà eseguita la configurazione del modulo modello.
Questo metodo non supporta il caricamento dell'immagine del sito in questa chiamata, il supporto dell'icona del sito verrà fornito come chiamata separata.
La chiamata al metodo prevede un ID categoria esistente. L'ID categoria deve essere ottenuto dall'applicazione chiamante da una chiamata precedente all'interfaccia Categorie sito.
Se non vengono fornite categorie nella richiesta, per impostazione predefinita non verrà aggiunta alcuna categoria (non effettiva alcuna categoria).
La data di inizio e di fine del sito deve essere nel formato 'gg MMM aaaa' e non è UTC.
Il client API richiederà sempre la data effettiva.
"landingpage" ha un valore predefinito come "file (cartella radice)".
"landingpage" prevede tre diverse formulazioni o identificazioni per il modulo File.
I valori possibili sono:
- file (cartella radice)
- file (attività recente)
- file (ricerca avanzata)
L'implementazione del metodo supporta ora (dalla 5.1 successiva) nomesito multilingue.
L'API versione 6 o un nome< sito superiore >rappresenterà nel corpo della richiesta in base all'ordine delle preferenze utente.
L'API versione 5 o il nome< del sito precedente >rappresenterà l'inglese regno unito predefinito.
<sitenametranslations> rappresenterà i nomi del sito in tutte le lingue (che saranno tag aggiuntivi nell'API "Object stesso" da 5.1 in poi) API versione 6 o successiva, nel corpo della richiesta, inviano entrambi i tag, ad esempio <sitename e >sitenametranslations<>, quindi è necessario convalidare i valori, ad esempio sitename <> deve corrispondere con il rispettivo <tag di traduzione> in termini di preferenza per la lingua dell'utente.
L'API 7 o versione successiva, il sito creato dal modello seguirà i moduli del modello di origine e ignorerà l'elenco dei moduli inviato nel corpo della richiesta.
L'implementazione del metodo supporta ora la creazione di un sito dal modello fornendo il tag "sitetemplateid" (approccio precedente)
Si noti che il supporto per la creazione di un sito dal modello con questa API sarà deprecato in futuro. Per creare un sito dal modello, usare la nuova API Create site from template (/sites/templates/{templateid}/site) che è un'API di polling prolungata (con supporto per le richieste a esecuzione prolungata)
Questo metodo supporta più numeri di materia da aggiungere al sito usando l'API versione 10 e successive.
Il tag "matternos" indica più numeri di materia con sola lettura o meno.
La versione precedente (minore della versione 10) il numero di materia singola "matterno" rifletterà il primo numero di numeri di materia presenti nel sito.
Versione 18 e successive: è necessaria una categoria (scopo del sito).
Se lo scopo del sito è nascosto, viene visualizzato un messaggio; in caso contrario, gli scopi nascosti del sito non vengono aggiunti al sito.
Fino alla versione 17: il proprietario del sito è l'utente connesso; nessun altro utente può essere aggiunto.
Versione 18 successiva: il proprietario del sito può aggiungere altri utenti al sito.
A partire dalla versione 19 dell'API, viene introdotto un nuovo modulo denominato "customPages", strettamente associato al modulo home. Pertanto, se il valore del modulo home è True, customPages sarà true e viceversa.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API richiesta
|
version | True | string |
versione dell'API |
|
id
|
id | integer |
Identificatore del sito. |
|
|
sitename
|
sitename | string |
Il nome del sito. |
|
|
ruolo
|
role | string |
Ruolo del sito. |
|
|
sitedescription
|
sitedescription | string |
Descrizione del sito. |
|
|
enabledmodules
|
enabledmodules | string |
Elenco di moduli abilitati per il sito. |
|
|
sitefolderID
|
sitefolderID | string |
Identificatore della cartella del sito. |
|
|
sitefolderpermission
|
sitefolderpermission | string |
Livello di autorizzazione per la cartella del sito. |
|
|
abilitare
|
enable | string |
Abilitare lo stato per HomeDBO. |
|
|
abilitare
|
enable | string |
Abilitare lo stato per ActivityDBO. |
|
|
microblog
|
microblog | string |
Contenuto del microblog associato a ActivityDBO. |
|
|
docid
|
docid | string |
ID documento. |
|
|
blogTitle
|
blogTitle | string |
Titolo del post di blog. |
|
|
blogContent
|
blogContent | string |
Contenuto del post di blog. |
|
|
showComment
|
showComment | integer |
visualizzare il commento. |
|
|
tagList
|
tagList | array of string |
Elenco di tag associati al blog. |
|
|
status
|
status | integer |
stato del post di blog. |
|
|
siteID
|
siteID | integer |
Identificatore del sito associato. |
|
|
autore
|
author | string |
Autore del blog. |
|
|
categoryList
|
categoryList | array of string |
Categorie assegnate al post di blog. |
|
|
notificationTypeID
|
notificationTypeID | integer |
Identificatore per il tipo di notifica. |
|
|
message
|
message | string |
Contenuto del messaggio correlato al blog. |
|
|
messageCode
|
messageCode | integer |
Codice associato al messaggio. |
|
|
ID esterno
|
externalID | string |
Identificatore esterno collegato al blog. |
|
|
data di pubblicazione
|
publishDate | string |
Data di pubblicazione del blog. |
|
|
processtype
|
processtype | string |
Tipo di processo associato al blog. |
|
|
abilitare
|
enable | string |
Abilitare lo stato per BlogDBO. |
|
|
wikiid
|
wikiid | integer |
Identificatore univoco per il wiki. |
|
|
currentversionid
|
currentversionid | integer |
Identificatore per la versione corrente del wiki |
|
|
parentwikiid
|
parentwikiid | integer |
Identificatore per il wiki padre. |
|
|
wikititle
|
wikititle | string |
Titolo del wiki. |
|
|
wikicontent
|
wikicontent | string |
Contenuto del wiki. |
|
|
showcomment
|
showcomment | integer |
Indica se i commenti sono abilitati. |
|
|
createddate
|
createddate | string |
Data di creazione del wiki. |
|
|
modifieddate
|
modifieddate | string |
Data ultima modifica del wiki. |
|
|
taglist
|
taglist | string |
Elenco delimitato da virgole di tag associati al wiki. |
|
|
Wikipath
|
wikipath | string |
Percorso per accedere al wiki. |
|
|
wikidraftid
|
wikidraftid | integer |
Identificatore per la versione bozza del wiki. |
|
|
drafttype
|
drafttype | string |
Tipo di bozza associata al wiki. |
|
|
status
|
status | integer |
Stato corrente del wiki. |
|
|
wikiversionid
|
wikiversionid | integer |
Identificatore della versione del wiki. |
|
|
index
|
index | string |
Indice o identificatore per l'attività. |
|
|
parenttaskid
|
parenttaskid | integer |
Identificatore per l'attività padre. |
|
|
taskid
|
taskid | integer |
Identificatore univoco per l'attività. |
|
|
title
|
title | string |
Titolo dell'attività. |
|
|
descrizione
|
description | string |
Descrizione dettagliata dell'attività. |
|
|
scadenza
|
duedate | string |
Scadenza per il completamento dell'attività. |
|
|
startdate
|
startdate | string |
Data di inizio dell'avvio dell'attività. |
|
|
mattermaptaskid
|
mattermaptaskid | string |
Identificatore collegato all'attività di mapping della materia. |
|
|
type
|
type | string |
Digitare o categoria dell'attività. |
|
|
dependenton
|
dependenton | string |
Attività da cui dipende questa attività. |
|
|
daysfromdependent
|
daysfromdependent | string |
Numero di giorni dall'attività dipendente. |
|
|
ignoreweekend
|
ignoreweekend | integer |
Indica se i fine settimana vengono ignorati nella pianificazione. |
|
|
duration
|
duration | integer |
Durata per completare l'attività. |
|
|
resource
|
resource | string |
Risorse assegnate all'attività. |
|
|
eventTitle
|
eventTitle | string |
Titolo dell'evento. |
|
|
eventContent
|
eventContent | string |
Contenuto dell'evento. |
|
|
showComment
|
showComment | integer |
Indica se i commenti sono abilitati per l'evento. |
|
|
tagList
|
tagList | array of string |
Elenco di tag associati all'evento. |
|
|
status
|
status | integer |
Stato corrente dell'evento. |
|
|
siteID
|
siteID | integer |
Identificatore del sito. |
|
|
contatto
|
contact | string |
Informazioni di contatto per l'evento. |
|
|
categoryList
|
categoryList | array of string |
Categorie in cui viene elencato l'evento. |
|
|
notificationTypeID
|
notificationTypeID | integer |
Tipo di notifica correlato all'evento. |
|
|
message
|
message | string |
Messaggio dell'evento. |
|
|
messageCode
|
messageCode | integer |
Codice del messaggio dell'evento. |
|
|
ID esterno
|
externalID | string |
Identificatore esterno. |
|
|
startDate
|
startDate | string |
Data di inizio dell'evento. |
|
|
Data di fine
|
endDate | string |
Data di fine dell'evento. |
|
|
startTime
|
startTime | string |
Ora di inizio dell'evento. |
|
|
endTime
|
endTime | string |
Ora di fine dell'evento. |
|
|
ubicazione
|
location | string |
Posizione dell'evento. |
|
|
autore
|
author | string |
Autore dell'evento. |
|
|
processtype
|
processtype | string |
Ora del processo dell'evento. |
|
|
abilitare
|
enable | string |
Abilitare l'evento. |
|
|
id
|
id | integer |
Identificatore univoco per iSheet. |
|
|
title
|
title | string |
Titolo del foglio iSheet. |
|
|
descrizione
|
description | string |
Descrizione del foglio isheet. |
|
|
status
|
status | string |
Stato del foglio isheet. |
|
|
accesstype
|
accesstype | string |
Tipo di accesso del foglio isheet. |
|
|
type
|
type | string |
Tipo del foglio isheet. |
|
|
viewlink
|
viewlink | string |
Collegamento per visualizzare iSheet. |
|
|
consentiszioni
|
allowsections | string |
Indica se le sezioni sono consentite. |
|
|
allowlookup
|
allowlookup | string |
Indica se i campi di ricerca sono abilitati. |
|
|
displayisheet
|
displayisheet | string |
Opzioni di visualizzazione per iSheet. |
|
|
searchasdefaultview
|
searchasdefaultview | string |
Indica se la ricerca è la visualizzazione predefinita. |
|
|
enableversion
|
enableversion | string |
Flag abilitato per il controllo delle versioni. |
|
|
enablesheetalerter
|
enablesheetalerter | string |
Contrassegno per abilitare gli avvisi del foglio. |
|
|
alertercondition
|
alertercondition | string |
Condizioni per l'attivazione degli avvisi. |
|
|
overrideitemmodifieddate
|
overrideitemmodifieddate | string |
Eseguire l'override del flag di data modificato. |
|
|
enablebulkinsertupdate
|
enablebulkinsertupdate | string |
Abilitare l'inserimento/aggiornamento bulk. |
|
|
fielddescriptions
|
fielddescriptions | string |
Descrizioni dei campi per iSheet. |
|
|
enablerowlocking
|
enablerowlocking | string |
Abilitare il blocco a livello di riga. |
|
|
setcharlimittruncatemultilinetextenabled
|
setcharlimittruncatemultilinetextenabled | string |
Tronca il flag di testo su più righe. |
|
|
setcharlimittruncatemultilinetextval
|
setcharlimittruncatemultilinetextval | string |
Limite di caratteri per il troncamento su più righe. |
|
|
allowchoicelistvaluesforreuse
|
allowchoicelistvaluesforreuse | string |
Consenti riutilizzo dei valori dell'elenco di scelte. |
|
|
allowscorelistvaluesforreuse
|
allowscorelistvaluesforreuse | string |
Consenti riutilizzo dei valori dell'elenco dei punteggi. |
|
|
allowIsheetComments
|
allowIsheetComments | string |
Consenti commenti in iSheet. |
|
|
shareRecordsLimit
|
shareRecordsLimit | integer |
Limite di record consentiti per la condivisione. |
|
|
shareRecordsLimitEnabled
|
shareRecordsLimitEnabled | integer |
Limite di condivisione record abilitati. |
|
|
enableIsheetAddRecordFormSharing
|
enableIsheetAddRecordFormSharing | string |
Abilitare la condivisione dei moduli per l'aggiunta di record. |
|
|
recordcount
|
recordcount | string |
Conteggio record corrente. |
|
|
sheettypeid
|
sheettypeid | integer |
ID di tipo del foglio iSheet |
|
|
abilitare
|
enable | string |
Abilitare la funzionalità di controllo di qualità. |
|
|
userid
|
userid | integer |
ID utente. |
|
|
posta elettronica
|
string |
indirizzo email. |
||
|
httpavatar
|
httpavatar | string |
URL HTTP dell'avatar. |
|
|
avatar
|
avatar | string |
Immagine avatar. |
|
|
userlink
|
userlink | string |
Collegamento al profilo utente. |
|
|
httplink
|
httplink | string |
Collegamento HTTP al profilo utente. |
|
|
phone
|
phone | string |
Numero di telefono. |
|
|
mobile
|
mobile | string |
Numero di cellulare. |
|
|
dipartimento
|
department | string |
Reparto dell'utente. |
|
|
abilitare
|
enable | string |
Abilitare l'integrazione di Contract Express. |
|
|
adminnote
|
adminnote | string |
Note amministrative relative al sito. |
|
|
startdate
|
startdate | string |
Data di inizio dell'operazione del sito. |
|
|
enddate
|
enddate | string |
Data di fine dell'operazione del sito. |
|
|
createddate
|
createddate | string |
Data di creazione del sito. |
|
|
archiveddate
|
archiveddate | string |
Data di archiviazione del sito. |
|
|
clientno
|
clientno | string |
Numero client associato al sito. |
|
|
matterno
|
matterno | string |
Numero di materia associato al sito. |
|
|
pagina di destinazione
|
landingpage | string |
URL della pagina di destinazione per il sito. |
|
|
link
|
link | string |
Collegamento correlato al sito. |
|
|
status
|
status | string |
Stato corrente del sito. |
|
|
statusid
|
statusid | integer |
Identificatore dello stato del sito. |
|
|
size
|
size | string |
Dimensioni del sito. |
|
|
billingnotes
|
billingnotes | string |
Note relative alla fatturazione per il sito. |
|
|
billingnextinvoicedate
|
billingnextinvoicedate | string |
Data della fattura successiva per il sito. |
|
|
billinglastinvoicedate
|
billinglastinvoicedate | string |
Data dell'ultima fattura per il sito. |
|
|
filepagecount
|
filepagecount | string |
Numero totale di pagine dei file nel sito. |
|
|
maxpagecount
|
maxpagecount | string |
Numero massimo di pagine consentite per i file nel sito. |
|
|
sitehttplink
|
sitehttplink | string |
Collegamento HTTP al sito. |
|
|
isSyncable
|
isSyncable | integer |
Indica se il sito è sincronizzabile. |
|
|
enforceusergroups
|
enforceusergroups | string |
I gruppi di utenti applicati per il sito. |
|
|
csvSiteCategory
|
csvSiteCategory | string |
Categoria del sito in formato CSV. |
|
|
siteNameInDefaultLanguage
|
siteNameInDefaultLanguage | string |
Nome del sito nella lingua predefinita. |
|
|
visibile
|
visible | integer |
Indica se il sito è visibile. |
|
|
siteLogoName
|
siteLogoName | string |
Nome del file logo del sito. |
|
|
siteLogoFileSize
|
siteLogoFileSize | integer |
Dimensioni del file del logo del sito. |
|
|
siteLogoHeight
|
siteLogoHeight | integer |
Altezza del logo del sito. |
|
|
siteLogoWidth
|
siteLogoWidth | integer |
Larghezza del logo del sito. |
|
|
siteStatus
|
siteStatus | integer |
Codice di stato del sito. |
|
|
applySiteTerms
|
applySiteTerms | integer |
Indica se vengono applicate le condizioni del sito. |
|
|
siteTerm
|
siteTerm | string |
Termini applicati al sito. |
|
|
termType
|
termType | integer |
Tipo di termini applicati al sito. |
|
|
nextLoginSiteTerms
|
nextLoginSiteTerms | integer |
Indica se i termini del sito sono necessari all'accesso successivo. |
|
|
defaultSiteTermsEnable
|
defaultSiteTermsEnable | integer |
Indica se i termini predefiniti del sito sono abilitati. |
|
|
advancedQAPermission
|
advancedQAPermission | integer |
Livello di autorizzazione di controllo di qualità avanzato per il sito. |
|
|
isInternal
|
isInternal | integer |
Indica se il sito è interno. |
|
|
Psm
|
psm | integer |
Identificatore di Product Service Manager. |
|
|
siteLabelDisplay
|
siteLabelDisplay | string |
Etichetta di visualizzazione per il sito. |
|
|
allowSiteAdministration
|
allowSiteAdministration | integer |
Indica se l'amministrazione del sito è consentita. |
|
|
siteLevelPasswordEnable
|
siteLevelPasswordEnable | integer |
Per abilitare la protezione password a livello di sito. |
|
|
siteLevelPasscodeEnable
|
siteLevelPasscodeEnable | integer |
Per abilitare la protezione passcode a livello di sito. |
|
|
passcodeUsingAuthApp
|
passcodeUsingAuthApp | integer |
Indica se l'autenticazione passcode usa un'app di autenticazione. |
|
|
sitePassword
|
sitePassword | string |
Password associata al sito. |
|
|
ipRestrictionEnable
|
ipRestrictionEnable | integer |
Per abilitare le restrizioni IP per l'accesso al sito. |
|
|
availableIP
|
availableIP | string |
Elenco delimitato da virgole di indirizzi IP autorizzati ad accedere al sito. |
|
|
highqDrive
|
highqDrive | integer |
Indica se l'integrazione di HighQ Drive è abilitata. |
|
|
applySiteHomePage
|
applySiteHomePage | integer |
Per applicare una home page personalizzata per il sito. |
|
|
siteHomePage
|
siteHomePage | string |
URL della home page personalizzata per il sito. |
|
|
siteHomePageType
|
siteHomePageType | integer |
Tipo della home page. |
|
|
nextLoginSiteHomePage
|
nextLoginSiteHomePage | integer |
Per impostare l'account di accesso successivo alla home page del sito. |
|
|
applyDisplayContent
|
applyDisplayContent | integer |
Per applicare le impostazioni del contenuto di visualizzazione. |
|
|
displayContent
|
displayContent | string |
Contenuto da visualizzare nel sito. |
|
|
rssSecurity
|
rssSecurity | integer |
Livello di sicurezza del feed RSS. |
|
|
encryptedPassword
|
encryptedPassword | integer |
Indica se la password del sito è crittografata. |
|
|
availableIPRangeCSV
|
availableIPRangeCSV | string |
Elenco delimitato da virgole di intervalli di indirizzi IP autorizzati ad accedere al sito. |
|
|
siteModuleID
|
siteModuleID | integer |
Identificatore del modulo del sito. |
|
|
icalSecurity
|
icalSecurity | integer |
Livello di sicurezza del feed iCal. |
|
|
defaultDisplayContent
|
defaultDisplayContent | string |
Contenuto predefinito da visualizzare nel sito. |
|
|
defaultEmailAlert
|
defaultEmailAlert | integer |
Per abilitare gli avvisi di posta elettronica predefiniti. |
|
|
excelReportFooter
|
excelReportFooter | integer |
Include un piè di pagina nei report di Excel. |
|
|
excelReportFooterText
|
excelReportFooterText | string |
Testo da visualizzare nel piè di pagina dei report di Excel. |
|
|
announcementMLJSON
|
announcementMLJSON | string |
Annunci in formato JSON per il sito. |
|
|
templateType
|
templateType | integer |
Tipo di modello usato per il sito. |
|
|
templateLicence
|
templateLicence | integer |
Tipo di licenza per il modello di sito. |
|
|
openChannelAppID
|
openChannelAppID | string |
ID applicazione per l'integrazione del canale aperto. |
|
|
itemid
|
itemid | integer |
Identificatore per l'elemento associato al sito. |
|
|
sitemetadatasheetid
|
sitemetadatasheetid | integer |
ID del foglio di metadati associato al sito. |
|
|
sito personale
|
mysite | boolean |
Indica se si tratta del sito personale dell'utente. |
|
|
lastaccesseddate
|
lastaccesseddate | string |
Data e ora dell'ultimo accesso al sito. |
|
|
defaultViewerMetaDataTab
|
defaultViewerMetaDataTab | integer |
Scheda dei metadati predefinita per il visualizzatore del sito. |
|
|
documentMetadataViewId
|
documentMetadataViewId | integer |
metadati del documento per l'identificatore di visualizzazione. |
|
|
folderMetadataViewId
|
folderMetadataViewId | integer |
metadati della cartella per l'identificatore di visualizzazione. |
|
|
docSort
|
docSort | integer |
Ordinamento dei documenti. |
|
|
folderSort
|
folderSort | integer |
Ordinamento delle cartelle. |
|
|
defaultFolderRenderView
|
defaultFolderRenderView | integer |
Determina la modalità di visualizzazione predefinita per le cartelle. |
|
|
isTaskAttachmentDefault
|
isTaskAttachmentDefault | integer |
Percorso predefinito per gli allegati delle attività. |
|
|
taskAttachmentDefaultFolderId
|
taskAttachmentDefaultFolderId | integer |
Identificatore univoco della cartella designata come percorso predefinito per gli allegati delle attività. |
|
|
favorito
|
favourite | string |
stato preferito. |
|
|
enabledocumentredaction
|
enabledocumentredaction | boolean |
Specifica se la ridistribuzione del documento è abilitata per il sito. |
|
|
menzionigroup
|
mentiongroups | integer |
Gruppi menzionati. |
|
|
enablefilerelationships
|
enablefilerelationships | boolean |
Indica se le relazioni tra file sono abilitate. |
|
|
filerelationshipsitepermissionlevel
|
filerelationshipsitepermissionlevel | integer |
Livello di autorizzazione necessario per gestire le relazioni tra file. |
Restituisce
- Corpo
- site
Aggiungi utente
Questa chiamata API viene usata per aggiungere un nuovo utente al sistema.
Nota:
1. Aggiunta del supporto per i nuovi campi seguenti
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirth
2. Il tag indirizzo è stato aggiunto nell'API versione 4
| Sommario | Codice di riferimento (prima della versione 4) | Codice di riferimento (V4) |
|
L'indirizzo di posta elettronica è obbligatorio |
101 | 101 |
|
Indirizzo di posta elettronica non valido |
104 | 104 |
|
Il nome è obbligatorio |
102 | 102 |
|
Il numero massimo di caratteri consentiti per il nome deve essere compreso tra 1 e 100 |
102 | 352 |
|
L'indirizzo di posta elettronica del segretario/assistente non è valido |
104 | 353 |
|
Lo stato deve essere attivo o inattivo |
116 | 116 |
|
Il reparto immesso non può contenere più di 256 caratteri |
N/A | 354 |
|
Attributo ifpartner immesso non valido |
N/A | 355 |
|
L'attributo systemuser immesso non è valido |
N/A | 356 |
|
L'attributo usertypeid immesso non è valido |
N/A | 357 |
|
L'attributo langcode immesso non è valido |
N/A | 358 |
|
L'attributo sourcetype immesso non è valido. I valori validi sono System, Active Directory o System default . |
N/A | 359 |
|
Immettere il numero di telefono valido |
N/A | 360 |
|
Immettere il numero di telefono valido nel formato {countrycode} ${areacode}${number}. |
N/A | 361 |
|
Immettere un numero di cellulare valido nel formato {countrycode}${number}. |
N/A | 362 |
|
Immettere un codice paese di telefono dell'ufficio valido |
N/A | 363 |
|
Il codice paese dell'ufficio può avere un massimo di 4 cifre |
N/A | 364 |
|
Immettere un codice per l'area di telefono dell'ufficio valido |
N/A | 365 |
|
Il codice dell'area telefonica dell'ufficio può avere un massimo di 5 cifre |
N/A | 366 |
|
Il numero di telefono dell'ufficio deve avere un massimo di 15 cifre |
N/A | 368 |
|
Immettere un codice paese di telefono cellulare valido |
N/A | 369 |
|
Il codice paese del telefono cellulare può avere un massimo di 4 cifre |
N/A | 372 |
|
Immettere un numero di cellulare valido |
N/A | 373 |
|
Il numero di telefono cellulare deve avere un massimo di 20 cifre |
N/A | 374 |
|
Il dominio non esiste |
105 | 105 |
|
La posta elettronica esiste già nel sistema |
111 | 111 |
|
Menzionare l'organizzazione in caso di dominio autoregistrato |
187 | 187 |
|
Menzionare l'organizzazione nel caso di un dominio eccezionale |
115 | 115 |
|
L'ID organizzazione non è nel formato corretto |
112 | 112 |
|
L'organizzazione non esiste |
106 | 106 |
|
Il dominio esiste in un'altra organizzazione |
114 | 114 |
|
ID indirizzo immesso non valido |
N/A | 308 |
|
Nome del collegamento social non trovato nel sistema. |
N/A | 375 |
|
Il nome del collegamento di social networking è obbligatorio |
N/A | 376 |
|
Il valore del collegamento sociale è obbligatorio |
N/A | 377 |
|
Il numero massimo di caratteri per il valore del collegamento di social networking deve essere compreso tra 1 e 500 |
N/A | 378 |
|
Immettere il nome per il collegamento personalizzato |
N/A | 379 |
|
Valore del collegamento personalizzato obbligatorio |
N/A | 380 |
|
Il numero massimo di caratteri per il nome del collegamento personalizzato deve essere compreso tra 1 e 500 |
N/A | 381 |
|
Il numero massimo di caratteri per il valore del collegamento personalizzato deve essere compreso tra 1 e 500 |
N/A | 382 |
|
Nome del collegamento del messaggio obbligatorio |
N/A | 383 |
|
Nome del collegamento del messaggio non trovato nel sistema |
N/A | 384 |
|
Valore del collegamento al messaggio obbligatorio |
N/A | 385 |
|
Il numero massimo di caratteri per il valore del collegamento di messaggio deve essere compreso tra 1 e 500 |
N/A | 386 |
|
Il collegamento social è disabilitato |
N/A | 408 |
|
Il collegamento al messaggio è disabilitato |
N/A | 409 |
|
Il collegamento personalizzato è disabilitato |
N/A | 410 |
Ticket JIRA : https://dev.highq.com/jira/browse/COL-65685
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API
|
version | True | string |
versione dell'API |
|
index
|
index | integer |
Indice univoco per l'utente. |
|
|
userid
|
userid | integer |
Identificatore univoco dell’utente. |
|
|
firstname
|
firstname | string |
Nome dell'utente. |
|
|
lastname
|
lastname | string |
Cognome dell'utente. |
|
|
practicegroup
|
practicegroup | string |
Gruppo di pratiche a cui appartiene l'utente. |
|
|
langcode
|
langcode | string |
Codice linguistico dell'utente. |
|
|
localeID
|
localeID | string |
ID delle impostazioni locali dell'utente. |
|
|
publicprofile
|
publicprofile | string |
Profilo pubblico dell'utente. |
|
|
pwpid
|
pwpid | string |
ID PWP dell'utente. |
|
|
usertypeid
|
usertypeid | string |
ID tipo utente. |
|
|
systemuser
|
systemuser | string |
Flag utente di sistema. |
|
|
posta elettronica
|
string |
Email indirizzo dell'utente. |
||
|
phone
|
phone | string |
Numero di telefono dell'utente. |
|
|
mobile
|
mobile | string |
Numero di cellulare dell'utente. |
|
|
dipartimento
|
department | string |
Reparto dell'utente. |
|
|
Org
|
org | string |
L'organizzazione a cui appartiene l'utente. |
|
|
addressline1
|
addressline1 | string |
Prima riga dell'indirizzo. |
|
|
addressline2
|
addressline2 | string |
Seconda riga dell'indirizzo. |
|
|
addressline3
|
addressline3 | string |
Terza riga dell'indirizzo. |
|
|
city
|
city | string |
Città dell'indirizzo. |
|
|
state
|
state | string |
Stato dell'indirizzo. |
|
|
country
|
country | string |
Paese dell'indirizzo. |
|
|
codice postale
|
postcode | string |
Codice postale dell'indirizzo. |
|
|
addressid
|
addressid | string |
Identificatore univoco per l'indirizzo. |
|
|
addressline1
|
addressline1 | string |
Prima riga dell'indirizzo. |
|
|
addressline2
|
addressline2 | string |
Seconda riga dell'indirizzo. |
|
|
addressline3
|
addressline3 | string |
Terza riga dell'indirizzo. |
|
|
city
|
city | string |
Città dell'indirizzo. |
|
|
state
|
state | string |
Stato dell'indirizzo. |
|
|
country
|
country | string |
Paese dell'indirizzo. |
|
|
codice postale
|
postCode | string |
Codice postale dell'indirizzo. |
|
|
knownas
|
knownas | string |
Nome alternativo o nome alternativo per l'indirizzo. |
|
|
esperienza
|
experience | array of string | ||
|
id
|
id | string |
ID collegamento |
|
|
nome
|
name | string |
Nome collegamento. |
|
|
value
|
value | string |
Valore collegamento. |
|
|
id
|
id | string |
ID collegamento |
|
|
nome
|
name | string |
Nome collegamento. |
|
|
value
|
value | string |
Valore collegamento. |
|
|
id
|
id | string |
ID collegamento |
|
|
nome
|
name | string |
Nome collegamento. |
|
|
value
|
value | string |
Valore collegamento. |
|
|
img
|
img | string | ||
|
reportto
|
reportsto | string | ||
|
metadataname
|
metadataname | array of string | ||
|
metadatavalue
|
metadatavalue | array of string | ||
|
group
|
group | array of string | ||
|
externalid
|
externalid | string |
ID esterno dell'utente. |
|
|
jobtitle
|
jobtitle | string |
Titolo del processo dell'utente. |
|
|
secretaryname
|
secretaryname | string |
Nome della segretaria dell'utente. |
|
|
segretaria
|
secretarymail | string |
Indirizzo di posta elettronica della segretaria dell'utente. |
|
|
Specialità
|
specialities | string |
Specialità dell'utente. |
|
|
title
|
title | string |
Titolo dell'utente. |
|
|
goesby
|
goesby | string |
nome preferito dell'utente. |
|
|
suffisso
|
suffix | string |
Suffisso del nome dell'utente. |
|
|
atomlink
|
atomlink | string |
Collegamento Atom associato all'utente. |
|
|
bio
|
bio | string |
Biografia dell'utente. |
|
|
dateOfBirth
|
dateOfBirth | string |
Data di nascita dell'utente. |
|
|
link
|
link | string |
Collegamento associato all'utente. |
|
|
status
|
status | string |
Stato dell'utente. |
|
|
codice di stato
|
statuscode | string |
Codice di stato dell'utente. |
|
|
message
|
message | string |
Messaggio associato all'utente. |
|
|
sourcetype
|
sourcetype | string |
Tipo di origine dell'utente. |
|
|
orgid
|
orgid | string |
ID organizzazione. |
|
|
ifpartner
|
ifpartner | string |
Flag partner. |
|
|
emaildomain
|
emaildomain | string |
Dominio di posta elettronica dell'utente. |
|
|
invitationsent
|
invitationsent | string |
Flag di invito inviato. |
|
|
creato da
|
createdby | string |
Utente che ha creato il record. |
|
|
createddate
|
createddate | string |
Data di creazione del record. |
|
|
modificatoda
|
modifiedby | string |
Utente che ha modificato il record. |
|
|
modifieddate
|
modifieddate | string |
Data di modifica del record. |
|
|
lastlogindate
|
lastlogindate | string |
Data dell'ultimo account di accesso. |
|
|
invalidlogins
|
invalidlogins | string |
Numero di tentativi di accesso non validi. |
|
|
publicwebsiteprofileid
|
publicwebsiteprofileid | string |
ID profilo sito Web pubblico. |
|
|
resetpassworddate
|
resetpassworddate | string |
Data di reimpostazione della password. |
|
|
avatar
|
avatar | string |
URL immagine avatar. |
|
|
followingcount
|
followingcount | integer |
Numero di utenti seguiti. |
|
|
followercount
|
followercount | integer |
Conteggio dei follower. |
|
|
seguente
|
following | boolean |
Flag seguente. |
|
|
ruolo
|
role | string |
Ruolo dell'utente. |
|
|
isbasicuser
|
isbasicuser | string |
Flag utente di base. |
|
|
encryptedUserId
|
encryptedUserId | string |
ID utente crittografato. |
|
|
selfregistered
|
selfregistered | integer |
Flag autoregistrato. |
|
|
registeredWith2FA
|
registeredWith2FA | string |
Flag di registrazione dell'autenticazione a due fattori. |
|
|
isInternal
|
isInternal | integer |
Flag utente interno. |
|
|
orgName
|
orgName | string |
Il nome dell'organizzazione. |
Restituisce
- Corpo
- IntegrationUserDBO
Archivio utente
Questa chiamata API viene usata per archiviare un utente all'interno del sistema.
Codici di errore
| Sommario | Codice di riferimento (prima della versione 4) | Codice di riferimento (V4) |
|
Gli utenti seguenti non esistono all'interno del sistema |
110 | 110 |
|
È necessario un ID utente |
109 | 109 |
|
L'ID utente non è nel formato corretto |
113 | 113 |
|
La lunghezza dell'ID dell'utente non può superare i 50 caratteri |
N/A | 304 |
Ticket JIRA : https://dev.highq.com/jira/browse/COL-67441
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API
|
version | True | string |
versione dell'API |
|
ID utente
|
userid | True | string |
ID utente |
Caricare un file
Questa chiamata API carica un file in una cartella specificata nella piattaforma HighQ Collaborate. Supporta i caricamenti in blocchi quando viene fornita l'intestazione Content-Range.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API
|
version | True | string |
Specifica la versione dell'API in uso. |
|
File da caricare
|
file | True | file |
Specifica il file da caricare. |
|
ID cartella padre
|
parentfolderid | True | string |
Specifica l'ID univoco della cartella padre in cui verrà caricato il file. |
|
Eseguire l'override del flag duplicato
|
overrideduplicate | boolean |
Indica se è necessario eseguire l'override dei caricamenti di file duplicati. |
|
|
Nome documento
|
filename | True | string |
Specifica il nome del documento. |
|
Nota sulla versione
|
versionnote | string |
Fornisce una nota che descrive la versione del file. |
|
|
Chiave dell'operazione progressiva
|
progressiveoperkey | string |
Specifica la chiave utilizzata per le operazioni progressive durante il caricamento del file. |
|
|
Nome database servizio Migrazione del database
|
dmsdatabasename | string |
Specifica il nome del database del sistema di gestione documenti. |
|
|
Data di modifica del Servizio Migrazione del database
|
dmseditdate | string |
Specifica la data di modifica registrata nel sistema di gestione dei documenti. |
|
|
ID cartella padre del Servizio Migrazione del database
|
dmsparentfolderid | string |
Specifica l'ID univoco della cartella padre nel sistema di gestione documenti. |
|
|
ID documento del Servizio Migrazione del database
|
dmsdocid | string |
Specifica l'ID univoco del documento nel sistema di gestione dei documenti. |
|
|
Versione del documento del Servizio Migrazione del database
|
dmsversion | string |
Specifica la versione del documento registrato nel sistema di gestione dei documenti. |
|
|
Dettagli notifica
|
notification | string |
Fornisce informazioni dettagliate su eventuali notifiche da inviare al caricamento di file. |
|
|
Batch ID
|
batchid | string |
Specifica l'ID univoco dell'operazione batch. |
|
|
ID cartella radice
|
rootfolderid | string |
Specifica l'ID univoco della cartella radice. |
Crea cartella
Questa API crea una nuova cartella all'interno del sito specificato. Consente di specificare i dettagli della cartella e di assicurarsi che la cartella venga creata nella cartella padre specificata.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API
|
version | True | string |
Specifica la versione dell'API. |
|
Identificatore batch
|
batchid | string |
Identificatore univoco per l'operazione batch. |
|
|
ID cartella radice
|
rootfolderid | string |
Identificatore univoco della cartella radice. |
|
|
ID cartella padre
|
parentfolderid | True | string |
Identificatore univoco della cartella padre in cui verrà creata la nuova cartella. |
|
Consenti cartella duplicata
|
allowduplicatefolder | boolean |
Indica se le cartelle duplicate sono consentite nella cartella padre specificata. |
|
|
nome
|
name | True | string |
Nome della cartella. |
|
descrizione
|
description | string |
Descrizione della cartella. |
|
|
accessInherited
|
accessInherited | integer |
Indica se l'accesso alla cartella viene ereditato. |
|
|
batchID
|
batchID | string |
Identificatore del batch per l'operazione. |
|
|
dmsfolderid
|
dmsfolderid | string |
Identificatore della cartella DMS. |
|
|
dmsParentFolderID
|
dmsParentFolderID | string |
Identificatore della cartella padre del Servizio Migrazione del database. |
|
|
dmscreateddate
|
dmscreateddate | date-time |
Data di creazione della cartella Servizio Migrazione del database. |
|
|
dmsmodifiedBy
|
dmsmodifiedBy | string |
Utente che ha modificato l'ultima cartella del Servizio Migrazione del database. |
|
|
dmsdatabasename
|
dmsdatabasename | string |
Nome del database del Servizio Migrazione del database. |
|
|
dmslink
|
dmslink | boolean |
Indica se è disponibile un collegamento dms. |
|
|
dmslinkby
|
dmslinkby | string |
Utente che ha collegato la cartella DMS. |
|
|
emailmetadata
|
emailmetadata | string |
Metadati di posta elettronica associati alla cartella. |
Restituisce
- Corpo
- FolderDBOV1
Ottenere informazioni sulla cartella
Il metodo fornisce i dettagli della cartella dell'ID cartella specificato.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API
|
version | True | string |
versione dell'API |
|
ID cartella
|
folderid | True | string |
folderID |
|
Informazioni sullo stato
|
statusinfo | boolean |
Il parametro statusinfo consente di accedere a informazioni aggiuntive sulla cartella. Le informazioni disponibili includono Stato condiviso, Stato preferito per l'utente connesso |
Restituisce
- Corpo
- FolderDBOV2
Per creare l'elemento iSheet
Questa chiamata API viene usata per inserire l'elemento iSheet. È possibile supportare più iSheet.
Per ottenere lo stato di un elemento iSheet basato su una chiave progressiva, chiamare API POST /api/3/progressivekeystatus/{progressive_key}
ad esempio POST /api/{version}/progressivekeystatus/{progressive_key}| Nome | TIPO | Description |
|---|---|---|
| progressive_key | String | Chiave per controllare lo stato dell'azione. |
risposta
<progressivekeyresponse>
\t<elementi>
\t\t<item>
\t\t\t<itemid>1232</itemid>
\t\t\t<status>SUCCESS</status>
\t\t\t<statuscode>200</statuscode>
\t\t\t<message>Record aggiunto correttamente</messaggio>
\t\t</item>
\t\t<item>
\t\t\t<itemid>1233</itemid>
\t\t\t<status>SUCCESS</status>
\t\t\t<statuscode>200</statuscode>
\t\t\t<message>Record aggiunto correttamente</messaggio>
\t\t</item>
\t</items>
</progressivekeyresponse>
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API
|
version | True | string |
Versione dell'API |
|
Identificatore iSheet
|
isheetid | True | integer |
ID del foglio iSheet |
|
Identificatore visualizzazione foglio
|
sheetviewid | integer |
ID della visualizzazione iSheet (facoltativo) |
|
|
id
|
id | integer |
Identificatore foglio Isheet. |
|
|
title
|
title | string |
Titolo del foglio. |
|
|
descrizione
|
description | string |
Descrizione del foglio. |
|
|
status
|
status | string |
Stato del foglio. |
|
|
accesstype
|
accesstype | string |
Tipo di accesso del foglio. |
|
|
type
|
type | string |
Tipo del foglio. |
|
|
viewlink
|
viewlink | string |
Collegamento URL per visualizzare il foglio. |
|
|
consentiszioni
|
allowsections | string |
Indica se le sezioni sono consentite. |
|
|
allowlookup
|
allowlookup | string |
Indica se la ricerca è consentita. |
|
|
displayisheet
|
displayisheet | string |
Visualizza isheet. |
|
|
searchasdefaultview
|
searchasdefaultview | string |
Imposta la ricerca come visualizzazione predefinita. |
|
|
enableversion
|
enableversion | string |
Abilitare la versione. |
|
|
enablesheetalerter
|
enablesheetalerter | string |
Attiva l'avviso del foglio. |
|
|
alertercondition
|
alertercondition | string |
Condizione per l'attivazione degli avvisi. |
|
|
overrideitemmodifieddate
|
overrideitemmodifieddate | string |
Over ride è la data di modifica dell'elemento. |
|
|
enablebulkinsertupdate
|
enablebulkinsertupdate | string |
Consenti aggiornamento inserimento bulk. |
|
|
fielddescriptions
|
fielddescriptions | string |
descrizione per i campi. |
|
|
enablerowlocking
|
enablerowlocking | string |
Abilita il blocco delle righe. |
|
|
setcharlimittruncatemultilinetextenabled
|
setcharlimittruncatemultilinetextenabled | string |
Abilita il troncamento del limite di caratteri per il testo su più righe. |
|
|
setcharlimittruncatemultilinetextval
|
setcharlimittruncatemultilinetextval | string |
imposta il limite di caratteri per il troncamento. |
|
|
allowchoicelistvaluesforreuse
|
allowchoicelistvaluesforreuse | string |
Consente il riutilizzo dei valori dell'elenco di scelte. |
|
|
allowscorelistvaluesforreuse
|
allowscorelistvaluesforreuse | string |
Consente il riutilizzo dei valori dell'elenco di punteggi. |
|
|
allowIsheetComments
|
allowIsheetComments | string |
Consente commenti sul foglio. |
|
|
shareRecordsLimit
|
shareRecordsLimit | integer |
Limite per i record condivisi. |
|
|
shareRecordsLimitEnabled
|
shareRecordsLimitEnabled | integer |
Abilitare il limite di record di condivisione. |
|
|
enableIsheetAddRecordFormSharing
|
enableIsheetAddRecordFormSharing | string |
Abilita la condivisione del modulo aggiungi record. |
|
|
allowViewBaseRendering
|
allowViewBaseRendering | string |
Consente il rendering di base delle visualizzazioni. |
|
|
colonna
|
column | object | ||
|
recordcount
|
recordcount | string |
Numero totale di record. |
|
|
viewId
|
viewId | integer |
Identificatore univoco per la visualizzazione. |
|
|
siteId
|
siteId | integer |
Identificatore del sito associato. |
|
|
siteName
|
siteName | string |
Nome del sito. |
|
|
sheetName
|
sheetName | string |
Nome del foglio. |
|
|
viewName
|
viewName | string |
Nome della visualizzazione. |
|
|
sheetId
|
sheetId | integer |
Identificatore del foglio. |
|
|
sequenza
|
sequence | string |
Numero di sequenza della colonna di intestazione. |
|
|
columnValue
|
columnValue | string |
Valore della colonna di intestazione. |
|
|
columnTypeId
|
columnTypeId | string |
Identificatore per il tipo di colonna. |
|
|
columnId
|
columnId | string |
Identificatore univoco per la colonna. |
|
|
columnTypeAlias
|
columnTypeAlias | string |
Nome alias per il tipo di colonna. |
|
|
itemsequence
|
itemsequence | string |
Numero di sequenza dell'elemento. |
|
|
itemid
|
itemid | string |
Identificatore univoco per l'elemento. |
|
|
externalid
|
externalid | string |
Identificatore esterno associato all'elemento. |
|
|
columnid
|
columnid | integer |
Identificatore univoco per la colonna |
|
|
nome
|
name | string |
Nome della colonna |
|
|
type
|
type | integer |
Tipo di dati della colonna. |
|
|
systemgeneratedtype
|
systemgeneratedtype | string |
Informazioni sul tipo generate dal sistema. |
|
|
section
|
section | integer |
Numero di sezione in cui si trova la colonna. |
|
|
descrizione
|
description | string |
Descrizione dettagliata della colonna. |
|
|
addtodefaultview
|
addtodefaultview | string |
Indica se la colonna viene aggiunta alla visualizzazione predefinita. |
|
|
columnconditionstate
|
columnconditionstate | string |
Stato della condizione della colonna. |
|
|
rowid
|
rowid | integer |
Identificatore della riga. |
|
|
columnid
|
columnid | integer |
Identificatore della colonna. |
|
|
operatorid
|
operatorid | integer |
Identificatore per l'operatore. |
|
|
oprand
|
oprand | string |
Valore dell'operando per il filtro. |
|
|
logicaltype
|
logicaltype | string |
Tipo logico del filtro. |
|
|
sheetfiltervaluetypeid
|
sheetfiltervaluetypeid | string |
ID per il tipo di valore del filtro foglio. |
|
|
displaytype
|
displaytype | string |
Tipo di visualizzazione del filtro. |
|
|
sourceColumnId
|
sourceColumnId | integer |
ID colonna di origine per il filtro. |
|
|
scoreConditionTypeid
|
scoreConditionTypeid | integer |
ID per il tipo di condizione del punteggio. |
|
|
defaultvalue
|
defaultvalue | string |
Valore predefinito per la colonna. |
|
|
columnwidth
|
columnwidth | string |
Larghezza della colonna. |
|
|
sheetname
|
sheetname | string |
Nome del foglio associato. |
|
|
sitename
|
sitename | string |
Nome del sito. |
|
|
obbligatorio
|
mandatory | string |
Indica se la colonna è obbligatoria. |
|
|
allowsearch
|
allowsearch | string |
Specifica se la ricerca è consentita. |
|
|
maxchars
|
maxchars | integer |
Numero massimo di caratteri. |
|
|
allowfieldfromanotherisheet
|
allowfieldfromanotherisheet | string |
Consente il campo da un altro foglio. |
|
|
allowrichhtmltext
|
allowrichhtmltext | string |
Specifica se è consentito il testo RTF. |
|
|
numberoflines
|
numberoflines | integer |
Numero di righe nella colonna. |
|
|
displaymethod
|
displaymethod | string |
Metodo utilizzato per visualizzare la colonna. |
|
|
includeotheroption
|
includeotheroption | string |
Include un'opzione 'Altro'. |
|
|
singleormultileselectioninsearch
|
singleormultileselectioninsearch | string |
Specifica il tipo di selezione nella ricerca. |
|
|
id
|
id | string |
Identificatore univoco per la scelta." |
|
|
label
|
label | string |
Etichetta per la scelta. |
|
|
Punteggio
|
score | string |
Punteggio associato alla scelta. |
|
|
color
|
color | string |
Codice colore per la scelta. |
|
|
imageid
|
imageid | integer |
ID dell'immagine associata. |
|
|
includeinalertpreferences
|
includeinalertpreferences | string |
Include nelle preferenze di avviso. |
|
|
min
|
min | string |
Valore minimo per la colonna. |
|
|
massimo
|
max | string |
Valore massimo per la colonna. |
|
|
decimalplaces
|
decimalplaces | integer |
Numero di posizioni decimali. |
|
|
showthousandseparators
|
showthousandseparators | string |
Visualizza i separatori delle migliaia. |
|
|
showaspercentage
|
showaspercentage | string |
Visualizza il valore come percentuale. |
|
|
formattype
|
formattype | string |
Specifica il tipo di formato della colonna. |
|
|
dateformat
|
dateformat | string |
Definisce il formato della data per la colonna. |
|
|
defaultdateandtime
|
defaultdateandtime | string |
Imposta il valore di data e ora predefinito per la colonna. |
|
|
sheetlookup
|
sheetlookup | string |
Indica se la colonna è una ricerca in un altro foglio. |
|
|
fielddisplay
|
fielddisplay | string |
Determina la modalità di visualizzazione del campo. |
|
|
allowmultipleusers
|
allowmultipleusers | string |
Specifica se più utenti possono accedere al campo. |
|
|
methodtype
|
methodtype | string |
Definisce il tipo di metodo per la colonna. |
|
|
sheetids
|
sheetids | string |
Elenca gli ID dei fogli associati alla colonna. |
|
|
allowuserstorenamelinks
|
allowuserstorenamelinks | string |
Indica se gli utenti possono rinominare i collegamenti nella colonna. |
|
|
sheetid
|
sheetid | integer |
Specifica l'ID del foglio. |
|
|
columnid
|
columnids | string |
Elenca gli ID delle colonne. |
|
|
viewid
|
viewid | integer |
Specifica l'ID della visualizzazione. |
|
|
allowmultiplevalues
|
allowmultiplevalues | string |
Indica se nella colonna sono consentiti più valori. |
|
|
restrictdelete
|
restrictdelete | string |
Specifica se l'eliminazione è limitata per la colonna. |
|
|
displaycolumnnameprefix
|
displaycolumnnameprefix | string |
Imposta il prefisso per la visualizzazione del nome della colonna. |
|
|
linkname
|
linkname | string |
Definisce il nome del collegamento associato alla colonna. |
|
|
donotcountweekendsonlycountmontofri
|
donotcountweekendsonlycountmontofri | string |
Specifica se i fine settimana vengono esclusi nel conteggio. |
|
|
currentsheetcolumnid
|
currentsheetcolumnid | integer |
ID della colonna del foglio corrente. |
|
|
targetsheetcolumnid
|
targetsheetcolumnid | integer |
ID della colonna del foglio di destinazione. |
|
|
formula
|
formula | string |
Specifica la formula applicata alla colonna. |
|
|
startvalue
|
startvalue | integer |
Imposta il valore iniziale per la colonna. |
|
|
prefix
|
prefix | string |
Definisce il prefisso per i valori di colonna. |
|
|
Postfix
|
postfix | string |
Definisce il suffisso per i valori di colonna. |
|
|
minlength
|
minlength | integer |
Specifica la lunghezza minima dei valori di colonna. |
|
|
lookupglossarysheetid
|
lookupglossarysheetid | integer |
Specifica l'ID del foglio di glossario di ricerca. |
|
|
lookupglossarysheetviewid
|
lookupglossarysheetviewid | integer |
Specifica l'ID visualizzazione del foglio di glossario di ricerca. |
|
|
Larghezza
|
width | integer |
Imposta la larghezza della colonna. |
|
|
otherscorevalue
|
otherscorevalue | string |
Definisce l'altro valore del punteggio per la colonna. |
|
|
importdatafromexternalsource
|
importdatafromexternalsource | string |
Indica se i dati sono importati da un'origine esterna. |
|
|
analysisengine
|
analysisengine | string |
Specifica il motore di analisi utilizzato per la colonna. |
|
|
attachmentcustomfolderid
|
attachmentcustomfolderid | integer |
Specifica l'ID cartella personalizzato per gli allegati. |
|
|
isattachmentfoldercurrentsite
|
isattachmentfoldercurrentsite | integer |
Indica se la cartella attachment si trova nel sito corrente. |
|
|
singleLineEmailValidation
|
singleLineEmailValidation | string |
Specifica se viene applicata la convalida della posta elettronica a riga singola. |
|
|
readonly
|
readonly | string |
Indica se la colonna è di sola lettura. |
|
|
virtualColumn
|
virtualColumn | integer |
Specifica se la colonna è virtuale. |
|
|
allowInlineEditing
|
allowInlineEditing | string |
Indica se la modifica inline è consentita per la colonna. |
|
|
sequenza
|
sequence | string |
Numero di sequenza della colonna. |
|
|
attributecolumnid
|
attributecolumnid | string |
Identificatore di colonna dell'attributo. |
|
|
value
|
value | string |
Valore dei dati non elaborati. |
|
|
date
|
date | string |
data di dati non elaborati. |
|
|
time
|
time | string |
Ora dei dati non elaborati. |
|
|
linkdisplayname
|
linkdisplayname | string |
Nome del collegamento visualizzato. |
|
|
linkdisplayurl
|
linkdisplayurl | string |
Collegamento con URL visualizzato. |
|
|
id
|
id | string |
ID ricerca |
|
|
posta elettronica
|
string |
Indirizzo di posta elettronica. |
||
|
userlookuptype
|
userlookuptype | string |
Tipo di ricerca utente. |
|
|
folderid
|
folderid | string |
ID cartella. |
|
|
docid
|
docid | string |
ID documento. |
|
|
fromdate
|
fromdate | string |
Da data. |
|
|
todate
|
todate | string |
Fino ad oggi. |
|
|
documento
|
file | string |
Contenuto del file. |
|
|
nome
|
name | string |
Nome dell'allegato. |
|
|
order
|
order | string |
Ordine dell'allegato. |
|
|
id
|
id | integer |
Identificatore univoco per l'allegato. |
|
|
extension
|
extension | string |
Estensione. |
|
|
parentfolderid
|
parentfolderid | integer |
ID della cartella padre. |
|
|
filehttplink
|
filehttplink | string |
Collegamento HTTP per accedere al file. |
|
|
folderpath
|
folderpath | string |
Percorso della cartella contenente il file. |
|
|
folderhttplink
|
folderhttplink | string |
Collegamento HTTP alla cartella. |
|
|
fileize
|
filesize | integer |
Dimensioni del file in byte. |
|
|
redactionStatus
|
redactionStatus | boolean |
Indica se il file viene redatto. |
|
|
displayname
|
displayname | string |
Nome visualizzato dell'allegato. |
|
|
siteid
|
siteid | integer |
ID del sito associato all'allegato. |
|
|
recordid
|
recordid | string |
ID record. |
|
|
linkname
|
linkname | string |
Nome del collegamento. |
|
|
apilink
|
apilink | string |
Collegamento API. |
|
|
httplink
|
httplink | string |
Collegamento HTTP. |
|
|
colViewPosition
|
colViewPosition | integer |
Posizione della colonna nella vista. |
|
|
columntype
|
columntype | string |
Tipo della colonna. |
|
|
data di creazione
|
createdDate | date-time |
Data e ora di creazione della colonna. |
|
|
modifiedDate
|
modifiedDate | date-time |
Data e ora dell'ultima modifica della colonna. |
|
|
injectReferenceColumn
|
injectReferenceColumn | integer |
Riferimento a una colonna inserita |
|
|
parentColumnID
|
parentColumnID | integer |
Identificatore della colonna padre. |
|
|
reusecolumnidfromisheet
|
reusecolumnidfromisheet | integer |
ID colonna riutilizzato da un foglio di input. |
|
|
choicelistid
|
choicelistid | integer |
Identificatore per l'elenco di scelte associato alla colonna. |
|
|
alerteroption
|
alerteroption | string |
Impostazione dell'opzione di avviso per l'elemento. |
|
|
sheettypeid
|
sheettypeid | integer |
Identificatore per il tipo di foglio. |
|
|
enableSmartForm
|
enableSmartForm | string |
Attiva le funzionalità del modulo intelligente. |
|
|
allowDeletedItemsView
|
allowDeletedItemsView | string |
Consente la visualizzazione degli elementi eliminati. |
|
|
allowAllColumnsInCustomView
|
allowAllColumnsInCustomView | string |
Consente tutte le colonne nelle viste personalizzate. |
Restituisce
- Corpo
- ProgressiveKeyDBO
Recuperare informazioni sui file
Questa chiamata API recupera informazioni dettagliate per un file specificato dalla piattaforma HighQ Collaborate.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API
|
version | True | string |
Specifica la versione dell'API in uso. |
|
File ID
|
fileid | True | string |
Specifica l'ID univoco del file. |
|
Flag di informazioni sul Servizio Migrazione del database più recente
|
lastdmsinfo | boolean |
Indica se recuperare le informazioni più recenti dal sistema di gestione dei documenti. |
|
|
Tipo di cartella
|
foldertype | string |
Specifica il tipo di cartella, se applicabile. |
|
|
Includi informazioni sullo stato dei file
|
statusinfo | boolean |
Indica se includere informazioni aggiuntive sullo stato del file, ad esempio lo stato condiviso, lo stato preferito, il numero di attività e lo stato apprezzato. Il valore predefinito è false. |
|
|
Includi metadati di posta elettronica
|
emailmetadata | boolean |
Indica se includere metadati di posta elettronica, ad esempio mittente, destinatari e timestamp. Il valore predefinito è false. |
Restituisce
- Corpo
- DocumentDBO
Recuperare l'elenco utenti
Recuperare un elenco di utenti Questa API recupera un elenco di utenti dal sistema. Funzionalità principali di ## - Recuperare i dettagli dell'utente con più opzioni di filtro - Supporta la paginazione con limit e offset - Nuovi parametri e campi di query introdotti nelle versioni recenti - Risposta strutturata con ruoli utente e attributi ## Nuovi parametri di query (Version-Specific) - Introdotto nella versione 12: - : systemAdminSearchSe impostato su 1, restituisce solo gli utenti con il ruolo amministratore di sistema.
-
Introdotto nella versione 18: - userid: accetta valori delimitati da virgole (CSV). ## Response Body Updates - Nuovi campi aggiunti: - , emaildomainorginvitationsentcreatedbycreateddate, modifiedbymodifieddate - ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid - systemuserresetpassworddateusertypeidavatarpracticegroup - langcodepublicprofile# dateOfBirth # Address Format Change (from V11) - Il location tag è stato rinominato in address per coerenza. - Risposta di esempio: 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> ## Ruoli utente (introdotti nell'API V11+) - Risposta di esempio: 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> ## Limiti e offset - Comportamento limite: - Impostazione predefinita: 100 se non viene specificato alcun valore. - Usare -1 per restituire tutti i record. - Se il valore è minore di -1, il valore predefinito è 100.
-
Comportamento offset: - Impostazione predefinita: 0 se non viene specificato alcun valore. - Se l'offset supera i record totali, il valore predefinito è 0. ## Nuovi ruoli introdotti - V12: Basic User, Allow user to bypass XSS protection - V14: Allow user to manage Contract Express system groups ## Codici errore | Riepilogo | Codice di riferimento (prima della versione 4) | Codice di riferimento (V4) | |---------|----------------------|--------------| | Input non valido per lo stato utente (ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | ID organizzazione non valido | N/D | 260 | | Valore non valido neverinvited (true/false) | N/D | 387 | | Valore non valido neverlogin (true/false) | N/D | 388 | | Valore non valido groupids | N/D | 214 | | Valore non valido notingroup (true/false) | N/D | 389 | | Non valido ordertype (supportato: nome, organizzazione, stato e così via) | N/D | 289 | | Non valido orderby (supportato: asc, desc) | N/D | 290 | | Valore non valido offset | 138 | 138 | | Valore non valido limit | 137 | 137 | ## Note - Dalla versione 13 in poi, questa API è aperta per tutti gli utenti (in precedenza limitata agli amministratori di sistema). - Dalla versione 18 in poi, il userregistered2FA campo indica se un utente è registrato per 2FA. --- Questa descrizione segue la formattazione dello schema Swagger 2.0 e deve essere inserita nel campo descrizione nello schema del connettore personalizzato.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API
|
version | True | string |
Versione dell'API. |
|
Stato utente
|
status | string |
Filtrare gli utenti in base allo stato: Attivo, Archiviato, Inattivo o Bloccato. |
|
|
Offset impaginazione
|
offset | string |
Posizione iniziale per la paginazione. |
|
|
Limite risultati
|
limit | string |
Numero di elementi da restituire per richiesta. |
|
|
ID organizzazione
|
orgid | string |
Filtrare gli utenti in base all'ID organizzazione. |
|
|
Utenti non invitati
|
neverinvited | string |
Recuperare gli utenti che non sono mai stati invitati. |
|
|
Utenti non connessi
|
neverlogin | string |
Recuperare gli utenti che non hanno mai eseguito l'accesso. |
|
|
ID utente
|
userid | string |
Filtrare gli utenti in base agli ID utente univoci. |
|
|
ID del Gruppo
|
groupid | string |
Filtrare gli utenti in base agli ID gruppo. |
|
|
Utenti non inclusi nei gruppi
|
notingroup | string |
Recuperare gli utenti che non si trovano in alcun gruppo. |
|
|
Tipo di ordinamento
|
ordertype | string |
Ordinare gli utenti in base a un campo specificato, ad esempio nome, organizzazione o stato. |
|
|
Ordine di ordinamento
|
orderby | string |
L'ordinamento comporta un ordine crescente o decrescente. |
|
|
ID esterno
|
externalid | string |
Filtrare gli utenti in base all'ID esterno. |
|
|
Nome di battesimo
|
firstname | string |
Filtrare gli utenti in base al nome. |
|
|
Cognome
|
lastname | string |
Filtrare gli utenti in base al cognome. |
|
|
Indirizzo di posta elettronica
|
string |
Filtrare gli utenti in base all'indirizzo di posta elettronica. |
||
|
Ricerca utenti
|
search | string |
Cercare gli utenti in base a vari attributi, tra cui nome, posta elettronica e titolo di lavoro. |
|
|
Filtro alfabetico
|
alphabets | string |
Filtrare gli utenti il cui cognome inizia con una lettera specifica. |
|
|
Posizione
|
jobtitle | string |
Filtrare gli utenti in base al titolo del lavoro. |
|
|
Posizione
|
locations | string |
Filtrare gli utenti in base alla città. |
|
|
Reparto
|
departments | string |
Filtrare gli utenti in base al reparto. |
|
|
Nome organizzazione
|
organisations | string |
Filtrare gli utenti in base al nome dell'organizzazione. |
|
|
Specialità
|
specialities | string |
Filtra gli utenti in base alle loro specialità. |
|
|
Ricerca amministratore di sistema
|
systemAdminSearch | string |
Recuperare gli utenti con il ruolo Amministratore di sistema. |
Restituisce
- Corpo
- users
Recuperare le colonne di iSheet
Questa chiamata API recupera le colonne associate all'iSheet specificato. Questa funzionalità è supportata nell'API versione 3 e successive.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID iSheet
|
isheetid | True | integer |
Specifica l'ID univoco del foglio iSheet per cui sono necessarie le colonne. |
|
Versione dell'API
|
version | True | string |
Specifica la versione dell'API in uso. |
|
ID visualizzazione iSheet
|
sheetviewid | string |
Specifica l'ID della visualizzazione iSheet. Se omesso, vengono restituite tutte le colonne. |
|
|
Includi colonne iSheet eliminate
|
onlyForDeletedIsheet | boolean |
Indica se includere colonne da un iSheet eliminato. Il valore predefinito è false. |
Restituisce
- Corpo
- columns
Recuperare un elenco di cartelle
Questa chiamata API recupera un elenco di cartelle contenute nella cartella specificata. Il parametro 'limit' imposta il numero massimo di elementi da restituire e il parametro 'offset' specifica la posizione iniziale per il recupero dei dati. I valori predefiniti vengono applicati se questi parametri vengono omessi e le cartelle vengono restituite in ordine crescente in base alla data di creazione.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API
|
version | True | string |
Specifica la versione dell'API in uso. |
|
ID cartella
|
folderid | True | string |
Specifica l'ID univoco della cartella. |
|
Limite elementi
|
limit | string |
Specifica il numero massimo di elementi da restituire. |
|
|
Offset elementi
|
offset | string |
Specifica la posizione iniziale per gli elementi restituiti. |
|
|
Direzione ordinamento
|
orderby | string |
Specifica la direzione dell'ordine per l'ordinamento degli elementi. Usare 'asc' per l'ordine crescente o 'desc' per l'ordine decrescente. |
|
|
Criterio di ordinamento
|
ordertype | string |
Specifica il criterio per l'ordinamento degli elementi, ad esempio nome, autore o data dell'ultima modifica. |
|
|
Includi informazioni sullo stato della cartella
|
statusinfo | boolean |
Indica se includere informazioni aggiuntive sullo stato della cartella. Il valore predefinito è false. |
|
|
Includi cartelle intelligenti
|
includesmartfolder | boolean |
Indica se includere cartelle intelligenti nell'elenco restituito. Il valore predefinito è false. |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
folder
|
folder | array of object | |
|
items
|
folder | object |
Recuperare un elenco di elementi di iSheet
Questa chiamata API recupera un elenco di elementi contenuti nell'iSheet specificato.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API
|
version | True | string |
Specifica la versione dell'API in uso. |
|
ID iSheet
|
isheetid | True | integer |
Specifica l'ID univoco di iSheet. |
|
ID visualizzazione iSheet
|
sheetviewid | integer |
Specifica l'ID della visualizzazione iSheet. Se omesso, viene restituita la visualizzazione predefinita. |
|
|
Ordina ID colonna
|
sortcolumnid | integer |
Specifica l'ID della colonna utilizzata per l'ordinamento dei risultati. |
|
|
Ordine di ordinamento
|
sortorder | integer |
Specifica l'ordinamento. Ad esempio, usare 0 per l'ordine crescente o un altro valore per l'ordine decrescente. |
|
|
Limite record
|
limit | integer |
Specifica il numero massimo di record da restituire; Il valore predefinito è 100 se non specificato. |
|
|
Record Offset
|
offset | integer |
Specifica la posizione iniziale per il recupero dei record; il valore predefinito è 0 se non specificato. |
|
|
Includi tutte le colonne
|
allColumnRequired | boolean |
Flag che indica se includere tutti i dati di colonna indipendentemente dalla visualizzazione corrente. |
|
|
Ignora restrizioni visualizzazione
|
isIgnoreView | boolean |
Flag che indica se ignorare le restrizioni di visualizzazione durante il recupero dei dati dell'elemento. |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
isheet
|
isheet | array of object |
Elenco di elementi di iSheet. |
|
ID articolo
|
isheet.itemId | string |
ID univoco dell'elemento. |
|
data
|
isheet.data | array of object |
Dati dettagliati dell'elemento. |
|
sequenza
|
isheet.data.sequence | string |
Numero di sequenza associato ai dati. |
|
columnDisplayName
|
isheet.data.columnDisplayName | string |
Nome visualizzato della colonna. |
|
value
|
isheet.data.value | string |
Valore contenuto nella colonna. |
Spostare documenti
Questa API sposta più file da una cartella a un'altra all'interno dello stesso sito.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Versione dell'API
|
version | True | string |
Specifica la versione dell'API. |
|
ID cartella di destinazione
|
targetfolder | True | string |
Identificatore univoco della cartella di destinazione in cui verranno spostati i file. |
|
fileidCSV
|
fileidCSV | string |
Elenco delimitato da virgole di ID file da spostare. |
Definizioni
ErrorDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
summary
|
summary | string | |
|
ref
|
ref | string | |
|
link
|
link | string |
DocumentDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
docid
|
docid | string |
ID documento. |
columns
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
colonna
|
column | array of object | |
|
items
|
column | object |
LocationDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
addressline1
|
addressline1 | string |
Prima riga dell'indirizzo. |
|
addressline2
|
addressline2 | string |
Seconda riga dell'indirizzo. |
|
addressline3
|
addressline3 | string |
Terza riga dell'indirizzo. |
|
city
|
city | string |
Città dell'indirizzo. |
|
state
|
state | string |
Stato dell'indirizzo. |
|
country
|
country | string |
Paese dell'indirizzo. |
|
codice postale
|
postcode | string |
Codice postale dell'indirizzo. |
Nome utente
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
title
|
title | string |
Titolo dell'utente. |
|
firstname
|
firstname | string |
Nome dell'utente. |
|
lastname
|
lastname | string |
Cognome dell'utente. |
|
goesby
|
goesby | string |
nome preferito dell'utente. |
MetadataListDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
metadataname
|
metadataname | array of string | |
|
metadatavalue
|
metadatavalue | array of string |
NameValueLink
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | string |
ID collegamento |
|
nome
|
name | string |
Nome collegamento. |
|
value
|
value | string |
Valore collegamento. |
Link
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
link
|
link | array of NameValueLink |
ExperiencesDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
esperienza
|
experience | array of string |
GroupsDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
group
|
group | array of string |
utente
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
userid
|
userid | integer |
ID utente. |
|
seguente
|
following | boolean |
Seguente. |
|
posta elettronica
|
string |
Indirizzo email. |
|
|
nome
|
name | UserName | |
|
userlink
|
userlink | string |
Collegamento utente. |
|
httplink
|
httplink | string |
Collegamento HTTP. |
|
httpavatar
|
httpavatar | string |
Avatar HTTP. |
|
avatar
|
avatar | integer |
Avatar dell'utente. |
|
externalid
|
externalid | string |
ID esterno. |
|
dateofbirth
|
dateofbirth | string |
Data di nascita. |
|
phone
|
phone | string |
Numero di telefono. |
|
jobtitle
|
jobtitle | string |
Posizione professionale. |
|
mobile
|
mobile | string |
Numero di cellulare. |
|
dipartimento
|
department | string |
Deparment. |
|
status
|
status | string |
Stato. |
|
Org
|
org | string |
Organizzazione. |
|
orgName
|
orgName | string |
Nome organizzazione. |
|
ubicazione
|
location | LocationDBO | |
|
img
|
img | string |
Immagine. |
|
Esperienze
|
experiences | ExperiencesDBO | |
|
sociallinks
|
sociallinks | Link | |
|
customlink
|
customlink | Link | |
|
messaginglink
|
messaginglink | Link | |
|
secretaryname
|
secretaryname | string |
Nome segretario. |
|
segretaria
|
secretarymail | string |
Mail segretaria. |
|
bio
|
bio | string |
Biografia dell'utente. |
|
sourcetype
|
sourcetype | string |
Tipo di origine. |
|
Specialità
|
specialities | string |
Specialità. |
|
reportto
|
reportsto | string |
Utente a cui l'utente corrente segnala. |
|
metadata
|
metadata | MetadataListDBO | |
|
groups
|
groups | GroupsDBO | |
|
suffisso
|
suffix | string |
Suffisso del nome dell'utente. |
|
atomlink
|
atomlink | string |
Collegamento Atom associato all'utente. |
|
link
|
link | string |
Collegamento associato all'utente. |
|
loguserlike
|
loggeduserlike | integer |
Numero di like dall'utente connesso. |
|
nome utente
|
userName | string |
Nome utente. |
users
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
utente
|
user | array of user |
FolderDBOV1
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
folderid
|
folderid | string |
Identificatore univoco della cartella creata. |
DmsDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
dmsfolderid
|
dmsfolderid | string |
Identificatore della cartella DMS. |
|
dmsParentFolderID
|
dmsParentFolderID | string |
Identificatore della cartella padre del Servizio Migrazione del database. |
|
dmscreateddate
|
dmscreateddate | date-time |
Data di creazione della cartella Servizio Migrazione del database. |
|
dmsmodifiedBy
|
dmsmodifiedBy | string |
Utente che ha modificato l'ultima cartella del Servizio Migrazione del database. |
|
dmsdatabasename
|
dmsdatabasename | string |
Nome del database del Servizio Migrazione del database. |
|
dmslink
|
dmslink | boolean |
Indica se è disponibile un collegamento dms. |
|
dmslinkby
|
dmslinkby | string |
Utente che ha collegato la cartella DMS. |
sitegroup
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
nome
|
name | string | |
|
id
|
id | integer | |
|
copypermissionsfrom
|
copypermissionsfrom | string | |
|
message
|
message | string | |
|
typeID
|
typeID | integer | |
|
type
|
type | string | |
|
numberofusers
|
numberofusers | string | |
|
creato
|
created | string | |
|
modified
|
modified | string | |
|
systemGroupID
|
systemGroupID | integer | |
|
descrizione
|
description | string | |
|
basicusergroup
|
basicusergroup | integer |
Address
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
addressid
|
addressid | string |
Identificatore univoco per l'indirizzo. |
|
addressline1
|
addressline1 | string |
Prima riga dell'indirizzo. |
|
addressline2
|
addressline2 | string |
Seconda riga dell'indirizzo. |
|
addressline3
|
addressline3 | string |
Terza riga dell'indirizzo. |
|
city
|
city | string |
Città dell'indirizzo. |
|
state
|
state | string |
Stato dell'indirizzo. |
|
country
|
country | string |
Paese dell'indirizzo. |
|
codice postale
|
postCode | string |
Codice postale dell'indirizzo. |
|
knownas
|
knownas | string |
Nome alternativo o nome alternativo per l'indirizzo. |
IntegrationUserDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
index
|
index | integer |
Indice univoco per l'utente. |
|
userid
|
userid | integer |
Identificatore univoco dell’utente. |
|
firstname
|
firstname | string |
Nome dell'utente. |
|
lastname
|
lastname | string |
Cognome dell'utente. |
|
practicegroup
|
practicegroup | string |
Gruppo di pratiche a cui appartiene l'utente. |
|
langcode
|
langcode | string |
Codice linguistico dell'utente. |
|
localeID
|
localeID | string |
ID delle impostazioni locali dell'utente. |
|
publicprofile
|
publicprofile | string |
Profilo pubblico dell'utente. |
|
pwpid
|
pwpid | string |
ID PWP dell'utente. |
|
usertypeid
|
usertypeid | string |
ID tipo utente. |
|
systemuser
|
systemuser | string |
Flag utente di sistema. |
|
posta elettronica
|
string |
Email indirizzo dell'utente. |
|
|
phone
|
phone | string |
Numero di telefono dell'utente. |
|
mobile
|
mobile | string |
Numero di cellulare dell'utente. |
|
dipartimento
|
department | string |
Reparto dell'utente. |
|
Org
|
org | string |
L'organizzazione a cui appartiene l'utente. |
|
ubicazione
|
location | LocationDBO | |
|
address
|
address | Address | |
|
Esperienze
|
experiences | ExperiencesDBO | |
|
sociallinks
|
sociallinks | Link | |
|
messaginglink
|
messaginglink | Link | |
|
customlink
|
customlink | Link | |
|
img
|
img | string | |
|
reportto
|
reportsto | string | |
|
metadata
|
metadata | MetadataListDBO | |
|
groups
|
groups | GroupsDBO | |
|
externalid
|
externalid | string |
ID esterno dell'utente. |
|
jobtitle
|
jobtitle | string |
Titolo del processo dell'utente. |
|
secretaryname
|
secretaryname | string |
Nome della segretaria dell'utente. |
|
segretaria
|
secretarymail | string |
Indirizzo di posta elettronica della segretaria dell'utente. |
|
Specialità
|
specialities | string |
Specialità dell'utente. |
|
title
|
title | string |
Titolo dell'utente. |
|
goesby
|
goesby | string |
nome preferito dell'utente. |
|
suffisso
|
suffix | string |
Suffisso del nome dell'utente. |
|
atomlink
|
atomlink | string |
Collegamento Atom associato all'utente. |
|
bio
|
bio | string |
Biografia dell'utente. |
|
dateOfBirth
|
dateOfBirth | string |
Data di nascita dell'utente. |
|
link
|
link | string |
Collegamento associato all'utente. |
|
status
|
status | string |
Stato dell'utente. |
|
codice di stato
|
statuscode | string |
Codice di stato dell'utente. |
|
message
|
message | string |
Messaggio associato all'utente. |
|
sourcetype
|
sourcetype | string |
Tipo di origine dell'utente. |
|
orgid
|
orgid | string |
ID organizzazione. |
|
ifpartner
|
ifpartner | string |
Flag partner. |
|
emaildomain
|
emaildomain | string |
Dominio di posta elettronica dell'utente. |
|
invitationsent
|
invitationsent | string |
Flag di invito inviato. |
|
creato da
|
createdby | string |
Utente che ha creato il record. |
|
createddate
|
createddate | string |
Data di creazione del record. |
|
modificatoda
|
modifiedby | string |
Utente che ha modificato il record. |
|
modifieddate
|
modifieddate | string |
Data di modifica del record. |
|
lastlogindate
|
lastlogindate | string |
Data dell'ultimo account di accesso. |
|
invalidlogins
|
invalidlogins | string |
Numero di tentativi di accesso non validi. |
|
publicwebsiteprofileid
|
publicwebsiteprofileid | string |
ID profilo sito Web pubblico. |
|
resetpassworddate
|
resetpassworddate | string |
Data di reimpostazione della password. |
|
avatar
|
avatar | string |
URL immagine avatar. |
|
followingcount
|
followingcount | integer |
Numero di utenti seguiti. |
|
followercount
|
followercount | integer |
Conteggio dei follower. |
|
seguente
|
following | boolean |
Flag seguente. |
|
ruolo
|
role | string |
Ruolo dell'utente. |
|
isbasicuser
|
isbasicuser | string |
Flag utente di base. |
|
encryptedUserId
|
encryptedUserId | string |
ID utente crittografato. |
|
selfregistered
|
selfregistered | integer |
Flag autoregistrato. |
|
registeredWith2FA
|
registeredWith2FA | string |
Flag di registrazione dell'autenticazione a due fattori. |
|
isInternal
|
isInternal | integer |
Flag utente interno. |
|
orgName
|
orgName | string |
Il nome dell'organizzazione. |
sito
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer |
Identificatore del sito. |
|
sitename
|
sitename | string |
Il nome del sito. |
|
ruolo
|
role | string |
Ruolo del sito. |
|
sitedescription
|
sitedescription | string |
Descrizione del sito. |
|
enabledmodules
|
enabledmodules | string |
Elenco di moduli abilitati per il sito. |
|
sitefolderID
|
sitefolderID | string |
Identificatore della cartella del sito. |
|
sitefolderpermission
|
sitefolderpermission | string |
Livello di autorizzazione per la cartella del sito. |
|
module
|
module | ModuleDBO | |
|
adminnote
|
adminnote | string |
Note amministrative relative al sito. |
|
startdate
|
startdate | string |
Data di inizio dell'operazione del sito. |
|
enddate
|
enddate | string |
Data di fine dell'operazione del sito. |
|
createddate
|
createddate | string |
Data di creazione del sito. |
|
archiveddate
|
archiveddate | string |
Data di archiviazione del sito. |
|
clientno
|
clientno | string |
Numero client associato al sito. |
|
matterno
|
matterno | string |
Numero di materia associato al sito. |
|
pagina di destinazione
|
landingpage | string |
URL della pagina di destinazione per il sito. |
|
link
|
link | string |
Collegamento correlato al sito. |
|
status
|
status | string |
Stato corrente del sito. |
|
statusid
|
statusid | integer |
Identificatore dello stato del sito. |
|
size
|
size | string |
Dimensioni del sito. |
|
billingnotes
|
billingnotes | string |
Note relative alla fatturazione per il sito. |
|
billingnextinvoicedate
|
billingnextinvoicedate | string |
Data della fattura successiva per il sito. |
|
billinglastinvoicedate
|
billinglastinvoicedate | string |
Data dell'ultima fattura per il sito. |
|
filepagecount
|
filepagecount | string |
Numero totale di pagine dei file nel sito. |
|
maxpagecount
|
maxpagecount | string |
Numero massimo di pagine consentite per i file nel sito. |
|
sitehttplink
|
sitehttplink | string |
Collegamento HTTP al sito. |
|
isSyncable
|
isSyncable | integer |
Indica se il sito è sincronizzabile. |
|
enforceusergroups
|
enforceusergroups | string |
I gruppi di utenti applicati per il sito. |
|
csvSiteCategory
|
csvSiteCategory | string |
Categoria del sito in formato CSV. |
|
siteNameInDefaultLanguage
|
siteNameInDefaultLanguage | string |
Nome del sito nella lingua predefinita. |
|
visibile
|
visible | integer |
Indica se il sito è visibile. |
|
siteLogoName
|
siteLogoName | string |
Nome del file logo del sito. |
|
siteLogoFileSize
|
siteLogoFileSize | integer |
Dimensioni del file del logo del sito. |
|
siteLogoHeight
|
siteLogoHeight | integer |
Altezza del logo del sito. |
|
siteLogoWidth
|
siteLogoWidth | integer |
Larghezza del logo del sito. |
|
siteStatus
|
siteStatus | integer |
Codice di stato del sito. |
|
applySiteTerms
|
applySiteTerms | integer |
Indica se vengono applicate le condizioni del sito. |
|
siteTerm
|
siteTerm | string |
Termini applicati al sito. |
|
termType
|
termType | integer |
Tipo di termini applicati al sito. |
|
nextLoginSiteTerms
|
nextLoginSiteTerms | integer |
Indica se i termini del sito sono necessari all'accesso successivo. |
|
defaultSiteTermsEnable
|
defaultSiteTermsEnable | integer |
Indica se i termini predefiniti del sito sono abilitati. |
|
advancedQAPermission
|
advancedQAPermission | integer |
Livello di autorizzazione di controllo di qualità avanzato per il sito. |
|
isInternal
|
isInternal | integer |
Indica se il sito è interno. |
|
Psm
|
psm | integer |
Identificatore di Product Service Manager. |
|
siteLabelDisplay
|
siteLabelDisplay | string |
Etichetta di visualizzazione per il sito. |
|
allowSiteAdministration
|
allowSiteAdministration | integer |
Indica se l'amministrazione del sito è consentita. |
|
siteLevelPasswordEnable
|
siteLevelPasswordEnable | integer |
Per abilitare la protezione password a livello di sito. |
|
siteLevelPasscodeEnable
|
siteLevelPasscodeEnable | integer |
Per abilitare la protezione passcode a livello di sito. |
|
passcodeUsingAuthApp
|
passcodeUsingAuthApp | integer |
Indica se l'autenticazione passcode usa un'app di autenticazione. |
|
sitePassword
|
sitePassword | string |
Password associata al sito. |
|
ipRestrictionEnable
|
ipRestrictionEnable | integer |
Per abilitare le restrizioni IP per l'accesso al sito. |
|
availableIP
|
availableIP | string |
Elenco delimitato da virgole di indirizzi IP autorizzati ad accedere al sito. |
|
highqDrive
|
highqDrive | integer |
Indica se l'integrazione di HighQ Drive è abilitata. |
|
applySiteHomePage
|
applySiteHomePage | integer |
Per applicare una home page personalizzata per il sito. |
|
siteHomePage
|
siteHomePage | string |
URL della home page personalizzata per il sito. |
|
siteHomePageType
|
siteHomePageType | integer |
Tipo della home page. |
|
nextLoginSiteHomePage
|
nextLoginSiteHomePage | integer |
Per impostare l'account di accesso successivo alla home page del sito. |
|
applyDisplayContent
|
applyDisplayContent | integer |
Per applicare le impostazioni del contenuto di visualizzazione. |
|
displayContent
|
displayContent | string |
Contenuto da visualizzare nel sito. |
|
rssSecurity
|
rssSecurity | integer |
Livello di sicurezza del feed RSS. |
|
encryptedPassword
|
encryptedPassword | integer |
Indica se la password del sito è crittografata. |
|
availableIPRangeCSV
|
availableIPRangeCSV | string |
Elenco delimitato da virgole di intervalli di indirizzi IP autorizzati ad accedere al sito. |
|
siteModuleID
|
siteModuleID | integer |
Identificatore del modulo del sito. |
|
icalSecurity
|
icalSecurity | integer |
Livello di sicurezza del feed iCal. |
|
defaultDisplayContent
|
defaultDisplayContent | string |
Contenuto predefinito da visualizzare nel sito. |
|
defaultEmailAlert
|
defaultEmailAlert | integer |
Per abilitare gli avvisi di posta elettronica predefiniti. |
|
excelReportFooter
|
excelReportFooter | integer |
Include un piè di pagina nei report di Excel. |
|
excelReportFooterText
|
excelReportFooterText | string |
Testo da visualizzare nel piè di pagina dei report di Excel. |
|
announcementMLJSON
|
announcementMLJSON | string |
Annunci in formato JSON per il sito. |
|
templateType
|
templateType | integer |
Tipo di modello usato per il sito. |
|
templateLicence
|
templateLicence | integer |
Tipo di licenza per il modello di sito. |
|
openChannelAppID
|
openChannelAppID | string |
ID applicazione per l'integrazione del canale aperto. |
|
itemid
|
itemid | integer |
Identificatore per l'elemento associato al sito. |
|
sitemetadatasheetid
|
sitemetadatasheetid | integer |
ID del foglio di metadati associato al sito. |
|
sito personale
|
mysite | boolean |
Indica se si tratta del sito personale dell'utente. |
|
lastaccesseddate
|
lastaccesseddate | string |
Data e ora dell'ultimo accesso al sito. |
|
defaultViewerMetaDataTab
|
defaultViewerMetaDataTab | integer |
Scheda dei metadati predefinita per il visualizzatore del sito. |
|
documentMetadataViewId
|
documentMetadataViewId | integer |
metadati del documento per l'identificatore di visualizzazione. |
|
folderMetadataViewId
|
folderMetadataViewId | integer |
metadati della cartella per l'identificatore di visualizzazione. |
|
docSort
|
docSort | integer |
Ordinamento dei documenti. |
|
folderSort
|
folderSort | integer |
Ordinamento delle cartelle. |
|
defaultFolderRenderView
|
defaultFolderRenderView | integer |
Determina la modalità di visualizzazione predefinita per le cartelle. |
|
isTaskAttachmentDefault
|
isTaskAttachmentDefault | integer |
Percorso predefinito per gli allegati delle attività. |
|
taskAttachmentDefaultFolderId
|
taskAttachmentDefaultFolderId | integer |
Identificatore univoco della cartella designata come percorso predefinito per gli allegati delle attività. |
|
favorito
|
favourite | string |
stato preferito. |
|
enabledocumentredaction
|
enabledocumentredaction | boolean |
Specifica se la ridistribuzione del documento è abilitata per il sito. |
|
menzionigroup
|
mentiongroups | integer |
Gruppi menzionati. |
|
enablefilerelationships
|
enablefilerelationships | boolean |
Indica se le relazioni tra file sono abilitate. |
|
filerelationshipsitepermissionlevel
|
filerelationshipsitepermissionlevel | integer |
Livello di autorizzazione necessario per gestire le relazioni tra file. |
ModuleDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
casa
|
home | HomeDBO | |
|
attività
|
activity | ActivityDBO | |
|
documento
|
document | DocumentDBO | |
|
blog
|
blog | BlogDBO | |
|
wiki
|
wiki | WikiDBO | |
|
compito
|
task | TaskDBO | |
|
evento
|
event | EventDBO | |
|
isheet
|
isheet | ISheetDBO | |
|
Qa
|
qa | QaDBO | |
|
persone
|
people | PeopleDBO | |
|
contractexpress
|
contractexpress | ContractExpressDBO |
HomeDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
abilitare
|
enable | string |
Abilitare lo stato per HomeDBO. |
ActivityDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
abilitare
|
enable | string |
Abilitare lo stato per ActivityDBO. |
|
microblog
|
microblog | string |
Contenuto del microblog associato a ActivityDBO. |
BlogDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
blogTitle
|
blogTitle | string |
Titolo del post di blog. |
|
blogContent
|
blogContent | string |
Contenuto del post di blog. |
|
showComment
|
showComment | integer |
visualizzare il commento. |
|
tagList
|
tagList | array of string |
Elenco di tag associati al blog. |
|
status
|
status | integer |
stato del post di blog. |
|
siteID
|
siteID | integer |
Identificatore del sito associato. |
|
autore
|
author | string |
Autore del blog. |
|
categoryList
|
categoryList | array of string |
Categorie assegnate al post di blog. |
|
notificationTypeID
|
notificationTypeID | integer |
Identificatore per il tipo di notifica. |
|
message
|
message | string |
Contenuto del messaggio correlato al blog. |
|
messageCode
|
messageCode | integer |
Codice associato al messaggio. |
|
ID esterno
|
externalID | string |
Identificatore esterno collegato al blog. |
|
data di pubblicazione
|
publishDate | string |
Data di pubblicazione del blog. |
|
processtype
|
processtype | string |
Tipo di processo associato al blog. |
|
abilitare
|
enable | string |
Abilitare lo stato per BlogDBO. |
WikiDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
wikiid
|
wikiid | integer |
Identificatore univoco per il wiki. |
|
currentversionid
|
currentversionid | integer |
Identificatore per la versione corrente del wiki |
|
parentwikiid
|
parentwikiid | integer |
Identificatore per il wiki padre. |
|
wikititle
|
wikititle | string |
Titolo del wiki. |
|
wikicontent
|
wikicontent | string |
Contenuto del wiki. |
|
showcomment
|
showcomment | integer |
Indica se i commenti sono abilitati. |
|
createddate
|
createddate | string |
Data di creazione del wiki. |
|
modifieddate
|
modifieddate | string |
Data ultima modifica del wiki. |
|
taglist
|
taglist | string |
Elenco delimitato da virgole di tag associati al wiki. |
|
Wikipath
|
wikipath | string |
Percorso per accedere al wiki. |
|
wikidraftid
|
wikidraftid | integer |
Identificatore per la versione bozza del wiki. |
|
drafttype
|
drafttype | string |
Tipo di bozza associata al wiki. |
|
status
|
status | integer |
Stato corrente del wiki. |
|
wikiversionid
|
wikiversionid | integer |
Identificatore della versione del wiki. |
TaskDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
index
|
index | string |
Indice o identificatore per l'attività. |
|
parenttaskid
|
parenttaskid | integer |
Identificatore per l'attività padre. |
|
taskid
|
taskid | integer |
Identificatore univoco per l'attività. |
|
title
|
title | string |
Titolo dell'attività. |
|
descrizione
|
description | string |
Descrizione dettagliata dell'attività. |
|
scadenza
|
duedate | string |
Scadenza per il completamento dell'attività. |
|
startdate
|
startdate | string |
Data di inizio dell'avvio dell'attività. |
|
mattermaptaskid
|
mattermaptaskid | string |
Identificatore collegato all'attività di mapping della materia. |
|
type
|
type | string |
Digitare o categoria dell'attività. |
|
dependenton
|
dependenton | string |
Attività da cui dipende questa attività. |
|
daysfromdependent
|
daysfromdependent | string |
Numero di giorni dall'attività dipendente. |
|
ignoreweekend
|
ignoreweekend | integer |
Indica se i fine settimana vengono ignorati nella pianificazione. |
|
duration
|
duration | integer |
Durata per completare l'attività. |
|
resource
|
resource | string |
Risorse assegnate all'attività. |
EventDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
eventTitle
|
eventTitle | string |
Titolo dell'evento. |
|
eventContent
|
eventContent | string |
Contenuto dell'evento. |
|
showComment
|
showComment | integer |
Indica se i commenti sono abilitati per l'evento. |
|
tagList
|
tagList | array of string |
Elenco di tag associati all'evento. |
|
status
|
status | integer |
Stato corrente dell'evento. |
|
siteID
|
siteID | integer |
Identificatore del sito. |
|
contatto
|
contact | string |
Informazioni di contatto per l'evento. |
|
categoryList
|
categoryList | array of string |
Categorie in cui viene elencato l'evento. |
|
notificationTypeID
|
notificationTypeID | integer |
Tipo di notifica correlato all'evento. |
|
message
|
message | string |
Messaggio dell'evento. |
|
messageCode
|
messageCode | integer |
Codice del messaggio dell'evento. |
|
ID esterno
|
externalID | string |
Identificatore esterno. |
|
startDate
|
startDate | string |
Data di inizio dell'evento. |
|
Data di fine
|
endDate | string |
Data di fine dell'evento. |
|
startTime
|
startTime | string |
Ora di inizio dell'evento. |
|
endTime
|
endTime | string |
Ora di fine dell'evento. |
|
ubicazione
|
location | string |
Posizione dell'evento. |
|
autore
|
author | string |
Autore dell'evento. |
|
processtype
|
processtype | string |
Ora del processo dell'evento. |
|
abilitare
|
enable | string |
Abilitare l'evento. |
ISheetDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer |
Identificatore univoco per iSheet. |
|
title
|
title | string |
Titolo del foglio iSheet. |
|
descrizione
|
description | string |
Descrizione del foglio isheet. |
|
status
|
status | string |
Stato del foglio isheet. |
|
accesstype
|
accesstype | string |
Tipo di accesso del foglio isheet. |
|
type
|
type | string |
Tipo del foglio isheet. |
|
viewlink
|
viewlink | string |
Collegamento per visualizzare iSheet. |
|
consentiszioni
|
allowsections | string |
Indica se le sezioni sono consentite. |
|
allowlookup
|
allowlookup | string |
Indica se i campi di ricerca sono abilitati. |
|
displayisheet
|
displayisheet | string |
Opzioni di visualizzazione per iSheet. |
|
searchasdefaultview
|
searchasdefaultview | string |
Indica se la ricerca è la visualizzazione predefinita. |
|
enableversion
|
enableversion | string |
Flag abilitato per il controllo delle versioni. |
|
enablesheetalerter
|
enablesheetalerter | string |
Contrassegno per abilitare gli avvisi del foglio. |
|
alertercondition
|
alertercondition | string |
Condizioni per l'attivazione degli avvisi. |
|
overrideitemmodifieddate
|
overrideitemmodifieddate | string |
Eseguire l'override del flag di data modificato. |
|
enablebulkinsertupdate
|
enablebulkinsertupdate | string |
Abilitare l'inserimento/aggiornamento bulk. |
|
fielddescriptions
|
fielddescriptions | string |
Descrizioni dei campi per iSheet. |
|
enablerowlocking
|
enablerowlocking | string |
Abilitare il blocco a livello di riga. |
|
setcharlimittruncatemultilinetextenabled
|
setcharlimittruncatemultilinetextenabled | string |
Tronca il flag di testo su più righe. |
|
setcharlimittruncatemultilinetextval
|
setcharlimittruncatemultilinetextval | string |
Limite di caratteri per il troncamento su più righe. |
|
allowchoicelistvaluesforreuse
|
allowchoicelistvaluesforreuse | string |
Consenti riutilizzo dei valori dell'elenco di scelte. |
|
allowscorelistvaluesforreuse
|
allowscorelistvaluesforreuse | string |
Consenti riutilizzo dei valori dell'elenco dei punteggi. |
|
allowIsheetComments
|
allowIsheetComments | string |
Consenti commenti in iSheet. |
|
shareRecordsLimit
|
shareRecordsLimit | integer |
Limite di record consentiti per la condivisione. |
|
shareRecordsLimitEnabled
|
shareRecordsLimitEnabled | integer |
Limite di condivisione record abilitati. |
|
enableIsheetAddRecordFormSharing
|
enableIsheetAddRecordFormSharing | string |
Abilitare la condivisione dei moduli per l'aggiunta di record. |
|
recordcount
|
recordcount | string |
Conteggio record corrente. |
|
sheettypeid
|
sheettypeid | integer |
ID di tipo del foglio iSheet |
QaDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
abilitare
|
enable | string |
Abilitare la funzionalità di controllo di qualità. |
PeopleDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
persona
|
person | array of PersonDBO |
PersonDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
userid
|
userid | integer |
ID utente. |
|
posta elettronica
|
string |
indirizzo email. |
|
|
httpavatar
|
httpavatar | string |
URL HTTP dell'avatar. |
|
avatar
|
avatar | string |
Immagine avatar. |
|
userlink
|
userlink | string |
Collegamento al profilo utente. |
|
httplink
|
httplink | string |
Collegamento HTTP al profilo utente. |
|
phone
|
phone | string |
Numero di telefono. |
|
mobile
|
mobile | string |
Numero di cellulare. |
|
dipartimento
|
department | string |
Reparto dell'utente. |
ContractExpressDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
abilitare
|
enable | string |
Abilitare l'integrazione di Contract Express. |
FolderDBOV2
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
nome
|
name | string |
Nome cartella. |
|
descrizione
|
description | string |
Descrizione della cartella. |
|
parentFolderID
|
parentFolderID | integer |
ID cartella padre. |
|
accessInherited
|
accessInherited | integer |
Stato di ereditarietà dell'accesso. |
|
batchID
|
batchID | string |
Identificatore batch |
|
DMS
|
dms | DmsDBO | |
|
id
|
id | integer |
ID cartella. |
|
link
|
link | string |
Collegamento alla cartella. |
|
createddate
|
createddate | string |
Data di creazione. |
|
modifieddate
|
modifieddate | string |
Data di modifica. |
|
bambino
|
child | integer |
Cartelle figlio. |
|
filecount
|
filecount | integer |
Numero di file. |
|
creato da
|
createdby | UserDBO | |
|
modificatoda
|
modifiedby | UserDBO | |
|
folderid
|
folderid | integer |
ID cartella. |
|
dmsfolderid
|
dmsfolderid | string |
Identificatore della cartella DMS. |
|
siteid
|
siteid | integer |
ID sede |
|
ubicazione
|
location | string |
Percorso cartella. |
|
autorizzazione
|
permission | PermissionDBO | |
|
contentstatus
|
contentstatus | integer |
Stato del contenuto. |
|
numerazione automatica
|
autonumbering | string |
Configurazione della numerazione automatica. |
|
cartelle
|
foldersize | string |
Dimensioni della cartella. |
|
sharedstatus
|
sharedstatus | integer |
Stato condivisione. |
|
favoritestatus
|
favouritestatus | integer |
Stato preferito. |
|
foldertype
|
foldertype | string |
Tipo di cartella. |
|
ID articolo
|
itemId | integer |
ID dell'elemento. |
|
folderMetadataSheetId
|
folderMetadataSheetId | integer |
Metadati della cartella dell'ID foglio. |
UserDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
firstname
|
firstname | string |
Nome di battesimo. |
|
lastname
|
lastname | string |
Cognome. |
|
posta elettronica
|
string |
Indirizzo di posta elettronica. |
|
|
userid
|
userid | integer |
ID utente. |
PermissionDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
view
|
view | integer |
Visualizzare l'autorizzazione. |
|
edit
|
edit | integer |
Modifica autorizzazione. |
|
delete
|
delete | integer |
Autorizzazione di eliminazione. |
|
addEditAllFiles
|
addEditAllFiles | integer |
Autorizzazione Aggiungi/Modifica tutti i file. |
|
Admin
|
admin | integer |
Autorizzazione amministratore. |
|
viewAllFiles
|
viewAllFiles | integer |
Visualizzare tutte le autorizzazioni per tutti i file. |
|
disableSave
|
disableSave | integer |
disabilitare l'autorizzazione di salvataggio. |
|
uploadFile
|
uploadFile | integer |
autorizzazione per il caricamento del file. |
|
updateFile
|
updateFile | integer |
update file Autorizzazione. |
|
deleteFile
|
deleteFile | integer |
Eliminare l'autorizzazione file. |
ProgressiveKeyDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
progressivekey
|
progressivekey | string |
Chiave per le operazioni progressive. |
|
siteid
|
siteid | integer |
Identificatore del sito. |
|
progressivekeystatus
|
progressivekeystatus | string |
Stato della chiave progressiva. |
|
userid
|
userid | integer |
Identificatore per l'utente. |
|
responsebody
|
responsebody | string |
Corpo della risposta. |
|
message
|
message | string |
Contenuto del messaggio. |
|
messagecode
|
messagecode | string |
Codice associato al messaggio. |
|
integrationResponseDBO
|
integrationResponseDBO | IntegrationResponseDBO | |
|
columns
|
columns | ColumnErrorsDBO | |
|
items
|
items | ItemErrorsDBO | |
|
importisheettemplate
|
importisheettemplate | importISheetTemplateDBO | |
|
Errore
|
error | ErrorDBO | |
|
tipo di contenuto
|
contentType | string |
Tipo di contenuto. |
|
failedEntities
|
failedEntities | integer |
Numero di entità non riuscite. |
|
downloadlink
|
downloadlink | string |
Collegamento per scaricare il contenuto. |
|
allegato
|
attachment | Attachment | |
|
link
|
link | string |
Collegamento associato. |
|
documenti
|
documentid | integer |
Identificatore del documento. |
|
progresskey
|
progresskey | string |
Chiave di stato per il rilevamento. |
|
progresskeystatus
|
progresskeystatus | string |
Stato della chiave di stato. |
IntegrationResponseDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
integrationResponseUsersObject
|
integrationResponseUsersObject | IntegrationResponseUsersObject | |
|
failedEntities
|
failedEntities | integer |
Numero di entità che non sono riuscite nell'elaborazione. |
|
successEntities
|
successEntities | integer |
Numero di entità elaborate correttamente. |
IntegrationResponseUsersObject
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
utente
|
user | array of IntegrationUserDBO |
ColumnErrorsDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
colonna
|
column | array of ColumnErrorDBO | |
|
failedEntities
|
failedEntities | integer |
Numero di entità non riuscite a causa di errori di colonna. |
|
successEntities
|
successEntities | integer |
Numero di entità elaborate correttamente. |
ColumnErrorDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
index
|
index | integer |
Posizione di indice della colonna con errore. |
|
columnid
|
columnid | integer |
Identificatore univoco della colonna con errore. |
|
nome
|
name | string |
Nome della colonna con errore. |
|
status
|
status | string |
Stato che indica la condizione di errore. |
|
codice di stato
|
statuscode | string |
Codice che rappresenta lo stato di errore. |
|
message
|
message | string |
Messaggio di errore dettagliato. |
ItemErrorsDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
oggetto
|
item | array of ItemErrorDBO | |
|
failedEntities
|
failedEntities | integer |
Numero di entità non riuscite a causa di errori di elemento. |
|
successEntities
|
successEntities | integer |
Numero di entità elaborate correttamente nonostante gli errori degli elementi. |
ItemErrorDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
index
|
index | integer |
Posizione dell'indice dell'elemento con errore. |
|
columns
|
columns | ColumnErrorsDBO | |
|
itemid
|
itemid | string |
Identificatore univoco dell'elemento con errore. |
|
externalid
|
externalid | string |
Identificatore esterno associato all'elemento. |
|
id
|
id | string |
Identificatore interno dell'elemento. |
|
nome
|
name | string |
Nome dell'elemento con errore. |
|
status
|
status | string |
Stato che indica la condizione di errore. |
|
codice di stato
|
statuscode | string |
Codice che rappresenta lo stato di errore. |
|
message
|
message | string |
Messaggio di errore dettagliato. |
|
successdeletedcount
|
successdeletedcount | integer |
Numero di entità eliminate correttamente. |
|
failurecount
|
failurecount | integer |
Numero di entità che non sono riuscite nell'elaborazione. |
|
failedEntities
|
failedEntities | integer |
Numero di entità non riuscite a causa di errori di elemento. |
|
successEntities
|
successEntities | integer |
Numero di entità elaborate correttamente. |
importISheetTemplateDBO
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
linkedtemplateid
|
linkedtemplateid | integer |
Identificatore del modello collegato. |
|
aliasname
|
aliasname | string |
Nome alias per il modello. |
|
linkedisheet
|
linkedisheet | string |
Identificatore del foglio di input collegato. |
|
importdata
|
importdata | string |
Dati da importare dal modello. |
|
appendisheetname
|
appendisheetname | string |
Nome del foglio a cui aggiungere i dati. |
|
templateparametergroups
|
templateparametergroups | ISheetTemplateParameterGroups | |
|
templateSheetIdMap
|
templateSheetIdMap | object | |
|
ID del modello
|
templateId | integer |
Identificatore del modello. |
|
templateTitle
|
templateTitle | string |
Titolo del modello. |
|
viewIDs
|
viewIDs | string |
Elenco delimitato da virgole di ID visualizzazione. |
ISheetTemplateParameterGroups
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
templateparametergroup
|
templateparametergroup | array of ISheetTemplateParameterGroup |
ISheetTemplateParameterGroup
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
templateruleid
|
templateruleid | integer |
Gruppo di parametri modello Isheet. |
|
templateparameter
|
templateparameter | array of ISheetTemplateParameter |
ISheetTemplateParameter
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | integer |
Identificatore del parametro modello isheet. |
|
nome
|
name | string |
Nome del parametro modello isheet. |
|
data
|
data | string |
dati del parametro modello isheet. |
Attachment
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
documento
|
file | string |
Contenuto del file. |
|
nome
|
name | string |
Nome dell'allegato. |
|
order
|
order | string |
Ordine dell'allegato. |
|
id
|
id | integer |
Identificatore univoco per l'allegato. |
|
extension
|
extension | string |
Estensione. |
|
parentfolderid
|
parentfolderid | integer |
ID della cartella padre. |
|
filehttplink
|
filehttplink | string |
Collegamento HTTP per accedere al file. |
|
folderpath
|
folderpath | string |
Percorso della cartella contenente il file. |
|
folderhttplink
|
folderhttplink | string |
Collegamento HTTP alla cartella. |
|
fileize
|
filesize | integer |
Dimensioni del file in byte. |
|
redactionStatus
|
redactionStatus | boolean |
Indica se il file viene redatto. |
|
displayname
|
displayname | string |
Nome visualizzato dell'allegato. |
|
siteid
|
siteid | integer |
ID del sito associato all'allegato. |