Endpoint del flusso di lavoro

file (file): obbligatorio. Consente di selezionare il file che desideri caricare sul sistema. Il tipo di media deve essere un file YXZP.

name (stringa): obbligatorio. Immetti il nome di un flusso di lavoro. Si tratta del nome del flusso di lavoro da visualizzare nell'interfaccia utente di Server.

ownerId (stringa): obbligatorio. Immetti l'ID del proprietario.

workerTag (stringa): opzionale. Specifica il tag worker definito nei worker per facilitare l'assegnazione dei processi a determinati nodi worker. Per ulteriori informazioni, consulta la pagina di assistenza Worker.

districtTags (stringa): opzionale. Invia come array in formato JSON, ad esempio, ["id1", "id2"]. Utilizza i distretti per raggruppare i flussi di lavoro pubblici condivisi per tag in modo che gli utenti possano trovarli facilmente. Per ulteriori informazioni, consulta la pagina di assistenza Distretti.

comments (stringa): opzionale. Immetti i commenti.

isPublic (booleano): obbligatorio. Seleziona "true" per rendere il flusso di lavoro disponibile pubblicamente. Seleziona "false" per rendere il flusso di lavoro privato e non disponibile pubblicamente.

isReadyForMigration (booleano): obbligatorio. Specifica se il flusso di lavoro è pronto per la migrazione. Per ulteriori informazioni sulla migrazione da un ambiente Server a un altro, consulta la pagina di assistenza Abilitazione dei flussi di lavoro per la migrazione.

sourceAppId (stringa): opzionale. Imposta l'ID dell'app di origine di un flusso di lavoro. Puoi utilizzarlo come riferimento "sourceId" per l'endpoint POST admin/v1/workflows. Se fornisci un parametro sourceAppId preesistente, la richiesta non sarà valida.

othersMayDownload (booleano): obbligatorio. Specifica se altri utenti possono scaricare il flusso di lavoro.

othersCanExecute (booleano): obbligatorio. Specifica se altri utenti possono eseguire il flusso di lavoro.

executionMode (stringa): obbligatorio. I valori accettati sono "Provvisoria", "Semi provvisoria" e "Standard". Per ulteriori informazioni sulla modalità di esecuzione, consulta la pagina di assistenza Modalità di esecuzione Provvisoria e Semi provvisoria: strumenti, eventi e connettori dati bloccati.

hasPrivateDataExemption (booleano): opzionale. Fornisci un'esenzione per consentire l'esecuzione di un flusso di lavoro con dati privati. Seleziona "true" per consentire un'esenzione o "false" per rifiutarla. Per ulteriori informazioni, consulta la pagina Opzioni del flusso di lavoro nell'interfaccia di amministrazione.

workflowCredentialType (stringa): obbligatorio. I valori accettati sono "Predefinito", "Obbligatorio" e "Specifico".

credentialId (stringa): opzionale. Specifica il parametro credentialId del flusso di lavoro.

collectionIds (stringa): opzionale. Immetti il parametro collectionId(s) in cui aggiungere il flusso di lavoro. Invia come array in formato JSON, ad esempio, ["id1", "id2"].

workflowId (stringa): obbligatorio. Immetti l'ID del flusso di lavoro di cui desideri caricare una nuova versione.

file (file): obbligatorio. Scegli il file che desideri caricare nel sistema come nuova versione. Il tipo di media deve essere un file YXZP.

name (stringa): obbligatorio. Immetti il nome del flusso di lavoro. Si tratta del nome del flusso di lavoro da visualizzare nell'interfaccia utente di Server.

ownerId (stringa): obbligatorio. Immetti l'ID del proprietario.

othersMayDownload (booleano): obbligatorio. L'impostazione predefinita è "true".

othersCanExecute (booleano): obbligatorio. L'impostazione predefinita è "true".

executionMode (stringa): obbligatorio. I valori accettati sono "Provvisoria", "Semi provvisoria" e "Standard". Per ulteriori informazioni sulla modalità di esecuzione, consulta la pagina di assistenza Modalità di esecuzione Provvisoria e Semi provvisoria: strumenti, eventi e connettori dati bloccati.

hasPrivateDataExemption (booleano): opzionale. Fornisci un'esenzione per consentire l'esecuzione di un flusso di lavoro con dati privati. Seleziona "true" per consentire un'esenzione o "false" per rifiutarla. Per ulteriori informazioni, consulta la pagina Opzioni del flusso di lavoro nell'interfaccia di amministrazione.

comments (stringa): opzionale. Immetti i commenti.

