Points de terminaison du workflow
Points de terminaison et paramètres de workflows
Charger une nouvelle version d'un workflow existant
Récupérer un enregistrement de workflow spécifique
Mettre à jour un workflow existant
Pour en savoir plus sur les relations d'objets et sur leur utilisation dans l'API, consultez la section Relations d'objets .
Pour plus d'informations à propos des workflows, consultez la page d'aide Workflows .
Charger un nouveau workflow
Pour charger un nouveau workflow, utilisez le point de terminaison
POST {baseURL}/v3/workflows
.
Paramètres
file (fichier) : obligatoire. Sélectionnez le fichier réel que vous souhaitez charger dans le système. Le type de support doit être un fichier YXZP.
name (chaîne) : obligatoire. Saisissez un nom de workflow. Il s'agit du nom du workflow à afficher dans l'interface utilisateur Server.
ownerId (chaîne) : obligatoire. Saisissez l'ID du propriétaire.
workerTag (chaîne) : facultatif. Indiquez la balise worker définie dans les workers pour attribuer des tâches à certains nœuds worker. Pour plus d'informations, consultez la page d'aide Worker .
districtTags (chaîne) : facultatif. Soumettez sous forme de tableau au format JSON, par exemple, ["id1", "id2"]. Utilisez les catégories pour regrouper les workflows publics partagés par balise, afin que les utilisateurs puissent les trouver facilement. Pour plus d'informations, consultez la page d'aide Catégories .
comments (chaîne) : facultatif. Saisissez vos commentaires.
isPublic (booléen) : obligatoire. Indiquez si le Workflow sera accessible au public.
isReadyForMigration (booléen) : obligatoire. Indiquez si le workflow est prêt à être migré. Pour plus d'informations sur la migration d'un environnement Server à un autre, consultez la page d'aide Activer les workflows pour la migration .
sourceAppId (chaîne) : facultatif.
othersMayDownload (booléen) : obligatoire. Indiquez si les autres utilisateurs peuvent télécharger ce workflow.
othersCanExecute (booléen) : obligatoire. Indiquez si les autres utilisateurs peuvent exécuter ce workflow.
executionMode (chaîne) : obligatoire. Les valeurs acceptées sont « Safe », « SemiSafe », « Standard ». Pour plus d'informations sur le mode d'exécution, consultez la page d'aide Modes d'exécution sécurisé et semi-sécurisé : outils bloqués, événements et connecteurs de données .
hasPrivateDataExemption (booléen) : facultatif. Accordez une exemption pour permettre l'exécution d'un workflow avec des données privées. Sélectionnez « true » pour autoriser une exemption ou « false » pour refuser une exemption. Pour plus d'informations, consultez la page Options de workflow dans l'interface d'administration .
Charger une nouvelle version d'un workflow existant
Pour charger une nouvelle version d'un workflow existant, utilisez le point de terminaison
POST {baseURL}/v3/workflows/{workflowId}/versions
endpoint.
Paramètres
workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow dont vous souhaitez charger une nouvelle version.
file (fichier) : facultatif. Sélectionnez le fichier réel que vous souhaitez charger dans le système en tant que nouvelle version. Le type de support doit être un fichier YXZP.
name (chaîne) : obligatoire. Saisissez le nom du workflow. Il s'agit du nom du workflow à afficher dans l'interface utilisateur Server.
ownerId (chaîne) : obligatoire. Saisissez l'ID du propriétaire.
othersMayDownload (booléen) : obligatoire. La valeur par défaut est « true ».
othersCanExecute (booléen) : obligatoire. La valeur par défaut est « true ».
executionMode (chaîne) : obligatoire. Les valeurs acceptées sont « Safe », « SemiSafe », « Standard ». Pour plus d'informations sur le mode d'exécution, consultez la page d'aide Modes d'exécution sécurisé et semi-sécurisé : outils bloqués, événements et connecteurs de données .
hasPrivateDataExemption (booléen) : facultatif. Accordez une exemption pour permettre l'exécution d'un workflow avec des données privées. Sélectionnez « true » pour autoriser une exemption ou « false » pour refuser une exemption. Pour plus d'informations, consultez la page Options de workflow dans l'interface d'administration .
comments (chaîne) : obligatoire. Saisissez vos commentaires.
makePublished (booléen) : obligatoire. La valeur par défaut est « true ». Le paramètre makePublished permet de contrôler si la nouvelle version d'un workflow que vous transmettez à Server doit être la version publiée ou non. Si vous définissez la valeur sur « false » lorsque vous transmettez le workflow à Server, vous seul aurez la possibilité de l'exécuter.
Récupérer tous les workflows
Pour obtenir des informations sur tous les enregistrements de workflow, utilisez le point de terminaison
GET {baseURL}/v3/workflows/
.
Paramètres
view (chaîne) : facultatif. Sélectionnez le mode d'affichage des informations du workflow. Peut être laissé sans valeur. Vous pouvez choisir parmi les valeurs suivantes : « Default » et « Full ». Si ce paramètre est défini sur « Default », un objet de vue réduite est renvoyé. Lorsqu'elle n'est pas spécifiée, la valeur « Default » est utilisée.
name (chaîne) : facultatif. Saisissez le nom du workflow si vous souhaitez filtrer les workflows par nom. Il s'agit du nom du workflow affiché dans l'interface utilisateur Server.
ownerId (chaîne) : facultatif. Saisissez l'ID du propriétaire si vous souhaitez filtrer les workflows selon leurs propriétaires.
createdAfter (chaîne) : facultatif. Saisissez la date et l'heure après laquelle le workflow a été créé. Saisissez la date et l'heure au format ISO8601.
createdBefore (chaîne) : facultatif. Saisissez la date et l'heure avant laquelle le workflow a été créé. Saisissez la date et l'heure au format ISO8601.
Exemple de demande : cUrl
curl --location --request GET 'http://localhost/webapi/v3/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Récupérer un enregistrement de workflow spécifique
Pour obtenir des informations sur un workflow spécifique, utilisez le point de terminaison
GET {baseURL}/v3/workflows/{workflowId}
.
Paramètres
workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow pour obtenir des informations sur ce workflow.
Exemple de demande : cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Mettre à jour un workflow existant
Pour charger une nouvelle version d'un workflow existant, utilisez le point de terminaison
PUT {baseURL}/v3/workflows/{workflowId}
.
Note
Pour modifier la valeur ownerId, le nouveau propriétaire doit disposer de la même souscription que le propriétaire actuel.
Paramètres
workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow que vous souhaitez mettre à jour.
updateWorkflowContract (corps) : obligatoire. Saisissez les informations du workflow à mettre à jour.
name (chaîne) : obligatoire. Saisissez le nom du workflow. Il s'agit du nom du workflow à afficher dans l'interface utilisateur Server.
versionId (chaîne) : obligatoire. Saisissez l'ID de la version.
makePublished (booléen) : facultatif. Lorsqu'elle n'est pas spécifiée, la valeur reste la même qu'avant. Le paramètre makePublished permet de contrôler si la nouvelle version d'un workflow que vous transmettez à Server doit être la version publiée ou non. Si vous définissez la valeur sur « false » lorsque vous transmettez le workflow à Server, vous seul aurez la possibilité de l'exécuter.
ownerId (chaîne) : obligatoire. Saisissez l'ID du propriétaire.
workerTag (chaîne) : obligatoire. Lorsqu'il n'y a pas de workerTag, utilisez "" à la place.
districtTags (chaîne) : obligatoire. Saisissez les balises de catégories. Utilisez les catégories pour regrouper les workflows publics partagés par balise, afin que les utilisateurs puissent les trouver facilement. Pour plus d'informations, consultez la page d'aide Catégories .
comments (chaîne) : obligatoire. Saisissez vos commentaires.
isPublic (booléen) : facultatif. Lorsqu'elle n'est pas spécifiée, la valeur reste la même qu'avant.
isReadyForMigration (booléen) : facultatif. Lorsqu'elle n'est pas spécifiée, la valeur reste la même qu'avant.
othersMayDownload (booléen) : facultatif. Lorsqu'elle n'est pas spécifiée, la valeur reste la même qu'avant. Lorsque la valeur est définie sur « false » pour un workflow public, le workflow est inutilisable.
othersCanExecute (booléen) : facultatif. Lorsqu'elle n'est pas spécifiée, la valeur reste la même qu'avant. Lorsque la valeur est définie sur « false » pour un workflow public, le workflow est inutilisable.
executionMode (chaîne) : facultatif. Les valeurs acceptées sont « Safe », « SemiSafe », « Standard ». Pour plus d'informations sur le mode d'exécution, consultez la page d'aide Modes d'exécution sécurisé et semi-sécurisé : outils bloqués, événements et connecteurs de données .
hasPrivateDataExemption (booléen) : facultatif. Accordez une exemption pour permettre l'exécution d'un workflow avec des données privées. Sélectionnez « true » pour autoriser une exemption ou « false » pour refuser une exemption. Lorsqu'elle n'est pas spécifiée, la valeur reste la même qu'avant. Pour plus d'informations, consultez la page Options de workflow dans l'interface d'administration .
Supprimer un workflow
Pour supprimer un workflow spécifique, utilisez le point de terminaison
DELETE {baseURL}/v3/workflows/{workflowId}
.
Paramètres
workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow à supprimer.
force (booléen) : facultatif. Lorsque cette option n'est pas sélectionnée, la valeur par défaut est « false ». Si un workflow est planifié, le paramètre défini sur « true » supprimera toutes les planifications avant de le supprimer.
Relations d'objets
Si vous chargez un workflow, vous pouvez utiliser les objets créés comme suit :
Objet créé : " workflowId " (par exemple, "id" : "7917969784f84bd09442f66996ecb8f3")
Vous pouvez l'utiliser comme :
workflowId si vous ajoutez des workflows à une collection .
appId si vous retirez des workflows d'une collection .
workflowId si vous recherchez un workflow spécifique .
workflowId si vous supprimez un workflow spécifique .
workflowId si vous mettez à jour un workflow existant .
workflowId si vous chargez une nouvelle version d'un workflow existant .
workflowId si vous recherchez une planification .
workflowId si vous créez une planification .
Exemples de demandes Postman
GET /v3/workflows/{workflowId}
Pour en savoir plus sur les demandes Postman, consultez la page d'aide Comment utiliser Postman .