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. 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"].
Caricamento di una nuova versione in 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. 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 .
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. 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 .
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. Si tratta del nome del flusso di lavoro da visualizzare nell'interfaccia utente di Server.
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
Se versionID ha due cifre, potrebbe raggiungere le dimensioni massime consentite e potrebbe apparire l'errore "414 - URI troppo lungo". In questo caso, analizza la stringa JSON versionID e ritagliala in modo da includere solo la versione più recente. Ciò permetterà di controllare la lunghezza del campo.
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'
Creazione di un nuovo processo
Per creare un nuovo processo e aggiungerlo alla coda, utilizza l'endpoint
POST /v3/workflows/{workflowId}/jobs
.
Parametri
workflowId (stringa): obbligatorio. Immetti l'ID di un flusso di lavoro che desideri pianificare.
contract (corpo): per creare un nuovo processo, specifica i seguenti parametri:
workerTag (stringa): opzionale. Specifica il worker assegnato. In assenza di specifica, il valore sarà "none".
credentialId (stringa): opzionale. Specifica il parametro credentialId per il flusso di lavoro.
questions (stringa): opzionale. Per le app analitiche, specifica le domande e le risposte per eseguire il flusso di lavoro.
priority (stringa): opzionale. Specifica la priorità per l'esecuzione della pianificazione. Puoi scegliere tra le seguenti opzioni: "Low", "Medium", "High" e "Critical". In assenza di specifica, il valore predefinito sarà "Low".
ESEMPIO DI RICHIESTA: cURL
Esempio di richiesta di creazione di un processo:
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'Authorization: Bearer BearerTokenGoesHere' -d '{ \ "workerTag": "", \ "credentialId": "", \ "questions": [], \ "priority": "Low" \ }' 'http://localhost/webapi/v3/workflows/651faa8bde3e5381fd0dac29/jobs'{ "workerTag": "tag1", "credentialId": "652e6f90ea174cd34f6779d2", "questions": [ { "name": "Drop_Down", "value": "true" } ], "priority": "Low"}
Transfer Workflows and Schedules to a Specified Owner
To transfer a specific workflow to a specific owner, together with schedules if desired, use the PUT {baseURL}/v3/workflows/{workflowId}/transfer
endpoint.
Nota
Only Curators can use this API endpoint.
If any of the workflows require DCM connections, Server connections, or specific run as credentials to run, these items need to be updated before the workflow can run.
If users are not in the same studio and when a workflow is transferred to the new studio, all other users in the new owner's studio will also receive access to the workflow, and all users from the old studio will lose access.
Workflows can only be transferred to a user with the Artisan or Curator role.
If transferring schedules, the new owner must have access to the scheduled workflow, otherwise you won’t be able to transfer that workflow to the new owner.
If transferring schedules, the new owner must have permission to schedule workflows.
If the user is deleted, it returns a list of schedule Ids that will be broken or disabled after transfer.
Parameters
workflowId (string): Required. Specify the Id of the workflow to transfer.
contract (body): Required. Specify the following information:
ownerId (string): Specify the Id of the new owner.
transferSchedules (Boolean): Specify whether the schedules should be transferred to a new owner together with the workflow. Only the schedules owned by the current workflow owner will be transferred to the new owner.
Request Example: cURL
curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{ \ "ownerId": "63d17f6cb049da66d0afd4e2", \ "transferSchedules": true \ }' 'http://localhost/webapi/v3/workflows/7917969784f84bd09442f66996ecb8f3/transfer'
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:
workflowId se stai aggiungendo flussi di lavoro a una raccolta .
appId se stai rimuovendo flussi di lavoro da una raccolta .
workflowId se stai cercando un flusso di lavoro specifico .
workflowId se stai eliminando un flusso di lavoro specifico .
workflowId se stai aggiornando un flusso di lavoro esistente .
workflowId se stai caricando una nuova versione di un flusso di lavoro esistente .
workflowId se stai cercando una pianificazione .
workflowId se stai creando una pianificazione .
workflowId se stai scaricando un pacchetto del flusso di lavoro .
workflowId se desideri recuperare le informazioni sulle domande relative a un flusso di lavoro .
workflowId se desideri ottenere informazioni sui processi di un flusso di lavoro .
Esempi di richiesta Postman
GET /v3/Workflows/{workflowId}
Per ulteriori informazioni sulle richieste Postman, consulta la pagina di assistenza Come utilizzare Postman .