Note
Cette page d'aide traite de l'utilisation d'un point de terminaison de l'API Server. Pour commencer à utiliser l'API Server, consultez la présentation de l'API Server.
Utilisez le point de terminaison migratable pour migrer les workflows dans les environnements de Server. Vous pouvez l'utiliser pour gérer les déploiements de workflows pendant les phases de développement et de test.
Pour commencer, vous devez activer les workflows pour la migration. Une fois que vous avez marqué des workflows pour la migration, suivez ces étapes pour les publier à partir de l'environnement source dans la souscription appropriée (studio) d'un environnement cible.
Ensuite, obtenez une liste des workflows prêts pour la migration à l'aide du point de terminaison suivant :
Environnement : source
Méthode : GET
Point de terminaison : webapi/admin/v1/workflows/migratable/?subscriptionIds={subscriptionIds}/
Incluez une liste de subscriptionIds séparés par des virgules comme paramètre de requête. Les ID de souscription identifient un studio spécifique.
Vous obtenez un tableau des workflows marqués comme prêts pour la migration sous la souscription spécifiée (studio). Si vous ne fournissez pas de subscriptionsIds, le résultat inclut tous les workflows marqués comme prêts pour la migration. Le résultat inclut 3 propriétés : l'appId, le revisionId actuellement publié et le subscriptionID auquel appartient le workflow.
Le point de terminaison suivant télécharge le workflow sous forme de fichier YXZP.
Environnement : source
Méthode : GET
Point de terminaison : webapi/admin/v1/{appID}/package/
Incluez un appID comme paramètre de chemin. Vous obtiendrez un téléchargement de l'ensemble du workflow sous forme de package.
Le point de terminaison suivant publie le workflow téléchargé dans l'environnement cible.
Environnement : cible
Méthode : POST
Point de terminaison : webapi/admin/v1/workflows/
Paramètres | |||
Paramètre | Description | Type | Obligatoire |
|---|---|---|---|
file | Nom de fichier du nouveau workflow. | Chaîne | Vrai |
nom | Nom du nouveau workflow. | Chaîne | Vrai |
owner | Propriétaire du workflow migré. L'adresse e-mail doit exister dans l'environnement cible. | Chaîne | Vrai |
validate | Indicateur pour valider le workflow lors de la migration vers l'environnement cible. | Booléen | Vrai |
isPublic | Indicateur permettant de définir le workflow sur public afin de l'afficher dans « Server de mon entreprise » dans l'environnement cible. | Booléen | Vrai |
sourceId | Il s'agit de l'appId de l'environnement source du workflow à migrer. Si un workflow avec le même sourceId existe, la version du workflow est incrémentée. Dans le cas contraire, un nouveau workflow sera généré. (Envoyez une chaîne vide si vous ne souhaitez pas spécifier d'appID.) | Chaîne | Vrai |
workerTag | Ajoutez une balise worker au workflow pour qu'un worker spécifique exécute le workflow. (Envoyez une chaîne vide si vous ne souhaitez pas spécifier de worker.) | Chaîne | Vrai |
canDownload | Indicateur pour définir le workflow comme disponible au téléchargement par d'autres utilisateurs dans l'environnement cible. | Booléen | Vrai |
Si vous le souhaitez, vous pouvez utiliser le point de terminaison migratable pour définir le paramètre Ce workflow est prêt à être migré sur Non dans l'environnement source après la migration du workflow dans l'environnement cible.
Environnement : source
Méthode : PUT
Point de terminaison : webapi/admin/v1/workflows/migratable/{appID}/