Power Connect di Gestione contenuto
Content Manager è un sistema di gestione dei contenuti aziendale basato sulla governance progettato per aiutare le agenzie governative, i settori regolamentati e le organizzazioni globali a gestire i contenuti aziendali dalla creazione alla eliminazione. Connettersi a Gestione contenuto per eseguire azioni, tra cui la creazione o l'aggiornamento di record o posizioni, il caricamento o il download di file elettronici, la ricerca e altro ancora. (1.0.4.757)
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 | Kapish Services Pty Ltd |
| URL | https://kapish.com.au/products/power_connect/ |
| sales@kapish.com.au |
| Metadati del connettore | |
|---|---|
| Editore | Kapish Services Pty Ltd |
| Sito web | https://kapish.com.au/products/power_connect/ |
| Informativa sulla privacy | https://kapish.com.au/products/privacy-policy/ |
| Categorie | Dati; Contenuto e file |
Content Manager Power Connect by Kapish è un connettore che fornisce funzioni di automazione e integrazione in Content Manager per semplificare la capacità dell'organizzazione di soddisfare i requisiti di gestione e governance delle informazioni.
Pre-requisites
- Un'API del servizio Di Gestione contenuto accessibile esternamente
- Una chiave di sottoscrizione fornita da Kapish Services Pty Ltd
Per un elenco dettagliato di specifiche e requisiti o per ulteriori informazioni su come il connettore può aiutare la tua organizzazione, contatta Kapish Services Pty Ltd
Creazione di una connessione
Il connettore supporta i tipi di autenticazione seguenti:
| OAuth (flusso client riservato) | Usare OAuth per connettersi a Gestione contenuto | Tutte le aree geografiche | Non condivisibile |
| Gestito dal sistema | Usare un nome utente e una password per connettersi a Gestione contenuto | Tutte le aree geografiche | Non condivisibile |
| Impostazione predefinita [DEPRECATO] | Questa opzione è solo per le connessioni meno recenti senza un tipo di autenticazione esplicito e viene fornita solo per la compatibilità con le versioni precedenti. | Tutte le aree geografiche | Non condivisibile |
OAuth (flusso client riservato)
ID autenticazione: OAuth
Applicabile: tutte le aree
Usare OAuth per connettersi a Gestione contenuto
Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.
| Nome | TIPO | Description | Obbligatorio |
|---|---|---|---|
| Chiave di sottoscrizione KPC | securestring | Chiave API per l'accesso a Kapish Power Connect | Vero |
| URL CM ServiceAPI (ad esempio, https://myserver/CMServiceAPI/) | corda | URL in cui è possibile raggiungere l'API del servizio cm | Vero |
| URL del server di autorizzazione ,ad esempio https://myserver/adfs/oauth2/token) | corda | URL per ottenere il token di accesso | Vero |
| ID cliente | corda | ID client per l'autenticazione | Vero |
| Segreto del cliente | securestring | Segreto client per l'autenticazione | Vero |
Gestito dal sistema
ID autenticazione: Basic
Applicabile: tutte le aree
Usare un nome utente e una password per connettersi a Gestione contenuto
Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.
| Nome | TIPO | Description | Obbligatorio |
|---|---|---|---|
| Chiave di sottoscrizione KPC | securestring | Chiave API per l'accesso a Kapish Power Connect | Vero |
| URL CM ServiceAPI (ad esempio, https://myserver/CMServiceAPI/) | corda | URL in cui è possibile raggiungere l'API del servizio cm | Vero |
| Nome utente | corda | Nome utente per l'autenticazione | Vero |
| Parola chiave | securestring | Password per l'autenticazione | Vero |
Impostazione predefinita [DEPRECATO]
Applicabile: tutte le aree
Questa opzione è solo per le connessioni meno recenti senza un tipo di autenticazione esplicito e viene fornita solo per la compatibilità con le versioni precedenti.
Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.
| Nome | TIPO | Description | Obbligatorio |
|---|---|---|---|
| Chiave di sottoscrizione KPC | securestring | Chiave API per l'accesso a Kapish Power Connect | Vero |
| URL CM ServiceAPI (ad esempio, https://myserver/CMServiceAPI/) | corda | URL in cui è possibile raggiungere l'API del servizio cm | Vero |
| URL del server di autorizzazione ,ad esempio https://myserver/adfs/oauth2/token) | corda | URL per ottenere il token di accesso | Vero |
| ID cliente | corda | ID client per l'autenticazione | Vero |
| Segreto del cliente | securestring | Segreto client per l'autenticazione | Vero |
Limiti per la limitazione delle richieste
| Nome | Chiamate | Periodo di rinnovo |
|---|---|---|
| Chiamate API per connessione | 100 | 60 secondi |
Azioni
| Aggiorna record (allega azione o routine) |
Allegare un'azione o una routine a un record |
| Aggiorna record (annulla estrazione) |
Annullare un checkout precedente del documento elettronico per questo record, ignorando le eventuali modifiche apportate dal momento in cui è stato estratto |
| Aggiorna record (avanzato) |
Aggiornare un record con proprietà avanzate |
| Aggiorna record (azione riassegna) |
Riassegna l'azione designata a una posizione specificata |
| Aggiorna record (azioni di riprogrammazione) |
Riprogramma tutte le azioni associate a questo record |
| Aggiorna record (campi aggiuntivi) |
Aggiornare campi aggiuntivi in un record |
| Aggiorna record (checkout) |
Impostare lo stato del record su estratto |
| Aggiorna record (chiudi) |
Usare la funzione CloseRecord per chiudere un contenitore, lasciare vuota la data se si vuole che la data di chiusura sia "ora". Poiché la chiusura di un record può richiedere l'aggiornamento di molti record contenuti, questa funzione esegue automaticamente il commit delle modifiche |
| Aggiorna record (classificazione) |
Aggiornare la classificazione di un record |
| Aggiorna record (Dispose) |
Eliminare un record |
| Aggiorna record (imposta etichetta utente) |
Consente l'impostazione di un'etichetta utente in un record |
| Aggiorna record (proprietà) |
Aggiornare un record |
| Aggiorna record (rendering richiesta) |
Consente di creare una richiesta per il motore di rendering automatico per eseguire un rendering di un record |
| Aggiorna record (riaperto) |
Usare la funzione ReopenRecord per riaprire un contenitore chiuso. Poiché l'apertura di un record può richiedere l'aggiornamento di molti record contenuti, questa funzione esegue automaticamente il commit delle modifiche |
| Aggiorna record (rimuovi tutte le azioni) |
Rimuove tutte le azioni associate al record specificato |
| Aggiorna record (sostituisci controlli di accesso) |
SetAccessControl |
| Aggiornare il record (impostare l'accesso senza restrizioni o in base al contenitore) |
InheritAccessControl |
| Carica file elettronici |
Caricare un file elettronico che in un secondo momento può essere allegato a un record |
| Crea percorso (altro) |
Creare un percorso di qualsiasi tipo |
| Crea posizione (persona) |
Creare una posizione di persona |
| Crea record (avanzato) |
Creare un record con campi avanzati |
| Crea record (cartella) |
Creare un record |
| Crea record (documento) |
Creare un record |
| Elimina record |
Eliminare un record |
| Leggere i dati dell'evento |
Trasformare i dati dell'evento Kapish Dispatch per l'utilizzo del flusso |
| Ottenere un file dall'URL |
Scaricare un file dall'URL a un'area di gestione temporanea usando il plug-in dell'API del servizio CM 'GetFileFromUrl' |
| Percorso aggiornamento (campi aggiuntivi) |
Aggiornare campi aggiuntivi in un percorso |
| Percorso aggiornamento (indirizzo) |
Creare/aggiornare l'indirizzo di una posizione usando l'ID univoco dell'indirizzo |
| Percorso di aggiornamento (altro) |
Aggiornare un percorso |
| Percorso di aggiornamento (persona) |
Aggiornare una posizione di persona usando il relativo identificatore univoco |
| Record di aggiornamento (aggiunta di controlli di accesso) |
AddAccessControl |
| Record di aggiornamento (allega file elettronici) |
Allegare un file elettronico a un record |
| Record di aggiornamento (allegare il termine del thesaurus) |
Collegare un termine del thesaurus a un record |
| Record di aggiornamento (azioni complete) |
Completare una o tutte le azioni dovute a un determinato record |
| Record di aggiornamento (collega contatto) |
Allegare un contatto a un record |
| Record di aggiornamento (rimuovi posizione dai controlli di accesso) |
RemoveAccessControl |
| Scarica file elettronici |
Scaricare un file elettronico di un record |
| Trova posizione in base all'ID |
Recuperare un'unica posizione in base all'ID univoco o al nome |
| Trova posizioni |
Cercare Locations (Recuperare una raccolta di percorsi usando una stringa di ricerca) |
| Trova record |
Cercare Record (recuperare una raccolta di record usando una stringa di ricerca) |
| Trova record (avanzato) |
Cercare Records (Recuperare un insieme di record usando una stringa di ricerca). Restituisce una risposta ServiceAPI di Content Manager non elaborata. |
| Trova record per ID |
Recuperare un singolo record in base all'ID univoco o al nome |
| Trovare l'ID univoco dell'indirizzo di posizione |
Ottenere l'ID univoco dell'indirizzo figlio di una località |
| Trovare oggetti CM |
Cercare oggetti CM |
| Update Record (Finalise) |
Aggiornare un record bozza |
| Update Record (Set Assignee) |
Impostare l'assegnatario su una determinata posizione, tornare a Home o registrarsi come mancante |
| Update Record (Undispose) |
Ripristina lo stato del record (e il relativo contenuto) in modo che non venga più eliminato |
| Update Record (Unfinalise - Set As Draft) |
Aggiornare un record finalizzato alla bozza |
Aggiorna record (allega azione o routine)
Allegare un'azione o una routine a un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Azione da allegare
|
ActionToAttach | True | integer | |
|
Id univoco assegnatario
|
NewAssignee | integer | ||
|
Opzione Assignee
|
AssigneeOption | string | ||
|
Data di inizio pianificazione
|
ScheduleStartDate | date | ||
|
Azione esistente
|
RecordAction | integer | ||
|
Inserisci posizione
|
InsertPos | string | ||
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Aggiorna record (annulla estrazione)
Annullare un checkout precedente del documento elettronico per questo record, ignorando le eventuali modifiche apportate dal momento in cui è stato estratto
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Comments
|
Comments | string | ||
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Aggiorna record (avanzato)
Aggiornare un record con proprietà avanzate
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Tipo di record
|
RecordRecordType | string | ||
|
Classification
|
RecordClassification | string |
Specificare l'identificatore univoco della classificazione |
|
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
|
|
Autore
|
RecordAuthor | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Numero di adesione
|
RecordAccessionNumber | string | ||
|
Destinatario
|
RecordAddressee | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Contenitore alternativo
|
RecordAlternativeContainer | string | ||
|
Assegnatario
|
RecordAssignee | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Livello di confidenza classificazione automatica
|
RecordAutoClassificationConfidenceLevel | string | ||
|
Rendering automatico in PDF al salvataggio
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Ignorare i controlli di accesso ai tipi di record
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Ignora salva?
|
ByPassSave | boolean |
True per non salvare l'oggetto. Uno di questi elementi consiste nell'impostare una o più proprietà in un post record e restituire il modulo di immissione dei dati. Il modulo di immissione dati rifletterà quindi le varie proprietà impostate sull'oggetto Record originale. |
|
|
Cambia posizione all'interno dei preferiti
|
ChangePositionWithinFavorites | string |
Quando si cercano i preferiti, questi verranno restituiti in questo ordine, a meno che non venga usato un altro ordinamento. |
|
|
Cambia posizione all'interno dell'etichetta utente
|
ChangePositionWithinUserLabel | string |
Quando si esegue la ricerca da UserLabel, questi verranno restituiti in questo ordine, a meno che non venga usato un altro ordinamento. |
|
|
Archiviazione come
|
CheckinAs | string |
Impostare la proprietà Source del documento elettronico. |
|
|
Classe di record
|
RecordClassOfRecord | string | ||
|
Cliente
|
RecordClient | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Client Record
|
RecordClientRecord | string | ||
|
Comments
|
comments | string |
Commenti da inserire nelle Note record quando il documento viene caricato. |
|
|
Spedizione
|
RecordConsignment | string | ||
|
Oggetto vettura
|
RecordConsignmentObject | string | ||
|
Contenitore
|
RecordContainer | string | ||
|
Copia documento da record
|
CopyDocumentFromRecord | string |
Specificare un ID univoco per il record da cui copiare il documento elettronico per questo oggetto Record. |
|
|
Creatore
|
RecordCreator | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Data creazione
|
RecordDateCreated | string | ||
|
Data di scadenza
|
RecordDateDue | string | ||
|
Data di pubblicazione
|
RecordDatePublished | string | ||
|
Data ricezione
|
RecordDateReceived | string | ||
|
Redattore
|
RecordEditor | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Archivio documenti elettronici
|
RecordEStore | string | ||
|
Riferimento esterno
|
RecordExternalReference | string | ||
|
Errori in caso di avvisi?
|
FailOnWarnings | boolean |
True per non creare/salvare un oggetto se sono presenti avvisi. |
|
|
Nome file nella cartella Uploads
|
RecordFilePath | string |
Nome file visualizzato nella cartella Uploads. |
|
|
Finalizzare al salvataggio
|
RecordFinalizeOnSave | boolean | ||
|
Codice a barre esterno
|
RecordForeignBarcode | string | ||
|
Posizione GPS
|
RecordGpsLocation | string | ||
|
Home Location
|
RecordHomeLocation | string |
ID univoco della posizione |
|
|
Spazio home
|
RecordHomeSpace | string | ||
|
È racchiuso
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Mantieni estratto
|
keepBookedOut | boolean |
True per lasciare estratto il record dopo il caricamento del documento elettronico. |
|
|
Data ultima azione
|
RecordLastActionDate | string | ||
|
Numero lungo
|
RecordLongNumber | string | ||
|
Rendi attivo
|
MakeActive | string |
Ripristina lo stato del record (e uno dei relativi contenuti) in modo che non sia più inattivo. Durante l'elaborazione del contenuto è possibile specificare se l'attività deve interrompersi in caso di errori. |
|
|
Rendi inattivo
|
MakeInactive | string |
Imposta dateInactive per questo record e il relativo contenuto. Durante l'elaborazione del contenuto è possibile specificare se l'attività deve interrompersi in caso di errori. |
|
|
Apportare una nuova revisione
|
makeNewRevision | boolean |
True per creare una nuova revisione con questo documento elettronico false per sostituire la revisione corrente. |
|
|
Data di distruzione manuale
|
RecordManualDestructionDate | string | ||
|
Record materia
|
RecordMatterRecord | string | ||
|
Tipo di media
|
RecordMediaType | string | ||
|
Commenti relativi all'autorizzazione
|
RecordMyAuthorizationComments | string | ||
|
Autorizzazione completata
|
RecordMyAuthorizationComplete | boolean | ||
|
Commenti per la mia recensione
|
RecordMyReviewComments | string | ||
|
La mia recensione è stata completata
|
RecordMyReviewComplete | boolean | ||
|
È necessaria l'autorizzazione?
|
RecordNeedsAuthorization | boolean | ||
|
È necessario rivedere?
|
RecordNeedsReview | boolean | ||
|
Nuova regola di creazione di parti
|
RecordNewPartCreationRule | string |
ID univoco della regola di creazione di parti automatica |
|
|
Note
|
RecordNotes | string | ||
|
Tipo di aggiornamento note
|
NotesUpdateType | string | ||
|
Altro contatto
|
RecordOtherContact | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Posizione del proprietario
|
RecordOwnerLocation | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Gerarchia del preserver nell'immissione dei dati?
|
RecordPreserveHierarchyOnDataEntry | boolean | ||
|
Record della parte precedente
|
RecordPrevPartRecord | string | ||
|
Priority
|
RecordPriority | string | ||
|
Nuovo tipo di record
|
RecordNewType | string |
Lasciare l'impostazione predefinita a meno che non venga creata una nuova versione o copia della nuova parte. |
|
|
Record correlato
|
RecordRelatedRecord | string | ||
|
Rappresentativo
|
RecordRepresentative | string | ||
|
Pianificazione conservazione
|
RecordRetentionSchedule | string | ||
|
Data revisione
|
RecordReviewDate | string | ||
|
Verifica data di scadenza
|
RecordReviewDueDate | string | ||
|
Esaminare lo stato
|
RecordReviewState | string | ||
|
Security
|
RecordSecurity | string | ||
|
Record serie
|
RecordSeriesRecord | string | ||
|
Titolo (parte testo libero)
|
RecordTypedTitle | string | ||
|
Stringa di query
|
q | string |
Specificare una query in questo caso per applicare l'aggiornamento a un set di record anziché a uno (come specificato dall'ID univoco). |
Restituisce
- Corpo
- CMRecordsResponse
Aggiorna record (azione riassegna)
Riassegna l'azione designata a una posizione specificata
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Nuovo assegnatario
|
NewAssignee | True | string |
ID univoco o indirizzo di posta elettronica del nuovo assegnatario |
|
Azione di riassegnazione
|
RecordActionUri | True | integer | |
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Aggiorna record (azioni di riprogrammazione)
Riprogramma tutte le azioni associate a questo record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Dalla data di base
|
FromBaseDate | date | ||
|
Usa durate effettive
|
UseActualDurations | boolean | ||
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Aggiorna record (campi aggiuntivi)
Aggiornare campi aggiuntivi in un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | integer | ||
|
Nome
|
SearchClause | string | ||
|
Value
|
Value | string | ||
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Aggiorna record (checkout)
Impostare lo stato del record su estratto
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Comments
|
Comments | string | ||
|
Salva percorso di estrazione con nome
|
SaveCheckoutPathAs | string | ||
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Aggiorna record (chiudi)
Usare la funzione CloseRecord per chiudere un contenitore, lasciare vuota la data se si vuole che la data di chiusura sia "ora". Poiché la chiusura di un record può richiedere l'aggiornamento di molti record contenuti, questa funzione esegue automaticamente il commit delle modifiche
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Continua in caso di errore?
|
ContinueOnError | boolean | ||
|
Racchiudere il contenuto?
|
EncloseContents | boolean | ||
|
Finalizzare il contenuto?
|
FinalizeContents | boolean | ||
|
Solo errori di log?
|
LogErrorsOnly | boolean | ||
|
Risultati del log?
|
LogResults | boolean |
Restituisce un log di testo dei record chiusi nella proprietà Log Message? |
|
|
Ripulire le revisioni del contenuto?
|
PurgeContentRevisions | boolean | ||
|
Data di chiusura specifica?
|
SpecificCloseDate | date | ||
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMLogResponse
Aggiorna record (classificazione)
Aggiornare la classificazione di un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Classification
|
RecordClassification | True | string |
Specificare l'identificatore univoco della classificazione |
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Aggiorna record (Dispose)
Eliminare un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Continuare in caso di errore?
|
ContinueOnError | boolean | ||
|
Metodo di eliminazione
|
MethodOfDisposal | string | ||
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Aggiorna record (imposta etichetta utente)
Consente l'impostazione di un'etichetta utente in un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Record
|
Uri | True | integer |
ID univoco del record a cui associare l'etichetta utente |
|
Etichetta utente
|
UserLabel | True | string |
ID univoco o nome dell'etichetta utente da applicare |
|
Tipo preferito
|
FavouriteType | string | ||
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Aggiorna record (proprietà)
Aggiornare un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | integer | ||
|
Query
|
q | string |
Specificare una query qui per applicare l'aggiornamento a un set di record anziché a uno (come specificato dall'ID univoco) |
|
|
Titolo (parte testo libero)
|
RecordTypedTitle | string | ||
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
|
|
Autore
|
RecordAuthor | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Contenitore
|
RecordContainer | string | ||
|
Classification
|
RecordClassification | string |
Specificare l'identificatore univoco della classificazione |
|
|
Destinatario
|
RecordAddressee | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Contenitore alternativo
|
RecordAlternativeContainer | string | ||
|
Assegnatario
|
RecordAssignee | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Rendering automatico in PDF al salvataggio
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Ignorare i controlli di accesso ai tipi di record
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Archiviazione come
|
CheckinAs | string |
Impostare la proprietà Source del documento elettronico. |
|
|
Cliente
|
RecordClient | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Client Record
|
RecordClientRecord | string | ||
|
Copia documento da record
|
CopyDocumentFromRecord | string |
Specificare un ID univoco per il record da cui copiare il documento elettronico per questo oggetto Record. |
|
|
Creatore
|
RecordCreator | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Data creazione
|
RecordDateCreated | string | ||
|
Data di scadenza
|
RecordDateDue | string | ||
|
Data di pubblicazione
|
RecordDatePublished | string | ||
|
Data ricezione
|
RecordDateReceived | string | ||
|
Riferimento esterno
|
RecordExternalReference | string | ||
|
Errori in caso di avvisi?
|
FailOnWarnings | boolean |
True per non creare/salvare un oggetto se sono presenti avvisi. |
|
|
Nome file nella cartella Uploads
|
RecordFilePath | string |
Nome file visualizzato nella cartella Uploads. |
|
|
Finalizzare al salvataggio
|
RecordFinalizeOnSave | boolean | ||
|
Codice a barre esterno
|
RecordForeignBarcode | string | ||
|
Posizione GPS
|
RecordGpsLocation | string | ||
|
Home Location
|
RecordHomeLocation | string |
ID univoco della posizione |
|
|
Spazio home
|
RecordHomeSpace | string | ||
|
È racchiuso
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Mantieni estratto
|
keepBookedOut | boolean |
True per lasciare estratto il record dopo il caricamento del documento elettronico. |
|
|
Numero lungo
|
RecordLongNumber | string | ||
|
Tipo di media
|
RecordMediaType | string | ||
|
Note
|
RecordNotes | string | ||
|
Tipo di aggiornamento note
|
NotesUpdateType | string | ||
|
Altro contatto
|
RecordOtherContact | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Posizione del proprietario
|
RecordOwnerLocation | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Record correlato
|
RecordRelatedRecord | string | ||
|
Rappresentativo
|
RecordRepresentative | string | ||
|
Data revisione
|
RecordReviewDate | string | ||
|
Verifica data di scadenza
|
RecordReviewDueDate | string | ||
|
Esaminare lo stato
|
RecordReviewState | string | ||
|
Security
|
RecordSecurity | string |
Restituisce
- Corpo
- CMRecordsResponse
Aggiorna record (rendering richiesta)
Consente di creare una richiesta per il motore di rendering automatico per eseguire un rendering di un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Tipo di rendering
|
RenditionType | True | string | |
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Aggiorna record (riaperto)
Usare la funzione ReopenRecord per riaprire un contenitore chiuso. Poiché l'apertura di un record può richiedere l'aggiornamento di molti record contenuti, questa funzione esegue automaticamente il commit delle modifiche
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Continua in caso di errore?
|
ContinueOnError | boolean | ||
|
Risultati del log?
|
LogResults | boolean |
Restituisce un log di testo dei record riaperti nella proprietà Log Message? |
|
|
Unfinalize Contents?
|
UnfinalizeContents | boolean | ||
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMLogResponse
Aggiorna record (rimuovi tutte le azioni)
Rimuove tutte le azioni associate al record specificato
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Aggiorna record (sostituisci controlli di accesso)
SetAccessControl
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Identificatore univoco
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
ID univoco
|
Uri | integer |
Identificatore univoco percorso |
Restituisce
- Corpo
- CMRecordsResponse
Aggiornare il record (impostare l'accesso senza restrizioni o in base al contenitore)
InheritAccessControl
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Identificatore univoco
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
ID univoco
|
Uri | integer |
Identificatore univoco percorso |
Restituisce
- Corpo
- CMRecordsResponse
Carica file elettronici
Caricare un file elettronico che in un secondo momento può essere allegato a un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Nome del file
|
RecordFilePath | True | string | |
|
Identificatore univoco
|
Uri | True | string |
Crea percorso (altro)
Creare un percorso di qualsiasi tipo
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Tipo di posizione
|
LocationTypeOfLocation | string | ||
|
Nome
|
LocationSortName | True | string | |
|
Nome univoco
|
LocationNickName | string | ||
|
Numero ID
|
LocationIdNumber | string | ||
|
Interno
|
LocationIsWithin | boolean | ||
|
Telefono ufficio
|
LocationPhoneNumber | string | ||
|
Cellulare
|
LocationMobileNumber | string | ||
|
Fax
|
LocationFaxNumber | string | ||
|
Telefono di casa
|
LocationAfterHoursPhoneNumber | string | ||
|
Uguale all'indirizzo
|
LocationUseAddressOf | integer |
ID univoco della posizione |
|
|
Tipo di indirizzo
|
LocationAddressAddressType | string |
Selezionare tipo di indirizzo. Limite di uno per tipo. |
|
|
Via
|
LocationAddressAddressLines | string | ||
|
Sobborgo/Città
|
LocationAddressCity | string | ||
|
stato
|
LocationAddressState | string | ||
|
Codice postale
|
LocationAddressPostcode | string | ||
|
Paese
|
LocationAddressCountry | string | ||
|
Imposta valore predefinito
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
ID univoco correlato
|
AddRelationshipRelatedLocation | integer | ||
|
TIPO
|
AddRelationshipRelationshipType | string | ||
|
Indirizzo di posta elettronica
|
LocationEmailAddress | string | ||
|
Da
|
SetActiveDateRangeValidFromDate | string |
gg/mm/aaaaa |
|
|
Per
|
SetActiveDateRangeValidToDate | string |
gg/mm/aaaaa |
|
|
Note
|
LocationNotes | string | ||
|
Tipo di aggiornamento note
|
NotesUpdateType | string |
Restituisce
- Corpo
- CMLocationsResponse
Crea posizione (persona)
Creare una posizione di persona
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Titolo
|
LocationHonorific | string | ||
|
Cognome
|
LocationSurname | string | ||
|
Nome di battesimo
|
LocationGivenNames | string | ||
|
Interno
|
LocationIsWithin | boolean | ||
|
Posizione
|
LocationJobDescription | string | ||
|
Data di nascita
|
LocationDateOfBirth | string | ||
|
Saluto
|
LocationSalutation | string | ||
|
Nome univoco
|
LocationNickName | string | ||
|
Numero ID
|
LocationIdNumber | string | ||
|
Telefono ufficio
|
LocationPhoneNumber | string | ||
|
Cellulare
|
LocationMobileNumber | string | ||
|
Fax
|
LocationFaxNumber | string | ||
|
Telefono di casa
|
LocationAfterHoursPhoneNumber | string | ||
|
Uguale all'indirizzo
|
LocationUseAddressOf | integer |
ID univoco della posizione |
|
|
Tipo di indirizzo
|
LocationAddressAddressType | string |
Selezionare tipo di indirizzo. Limite di uno per tipo. |
|
|
Via
|
LocationAddressAddressLines | string | ||
|
Sobborgo/Città
|
LocationAddressCity | string | ||
|
stato
|
LocationAddressState | string | ||
|
Codice postale
|
LocationAddressPostcode | string | ||
|
Paese
|
LocationAddressCountry | string | ||
|
Imposta valore predefinito
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
ID univoco correlato
|
AddRelationshipRelatedLocation | integer | ||
|
TIPO
|
AddRelationshipRelationshipType | string | ||
|
Indirizzo di posta elettronica
|
LocationEmailAddress | string | ||
|
Sesso
|
LocationGenderValue | string | ||
|
Accettazione degli account di accesso
|
LocationCanLogin | boolean | ||
|
Account di accesso alla rete
|
LocationLogsInAs | string | ||
|
Account di accesso di rete aggiuntivo
|
LocationAdditionalLogin | string | ||
|
Login Expires On
|
LocationLoginExpires | string | ||
|
Profilo utente di
|
LocationUseProfileOf | integer |
ID univoco della posizione |
|
|
Tipo di utente
|
LocationUserType | string | ||
|
Stringa di sicurezza
|
LocationSecurityString | string | ||
|
Da
|
SetActiveDateRangeValidFromDate | string |
gg/mm/aaaaa |
|
|
Per
|
SetActiveDateRangeValidToDate | string |
gg/mm/aaaaa |
|
|
Note
|
LocationNotes | string | ||
|
Tipo di aggiornamento note
|
NotesUpdateType | string |
Restituisce
- Corpo
- CMLocationsResponse
Crea record (avanzato)
Creare un record con campi avanzati
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Tipo di record
|
RecordRecordType | True | string | |
|
Titolo (parte testo libero)
|
RecordTypedTitle | True | string | |
|
Classification
|
RecordClassification | string |
Specificare l'identificatore univoco della classificazione |
|
|
Autore
|
RecordAuthor | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
|
|
Numero di adesione
|
RecordAccessionNumber | string | ||
|
Destinatario
|
RecordAddressee | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Contenitore alternativo
|
RecordAlternativeContainer | string | ||
|
Assegnatario
|
RecordAssignee | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Livello di confidenza classificazione automatica
|
RecordAutoClassificationConfidenceLevel | string | ||
|
Rendering automatico in PDF al salvataggio
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Ignorare i controlli di accesso ai tipi di record
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Ignora salva?
|
ByPassSave | boolean |
True per non salvare l'oggetto. Uno di questi elementi consiste nell'impostare una o più proprietà in un post record e restituire il modulo di immissione dei dati. Il modulo di immissione dati rifletterà quindi le varie proprietà impostate sull'oggetto Record originale. |
|
|
Cambia posizione all'interno dei preferiti
|
ChangePositionWithinFavorites | string |
Quando si cercano i preferiti, questi verranno restituiti in questo ordine, a meno che non venga usato un altro ordinamento. |
|
|
Cambia posizione all'interno dell'etichetta utente
|
ChangePositionWithinUserLabel | string |
Quando si esegue la ricerca da UserLabel, questi verranno restituiti in questo ordine, a meno che non venga usato un altro ordinamento. |
|
|
Archiviazione come
|
CheckinAs | string |
Impostare la proprietà Source del documento elettronico. |
|
|
Classe di record
|
RecordClassOfRecord | string | ||
|
Cliente
|
RecordClient | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Client Record
|
RecordClientRecord | string | ||
|
Comments
|
comments | string |
Commenti da inserire nelle Note record quando il documento viene caricato. |
|
|
Spedizione
|
RecordConsignment | string | ||
|
Oggetto vettura
|
RecordConsignmentObject | string | ||
|
Contenitore
|
RecordContainer | string | ||
|
Copia documento da record
|
CopyDocumentFromRecord | string |
Specificare un ID univoco per il record da cui copiare il documento elettronico per questo oggetto Record. |
|
|
Creatore
|
RecordCreator | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Data creazione
|
RecordDateCreated | string | ||
|
Data di scadenza
|
RecordDateDue | string | ||
|
Data di pubblicazione
|
RecordDatePublished | string | ||
|
Data ricezione
|
RecordDateReceived | string | ||
|
Redattore
|
RecordEditor | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Riferimento esterno
|
RecordExternalReference | string | ||
|
Errori in caso di avvisi?
|
FailOnWarnings | boolean |
True per non creare/salvare un oggetto se sono presenti avvisi. |
|
|
Nome file nella cartella Uploads
|
RecordFilePath | string |
Nome file visualizzato nella cartella Uploads. |
|
|
Finalizzare al salvataggio
|
RecordFinalizeOnSave | boolean | ||
|
Codice a barre esterno
|
RecordForeignBarcode | string | ||
|
Posizione GPS
|
RecordGpsLocation | string | ||
|
Home Location
|
RecordHomeLocation | string |
ID univoco della posizione |
|
|
Spazio home
|
RecordHomeSpace | string | ||
|
Avviare il modello
|
RecordInitiateTemplate | string | ||
|
È racchiuso
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Mantieni estratto
|
keepBookedOut | boolean |
True per lasciare estratto il record dopo il caricamento del documento elettronico. |
|
|
Data ultima azione
|
RecordLastActionDate | string | ||
|
Numero lungo
|
RecordLongNumber | string | ||
|
Rendi attivo
|
MakeActive | string |
Ripristina lo stato del record (e uno dei relativi contenuti) in modo che non sia più inattivo. Durante l'elaborazione del contenuto è possibile specificare se l'attività deve interrompersi in caso di errori. |
|
|
Rendi inattivo
|
MakeInactive | string |
Imposta dateInactive per questo record e il relativo contenuto. Durante l'elaborazione del contenuto è possibile specificare se l'attività deve interrompersi in caso di errori. |
|
|
Apportare una nuova revisione
|
makeNewRevision | boolean |
True per creare una nuova revisione con questo documento elettronico false per sostituire la revisione corrente. |
|
|
Data di distruzione manuale
|
RecordManualDestructionDate | string | ||
|
Record materia
|
RecordMatterRecord | string | ||
|
Tipo di media
|
RecordMediaType | string | ||
|
Commenti relativi all'autorizzazione
|
RecordMyAuthorizationComments | string | ||
|
Autorizzazione completata
|
RecordMyAuthorizationComplete | boolean | ||
|
Commenti per la mia recensione
|
RecordMyReviewComments | string | ||
|
La mia recensione è stata completata
|
RecordMyReviewComplete | boolean | ||
|
È necessaria l'autorizzazione?
|
RecordNeedsAuthorization | boolean | ||
|
È necessario rivedere?
|
RecordNeedsReview | boolean | ||
|
Nuova regola di creazione di parti
|
RecordNewPartCreationRule | string |
ID univoco della regola di creazione di parti automatica |
|
|
Note
|
RecordNotes | string | ||
|
Tipo di aggiornamento note
|
NotesUpdateType | string | ||
|
Altro contatto
|
RecordOtherContact | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Posizione del proprietario
|
RecordOwnerLocation | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Gerarchia del preserver nell'immissione dei dati?
|
RecordPreserveHierarchyOnDataEntry | boolean | ||
|
Record della parte precedente
|
RecordPrevPartRecord | string | ||
|
Priority
|
RecordPriority | string | ||
|
Nuovo tipo di record
|
RecordNewType | string |
Lasciare l'impostazione predefinita a meno che non venga creata una nuova versione o copia della nuova parte. |
|
|
Record correlato
|
RecordRelatedRecord | string | ||
|
Rappresentativo
|
RecordRepresentative | string | ||
|
Pianificazione conservazione
|
RecordRetentionSchedule | string | ||
|
Data revisione
|
RecordReviewDate | string | ||
|
Verifica data di scadenza
|
RecordReviewDueDate | string | ||
|
Esaminare lo stato
|
RecordReviewState | string | ||
|
Security
|
RecordSecurity | string | ||
|
Record serie
|
RecordSeriesRecord | string | ||
|
Set di proprietà
|
propertySets | string |
Specificare set di proprietà oltre a quelli inseriti per essere restituiti dalla richiesta. |
|
|
Stringa di query
|
q | string |
Specificare una query in questo caso per applicare l'aggiornamento a un set di record anziché a uno (come specificato dall'ID univoco). |
Restituisce
- Corpo
- CMRecordsResponse
Crea record (cartella)
Creare un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Tipo di record
|
RecordRecordType | True | string | |
|
Titolo (parte testo libero)
|
RecordTypedTitle | True | string | |
|
Classification
|
RecordClassification | string |
Specificare l'identificatore univoco della classificazione |
|
|
Contenitore
|
RecordContainer | string | ||
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
|
|
Autore
|
RecordAuthor | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Destinatario
|
RecordAddressee | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Contenitore alternativo
|
RecordAlternativeContainer | string | ||
|
Assegnatario
|
RecordAssignee | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Ignorare i controlli di accesso ai tipi di record
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Cliente
|
RecordClient | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Creatore
|
RecordCreator | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Data creazione
|
RecordDateCreated | string | ||
|
Data di scadenza
|
RecordDateDue | string | ||
|
Data di pubblicazione
|
RecordDatePublished | string | ||
|
Riferimento esterno
|
RecordExternalReference | string | ||
|
Errori in caso di avvisi?
|
FailOnWarnings | boolean |
True per non creare/salvare un oggetto se sono presenti avvisi. |
|
|
Nome file nella cartella Uploads
|
RecordFilePath | string |
Nome file visualizzato nella cartella Uploads. |
|
|
Codice a barre esterno
|
RecordForeignBarcode | string | ||
|
Posizione GPS
|
RecordGpsLocation | string | ||
|
Home Location
|
RecordHomeLocation | string |
ID univoco della posizione |
|
|
Spazio home
|
RecordHomeSpace | string | ||
|
È racchiuso
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Data ultima azione
|
RecordLastActionDate | string | ||
|
Numero lungo
|
RecordLongNumber | string | ||
|
Note
|
RecordNotes | string | ||
|
Tipo di aggiornamento note
|
NotesUpdateType | string | ||
|
Altro contatto
|
RecordOtherContact | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Posizione del proprietario
|
RecordOwnerLocation | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Record correlato
|
RecordRelatedRecord | string | ||
|
Rappresentativo
|
RecordRepresentative | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Data revisione
|
RecordReviewDate | string | ||
|
Verifica data di scadenza
|
RecordReviewDueDate | string | ||
|
Esaminare lo stato
|
RecordReviewState | string | ||
|
Security
|
RecordSecurity | string |
Restituisce
- Corpo
- CMRecordsResponse
Crea record (documento)
Creare un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Tipo di record
|
RecordRecordType | True | string | |
|
Titolo (parte testo libero)
|
RecordTypedTitle | True | string | |
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
|
|
Autore
|
RecordAuthor | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Destinatario
|
RecordAddressee | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Contenitore alternativo
|
RecordAlternativeContainer | string | ||
|
Assegnatario
|
RecordAssignee | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Rendering automatico in PDF al salvataggio
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Ignorare i controlli di accesso ai tipi di record
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Archiviazione come
|
CheckinAs | string |
Impostare la proprietà Source del documento elettronico. |
|
|
Classification
|
RecordClassification | string |
Specificare l'identificatore univoco della classificazione |
|
|
Cliente
|
RecordClient | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Client Record
|
RecordClientRecord | string | ||
|
Contenitore
|
RecordContainer | string | ||
|
Copia documento da record
|
CopyDocumentFromRecord | string |
Specificare un ID univoco per il record da cui copiare il documento elettronico per questo oggetto Record. |
|
|
Creatore
|
RecordCreator | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Data creazione
|
RecordDateCreated | string | ||
|
Data di scadenza
|
RecordDateDue | string | ||
|
Data di pubblicazione
|
RecordDatePublished | string | ||
|
Data ricezione
|
RecordDateReceived | string | ||
|
Riferimento esterno
|
RecordExternalReference | string | ||
|
Errori in caso di avvisi?
|
FailOnWarnings | boolean |
True per non creare/salvare un oggetto se sono presenti avvisi. |
|
|
Nome file nella cartella Uploads
|
RecordFilePath | string |
Nome file visualizzato nella cartella Uploads. |
|
|
Finalizzare al salvataggio
|
RecordFinalizeOnSave | boolean | ||
|
Codice a barre esterno
|
RecordForeignBarcode | string | ||
|
Posizione GPS
|
RecordGpsLocation | string | ||
|
Home Location
|
RecordHomeLocation | string |
ID univoco della posizione |
|
|
Spazio home
|
RecordHomeSpace | string | ||
|
È racchiuso
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Mantieni estratto
|
keepBookedOut | boolean |
True per lasciare estratto il record dopo il caricamento del documento elettronico. |
|
|
Data ultima azione
|
RecordLastActionDate | string | ||
|
Numero lungo
|
RecordLongNumber | string | ||
|
Tipo di media
|
RecordMediaType | string | ||
|
Note
|
RecordNotes | string | ||
|
Tipo di aggiornamento note
|
NotesUpdateType | string | ||
|
Altro contatto
|
RecordOtherContact | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Posizione del proprietario
|
RecordOwnerLocation | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Record correlato
|
RecordRelatedRecord | string | ||
|
Rappresentativo
|
RecordRepresentative | string |
ID univoco o indirizzo di posta elettronica della località |
|
|
Data revisione
|
RecordReviewDate | string | ||
|
Verifica data di scadenza
|
RecordReviewDueDate | string | ||
|
Esaminare lo stato
|
RecordReviewState | string | ||
|
Security
|
RecordSecurity | string |
Restituisce
- Corpo
- CMRecordsResponse
Elimina record
Eliminare un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer |
ID univoco del record da eliminare |
|
Elimina contenuto?
|
DeleteContents | True | boolean | |
|
Nuova home page per il contenuto
|
NewHomeForContents | string |
ID univoco o indirizzo di posta elettronica del nuovo percorso home per il contenuto |
Restituisce
- Corpo
- CMRecordsResponse
Leggere i dati dell'evento
Trasformare i dati dell'evento Kapish Dispatch per l'utilizzo del flusso
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Content
|
Content | string |
Contenuto dell'azione del bus di servizio che ha recuperato i dati dell'evento CM |
Restituisce
- Corpo
- CMEventData
Ottenere un file dall'URL
Scaricare un file dall'URL a un'area di gestione temporanea usando il plug-in dell'API del servizio CM 'GetFileFromUrl'
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
URL del file
|
url | True | string |
URL non codificato del file da scaricare |
|
Nome file da salvare con nome
|
filename | string |
Nome file per salvare l'URL scaricato come (solo il nome file con suffisso, non includere la directory completa) |
|
|
Tipo di contenuto
|
contentType | string |
Stringa tipica trovata nella maggior parte dell'intestazione Content-Type (ad esempio image/png, text/plain, application/pdf). |
Restituisce
Risposta dal plug-in dell'API del servizio CM 'GetFileFromUrl'.
Percorso aggiornamento (campi aggiuntivi)
Aggiornare campi aggiuntivi in un percorso
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | integer | ||
|
Nome
|
SearchClause | string | ||
|
Value
|
Value | string |
Restituisce
- Corpo
- CMLocationsResponse
Percorso aggiornamento (indirizzo)
Creare/aggiornare l'indirizzo di una posizione usando l'ID univoco dell'indirizzo
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer |
URI della posizione esistente da aggiornare |
|
ID univoco
|
Uri | integer |
URI dell'indirizzo stradale o postale esistente da aggiornare |
|
|
TIPO
|
LocationAddressAddressType | string |
Selezionare tipo di indirizzo. Limite di uno per tipo. |
|
|
Via
|
LocationAddressAddressLines | string | ||
|
Sobborgo/Città
|
LocationAddressCity | string | ||
|
stato
|
LocationAddressState | string | ||
|
Codice postale
|
LocationAddressPostcode | string | ||
|
Paese
|
LocationAddressCountry | string |
Restituisce
- Corpo
- CMLocationsResponse
Percorso di aggiornamento (altro)
Aggiornare un percorso
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | integer | ||
|
Stringa di query
|
q | string |
Specificare una query in questo caso per applicare l'aggiornamento a un set di percorsi anziché a uno (come specificato dall'ID univoco). |
|
|
Nome
|
LocationSortName | string | ||
|
Nome univoco
|
LocationNickName | string | ||
|
Numero ID
|
LocationIdNumber | string | ||
|
Telefono ufficio
|
LocationPhoneNumber | string | ||
|
Cellulare
|
LocationMobileNumber | string | ||
|
Fax
|
LocationFaxNumber | string | ||
|
Telefono di casa
|
LocationAfterHoursPhoneNumber | string | ||
|
Uguale all'indirizzo
|
LocationUseAddressOf | integer |
ID univoco della posizione |
|
|
Imposta valore predefinito
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
ID univoco correlato
|
AddRelationshipRelatedLocation | integer | ||
|
TIPO
|
AddRelationshipRelationshipType | string | ||
|
Indirizzo di posta elettronica
|
LocationEmailAddress | string | ||
|
Da
|
SetActiveDateRangeValidFromDate | string |
gg/mm/aaaaa |
|
|
Per
|
SetActiveDateRangeValidToDate | string |
gg/mm/aaaaa |
|
|
Note
|
LocationNotes | string | ||
|
Tipo di aggiornamento note
|
NotesUpdateType | string | ||
|
ID univoco correlato
|
RemoveRelationshipRelatedLocation | integer |
Restituisce
- Corpo
- CMLocationsResponse
Percorso di aggiornamento (persona)
Aggiornare una posizione di persona usando il relativo identificatore univoco
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | integer | ||
|
Stringa di query
|
q | string |
Specificare una query in questo caso per applicare l'aggiornamento a un set di percorsi anziché a uno (come specificato dall'ID univoco). |
|
|
Titolo
|
LocationHonorific | string | ||
|
Cognome
|
LocationSurname | string | ||
|
Nome di battesimo
|
LocationGivenNames | string | ||
|
Interno
|
LocationIsWithin | boolean | ||
|
Posizione
|
LocationJobDescription | string | ||
|
Data di nascita
|
LocationDateOfBirth | string | ||
|
Saluto
|
LocationSalutation | string | ||
|
Nome univoco
|
LocationNickName | string | ||
|
Numero ID
|
LocationIdNumber | string | ||
|
Telefono ufficio
|
LocationPhoneNumber | string | ||
|
Cellulare
|
LocationMobileNumber | string | ||
|
Fax
|
LocationFaxNumber | string | ||
|
Telefono di casa
|
LocationAfterHoursPhoneNumber | string | ||
|
Uguale all'indirizzo
|
LocationUseAddressOf | integer |
ID univoco della posizione |
|
|
Imposta valore predefinito
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
ID univoco correlato
|
AddRelationshipRelatedLocation | integer | ||
|
TIPO
|
AddRelationshipRelationshipType | string | ||
|
Indirizzo di posta elettronica
|
LocationEmailAddress | string | ||
|
Sesso
|
LocationGenderValue | string | ||
|
Accettazione degli account di accesso
|
LocationCanLogin | boolean | ||
|
Account di accesso alla rete
|
LocationLogsInAs | string | ||
|
Account di accesso di rete aggiuntivo
|
LocationAdditionalLogin | string | ||
|
Login Expires On
|
LocationLoginExpires | string | ||
|
Profilo utente di
|
LocationUseProfileOf | integer |
ID univoco della posizione |
|
|
Tipo di utente
|
LocationUserType | string | ||
|
Stringa di sicurezza
|
LocationSecurityString | string | ||
|
Da
|
SetActiveDateRangeValidFromDate | string |
gg/mm/aaaaa |
|
|
Per
|
SetActiveDateRangeValidToDate | string |
gg/mm/aaaaa |
|
|
Note
|
LocationNotes | string | ||
|
Tipo di aggiornamento note
|
NotesUpdateType | string | ||
|
ID univoco correlato
|
RemoveRelationshipRelatedLocation | integer |
Restituisce
- Corpo
- CMLocationsResponse
Record di aggiornamento (aggiunta di controlli di accesso)
AddAccessControl
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Identificatore univoco
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
ID univoco
|
Uri | integer |
Identificatore univoco percorso |
Restituisce
- Corpo
- CMRecordsResponse
Record di aggiornamento (allega file elettronici)
Allegare un file elettronico a un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
File
|
File | True | file |
Contenuto file/corpo del documento elettronico da allegare |
|
Identificatore univoco
|
Uri | True | string |
ID univoco del record |
Restituisce
- Corpo
- CMRecordsResponse
Record di aggiornamento (allegare il termine del thesaurus)
Collegare un termine del thesaurus a un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Record
|
Uri | True | integer |
ID univoco del record a cui collegare il termine del thesaurus |
|
Termine thesaurus
|
Keyword | True | string |
ID univoco o nome del termine del thesaurus da allegare |
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Record di aggiornamento (azioni complete)
Completare una o tutte le azioni dovute a un determinato record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Completo
|
Complete | True | string |
Specificare le azioni record da completare |
|
Completare le azioni precedenti
|
CompletePrevious | boolean |
Completare tutte le azioni record prima di quella specificata |
|
|
Data di completamento
|
CompletionDate | date |
Data da impostare come data di completamento |
|
|
ID univoco azione record
|
RecordActionUri | integer |
ID univoco dell'azione di record da completare se è selezionato 'For Unique Identifier' |
|
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Record di aggiornamento (collega contatto)
Allegare un contatto a un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Tipo di contatto
|
ContactType | True | string | |
|
Posizione contatto
|
ContactLocation | True | string |
ID univoco o indirizzo di posta elettronica della località |
|
Impostare come contatto principale?
|
IsPrimary | True | boolean | |
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Record di aggiornamento (rimuovi posizione dai controlli di accesso)
RemoveAccessControl
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Identificatore univoco
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
ID univoco
|
Uri | integer |
Identificatore univoco percorso |
Restituisce
- Corpo
- CMRecordsResponse
Scarica file elettronici
Scaricare un file elettronico di un record
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Identificatore univoco
|
uri | True | string |
ID univoco o numero di record |
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
Restituisce
- response
- binary
Trova posizione in base all'ID
Recuperare un'unica posizione in base all'ID univoco o al nome
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Id | True | string |
ID univoco o nome dell'oggetto |
|
Proprietà discendenti
|
descendantProperties | string |
Un elenco delimitato da virgole di proprietà dell'oggetto, si applica solo alle proprietà dell'oggetto di questo e di livello inferiore, ad esempio Cognome,GivenNames |
|
|
Includi definizioni di proprietà
|
IncludePropertyDefs | boolean |
True per restituire una matrice delle definizioni delle proprietà utilizzate dalle proprietà in questa risposta |
|
|
Proprietà
|
properties | string |
Elenco delimitato da virgole di proprietà dell'oggetto, ad esempio Cognome,GivenNames |
|
|
Set di proprietà
|
propertySets | string |
Uno o più set di proprietà predefiniti, selezionare da DataGridVisible, Detailed, FromSearch, All o un set di proprietà personalizzato come definito nella configurazione del servizio |
|
|
Valore della proprietà
|
PropertyValue | string |
Includere il valore non elaborato, il valore stringa o entrambi nei risultati |
|
|
Tipo di visualizzazione stringa
|
stringDisplayType | string |
Restituisce il valore stringa da utilizzare in formato |
Restituisce
- Corpo
- CMLocationsResponse
Trova posizioni
Cercare Locations (Recuperare una raccolta di percorsi usando una stringa di ricerca)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Query
|
q | True | string |
Immettere una query di ricerca, ad esempio 'all' per ottenere tutti gli oggetti. |
|
Applica valori predefiniti
|
ApplyDefaults | boolean |
True per applicare il filtro predefinito dell'utente e ordinare a questa ricerca |
|
|
Conteggio risultati
|
CountResults | boolean |
True per includere un conteggio dei risultati |
|
|
Escludi conteggio
|
ExcludeCount | boolean |
True per escludere un conteggio dei risultati |
|
|
Filter
|
filter | string |
Elenco delimitato da spazi di clausole di ricerca da applicare come filtro. |
|
|
Dalla ricerca
|
fromSearch | string |
ID univoco di una ricerca salvata da cui costruire la ricerca |
|
|
Proprietà discendenti
|
descendantProperties | string |
Un elenco delimitato da virgole di proprietà dell'oggetto, si applica solo alle proprietà dell'oggetto di questo e di livello inferiore, ad esempio RecordNumber,RecordTitle |
|
|
Includi definizioni di proprietà
|
IncludePropertyDefs | boolean |
True per restituire una matrice delle definizioni delle proprietà utilizzate dalle proprietà in questa risposta |
|
|
Options
|
Options | string |
Impostare una o più opzioni in genere impostate in Opzioni utente solo per questa ricerca. Usare gli ID di /PropertyDef? Get=SearchOptions service, aggiungere un segno meno da impostare su false. In caso contrario, viene utilizzato true. |
|
|
Proprietà
|
properties | string |
Elenco delimitato da virgole di proprietà dell'oggetto, ad esempio RecordNumber,RecordTitle |
|
|
Set di proprietà
|
propertySets | string |
Uno o più set di proprietà predefiniti, selezionare da DataGridVisible, Detailed, FromSearch, All o un set di proprietà personalizzato come definito nella configurazione del servizio |
|
|
Valore della proprietà
|
PropertyValue | string |
Includere il valore non elaborato, il valore stringa o entrambi nei risultati |
|
|
Dimensioni pagina
|
pageSize | string |
Numero di elementi da restituire in ogni pagina di risultati |
|
|
Scopo
|
purpose | string |
Proprietà speciale per filtrare i risultati della ricerca in base ai valori di enumerazione scopo oggetto |
|
|
Extra scopo
|
purposeExtra | string |
Necessario come supplemento ad alcuni scopi. Il servizio ObjectDef fornisce informazioni sul tipo enum o TrimMainObject da specificare, in particolare ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes e HaveExtraPurposeParameter. |
|
|
Ordina per
|
sortBy | string |
Elenco delimitato da virgole di ID clausola di ricerca |
|
|
Start
|
start | string |
Posizione nel set di risultati da avviare, vuota (o 1) da iniziare all'inizio, 2 per iniziare al secondo oggetto, 3 al terzo e così via |
|
|
Tipo di visualizzazione stringa
|
stringDisplayType | string |
Se restituisce il valore stringa da usare |
Restituisce
- Corpo
- CMLocationsResponse
Trova record
Cercare Record (recuperare una raccolta di record usando una stringa di ricerca)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Query
|
q | True | string |
Query di ricerca |
|
Proprietà
|
properties | True | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Trova record (avanzato)
Cercare Records (Recuperare un insieme di record usando una stringa di ricerca). Restituisce una risposta ServiceAPI di Content Manager non elaborata.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Query
|
q | True | string |
Query di ricerca |
|
Proprietà
|
properties | True | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- response
- object
Trova record per ID
Recuperare un singolo record in base all'ID univoco o al nome
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Documento d'identità
|
Id | True | string |
ID univoco o nome dell'oggetto |
|
Includi definizioni di proprietà
|
IncludePropertyDefs | boolean |
True per restituire una matrice delle definizioni delle proprietà utilizzate dalle proprietà in questa risposta |
|
|
Proprietà discendenti
|
descendantProperties | string |
Un elenco delimitato da virgole di proprietà dell'oggetto, si applica solo alle proprietà dell'oggetto di questo e di livello inferiore, ad esempio RecordNumber,RecordTitle. |
|
|
Proprietà
|
properties | string |
Elenco delimitato da virgole di proprietà dell'oggetto, ad esempio RecordNumber,RecordTitle. |
|
|
Set di proprietà
|
propertySets | string |
Uno o più set di proprietà predefiniti, selezionare da DataGridVisible, Detailed, FromSearch, All o un set di proprietà personalizzato come definito nella configurazione del servizio. |
|
|
Valore della proprietà
|
PropertyValue | string |
Includere il valore non elaborato, il valore stringa o entrambi nei risultati |
|
|
Tipo di visualizzazione stringa
|
stringDisplayType | string |
Se restituisce il valore stringa da usare |
Restituisce
- Corpo
- CMRecordsResponse
Trovare l'ID univoco dell'indirizzo di posizione
Ottenere l'ID univoco dell'indirizzo figlio di una località
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
TIPO
|
type | string |
Selezionare il tipo di indirizzo |
|
|
Identificatore univoco
|
LocationUri | True | string |
ID univoco della posizione |
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
Restituisce
- Indirizzo figlio
- CMLocationAddressUri
Trovare oggetti CM
Cercare oggetti CM
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Cercare
|
TrimType | True | string | |
|
Stringa di query
|
q | True | string |
Immettere una query di ricerca, ad esempio 'all' per ottenere tutti gli oggetti. |
|
Applica valori predefiniti
|
ApplyDefaults | boolean |
True per applicare il filtro predefinito dell'utente e ordinare a questa ricerca. |
|
|
Conteggio risultati
|
CountResults | boolean |
CountResults restituisce il conteggio più affidabile e più lento dei risultati totali della ricerca. Il conteggio risultante si trova nella proprietà Response Count. |
|
|
Proprietà discendenti
|
DescendantProperties | string |
Un elenco delimitato da virgole di proprietà dell'oggetto, si applica solo alle proprietà dell'oggetto di questo e di livello inferiore, ad esempio RecordNumber,RecordTitle. |
|
|
Escludi conteggio
|
ExcludeCount | boolean |
La restituzione di TotalResults e SearchTitle può ridurre le prestazioni. Impostare su true se TotalResults e SearchTitle non sono obbligatori. |
|
|
Filter
|
Filter | string |
Elenco delimitato da spazi di clausole di ricerca da applicare come filtro. |
|
|
Dalla ricerca
|
FromSearch | integer |
ID univoco di una ricerca salvata da cui costruire la ricerca. |
|
|
Includi proprietà Defs
|
IncludePropertyDefs | boolean |
True per restituire una matrice delle definizioni delle proprietà utilizzate dalle proprietà in questa risposta. |
|
|
Options
|
Options | string |
Impostare una o più opzioni in genere impostate in Opzioni utente solo per questa ricerca. Usare gli ID di /PropertyDef? Get=SearchOptions service, aggiungere un segno meno da impostare su false. In caso contrario, viene utilizzato true. |
|
|
Dimensioni pagina
|
pageSize | integer |
Numero di elementi da restituire in ogni pagina di risultati. Se vuoto, il valore predefinito è impostato nella configurazione. |
|
|
Valore della proprietà
|
PropertyValue | string |
Includere il valore non elaborato, il valore stringa o entrambi nei risultati. |
|
|
Set di proprietà
|
PropertySets | string |
Uno o più set di proprietà predefiniti, selezionare da DataGridVisible, Detailed, FromSearch, All o un set di proprietà personalizzato come definito nella configurazione del servizio. |
|
|
Scopo
|
purpose | integer |
Proprietà speciale per filtrare i risultati della ricerca in base ai valori di enumerazione Scopo oggetto. |
|
|
Extra scopo
|
purposeExtra | integer |
Necessario come supplemento ad alcuni scopi. Il servizio ObjectDef fornisce informazioni sul tipo enum o TrimMainObject da specificare, in particolare ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes e HaveExtraPurposeParameter. |
|
|
Ordina per
|
sortBy | string |
Elenco delimitato da virgole di ID clausola di ricerca. Usare : per specificare la decrescente. Ad esempio, |
|
|
Start
|
start | integer |
Posizione nel set di risultati da avviare, vuota (o 1) da iniziare all'inizio, 2 per iniziare al secondo oggetto, 3 al terzo e così via. |
|
|
StringDisplayType
|
StringDisplayType | string |
Se restituisce il valore stringa da utilizzare. |
|
|
Proprietà
|
properties | string |
Elenco delimitato da virgole di proprietà dell'oggetto, ad esempio Uri, NameString |
Restituisce
- Corpo
- CMBobResponse
Update Record (Finalise)
Aggiornare un record bozza
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Rimuovi revisioni precedenti
|
SetAsFinalRemoveOldRevisions | boolean | ||
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Update Record (Set Assignee)
Impostare l'assegnatario su una determinata posizione, tornare a Home o registrarsi come mancante
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Nuovo assegnatario
|
NewAssignee | string |
ID univoco o indirizzo di posta elettronica del nuovo assegnatario |
|
|
Tipo assegnatario
|
AssigneeType | string | ||
|
Scadenza per data di restituzione
|
DueForReturnByDate | date | ||
|
Modifica effettiva dell'ora
|
ActualTimeChangeOccurred | date-time | ||
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Update Record (Undispose)
Ripristina lo stato del record (e il relativo contenuto) in modo che non venga più eliminato
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer | |
|
Continuare in caso di errore?
|
ContinueOnError | boolean | ||
|
Proprietà
|
Properties | string |
Elenco delimitato da virgole di proprietà da restituire |
Restituisce
- Corpo
- CMRecordsResponse
Update Record (Unfinalise - Set As Draft)
Aggiornare un record finalizzato alla bozza
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Utente da rappresentare
|
userToImpersonate | string |
Account di accesso di rete o account di accesso alternativo del percorso in CM da rappresentare |
|
|
Identificatore univoco
|
Uri | True | integer |
Restituisce
- Corpo
- CMRecordsResponse
Definizioni
CMRecord
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Percorso file
|
RecordFilePath | string |
Nome file visualizzato nella cartella Uploads |
|
Numero di adesione
|
RecordAccessionNumber | integer | |
|
Destinatario
|
RecordAddressee | integer | |
|
Contenitore alternativo
|
RecordAlternativeContainer | integer | |
|
Assegnatario
|
RecordAssignee | integer | |
|
Autore
|
RecordAuthor | integer | |
|
Authorization, metodo
|
RecordAuthorizationMethod | string | |
|
Livello di confidenza classificazione automatica
|
RecordAutoClassificationConfidenceLevel | integer | |
|
Rendering automatico in PDF al salvataggio
|
RecordAutoRenderToPDFOnSave | boolean | |
|
Titolo stampa blu
|
RecordBlueprintTitle | string | |
|
Ignorare i controlli di accesso ai tipi di record
|
RecordBypassRecordTypeAccessControls | boolean | |
|
Archiviato da
|
RecordCheckedInBy | integer | |
|
Estratto a
|
RecordCheckedOutTo | integer | |
|
Classification
|
RecordClassification | integer | |
|
Classe di record
|
RecordClassOfRecord | string | |
|
Cliente
|
RecordClient | integer | |
|
Client Record
|
RecordClientRecord | integer | |
|
Spedizione
|
RecordConsignment | string | |
|
Oggetto vettura
|
RecordConsignmentObject | string | |
|
Contenitore
|
RecordContainer | integer | |
|
Creatore
|
RecordCreator | integer | |
|
Versione corrente
|
RecordCurrentVersion | string | |
|
Data di chiusura
|
RecordDateClosed | date-time | |
|
Data creazione
|
RecordDateCreated | date-time | |
|
Data di scadenza
|
RecordDateDue | date-time | |
|
Data finalizzata
|
RecordDateFinalized | date-time | |
|
Data importazione
|
RecordDateImported | date-time | |
|
Data inattiva
|
RecordDateInactive | date-time | |
|
Data di modifica
|
RecordDateModified | date-time | |
|
Data di pubblicazione
|
RecordDatePublished | date-time | |
|
Data ricezione
|
RecordDateReceived | date-time | |
|
Data di registrazione
|
RecordDateRegistered | date-time | |
|
Allegato documento in sospeso
|
RecordDocumentAttachPending | boolean | |
|
Dimensioni documento
|
RecordDocumentSize | integer | |
|
Tipo di documento
|
RecordDocumentType | string | |
|
Redattore
|
RecordEditor | integer | |
|
Archivio documenti elettronici
|
RecordEStore | integer | |
|
Estensione documento
|
RecordExtension | string | |
|
Riferimento esterno
|
RecordExternalReference | string | |
|
Finalizzare al salvataggio
|
RecordFinalizeOnSave | boolean | |
|
Origine cartella
|
RecordFolderOrigin | integer | |
|
Codice a barre esterno
|
RecordForeignBarcode | string | |
|
Titolo generato
|
RecordGeneratedTitle | string | |
|
Posizione GPS
|
RecordGpsLocation | string | |
|
Home Location
|
RecordHomeLocation | integer | |
|
Spazio home
|
RecordHomeSpace | integer | |
|
Avviare il modello
|
RecordInitiateTemplate | string |
ID univoco del modello di flusso di lavoro |
|
È racchiuso
|
RecordIsEnclosed | boolean | |
|
Jurisdiction
|
RecordJurisdictions | string | |
|
Data ultima azione
|
RecordLastActionDate | date-time | |
|
Ultimo record parte
|
RecordLastPartRecord | integer | |
|
Versione più recente
|
RecordLatestVersion | integer | |
|
Numero espanso
|
RecordLongNumber | string | |
|
Numero record
|
RecordNumber | string | |
|
Data di distruzione manuale
|
RecordManualDestructionDate | date-time | |
|
Record materia
|
RecordMatterRecord | integer | |
|
Tipo di media
|
RecordMediaType | string | |
|
Riunione
|
RecordMeeting | integer | |
|
Tipo Mime
|
RecordMimeType | string | |
|
Commenti relativi all'autorizzazione
|
RecordMyAuthorizationComments | string | |
|
Autorizzazione completata
|
RecordMyAuthorizationComplete | boolean | |
|
Commenti per la mia recensione
|
RecordMyReviewComments | string | |
|
La mia recensione è stata completata
|
RecordMyReviewComplete | boolean | |
|
Pagine numeri?
|
RecordNbrPages | integer | |
|
È necessaria l'autorizzazione?
|
RecordNeedsAuthorization | boolean | |
|
È necessario rivedere?
|
RecordNeedsReview | boolean | |
|
Nuova regola di creazione di parti
|
RecordNewPartCreationRule | string |
ID univoco della regola di creazione di parti automatica |
|
Record della parte successiva
|
RecordNextPartRecord | integer | |
|
Tipo di aggiornamento note
|
NotesUpdateType | string | |
|
Note
|
RecordNotes | string | |
|
Originato da
|
RecordOriginatedFrom | string | |
|
Originato dall'esecuzione
|
RecordOriginatedFromRun | string | |
|
Altro contatto
|
RecordOtherContact | integer | |
|
Posizione del proprietario
|
RecordOwnerLocation | integer | |
|
Gerarchia del preserver nell'immissione dei dati?
|
RecordPreserveHierarchyOnDataEntry | boolean | |
|
Record della parte precedente
|
RecordPrevPartRecord | integer | |
|
Contatto principale
|
RecordPrimaryContact | integer | |
|
Priority
|
RecordPriority | string | |
|
Tipo di record
|
RecordRecordType | integer | |
|
Record correlato
|
RecordRelatedRecord | integer | |
|
Rappresentativo
|
RecordRepresentative | integer | |
|
Pianificazione conservazione
|
RecordRetentionSchedule | integer | |
|
Data revisione
|
RecordReviewDate | date-time | |
|
Verifica data di scadenza
|
RecordReviewDueDate | date-time | |
|
Esaminare lo stato
|
RecordReviewState | string | |
|
Record della parte radice
|
RecordRootPartRecord | integer | |
|
Security
|
RecordSecurity | string | |
|
Record serie
|
RecordSeriesRecord | integer | |
|
Titolo
|
RecordTitle | string | |
|
Titolo (parte testo libero)
|
RecordTypedTitle | string | |
|
Identificatore univoco
|
Uri | integer | |
|
Campi aggiuntivi
|
Fields | object |
CMEventData
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Identificatore univoco dell'evento
|
OnlineEventUri | integer | |
|
ID tipo di evento
|
EventType | integer | |
|
Tipo di evento
|
EventTypeString | string | |
|
Data evento
|
EventDate | date-time | |
|
ID tipo di oggetto
|
ObjectType | integer | |
|
Tipo di oggetto
|
ObjectTypeString | string | |
|
ID univoco oggetto
|
ObjectUri | integer | |
|
ID tipo di oggetto correlato
|
RelatedObjectType | integer | |
|
Tipo di oggetto correlato
|
RelatedObjectTypeString | string | |
|
ID univoco dell'oggetto correlato
|
RelatedObjectUri | integer | |
|
Dal computer
|
FromMachine | string | |
|
Indirizzo IP di connessione
|
ConnectionIPAddress | string | |
|
Indirizzo IP client
|
ClientIPAddress | string | |
|
Dal fuso orario
|
FromTimeZone | integer | |
|
Nome account di accesso
|
LoginName | string | |
|
ID univoco dell'account di accesso
|
LoginUri | integer | |
|
Dettagli aggiuntivi
|
ExtraDetails | string |
CMLogMessage
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Registra messaggio
|
LogMessage | string | |
|
Cercare
|
TrimType | CMTrimType | |
|
Identificatore univoco
|
Uri | integer |
CMRecordsResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Results
|
Results | array of CMRecord | |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Risultati totali
|
TotalResults | integer | |
|
Count String Ex
|
CountStringEx | string | |
|
Conteggio minimo
|
MinimumCount | integer | |
|
Conteggio
|
Count | integer | |
|
Ha più elementi
|
HasMoreItems | boolean | |
|
Titolo ricerca
|
SearchTitle | string | |
|
Hit Highlight String
|
HitHighlightString | string | |
|
Cercare
|
TrimType | CMTrimType | |
|
Stato risposta
|
ResponseStatus | CMResponseStatus |
Stato risposta |
CMLogResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Results
|
Results | array of CMLogMessage | |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Risultati totali
|
TotalResults | integer | |
|
Count String Ex
|
CountStringEx | string | |
|
Conteggio minimo
|
MinimumCount | integer | |
|
Conteggio
|
Count | integer | |
|
Ha più elementi
|
HasMoreItems | boolean | |
|
Titolo ricerca
|
SearchTitle | string | |
|
Hit Highlight String
|
HitHighlightString | string | |
|
Cercare
|
TrimType | CMTrimType | |
|
Stato risposta
|
ResponseStatus | CMResponseStatus |
Stato risposta |
CMUpdateErrorResponse
Aggiorna risposta errore
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Codice di errore
|
ErrorCode | string | |
|
Identificatore univoco
|
Uri | integer | |
|
Message
|
Message | string | |
|
Nome
|
Name | string | |
|
Nome (extra)
|
NameExtra | string |
CMResponseStatus
Stato risposta
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Codice di errore
|
ErrorCode | string | |
|
Message
|
Message | string | |
|
StackTrace
|
StackTrace | string | |
|
Errors
|
Errors | array of CMResponseError | |
|
Meta
|
Meta | object |
String del<dizionario, stringa> |
CMResponseError
Errore di risposta
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Codice di errore
|
ErrorCode | string | |
|
Nome campo
|
FieldName | string | |
|
Message
|
Message | string | |
|
Meta
|
Meta | object |
String del<dizionario, stringa> |
CMTrimType
- Cercare
- string
CMLocation
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Identificatore univoco
|
Uri | integer | |
|
Nome
|
NameString | string | |
|
Nome con formattazione completa percorso
|
LocationFullFormattedName | string | |
|
Nome ordinamento posizione
|
LocationSortName | string |
CMBob
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Identificatore univoco
|
Uri | integer | |
|
Nome
|
NameString | string |
CMLocationsResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Results
|
Results | array of CMLocation |
Results |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Risultati totali
|
TotalResults | integer | |
|
Count String Ex
|
CountStringEx | string | |
|
Conteggio minimo
|
MinimumCount | integer | |
|
Conteggio
|
Count | integer | |
|
Ha più elementi
|
HasMoreItems | boolean | |
|
Titolo ricerca
|
SearchTitle | string | |
|
Hit Highlight String
|
HitHighlightString | string | |
|
Cercare
|
TrimType | CMTrimType | |
|
Stato risposta
|
ResponseStatus | CMResponseStatus |
Stato risposta |
CMBobResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Results
|
Results | array of CMBob |
Results |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Risultati totali
|
TotalResults | integer | |
|
Count String Ex
|
CountStringEx | string | |
|
Conteggio minimo
|
MinimumCount | integer | |
|
Conteggio
|
Count | integer | |
|
Ha più elementi
|
HasMoreItems | boolean | |
|
Titolo ricerca
|
SearchTitle | string | |
|
Hit Highlight String
|
HitHighlightString | string | |
|
Cercare
|
TrimType | CMTrimType | |
|
Stato risposta
|
ResponseStatus | CMResponseStatus |
Stato risposta |
GetFileFromUrlResponse
Risposta dal plug-in dell'API del servizio CM 'GetFileFromUrl'.
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Percorso file
|
Filepath | string |
Percorso del file locale del file scaricato dall'URL. |
|
Message
|
Message | string |
CMLocationAddressUri
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID univoco
|
Uri | integer |
binario
Questo è il tipo di dati di base 'binario'.
oggetto
Si tratta del tipo 'object'.