makePublished (booleano): obbligatorio. L'impostazione predefinita è "true". Il parametro makePublished consente di controllare se la nuova versione di un flusso di lavoro che invii a Server deve essere o meno quella pubblicata. Puoi impostare il valore su "false" quando invii il flusso di lavoro a Server, nel qual caso solo tu potrai eseguirlo.

workflowCredentialType (stringa): obbligatorio. Immetti il tipo di credenziale da utilizzare per il flusso di lavoro. I valori accettati sono "Predefinito", "Obbligatorio" e "Specifico".

credentialId (stringa): opzionale. Specifica il parametro credentialId per il flusso di lavoro. Per ulteriori informazioni sugli endpoint delle credenziali, consulta Endpoint delle credenziali.

view (stringa): opzionale. Seleziona la modalità di visualizzazione delle informazioni del flusso di lavoro. È possibile non specificare nessun valore o selezionare ‘Default’ and ‘Full’. Se il parametro è impostato su "Default", viene restituito un oggetto vista ridotto. Se non è specificato nessun valore, viene utilizzato "Default".

name (stringa): opzionale. Immetti il nome del flusso di lavoro se desideri filtrare i flussi di lavoro per nome. Si tratta del nome del flusso di lavoro visualizzato nell'interfaccia utente di Server.

ownerId (stringa): opzionale. Immetti l'ID del proprietario se desideri filtrare i flussi di lavoro per proprietario.

createdAfter (stringa): opzionale. Immetti la data e l'ora dopo le quali è stato creato il flusso di lavoro. Immetti la data e l'ora in formato ISO8601.

createdBefore (stringa): opzionale. Immetti la data e l'ora prima delle quali è stato creato il flusso di lavoro. Immetti la data e l'ora in formato ISO8601.

workflowId (stringa): obbligatorio. Immetti l'ID del flusso di lavoro per ottenere informazioni sul flusso di lavoro.

workflowId (stringa): obbligatorio. Immetti l'ID del flusso di lavoro da aggiornare.

updateWorkflowContract (corpo): obbligatorio. Immetti i dati del flusso di lavoro da aggiornare.

Valore di esempio di UpdateWorkflowContract:

{
  "name": "string",
  "versionId": "string",
  "makePublished": true,
  "ownerId": "string",
  "workerTag": "string",
  "districtTags": [
    "string"
  ],
  "comments": "string",
  "isPublic": true,
  "isReadyForMigration": true,
  "othersMayDownload": true,
  "othersCanExecute": true,
  "executionMode": "Safe",
  "hasPrivateDataExemption": true,
  "workflowCredentialType": "Default",
  "credentialId": "string"
}

workflowId (stringa): obbligatorio. Immetti l'ID del flusso di lavoro per il quale desideri scaricare il pacchetto.

versionId (stringa): opzionale. Immetti l'ID della versione specifica di un flusso di lavoro. Se non viene fornita alcuna versione, viene scaricata quella pubblicata.

workflowId (stringa): obbligatorio. Immetti l'ID del flusso di lavoro per il quale desideri recuperare le informazioni.

versionId (stringa): opzionale. Immetti l'ID della versione specifica di un flusso di lavoro. Se non viene fornita alcuna versione, viene utilizzata quella pubblicata.

workflowId (stringa): obbligatorio. Immetti l'ID del flusso di lavoro per il quale desideri recuperare le informazioni.

sortField (stringa): opzionale. Immettere il nome del campo per il quale si desidera ordinare i risultati.

direction (stringa): opzionale. Specifica qui il tipo di ordinamento. I valori accettati sono "asc" (crescente) e "desc" (decrescente). Se non è specificato alcun ordinamento, il valore predefinito sarà crescente.

offset (stringa): opzionale. Fa riferimento al record con cui si desidera che inizino i risultati.

limit (stringa): opzionale. Si riferisce all'ultimo record con cui si desidera che terminino i risultati.

status (stringa): opzionale. Lo stato generale dell'esecuzione del processo. Un processo completato può comunque avere esito negativo. I valori consentiti sono: "Completo", "Errore", "In esecuzione" e "In coda".

resultCode (stringa): opzionale. Il codice del risultato dell'esecuzione di un flusso di lavoro. Esso indica un flusso di lavoro non riuscito, ma un processo riuscito. I valori accettati sono: "Operazione riuscita", "Avvertenza" ed "Errore".

workflowId (stringa): obbligatorio. Immetti l'ID del flusso di lavoro da eliminare.

force (booleano): opzionale. In assenza di una specifica, il valore predefinito è "false". Se è pianificato un flusso di lavoro, il parametro impostato su "true" eliminerà tutte le pianificazioni prima di procedere con l'eliminazione.