Workflow バージョンの公開
Workflow バージョンの公開
指定した Workflow バージョンを本番環境向けに公開できます。
本インターフェースは対象 Workflow 自身の API Key で認証を行い、バージョン管理権限を有効化した Workflow のみが呼び出せます。
リクエストメソッド
POST
リクエストURL
https://api.${endpoint}/v1/workflow/version/release
リクエスト認証
詳しくは API 概要の認証方式の説明をご参照ください。対象 Workflow の API Key を token として使用してください。
リクエスト
リクエスト例
curl -X POST 'https://api.${endpoint}/v1/workflow/version/release' \
-H 'Authorization: Bearer ${token}' \
-H 'Content-Type: application/json' \
-d '{
"version": "v2"
}'
curl -X POST 'https://api.${endpoint}/v1/workflow/version/release' \
-H 'Authorization: Bearer ${token}' \
-H 'Content-Type: application/json' \
-d '{
"version": "v2"
}'
このコードブロックをポップアップで表示
リクエストヘッダー
| フィールド | タイプ | 説明 |
|---|---|---|
| Authorization | Bearer ${token} | 対象 Workflow の API Key を使用して呼び出しを検証します。 |
| Content-Type | application/json | リクエストボディの形式。 |
リクエストパラメータ（Body Parameters）
| パラメータ | タイプ | 説明 | required |
|---|---|---|---|
| version | String | 本番として公開するバージョン番号。 | true |
レスポンス
レスポンスボディ
{
"code": 0,
"message": "OK",
"data": {
"version": "v2",
"previous_version": "v1"
}
}
{
"code": 0,
"message": "OK",
"data": {
"version": "v2",
"previous_version": "v1"
}
}
このコードブロックをポップアップで表示
成功時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| version | String | 今回公開したバージョン番号。 |
| previous_version | String | 公開前の本番バージョン番号。初回公開時は空。 |
エラー時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| code | int | エラーコード。 |
| message | string | エラー情報。 |
ステータスコード
| ステータスコード | 説明 |
|---|---|
| 200 | 成功 |
| 400 | パラメータエラー |
| 401 | 未認証 |
| 403 | 権限不足、または API Key でバージョン管理権限が有効化されていません |
| 429 | リクエストが頻繁すぎます |
| 500 | サーバーエラー |