API dei workflow

Gestisci i record dei workflow, esamina le esecuzioni e avviane l’esecuzione. L’esempio di creazione salva una bozza disabilitata; configura un system_spec valido prima di abilitare un workflow.

Usa Autenticazione API per le richieste protette. Gli esempi usano i tuoi ID di risorse e un token temporaneo; gli esempi di risposte salvate sono sintetici.

Metodo	Percorso	Operazione
`GET`	`/v1/workflow`	Elenca i workflow
`POST`	`/v1/workflow`	Crea workflow
`GET`	`/v1/workflow/{id}`	Ottieni workflow
`PUT`	`/v1/workflow/{id}`	Aggiorna workflow
`DELETE`	`/v1/workflow/{id}`	Elimina workflow
`GET`	`/v1/workflow/{id}/runs`	Elenca le esecuzioni del workflow
`POST`	`/v1/workflow/{id}/runs`	Esegui workflow
`GET`	`/v1/workflow/{id}/logs`	Ottieni i log del workflow

Elenca i workflow

GET /v1/workflow

Restituisce un elenco paginato di Workflow

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

Nome	Posizione	Obbligatorio	Descrizione
`X-Tenant-ID`	header	Sì	ID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.
`page`	query	No	Numero di pagina
`per_page`	query	No	Elementi per pagina

Esempio di richiesta

Imposta ADIOS_API_URL=https://api.adios.dev. Per le richieste protette, imposta ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID come nel guida rapida. Imposta le eventuali variabili aggiuntive ADIOS_* con i valori ottenuti dalle tue risorse.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workflow" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

Elenco di Workflow

Campi di risposta

Campo	Tipo	Descrizione
`data`	array
`data[].created_at`	integer	(timestamp Unix)
`data[].data`	object	Stato dell’editor di workflow e metadati esposti dall’API
`data[].deleted_at`	integer	(timestamp Unix)
`data[].enabled`	boolean
`data[].owner_id`	string
`data[].region`	string
`data[].status`	string	Valori consentiti: draft, active, disabled, archived, deleted.
`data[].system_spec`	object	Specifica canonica del workflow di sistema sincronizzata con il backend di sistema
`data[].team_id`	string
`data[].title`	string
`data[].updated_at`	integer	(timestamp Unix)
`data[].workflow_id`	string
`pagination`	object
`pagination.page`	integer	Numero di pagina attuale
`pagination.per_page`	integer	Numero di elementi per pagina
`pagination.total`	integer	Numero totale di elementi

Esempio illustrativo; non è una risposta dal vivo:

