Skip to main content

Endpoint del flusso di lavoro

Endpoint e parametri del flusso di lavoro

Per ulteriori informazioni sulle relazioni tra oggetti e su come utilizzarle nell'API, consulta la sezione Relazioni tra oggetti.

Per ulteriori informazioni sui flussi di lavoro, consulta la pagina di assistenza Flussi di lavoro.

Caricamento di un nuovo flusso di lavoro

Per caricare un nuovo flusso di lavoro, utilizza l'endpoint POST {baseURL}/v3/workflows.

Parametri

  • file (file): obbligatorio. Scegli il file che desideri caricare sul sistema. Il tipo di supporto deve essere un file yxzp.

  • name (stringa): obbligatorio. Immetti il nome di un flusso di lavoro.

  • 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 API 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"].

Caricamento di una nuova versione di un flusso di lavoro esistente

Per caricare una nuova versione di un flusso di lavoro esistente, utilizza l'endpoint POST {baseURL}/v3/workflows/{workflowId}/versions.

Parametri

  • 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.

  • name (stringa): obbligatorio. Immetti il nome del flusso di lavoro.

  • 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.

Recupero di tutti i flussi di lavoro

Per ottenere informazioni su tutti i record del flusso di lavoro, utilizza l'endpoint GET {baseURL}/v3/workflows/.

Parametri

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

  • name (stringa): opzionale. Immetti il nome del flusso di lavoro se desideri filtrare i flussi di lavoro per nome.

  • 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. Specifica 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. Specifica la data e l'ora in formato ISO8601.

Esempio di richiesta: cURL

Curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Recupero del record di un flusso di lavoro specifico

Per ottenere informazioni su un flusso di lavoro specifico, utilizza l'endpoint GET {baseURL}/v3/workflows/{workflowId}.

Parametri

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

Esempio di richiesta: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Aggiornamento di un flusso di lavoro esistente

Per modificare le informazioni su un flusso di lavoro esistente, utilizza PUT {baseURL}/v3/workflows/{workflowId}endpoint.

Nota

Per modificare il parametro ownerId, il nuovo proprietario deve far parte della stessa iscrizione di quello corrente.

Parametri

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

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

  • name (stringa): obbligatorio. Immetti il nome del flusso di lavoro.

  • versionId (stringa): obbligatorio. Immetti l'ID della versione.

  • makePublished (booleano): opzionale. Se non è specificato, il valore rimane invariato. 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.

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

  • workerTag (stringa): obbligatorio. Se non è presente nessun parametro workerTag, utilizza "".

  • districtTags (stringa): obbligatorio. Immetti i tag dei distretti. 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): obbligatorio. Immetti i commenti.

  • isPublic (booleano): opzionale. Se non è specificato, il valore rimane invariato.

  • isReadyForMigration (booleano): opzionale. Se non è specificato, il valore rimane invariato.

  • othersMayDownload (booleano): opzionale. Se non è specificato, il valore rimane invariato. Se è impostato su "false" per un flusso di lavoro pubblico, il flusso di lavoro sarà inutilizzabile.

  • othersCanExecute (booleano): opzionale. Se non è specificato, il valore rimane invariato. Se è impostato su "false" per un flusso di lavoro pubblico, il flusso di lavoro sarà inutilizzabile.

  • executionMode (stringa) opzionale. 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. Se non è specificato, il valore rimane invariato. Per ulteriori informazioni, consulta la pagina Opzioni del flusso di lavoro nell'interfaccia di amministrazione.

Download di un pacchetto del flusso di lavoro

Per scaricare un pacchetto del flusso di lavoro, utilizza l'endpoint GET {baseURL}/v3/workflows/{workflowId}/package.

Parametri

  • 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.

    Nota

    If the versionID is double-digit, it might reach the size limit and you might get a '414 - URI Too Long' error. In this case, please parse the JSON versionID string and trim it to the most recent version only. This will keep the field length under control.

Esempio di richiesta: cURL

curl -X GET --header 'Accept: application/octet-stream' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a4be7dc6e24bb8ff0/package'

Recupero delle informazioni sulle domande relative a un flusso di lavoro

Per ottenere informazioni sulle domande relative a un flusso di lavoro, utilizza l'endpoint GET {baseURL}/v3/workflows/{workflowId}/questions.

Parametri

  • 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.

Esempio di richiesta: cURL

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a4bc6e24b78d0b8ff0/questions'

Informazioni sui processi di un flusso di lavoro specifico

Per ottenere informazioni sui processi di un flusso di lavoro specifico, utilizza l'endpoint GET {baseURL}/v3/workflows/{workflowId}/jobs.

Parametri

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

  • sortField (stringa): opzionale.

  • direction (stringa): opzionale.

  • offset (stringa): opzionale.

  • limit (stringa): opzionale.

Esempio di richiesta: cURL

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a4be6e24b78d0b8ff0/jobs'

Eliminazione di un flusso di lavoro

Per eliminare un flusso di lavoro specifico, utilizza l'endpoint DELETE {baseURL}/v3/workflows/{workflowId}.

Parametri

  • 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.

Esempio di richiesta: cURL

curl -X DELETE --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' 'http://localhost/webapi/v3/workflows/635a752fdc6e278d0ba40b'

Relazioni tra oggetti

Se stai caricando un flusso di lavoro, puoi utilizzare gli oggetti creati nel modo seguente:

Oggetto creato: "workflowId" (ad esempio, "id": "7917969784f84bd09442f66996ecb8f3")

Puoi utilizzarlo come:

Esempi di richiesta Postman

GET /v3/Workflows/{workflowId}

Use GET /v3/workflows/{workflowId} endpoint.

Per ulteriori informazioni sulle richieste Postman, consulta la pagina di assistenza Come utilizzare Postman.

In questa sezione: