Tipologie di Processo

Le tipologie di processo (Workflow Types) sono modelli riutilizzabili che pre-configurano le impostazioni di una pratica di firma: firmatari, documenti, placeholder, scadenze e regole di visibilità. Anziché specificare tutti i parametri ad ogni invio, è possibile creare una tipologia una volta e richiamarla via API.

Concetto

Una tipologia di processo definisce un "template" per le pratiche. Quando si crea una pratica associata a una tipologia, il sistema applica automaticamente le configurazioni predefinite: documenti base, firmatari, coordinate di firma, placeholder, scadenze e regole di workflow.

Tipologia "Contratto Standard"
├── Documenti: template contratto.pdf
├── Firmatari: 2 (cliente + responsabile)
├── Placeholder: codice fiscale, data, città
├── Scadenza: 30 giorni
└── Notifiche: attive
    ↓
POST /api/v2/files/send { workflowTypeCode: "CONTRATTO_STD" }
    ↓
Pratica creata con tutte le configurazioni preimpostate

Utilizzo via API

Creare una pratica da tipologia

Specificare workflowTypeCode o idWorkflowType nella creazione della pratica:

{
  "workflowTypeCode": "CONTRATTO_STD",
  "documents": [
    { "filename": "allegato.pdf", "base64content": "..." }
  ],
  "signers": [
    {
      "email": "[email protected]",
      "firstName": "Mario",
      "lastName": "Rossi",
      "action": "S"
    }
  ]
}

I documenti e placeholder definiti nella tipologia vengono caricati automaticamente. È possibile aggiungere ulteriori documenti e firmatari nel body della richiesta.

Parametri di riferimento

Parametro	Tipo	Descrizione
workflowTypeCode	string	Codice univoco della tipologia (es. CONTRATTO_STD).
idWorkflowType	number	ID numerico della tipologia. Alternativa a workflowTypeCode.

suggerimento

Se entrambi sono specificati, idWorkflowType ha priorità. Se si usa workflowTypeCode, il sistema risolve automaticamente l'ID corrispondente.

---

Gestione Tipologie

Le tipologie si gestiscono tramite gli endpoint /api/v2/workflows/types.

Elenco tipologie

GET /workflows/types

Restituisce l'elenco paginato delle tipologie di processo.

Parametro	Tipo	Descrizione
query	string	Ricerca testuale per nome.
page	integer	Numero pagina (0-based).
size	integer	Elementi per pagina.

curl -X GET "https://sign.askme.it/api/v2/workflows/types?page=0&size=20" \
  -H "X-SignToken: your-api-token" \
  -H "X-SignUser: your-username"

Dettaglio tipologia

GET /workflows/types/{idWorkflowType}

Restituisce il dettaglio completo di una tipologia, inclusi documenti template, placeholder e limitazioni.

curl -X GET "https://sign.askme.it/api/v2/workflows/types/42" \
  -H "X-SignToken: your-api-token" \
  -H "X-SignUser: your-username"

Tipologie disponibili per l'invio

GET /workflows/types/submit

Restituisce solo le tipologie per le quali l'utente ha il permesso di sottomettere pratiche.

---

Struttura della Tipologia

Campo	Tipo	Descrizione
idWorkflowType	number	ID univoco della tipologia.
name	string	Nome della tipologia.
code	string	Codice univoco (usabile in workflowTypeCode).
notes	string	Note descrittive.
summary	string	Sommario.
preloadDocuments	boolean	Se true, i documenti template vengono caricati automaticamente nella pratica.
editSigners	boolean	Se true, i firmatari possono essere modificati al momento dell'invio.
blockTypePlaceholders	boolean	Se true, i placeholder della tipologia non possono essere modificati.
visibilityLimit	boolean	Se true, la visibilità della pratica è limitata.
retentionDays	integer	Giorni di conservazione prima dell'eliminazione automatica.
expirationDate	string	Data di validità della tipologia (dopo questa data non può essere usata).
urgent	boolean	Se true, le pratiche create sono marcate come urgenti.
draft	boolean	Se true, la tipologia è in bozza (non pubblicata).
attachedReport	boolean	Se true, il report di audit viene allegato automaticamente.
idDocumentFormat	number	ID del formato documento associato.
documents	array	Documenti template associati alla tipologia.
workflowTypesTemplates	array	Template di moduli associati.
workflowTypeLimitations	array	Limitazioni di accesso (per unità organizzativa, utente, ecc.).

---

Bozze

Le tipologie supportano lo stato bozza (draft: true): la tipologia è in fase di configurazione e non è ancora disponibile per l'invio di pratiche.

Endpoint	Descrizione
GET /workflows/draft	Elenco delle bozze.
POST /workflows/draft/insert	Crea una nuova bozza.
PUT /workflows/draft/update	Aggiorna una bozza.
DELETE /workflows/draft/delete/{idDraft}	Elimina una bozza.

Quando la bozza è pronta, pubblicarla aggiornando draft: false.

---

Clonazione

È possibile duplicare una tipologia esistente:

POST /workflows/types/{idWorkflowType}/clone

{
  "name": "Contratto Standard v2",
  "code": "CONTRATTO_STD_V2"
}

La nuova tipologia viene creata con tutte le configurazioni della tipologia originale.