Points de terminaison du workflow

file (fichier) : obligatoire. Choisissez le fichier 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.

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. Sélectionnez « true » pour rendre le workflow accessible au public. Sélectionnez « false » pour rendre le workflow privé et inaccessible 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. Définit l'ID de l'application source d'un workflow. Vous pouvez l'utiliser en tant que référence « sourceId » pour le point de terminaison d'API POST admin/v1/workflows. Si vous fournissez un ID d'application source préexistant, la demande sera non valide.

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.

workflowCredentialType (chaîne) : obligatoire. Les valeurs acceptées sont « Default », « Required » et « Specific ».

credentialId (chaîne) : facultatif. Indiquez le ID d'identification pour ce workflow.

collectionIds (chaîne) : facultatif. Saisissez le(s) Id(s) de collection où ce workflow doit être ajouté. Soumettez sous forme de tableau au format JSON, par exemple, ["id1", "id2"].

workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow dont vous souhaitez charger une nouvelle version.

file (fichier) : obligatoire. Choisissez le fichier que vous souhaitez charger dans le système en tant que nouvelle version.

name (chaîne) : obligatoire. Saisissez le nom du workflow.

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) : facultatif. 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.

workflowCredentialType (chaîne) : obligatoire. Saisissez le type d'informations d'identification à utiliser pour ce workflow. Les valeurs acceptées sont « Default », « Required » et « Specific ».

credentialId (chaîne) : facultatif. Indiquez l'Id d'identification pour ce workflow. Pour plus d'informations sur les points de terminaison d'informations d'identification, accédez à Points de terminaison d'informations d'identification.

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.

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.

workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow pour obtenir des informations sur ce workflow.

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.

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.

workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow pour lequel vous souhaitez télécharger un package.

versionId (chaîne) : facultatif. Saisissez l'ID de version spécifique d'un workflow. Si aucune version n'est fournie, la version publiée est téléchargée.

workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow dont vous souhaitez récupérer les informations.

versionId (chaîne) : facultatif. Saisissez l'ID de version spécifique d'un workflow. Si aucune version n'est fournie, la version publiée est utilisée.

workflowId (chaîne) : obligatoire. Saisissez l'ID du workflow dont vous souhaitez récupérer les informations.

sortField (chaîne) : facultatif.

direction (chaîne) : facultatif.

offset (chaîne) : facultatif.

limit (chaîne) : facultatif.

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.