DocsMarshal API

Richieste & autenticazione

DocsMarshal espone più API HTTP che si possono utilizzare per fare operazioni su profili, task, processi, workflow e documenti.
Per usare quese API è necessario essere autenticati a DocsMarshal (d'ora in poi DM), e per questo sono disponibili due metodi:

Login con username e password: La prima chiamata alla API deve essere verso il metodo di login, che dati una username e una password si occupa di loggare l'utente al sistema e restituire un Session ID.
Il login scade dopo un periodo di inattività predefinito.
Autenticazione tramite Static Session ID (SSID): È possibile impostare un Session ID statico per un utente. In questo modo non c'è bisogno di alcuna chiamata aggiuntiva per autenticarsi.

le richieste verso la API dovranno sempre riportare il Session ID dell'utente:

{
    'SessionID': mio_sid,
            
    ...copo della richiesta
}

Risposte

Tutti i metodi della API forchè quelli nel gruppo /DMLogin ritornano una stringa JSON in questo formato:

{
    'result':
    {
        'HasError': true/false,
        'Error': 'optional error description',
        ...corpo della risposta
    }
}

HasError è un valore booleano che informa se c'è stato un errore nell'elaborazione della richiesta. Nel caso HasError abbia valore true, allora nella proprietà Error si trova una stringa che descrive l'errore.
Se invece HasError ha valore false la richiesta è andata a buon fine e nelle altre proprietà dell'oggetto si possono trovare i risultati della richiesta, se ce ne sono.

Base di DocsMarshal

In questa sezione dedicata è documentata la base di DocsMarshal.
Leggi la documentazione base

Gruppi API

Path	Descrizione
/Home/	Utilizza DocsMarshal sul web
/DMDocuments/	Esegui operazioni sui documenti
/DMLogin/	Operazioni di autenticazione
/DMProfile/	Operazioni sui profili
/DMSearch/	Esegui delle ricerche sui profili
/DMWorkflow/	Esegui operazioni su workflow, processi e task
/Workflow/	Nuove API per eseguire operazioni su workflow
/DocumentModel/	Creazione e Download documenti
/Profile/	Form HTML per visualizzare, inserire e modificare profili
/Scheduler/	Utilizza gli scheduler configurati in DocsMarshal
/Grid/	Visualizza e gestisci liste di profili, task, processi o mail
/Task/	Visualizza e gestisci i task
/Mail/	Visualizza e gestisci le mail
/Tools/	App utilizzabili per visualizzare e lavorare sui dati tramite interfaccia grafica in DocsMarshal
/Gantt/	Visualizza e gestisci gli aspetti di un Gantt
/GanttTask/	Visualizza e gestisci gli aspetti di una attività di Gantt
/GanttTaskDependency/	Visualizza e gestisci le dipendenze di una attività di Gantt

Activity Library e Entità

In questa sezione dedicata sono documentate le activity e le entità disponibili per lo sviluppo dei workflow.
Leggi la documentazione delle activity
Leggi la documentazione delle entità

Javascript Framework