移行可能なエンドポイント
注記
このヘルプページでは、Server APIエンドポイントの使用方法について説明します。Server APIを開始するには、Server APIの概要を参照してください。
migratableエンドポイントを使用して、Server環境間でワークフローを移行します。これを利用して、開発およびテスト段階にあるワークフローのデプロイを管理することができます。
最初に、ワークフローを移行できるようにする必要があります。ワークフローに移行対象のマークを付けたら、以下の手順に従い、移行元の環境から移行先の環境の適切なサブスクリプション (スタジオ) に公開します。
ステップ 1.移行準備が整ったワークフローのリストを取得する
次に、次のエンドポイントを使用して、移行準備が整ったワークフローのリストを取得します。
環境: 移行元
方法: GET
エンドポイント: webapi/admin/v1/workflows/migratable/?subscriptionIds={subscriptionIds}/
クエリーパラメーターとして、subscriptionIdsのカンマ区切りリストを含めます。サブスクリプション ID は、特定のスタジオを識別します。
指定されたサブスクリプション (スタジオ) 下で移行準備完了とマークされた一連のワークフローが返されます。subscriptionsIdsを指定しない場合、移行準備完了としてマークされたすべてのワークフローが返されます。この戻り値には、appId、現在公開されているrevisionId、ワークフローが属するsubscriptionIDの3つのプロパティが含まれます。
ステップ 2.移行元環境からワークフローをダウンロードする
次のエンドポイントは、ワークフローを YXZP ファイルとしてダウンロードします。
環境: 移行元
方法: GET
エンドポイント: webapi/admin/v1/{appID}/package/
パスパラメーターとしてappIDを含めます。ワークフロー全体をパッケージとしたダウンロードが返されます。
ステップ 3.移行先の環境でワークフローを公開する
以下のエンドポイントは、ダウンロードしたワークフローを移行先の環境に公開します。
環境: 移行先
方法: POST
エンドポイント: webapi/admin/v1/workflows/
パラメーター | |||
パラメーター | 説明 | タイプ | 必須 |
|---|---|---|---|
ファイル | 新しいワークフローのファイル名です。 | 文字列 | True |
名前 | 新しいワークフロー名です。 | 文字列 | True |
所有者 | 移行されたワークフローの所有者です。E メールアドレスは、移行先の環境に存在している必要があります。 | 文字列 | True |
validate | 移行先の環境への移行時にワークフローを検証するためのフラグです。 | ブール値 | True |
isPublic | ワークフローを公開に設定し、移行先の環境で「自社のServer」に表示させるためのフラグです。 | ブール値 | True |
sourceId | 移行予定のワークフローの、移行元環境のappIdです。同じsourceIdを持つワークフローが存在する場合、ワークフローのバージョンが増加します。それ以外の場合は、新しいワークフローが生成されます。 (appID を指定しない場合は、空の文字列を送信します。) | 文字列 | True |
workerTag | ワークフローにワーカータグを追加し、特定のワーカーがワークフローを実行するようにします。 (ワーカーを指定しない場合は、空の文字列を送信します。) | 文字列 | True |
canDownload | 移行先の環境の他のユーザーがワークフローをダウンロードできるように設定するフラグです。 | ブール値 | True |
(オプション) ステップ 4.移行元の環境で移行設定のワークフローをリセットする
必要に応じて、migratableエンドポイントを使用し、移行先の環境でワークフローを移行した後に、移行先の環境におけるワークフローの[このワークフローを移行対象にする]設定を[いいえ]に戻すことができます。
環境: 移行元
方法: PUT
エンドポイント: webapi/admin/v1/workflows/migratable/{appID}/