{
  "data": [
    {
      "created_at": 1791072000,
      "data": {},
      "deleted_at": 0,
      "enabled": true,
      "owner_id": "000000000000000000000000001",
      "region": "",
      "status": "draft",
      "system_spec": {},
      "team_id": "000000000000000000000000001",
      "title": "Postman example",
      "updated_at": 1791072000,
      "workflow_id": "000000000000000000000000001"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Crea workflow

POST /v1/workflow

Crea un nuovo oggetto Workflow

Questa richiesta modifica dati o avvia un’azione. Controlla la destinazione e il corpo prima dell’invio.

Campi di richiesta (il corpo contiene un esempio modificabile):

Campo	Tipo	Obbligatorio	Descrizione
`data`	object	No	Stato dell’editor di workflow e metadati esposti dall’API
`enabled`	boolean	Sì	Valore predefinito: `true`.
`owner_id`	string	No
`region`	string	No	Valore predefinito: `""`.
`status`	string	Sì	Valori consentiti: draft, active, disabled, archived, deleted. Valore predefinito: `"draft"`.
`system_spec`	object	No	Specifica canonica del workflow di sistema sincronizzata con il backend di sistema
`team_id`	string	Sì
`title`	string	Sì

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

Nome	Posizione	Obbligatorio	Descrizione
`X-Tenant-ID`	header	Sì	ID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/workflow" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "team_id": "YOUR_TEAM_ID",
  "title": "Postman example workflow",
  "status": "draft",
  "enabled": false
}
JSON

Sostituisci YOUR_* nel corpo prima dell’invio. L’heredoc tra virgolette mantiene il JSON letterale.

Risposta: HTTP 201

Workflow creato

Campi di risposta

Campo	Tipo	Descrizione
`created_at`	integer	(timestamp Unix)
`data`	object	Stato dell’editor di workflow e metadati esposti dall’API
`deleted_at`	integer	(timestamp Unix)
`enabled`	boolean
`owner_id`	string
`region`	string
`status`	string	Valori consentiti: draft, active, disabled, archived, deleted.
`system_spec`	object	Specifica canonica del workflow di sistema sincronizzata con il backend di sistema
`team_id`	string
`title`	string
`updated_at`	integer	(timestamp Unix)
`workflow_id`	string

Esempio illustrativo; non è una risposta dal vivo:

{
  "created_at": 1791072000,
  "data": {},
  "deleted_at": 0,
  "enabled": true,
  "owner_id": "000000000000000000000000001",
  "region": "",
  "status": "draft",
  "system_spec": {},
  "team_id": "000000000000000000000000001",
  "title": "Postman example",
  "updated_at": 1791072000,
  "workflow_id": "000000000000000000000000001"
}

Ottieni workflow

GET /v1/workflow/{id}

Restituisce un oggetto Workflow

Imposta workflow_id usando gli ID restituiti dalle tue risposte API.

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

Nome	Posizione	Obbligatorio	Descrizione
`id`	path	Sì	Identificativo della risorsa ottenuto dai risultati API del tuo team.
`X-Tenant-ID`	header	Sì	ID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workflow/${ADIOS_WORKFLOW_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

Flusso di lavoro

Campi di risposta

Campo	Tipo	Descrizione
`created_at`	integer	(timestamp Unix)
`data`	object	Stato dell’editor di workflow e metadati esposti dall’API
`deleted_at`	integer	(timestamp Unix)
`enabled`	boolean
`owner_id`	string
`region`	string
`status`	string	Valori consentiti: draft, active, disabled, archived, deleted.
`system_spec`	object	Specifica canonica del workflow di sistema sincronizzata con il backend di sistema
`team_id`	string
`title`	string
`updated_at`	integer	(timestamp Unix)
`workflow_id`	string

Esempio illustrativo; non è una risposta dal vivo:

{
  "created_at": 1791072000,
  "data": {},
  "deleted_at": 0,
  "enabled": true,
  "owner_id": "000000000000000000000000001",
  "region": "",
  "status": "draft",
  "system_spec": {},
  "team_id": "000000000000000000000000001",
  "title": "Postman example",
  "updated_at": 1791072000,
  "workflow_id": "000000000000000000000000001"
}

Aggiorna workflow

PUT /v1/workflow/{id}

Aggiorna un oggetto Workflow esistente

Imposta workflow_id usando gli ID restituiti dalle tue risposte API.

Questa richiesta modifica dati o avvia un’azione. Controlla la destinazione e il corpo prima dell’invio.

Campi di richiesta (il corpo contiene un esempio modificabile):

Campo	Tipo	Obbligatorio	Descrizione
`data`	object	No	Stato dell’editor di workflow e metadati esposti dall’API
`enabled`	boolean	Sì	Valore predefinito: `true`.
`owner_id`	string	No
`region`	string	No	Valore predefinito: `""`.
`status`	string	Sì	Valori consentiti: draft, active, disabled, archived, deleted. Valore predefinito: `"draft"`.
`system_spec`	object	No	Specifica canonica del workflow di sistema sincronizzata con il backend di sistema
`team_id`	string	Sì
`title`	string	Sì

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

Nome	Posizione	Obbligatorio	Descrizione
`id`	path	Sì	Identificativo della risorsa ottenuto dai risultati API del tuo team.
`X-Tenant-ID`	header	Sì	ID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

curl --fail-with-body --request PUT "$ADIOS_API_URL/v1/workflow/${ADIOS_WORKFLOW_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "team_id": "YOUR_TEAM_ID",
  "title": "Postman example workflow",
  "status": "draft",
  "enabled": false
}
JSON

Sostituisci YOUR_* nel corpo prima dell’invio. L’heredoc tra virgolette mantiene il JSON letterale.

Risposta: HTTP 200

Workflow aggiornato

Campi di risposta

Campo	Tipo	Descrizione
`created_at`	integer	(timestamp Unix)
`data`	object	Stato dell’editor di workflow e metadati esposti dall’API
`deleted_at`	integer	(timestamp Unix)
`enabled`	boolean
`owner_id`	string
`region`	string
`status`	string	Valori consentiti: draft, active, disabled, archived, deleted.
`system_spec`	object	Specifica canonica del workflow di sistema sincronizzata con il backend di sistema
`team_id`	string
`title`	string
`updated_at`	integer	(timestamp Unix)
`workflow_id`	string

Esempio illustrativo; non è una risposta dal vivo:

{
  "created_at": 1791072000,
  "data": {},
  "deleted_at": 0,
  "enabled": true,
  "owner_id": "000000000000000000000000001",
  "region": "",
  "status": "draft",
  "system_spec": {},
  "team_id": "000000000000000000000000001",
  "title": "Postman example",
  "updated_at": 1791072000,
  "workflow_id": "000000000000000000000000001"
}

Elimina workflow

DELETE /v1/workflow/{id}

Elimina un oggetto Workflow

Imposta workflow_id usando gli ID restituiti dalle tue risposte API.

Questa richiesta modifica dati o avvia un’azione. Controlla la destinazione e il corpo prima dell’invio.

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

Nome	Posizione	Obbligatorio	Descrizione
`id`	path	Sì	Identificativo della risorsa ottenuto dai risultati API del tuo team.
`X-Tenant-ID`	header	Sì	ID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/workflow/${ADIOS_WORKFLOW_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

Risorsa eliminata.

Campi di risposta

Campo	Tipo	Descrizione
`message`	string

Esempio illustrativo; non è una risposta dal vivo:

{
  "message": "Deleted successfully"
}

Elenca le esecuzioni del workflow

GET /v1/workflow/{id}/runs

Elenca le esecuzioni appartenenti al workflow selezionato.

Imposta workflow_id usando gli ID restituiti dalle tue risposte API.

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

Nome	Posizione	Obbligatorio	Descrizione
`id`	path	Sì	Identificativo della risorsa ottenuto dai risultati API del tuo team.
`X-Tenant-ID`	header	Sì	ID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workflow/${ADIOS_WORKFLOW_ID}/runs" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

Risposta riuscita. Controlla lo stato restituito per le operazioni che avviano attività asincrone.

Per questa operazione personalizzata non è pubblicato uno schema completo del corpo della risposta. Controlla il contenuto e lo stato restituiti; qui non si presume alcun formato del payload.

Esegui workflow

POST /v1/workflow/{id}/runs

Avvia un workflow configurato. Inserisci l’input del workflow in payload. L’operazione può eseguire le azioni esterne definite dal workflow e richiede un abbonamento a pagamento.

Imposta workflow_id usando gli ID restituiti dalle tue risposte API.

Questa richiesta modifica dati o avvia un’azione. Controlla la destinazione e il corpo prima dell’invio.

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

Nome	Posizione	Obbligatorio	Descrizione
`id`	path	Sì	Identificativo della risorsa ottenuto dai risultati API del tuo team.
`X-Tenant-ID`	header	Sì	ID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/workflow/${ADIOS_WORKFLOW_ID}/runs" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "payload": {}
}
JSON

Sostituisci YOUR_* nel corpo prima dell’invio. L’heredoc tra virgolette mantiene il JSON letterale.

Risposta: HTTP 201

Risposta riuscita. Controlla lo stato restituito per le operazioni che avviano attività asincrone.

Per questa operazione personalizzata non è pubblicato uno schema completo del corpo della risposta. Controlla il contenuto e lo stato restituiti; qui non si presume alcun formato del payload.

Ottieni i log del workflow

GET /v1/workflow/{id}/logs

Leggi i log del ciclo di vita del workflow.

Imposta workflow_id usando gli ID restituiti dalle tue risposte API.

Autenticazione: token bearer e intestazione del team mostrate di seguito.

Parametri

Nome	Posizione	Obbligatorio	Descrizione
`id`	path	Sì	Identificativo della risorsa ottenuto dai risultati API del tuo team.
`X-Tenant-ID`	header	Sì	ID del team attivo. Deve corrispondere al tenant a cui è vincolato il token diagnostico.

Esempio di richiesta

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workflow/${ADIOS_WORKFLOW_ID}/logs" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Risposta: HTTP 200

Risposta riuscita. Controlla lo stato restituito per le operazioni che avviano attività asincrone.

Per questa operazione personalizzata non è pubblicato uno schema completo del corpo della risposta. Controlla il contenuto e lo stato restituiti; qui non si presume alcun formato del payload.