{ "components": { "securitySchemes": { "ApiKeyAuth": { "description": "APIキーを利用したBasic認証", "scheme": "basic", "type": "http" } } }, "info": { "contact": { "name": "SAKURA internet Inc." }, "description": "***\n\n「Workflows」が提供するAPIの利用方法とサンプルを公開しております。\n\n# 基本的な使い方\n\n## APIキーの利用\n\n認証には「APIキー」が利用できます。事前にキーを発行しておきます。\nAPIキーは「ユーザーID」「パスワード」に相当する「トークン」と呼ばれる認証情報で構成されています。\n\n| 項目名 | APIキー発行時の項目名 | このドキュメント内での例 |\n| ------ | -------------- | ------------------------------------ |\n| ユーザーID | アクセストークン(UUID) | 01234567-89ab-cdef-0123-456789abcdef |\n| パスワード | アクセストークンシークレット | SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM |\n\n \u003cdiv class=\"warning\"\u003e\n 操作マニュアル\u003cbr /\u003e\n \u003cul\u003e\u003cli\u003e\u003ca href=\"https://manual.sakura.ad.jp/cloud/api/apikey.html\"\u003eAPIキー | さくらのクラウド ドキュメント\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\n \u003c/div\u003e\n\n## 出力結果と応答コード（HTTPステータスコード）\n\nAPIからの結果は、「応答コード（HTTPステータスコード）」と、「JSON形式(UTF-8)の結果」として出力されます。\n\n応答コードは、リクエストが成功したのか、失敗したのか大まかな情報を判断することができるもので、例えば失敗したときには、なぜこのような結果になったのかなど、具体的な情報は応答コードと主に返された本文を見ることで把握することができます。\n\n| 結果 | 応答コード/status | レスポンス |\n| ----------------- | ------------ | ----------------- |\n| 成功（要求を受け付けた） | 2xx | \"is\\_ok\": true |\n| 失敗（要求が受け付けられなかった） | 4xx, 5xx | \"is\\_fatal\": true, \"is\\_ok\": false |\n\n```json\n# 出力結果サンプル(成功時)\n{\n \"is_ok\": true,\n \"Total\": 0,\n \"From\": 0,\n \"Count\": 0,\n \"Log\": []\n}\n```\n\n```json\n# 出力結果サンプル（認証経路で失敗時）\n{\n \"is_fatal\": true,\n \"serial\": \"e0f36f2b4e056e2aefc3bc1242b36f1e\",\n \"status\": \"500 Internal Server Error\",\n \"error_code\": \"internal_server_error\",\n \"error_msg\": \"サーバ内部エラーが発生しました。このエラーが繰り返し発生する場合は、メンテナンス情報、サポートサイトをご確認ください。\"\n}\n# 出力結果サンプル（ワークフロー内で失敗時）\n{\n \"is_ok\": false,\n \"Code\": \"H-0000\",\n \"Message\": \"Malformed JSON in request body\",\n \"Cause\": []\n}\n```\n\n## Runbookのコードサンプル\n\n### エラトステネスの篩\n\n```yaml\nmeta:\n description: エラトステネスの篩\nargs:\n maxNumber:\n type: number\n description: 素数を求める最大の数\nsteps:\n setup:\n assign:\n sieve: ${array.fill(array.range(args.maxNumber), true)}\n primes: []\n initial:\n assign:\n _a: ${array.set(sieve, 0, false)}\n _b: ${array.set(sieve, 1, false)}\n loop:\n for:\n in: ${array.range(2, math.ceil(math.sqrt(args.maxNumber)))}\n as: index\n steps:\n if:\n switch:\n # falseだったら飛ばす\n - condition: ${sieve[index] == false}\n next: continue\n # trueだったら素数\n - condition: ${sieve[index] != false}\n steps:\n # 素数の倍数を篩にかける\n updateSieve:\n for:\n in: ${array.range(index * 2, args.maxNumber, index)}\n as: n\n steps:\n set:\n assign:\n _a: ${array.set(sieve, n, false)}\n continue:\n printPrimes:\n for:\n in: ${array.range(2, args.maxNumber)}\n as: index\n steps:\n if:\n switch:\n - condition: ${sieve[index] == true}\n steps:\n push:\n assign:\n _a: ${array.push(primes, index)}\n log:\n assign:\n log: '${\"素数: \" + index}'\n done:\n return: ${primes}\n```\n\n### 住所検索\n\n```yaml\nmeta:\n description: 住所検索\nargs:\n address:\n type: string\n description: \"住所を取得するための郵便番号\"\nsteps:\n set:\n switch:\n - condition: ${args.address}\n steps:\n x:\n assign:\n address: ${args.address}\n - condition: ${!args.address}\n steps:\n x:\n assign:\n address: \"1000001\"\n get:\n call: http.get\n args:\n url: ${\"https://zipcloud.ibsnet.co.jp/api/search\"}\n headers:\n Accept: application/json\n query:\n zipcode: ${address}\n result: atomBody\n parse:\n assign:\n jsonData: ${json.decode(atomBody.body)}\n done:\n return: ${jsonData.results[0].address1 + jsonData.results[0].address2 + jsonData.results[0].address3}\n```\n\n# 利用例\n\n上記で取得した`ユーザーID`、`トークン`を利用してAPIの利用が可能になります。\n\n## プランの設定\n\nプランを設定しワークフローを利用するには、以下のような入力を行います。\n\n### プラン一覧の確認\n\n```sh\n# 入力サンプル\ncurl -u '01234567-89ab-cdef-0123-456789abcdef:sampletokensampletokensampletoke' \\\n -X GET \\\n -H 'Content-Type: application/json' \\\n -H 'X-Requested-With: XMLHttpRequest' \\\n https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0/plans | jq .\n```\n\n```json\n{\n \"is_ok\": true,\n \"Plans\": [\n {\n \"id\": 1,\n \"name\": \"200Kプラン\",\n \"grade\": 200,\n \"basePrice\": 4000,\n \"includedSteps\": 200000,\n \"overageStepUnit\": 1000,\n \"overagePricePerUnit\": 80,\n ...\n },\n {\n \"id\": 2,\n \"name\": \"600Kプラン\",\n \"grade\": 300,\n \"basePrice\": 10000,\n \"includedSteps\": 600000,\n \"overageStepUnit\": 1000,\n \"overagePricePerUnit\": 80,\n ...\n }\n ],\n \"TaxRate\": 10\n}\n```\n\n### プランの設定\n上記で取得した任意の`プランID(Plans[].id)`を利用して、プランを設定します。\n\n```sh\n# 入力サンプル\ncurl -u '01234567-89ab-cdef-0123-456789abcdef:sampletokensampletokensampletoke' \\\n -X POST \\\n -H 'Content-Type: application/json' \\\n -H 'X-Requested-With: XMLHttpRequest' \\\n -d '{\"PlanId\": 1}' \\\n https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0/subscription | jq .\n```\n\n上記プラン設定完了後、ワークフローが利用可能になります。\n\n## ワークフローの作成\n\nワークフローを作成するには、以下のような入力を行います。\n\n\u003e ワークフロー作成前にRunbookの作成が必要になります。\n\u003e 詳しくは[構文リファレンス](https://manual.sakura.ad.jp/cloud/appliance/workflows/reference-syntax.html)を参照してください。\n\n### Runbookをパラメータに設定する\n\nJSON内にYAMLを格納するために必要なこと\n\n- Runbookの改行を `\\n` に変換する。\n- YAML内にあるダブルクォーテーションをエスケープする。\n convertYaml.sh\n\n```bash\n#!/bin/bash\n\n# Runbookファイルを読み込み、文字列に変換\n# 改行は\\nに変換し、ダブルクォーテーションはエスケープする\n# gsedはMacのsedで改行を含む文字列を扱うために使用\n# Mac環境でのみ動作確認済み\n\n# runbook_to_string 関数を定義\nfunction runbook_to_string() {\n local file_path=\"$1\"\n local runbook\n\n if [ ! -f \"$file_path\" ]; then\n echo \"Error: File not found.\" \u003e\u00262\n return 1\n fi\n\n runbook=$(gsed ':a;N;$!ba;s/\\n/\\\\n/g' \"$file_path\" | gsed 's/\"/\\\\\"/g')\n echo \"$runbook\"\n}\n\n# コマンドラインからの引数をチェック\nif [ $# -eq 0 ]; then\n echo \"Usage: $0 \u003cfile_path\u003e\"\n exit 1\nfi\n\n# 引数からファイルパスを取得\nfile_path=\"$1\"\n\n# runbook_to_string 関数を呼び出し、結果を表示\nrunbook_to_string \"$file_path\"\n```\n\n上記で作成したbashに実行権限を付け、yamlをリクエストパラメータで使えるよう文字列に変換します。\n\n```sh\nchmod +x convertYaml.sh\n./convertYaml.sh sample.yaml\n```\n\n### ワークフローの作成\n\n```sh\n# 入力サンプル\nvi request_body.json\n\ncat request_body.json\n{\n \"Runbook\": \"[上記bashで出力した文字列]\",\n \"Name\": \"Workflowの名前\",\n \"Description\": \"ワークフローの説明\",\n \"Publish\": true,\n \"Logging\": true,\n}\n\ncurl -u '01234567-89ab-cdef-0123-456789abcdef:sampletokensampletokensampletoke' \\\n -X POST \\\n -H 'Content-Type: application/json' \\\n -H 'X-Requested-With: XMLHttpRequest' \\\n -d '@request_body.json' \\\n https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0/workflows/ | jq .\n```\n\n```json\n{\n \"is_ok\": true,\n \"Workflow\": {\n \"Id\": \"uhqybrbehx8lnpo9x8hd8ikt\",　\u003c- workflowID\n \"Name\": \"Workflowの名前\",\n \"Description\": \"ワークフローの説明\",\n \"Publish\": true,\n \"Logging\": true,\n \"Tags\": [\n {\n \"Name\": null\n }\n ],\n \"CreatedAt\": \"2025-01-30T17:54:28.710Z\",\n \"UpdatedAt\": \"2025-01-30T17:54:28.710Z\"\n }\n}\n```\n\n## ワークフローの実行\n\nワークフローを実行するには、以下のような入力を行います。\n\nurlには上記で取得した`workflowID`を使います。\n\n```sh\n# 入力サンプル\nvi request_body.json\n\ncat request_body.json\n{}\n\ncurl -u '01234567-89ab-cdef-0123-456789abcdef:sampletokensampletokensampletoke' \\\n -X POST \\\n -H 'Content-Type: application/json' \\\n -H 'X-Requested-With: XMLHttpRequest' \\\n -d '@request_body.json' \\\n https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0/workflows/[workflowId]/executions | jq .\n```\n\n```json\n{\n \"is_ok\": true,\n \"Execution\": {\n \"ExecutionId\": \"bcohwmnwlhpkhowhn80k3ird\", \u003c- executionId\n \"Name\": \"Workflowの名前\",\n \"Workflow\": {\n \"Id\": \"uhqybrbehx8lnpo9x8hd8ikt\",　\u003c- workflowID\n \"Name\": \"Workflowの名前\",\n \"Description\": \"Workflowの説明\",\n \"Publish\": true,\n \"Logging\": true,\n \"Tags\": [\n {\n \"Name\": null\n }\n ],\n \"CreatedAt\": \"2025-01-30T17:54:28.710Z\",\n \"UpdatedAt\": \"2025-01-30T17:54:28.710Z\"\n },\n \"Status\": \"Queued\",\n \"Revision\": 1,\n \"RevisionAlias\": \"string\",\n \"Args\": \"null\",\n \"Result\": \"null\",\n \"Error\": \"null\",\n \"CreatedAt\": \"2025-01-30T18:09:34.810Z\",\n \"UpdatedAt\": \"2025-01-30T18:09:34.810Z\"\n }\n}\n```\n\n## ワークフローの実行の履歴を取得\n\nワークフローの実行の履歴を取得するには、以下のような入力を行います。\n\nurlには上記で取得した`workflowID`と`executionId`を使います。\n\n```sh\n# 入力サンプル\ncurl -u '01234567-89ab-cdef-0123-456789abcdef:sampletokensampletokensampletoke' \\\n -X GET \\\n -H 'Content-Type: application/json' \\\n -H 'X-Requested-With: XMLHttpRequest' \\\n https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0/workflows/[workflowId]/executions/[executionId]/exec_history | jq .\n```\n", "license": { "name": "Copyright(C) SAKURA internet Inc. all rights reserved." }, "title": "Workflows APIドキュメント", "version": "1.1.0" }, "openapi": "3.0.0", "paths": { "/plans": { "get": { "description": "現在契約可能な Workflows の料金プランの一覧を取得します。", "operationId": "listPlans", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "Plans": [ { "basePrice": 123, "grade": 123, "id": 123, "includedSteps": 123, "name": "sampleString", "overagePricePerUnit": 123, "overageStepUnit": 123, "serviceClassPath": "sampleString" } ], "TaxRate": 10, "is_ok": true }, "schema": { "properties": { "Plans": { "items": { "properties": { "basePrice": { "type": "integer" }, "grade": { "type": "integer" }, "id": { "type": "integer" }, "includedSteps": { "type": "integer" }, "name": { "type": "string" }, "overagePricePerUnit": { "type": "integer" }, "overageStepUnit": { "type": "integer" }, "serviceClassPath": { "type": "string" } }, "required": [ "id", "name", "grade", "serviceClassPath", "basePrice", "includedSteps", "overageStepUnit", "overagePricePerUnit" ], "type": "object" }, "type": "array" }, "TaxRate": { "default": 10, "type": "integer" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Plans", "TaxRate" ], "type": "object" } } }, "description": "プラン一覧の取得に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "プラン一覧を取得する", "tags": [ "プラン" ] } }, "/subscriptions": { "delete": { "description": "ワークフローの課金プランの削除をする", "operationId": "deleteSubscription", "parameters": [], "responses": { "204": { "description": "ワークフローのプラン削除に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローの課金プランの削除をする", "tags": [ "サブスクリプション" ] }, "get": { "description": "ワークフローの課金プランの取得をする", "operationId": "readSubscription", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "CurrentPlan": { "accountId": "sampleString", "activateFrom": "2020-01-01T00:00:00Z", "activateUntil": "2020-01-01T00:00:00Z", "contractId": "sampleString", "createdAt": "2020-01-01T00:00:00Z", "id": "sampleString", "planId": 123, "planName": "sampleString", "updatedAt": "2020-01-01T00:00:00Z" }, "MonthAppliedPlan": { "accountId": "sampleString", "activateFrom": "2020-01-01T00:00:00Z", "activateUntil": "2020-01-01T00:00:00Z", "basePrice": 123, "contractId": "sampleString", "createdAt": "2020-01-01T00:00:00Z", "id": "sampleString", "includedSteps": 123, "overagePricePerUnit": 123, "overageStepUnit": 123, "planGrade": 123, "planId": 123, "planName": "sampleString", "updatedAt": "2020-01-01T00:00:00Z" }, "is_ok": true }, "schema": { "properties": { "CurrentPlan": { "nullable": true, "properties": { "accountId": { "type": "string" }, "activateFrom": { "format": "date-time", "type": "string" }, "activateUntil": { "format": "date-time", "nullable": true, "type": "string" }, "contractId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "planId": { "type": "integer" }, "planName": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "accountId", "contractId", "planId", "activateFrom", "activateUntil", "createdAt", "updatedAt", "planName" ], "type": "object" }, "MonthAppliedPlan": { "properties": { "accountId": { "type": "string" }, "activateFrom": { "format": "date-time", "type": "string" }, "activateUntil": { "format": "date-time", "nullable": true, "type": "string" }, "basePrice": { "type": "integer" }, "contractId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "includedSteps": { "type": "integer" }, "overagePricePerUnit": { "type": "integer" }, "overageStepUnit": { "type": "integer" }, "planGrade": { "type": "integer" }, "planId": { "type": "integer" }, "planName": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "id", "accountId", "contractId", "planId", "activateFrom", "activateUntil", "createdAt", "updatedAt", "planName", "planGrade", "basePrice", "includedSteps", "overageStepUnit", "overagePricePerUnit" ], "type": "object" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok" ], "type": "object" } } }, "description": "ワークフローのプラン取得に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローの課金プランの取得をする", "tags": [ "サブスクリプション" ] }, "post": { "description": "ワークフローの課金プランの設定をする", "operationId": "createSubscription", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "PlanId": 123 }, "schema": { "properties": { "PlanId": { "minimum": 1, "type": "integer" } }, "required": [ "PlanId" ], "type": "object" } } }, "required": true }, "responses": { "204": { "description": "ワークフローのプラン設定に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローの課金プランの設定をする", "tags": [ "サブスクリプション" ] } }, "/workflows": { "get": { "description": "ワークフローの一覧を取得する", "operationId": "listWorkflows", "parameters": [ { "description": "ページ番号", "example": 1, "in": "query", "name": "Page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "description": "1ページあたりのリソースの取得数", "example": 20, "in": "query", "name": "PageLimit", "required": false, "schema": { "default": 20, "maximum": 500, "minimum": 5, "type": "integer" } }, { "description": "Workflowのソートに利用するプロパティ", "example": "createdAt", "in": "query", "name": "SortBy", "required": false, "schema": { "enum": [ "createdAt", "updatedAt", "id" ], "type": "string" } }, { "description": "ソートの順序", "example": "asc", "in": "query", "name": "Order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "公開状態の絞り込み", "example": true, "in": "query", "name": "Published", "required": false, "schema": { "type": "boolean" } }, { "description": "ワークフロー名の絞り込み", "example": "sampleString", "in": "query", "name": "Name", "required": false, "schema": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" } }, { "description": "ワークフロー名の絞り込み方法", "example": "partial", "in": "query", "name": "NameMatchType", "required": false, "schema": { "enum": [ "partial", "prefix" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "Count": 0, "From": 0, "Total": 0, "Workflows": [ { "ConcurrencyMode": "parallel", "CreatedAt": "2020-01-01T00:00:00Z", "Description": "sampleString", "Id": "sampleString", "Logging": true, "Name": "sampleString", "Publish": true, "ServicePrincipalId": "sampleString", "Tags": [ { "Name": "sampleString" } ], "UpdatedAt": "2020-01-01T00:00:00Z" } ], "is_ok": true }, "schema": { "properties": { "Count": { "default": 0, "minimum": 0, "type": "integer" }, "From": { "default": 0, "minimum": 0, "type": "integer" }, "Total": { "default": 0, "minimum": 0, "type": "integer" }, "Workflows": { "items": { "properties": { "ConcurrencyMode": { "enum": [ "parallel", "lock", "queue" ], "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Description": { "maxLength": 1024, "minLength": 0, "type": "string" }, "Id": { "maxLength": 36, "minLength": 1, "type": "string" }, "Logging": { "type": "boolean" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Publish": { "type": "boolean" }, "ServicePrincipalId": { "oneOf": [ { "pattern": "^[0-9]{12}$", "type": "string" }, { "type": "number" } ] }, "Tags": { "items": { "properties": { "Name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "Name" ], "type": "object" }, "type": "array" }, "UpdatedAt": { "format": "date-time", "type": "string" } }, "required": [ "Id", "Name", "Publish", "Logging", "Tags", "CreatedAt", "UpdatedAt" ], "type": "object" }, "type": "array" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Total", "From", "Count", "Workflows" ], "type": "object" } } }, "description": "ワークフローの一覧の取得に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローの一覧を取得する", "tags": [ "ワークフローの管理" ] }, "post": { "description": "ワークフローを作成する", "operationId": "createWorkflow", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "ConcurrencyMode": "parallel", "Description": "sampleString", "Logging": true, "Name": "sampleString", "Publish": true, "RevisionAlias": "sampleString", "Runbook": "sampleString", "ServicePrincipalId": "sampleString", "Tags": [ { "Name": "sampleString" } ] }, "schema": { "properties": { "ConcurrencyMode": { "enum": [ "parallel", "lock", "queue" ], "type": "string" }, "Description": { "maxLength": 1024, "minLength": 0, "type": "string" }, "Logging": { "type": "boolean" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Publish": { "type": "boolean" }, "RevisionAlias": { "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]*$", "type": "string" }, "Runbook": { "type": "string" }, "ServicePrincipalId": { "oneOf": [ { "pattern": "^[0-9]{12}$", "type": "string" }, { "type": "number" } ] }, "Tags": { "items": { "properties": { "Name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "Name" ], "type": "object" }, "type": "array" } }, "required": [ "Name", "Runbook", "Publish", "Logging" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "Workflow": { "ConcurrencyMode": "parallel", "CreatedAt": "2020-01-01T00:00:00Z", "Description": "sampleString", "Id": "sampleString", "Logging": true, "Name": "sampleString", "Publish": true, "ServicePrincipalId": "sampleString", "Tags": [ { "Name": "sampleString" } ], "UpdatedAt": "2020-01-01T00:00:00Z" }, "is_ok": true }, "schema": { "properties": { "Workflow": { "properties": { "ConcurrencyMode": { "enum": [ "parallel", "lock", "queue" ], "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Description": { "maxLength": 1024, "minLength": 0, "type": "string" }, "Id": { "maxLength": 36, "minLength": 1, "type": "string" }, "Logging": { "type": "boolean" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Publish": { "type": "boolean" }, "ServicePrincipalId": { "oneOf": [ { "pattern": "^[0-9]{12}$", "type": "string" }, { "type": "number" } ] }, "Tags": { "items": { "properties": { "Name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "Name" ], "type": "object" }, "type": "array" }, "UpdatedAt": { "format": "date-time", "type": "string" } }, "required": [ "Id", "Name", "Publish", "Logging", "Tags", "CreatedAt", "UpdatedAt" ], "type": "object" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Workflow" ], "type": "object" } } }, "description": "ワークフローの作成に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローを作成する", "tags": [ "ワークフローの管理" ] } }, "/workflows/suggest": { "get": { "description": "ワークフローのサジェストを取得する", "operationId": "listSuggestions", "parameters": [ { "description": "ワークフロー名の絞り込み", "example": "sampleString", "in": "query", "name": "Name", "required": true, "schema": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" } }, { "description": "ページ番号", "example": 1, "in": "query", "name": "Page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "description": "1ページあたりのリソースの取得数", "example": 20, "in": "query", "name": "PageLimit", "required": false, "schema": { "default": 20, "maximum": 500, "minimum": 5, "type": "integer" } }, { "description": "サジェストのソートに利用するプロパティ", "example": "name", "in": "query", "name": "SortBy", "required": false, "schema": { "enum": [ "name", "count" ], "type": "string" } }, { "description": "ソートの順序", "example": "asc", "in": "query", "name": "Order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "Count": 0, "From": 0, "Suggests": [ { "Count": 123, "Name": "sampleString" } ], "Total": 0, "is_ok": true }, "schema": { "properties": { "Count": { "default": 0, "minimum": 0, "type": "integer" }, "From": { "default": 0, "minimum": 0, "type": "integer" }, "Suggests": { "items": { "properties": { "Count": { "minimum": 1, "type": "integer" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" } }, "required": [ "Name", "Count" ], "type": "object" }, "type": "array" }, "Total": { "default": 0, "minimum": 0, "type": "integer" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Total", "From", "Count", "Suggests" ], "type": "object" } } }, "description": "ワークフローのサジェストの取得に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローのサジェストを取得する", "tags": [ "ワークフローの管理" ] } }, "/workflows/{id}": { "delete": { "description": "ワークフローを削除する", "operationId": "deleteWorkflow", "parameters": [ { "description": "Workflow ID", "example": "sampleString", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "is_ok": true }, "schema": { "properties": { "is_ok": { "type": "boolean" } }, "required": [ "is_ok" ], "type": "object" } } }, "description": "ワークフローを削除に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "example": { "Message": "sampleString", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "ワークフローを削除できない状態" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローを削除する", "tags": [ "ワークフローの管理" ] }, "get": { "description": "ワークフローを取得する", "operationId": "readWorkflow", "parameters": [ { "description": "Workflow ID", "example": "sampleString", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "Workflow": { "ConcurrencyMode": "parallel", "CreatedAt": "2020-01-01T00:00:00Z", "Description": "sampleString", "Id": "sampleString", "Logging": true, "Name": "sampleString", "Publish": true, "ServicePrincipalId": "sampleString", "Tags": [ { "Name": "sampleString" } ], "UpdatedAt": "2020-01-01T00:00:00Z" }, "is_ok": true }, "schema": { "properties": { "Workflow": { "properties": { "ConcurrencyMode": { "enum": [ "parallel", "lock", "queue" ], "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Description": { "maxLength": 1024, "minLength": 0, "type": "string" }, "Id": { "maxLength": 36, "minLength": 1, "type": "string" }, "Logging": { "type": "boolean" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Publish": { "type": "boolean" }, "ServicePrincipalId": { "oneOf": [ { "pattern": "^[0-9]{12}$", "type": "string" }, { "type": "number" } ] }, "Tags": { "items": { "properties": { "Name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "Name" ], "type": "object" }, "type": "array" }, "UpdatedAt": { "format": "date-time", "type": "string" } }, "required": [ "Id", "Name", "Publish", "Logging", "Tags", "CreatedAt", "UpdatedAt" ], "type": "object" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Workflow" ], "type": "object" } } }, "description": "ワークフローの取得に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローを取得する", "tags": [ "ワークフローの管理" ] }, "patch": { "description": "ワークフローを更新する", "operationId": "patchWorkflow", "parameters": [ { "description": "Workflow ID", "example": "sampleString", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "ConcurrencyMode": "parallel", "Description": "sampleString", "Logging": true, "Name": "sampleString", "Publish": true, "Tags": [ { "Name": "sampleString" } ] }, "schema": { "properties": { "ConcurrencyMode": { "enum": [ "parallel", "lock", "queue" ], "type": "string" }, "Description": { "maxLength": 1024, "minLength": 0, "type": "string" }, "Logging": { "type": "boolean" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Publish": { "type": "boolean" }, "Tags": { "items": { "properties": { "Name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "Name" ], "type": "object" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "Workflow": { "ConcurrencyMode": "parallel", "CreatedAt": "2020-01-01T00:00:00Z", "Description": "sampleString", "Id": "sampleString", "Logging": true, "Name": "sampleString", "Publish": true, "ServicePrincipalId": "sampleString", "Tags": [ { "Name": "sampleString" } ], "UpdatedAt": "2020-01-01T00:00:00Z" }, "is_ok": true }, "schema": { "properties": { "Workflow": { "properties": { "ConcurrencyMode": { "enum": [ "parallel", "lock", "queue" ], "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Description": { "maxLength": 1024, "minLength": 0, "type": "string" }, "Id": { "maxLength": 36, "minLength": 1, "type": "string" }, "Logging": { "type": "boolean" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Publish": { "type": "boolean" }, "ServicePrincipalId": { "oneOf": [ { "pattern": "^[0-9]{12}$", "type": "string" }, { "type": "number" } ] }, "Tags": { "items": { "properties": { "Name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "Name" ], "type": "object" }, "type": "array" }, "UpdatedAt": { "format": "date-time", "type": "string" } }, "required": [ "Id", "Name", "Publish", "Logging", "Tags", "CreatedAt", "UpdatedAt" ], "type": "object" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Workflow" ], "type": "object" } } }, "description": "ワークフローの更新に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローを更新する", "tags": [ "ワークフローの管理" ] } }, "/workflows/{id}/executions": { "get": { "description": "ワークフローの実行の一覧を取得する", "operationId": "listExecutions", "parameters": [ { "description": "ページ番号", "example": 1, "in": "query", "name": "Page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "description": "1ページあたりのリソースの取得数", "example": 20, "in": "query", "name": "PageLimit", "required": false, "schema": { "default": 20, "maximum": 500, "minimum": 5, "type": "integer" } }, { "description": "ソートの順序", "example": "asc", "in": "query", "name": "Order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Workflow ID", "example": "sampleString", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "Count": 0, "Executions": [ { "Args": "sampleString", "CancelRequestedAt": "2020-01-01T00:00:00Z", "CanceledAt": "2020-01-01T00:00:00Z", "CreatedAt": "2020-01-01T00:00:00Z", "Error": "sampleString", "ExecutionId": "sampleString", "FailedAt": "2020-01-01T00:00:00Z", "Name": "sampleString", "Result": "sampleString", "Revision": 123, "RevisionAlias": "sampleString", "RunAt": "2020-01-01T00:00:00Z", "Status": "Queued", "StepCount": 0, "SucceededAt": "2020-01-01T00:00:00Z", "UpdatedAt": "2020-01-01T00:00:00Z", "Workflow": { "ConcurrencyMode": "parallel", "CreatedAt": "2020-01-01T00:00:00Z", "Description": "sampleString", "Id": "sampleString", "Logging": true, "Name": "sampleString", "Publish": true, "ServicePrincipalId": "sampleString", "Tags": [ { "Name": "sampleString" } ], "UpdatedAt": "2020-01-01T00:00:00Z" } } ], "From": 0, "Total": 0, "is_ok": true }, "schema": { "properties": { "Count": { "default": 0, "minimum": 0, "type": "integer" }, "Executions": { "items": { "properties": { "Args": { "maxLength": 65536, "minLength": 1, "type": "string" }, "CancelRequestedAt": { "format": "date-time", "type": "string" }, "CanceledAt": { "format": "date-time", "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Error": { "maxLength": 65536, "minLength": 1, "type": "string" }, "ExecutionId": { "maxLength": 36, "minLength": 1, "type": "string" }, "FailedAt": { "format": "date-time", "type": "string" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Result": { "maxLength": 65536, "minLength": 1, "type": "string" }, "Revision": { "type": "integer" }, "RevisionAlias": { "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]*$", "type": "string" }, "RunAt": { "format": "date-time", "type": "string" }, "Status": { "enum": [ "Queued", "Running", "Succeeded", "Failed", "Canceling", "Canceled" ], "type": "string" }, "StepCount": { "default": 0, "minimum": 0, "type": "integer" }, "SucceededAt": { "format": "date-time", "type": "string" }, "UpdatedAt": { "format": "date-time", "type": "string" }, "Workflow": { "properties": { "ConcurrencyMode": { "enum": [ "parallel", "lock", "queue" ], "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Description": { "maxLength": 1024, "minLength": 0, "type": "string" }, "Id": { "maxLength": 36, "minLength": 1, "type": "string" }, "Logging": { "type": "boolean" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Publish": { "type": "boolean" }, "ServicePrincipalId": { "oneOf": [ { "pattern": "^[0-9]{12}$", "type": "string" }, { "type": "number" } ] }, "Tags": { "items": { "properties": { "Name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "Name" ], "type": "object" }, "type": "array" }, "UpdatedAt": { "format": "date-time", "type": "string" } }, "required": [ "Id", "Name", "Publish", "Logging", "Tags", "CreatedAt", "UpdatedAt" ], "type": "object" } }, "required": [ "ExecutionId", "Name", "Workflow", "Status", "Revision", "RevisionAlias", "Args", "StepCount", "Result", "Error", "CreatedAt", "UpdatedAt" ], "type": "object" }, "type": "array" }, "From": { "default": 0, "minimum": 0, "type": "integer" }, "Total": { "default": 0, "minimum": 0, "type": "integer" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Total", "From", "Count", "Executions" ], "type": "object" } } }, "description": "ワークフローの実行の一覧の取得に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローの実行の一覧を取得する", "tags": [ "ワークフローの実行" ] }, "post": { "description": "ワークフローを実行する", "operationId": "createExecution", "parameters": [ { "description": "Workflow ID", "example": "sampleString", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "Args": "sampleString", "Name": "sampleString", "RevisionAlias": "sampleString", "RevisionId": 123 }, "schema": { "properties": { "Args": { "maxLength": 65536, "minLength": 1, "type": "string" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "RevisionAlias": { "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]*$", "type": "string" }, "RevisionId": { "type": "integer" } }, "type": "object" } } } }, "responses": { "201": { "content": { "application/json": { "example": { "Execution": { "Args": "sampleString", "CancelRequestedAt": "2020-01-01T00:00:00Z", "CanceledAt": "2020-01-01T00:00:00Z", "CreatedAt": "2020-01-01T00:00:00Z", "Error": "sampleString", "ExecutionId": "sampleString", "FailedAt": "2020-01-01T00:00:00Z", "Name": "sampleString", "Result": "sampleString", "Revision": 123, "RevisionAlias": "sampleString", "RunAt": "2020-01-01T00:00:00Z", "Status": "Queued", "StepCount": 0, "SucceededAt": "2020-01-01T00:00:00Z", "UpdatedAt": "2020-01-01T00:00:00Z", "Workflow": { "ConcurrencyMode": "parallel", "CreatedAt": "2020-01-01T00:00:00Z", "Description": "sampleString", "Id": "sampleString", "Logging": true, "Name": "sampleString", "Publish": true, "ServicePrincipalId": "sampleString", "Tags": [ { "Name": "sampleString" } ], "UpdatedAt": "2020-01-01T00:00:00Z" } }, "is_ok": true }, "schema": { "properties": { "Execution": { "properties": { "Args": { "maxLength": 65536, "minLength": 1, "type": "string" }, "CancelRequestedAt": { "format": "date-time", "type": "string" }, "CanceledAt": { "format": "date-time", "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Error": { "maxLength": 65536, "minLength": 1, "type": "string" }, "ExecutionId": { "maxLength": 36, "minLength": 1, "type": "string" }, "FailedAt": { "format": "date-time", "type": "string" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Result": { "maxLength": 65536, "minLength": 1, "type": "string" }, "Revision": { "type": "integer" }, "RevisionAlias": { "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]*$", "type": "string" }, "RunAt": { "format": "date-time", "type": "string" }, "Status": { "enum": [ "Queued", "Running", "Succeeded", "Failed", "Canceling", "Canceled" ], "type": "string" }, "StepCount": { "default": 0, "minimum": 0, "type": "integer" }, "SucceededAt": { "format": "date-time", "type": "string" }, "UpdatedAt": { "format": "date-time", "type": "string" }, "Workflow": { "properties": { "ConcurrencyMode": { "enum": [ "parallel", "lock", "queue" ], "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Description": { "maxLength": 1024, "minLength": 0, "type": "string" }, "Id": { "maxLength": 36, "minLength": 1, "type": "string" }, "Logging": { "type": "boolean" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Publish": { "type": "boolean" }, "ServicePrincipalId": { "oneOf": [ { "pattern": "^[0-9]{12}$", "type": "string" }, { "type": "number" } ] }, "Tags": { "items": { "properties": { "Name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "Name" ], "type": "object" }, "type": "array" }, "UpdatedAt": { "format": "date-time", "type": "string" } }, "required": [ "Id", "Name", "Publish", "Logging", "Tags", "CreatedAt", "UpdatedAt" ], "type": "object" } }, "required": [ "ExecutionId", "Name", "Workflow", "Status", "Revision", "RevisionAlias", "Args", "StepCount", "Result", "Error", "CreatedAt", "UpdatedAt" ], "type": "object" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Execution" ], "type": "object" } } }, "description": "ワークフローの実行開始をキューに登録した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "example": { "Message": "sampleString", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "ワークフローを実行できない状態" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローを実行する", "tags": [ "ワークフローの実行" ] } }, "/workflows/{id}/executions/{executionId}": { "delete": { "description": "ワークフローの実行を削除する", "operationId": "deleteExecution", "parameters": [ { "description": "Workflow ID", "example": "sampleString", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } }, { "description": "Execution ID", "example": "sampleString", "in": "path", "name": "executionId", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "is_ok": true }, "schema": { "properties": { "is_ok": { "type": "boolean" } }, "required": [ "is_ok" ], "type": "object" } } }, "description": "ワークフローの削除に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "example": { "Message": "sampleString", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "ワークフローの実行を削除できない状態" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローの実行を削除する", "tags": [ "ワークフローの実行" ] }, "get": { "description": "ワークフローの実行を取得する", "operationId": "readExecution", "parameters": [ { "description": "Workflow ID", "example": "sampleString", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } }, { "description": "Execution ID", "example": "sampleString", "in": "path", "name": "executionId", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "Execution": { "Args": "sampleString", "CancelRequestedAt": "2020-01-01T00:00:00Z", "CanceledAt": "2020-01-01T00:00:00Z", "CreatedAt": "2020-01-01T00:00:00Z", "Error": "sampleString", "ExecutionId": "sampleString", "FailedAt": "2020-01-01T00:00:00Z", "Name": "sampleString", "Result": "sampleString", "Revision": 123, "RevisionAlias": "sampleString", "RunAt": "2020-01-01T00:00:00Z", "Status": "Queued", "StepCount": 0, "SucceededAt": "2020-01-01T00:00:00Z", "UpdatedAt": "2020-01-01T00:00:00Z", "Workflow": { "ConcurrencyMode": "parallel", "CreatedAt": "2020-01-01T00:00:00Z", "Description": "sampleString", "Id": "sampleString", "Logging": true, "Name": "sampleString", "Publish": true, "ServicePrincipalId": "sampleString", "Tags": [ { "Name": "sampleString" } ], "UpdatedAt": "2020-01-01T00:00:00Z" } }, "is_ok": true }, "schema": { "properties": { "Execution": { "properties": { "Args": { "maxLength": 65536, "minLength": 1, "type": "string" }, "CancelRequestedAt": { "format": "date-time", "type": "string" }, "CanceledAt": { "format": "date-time", "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Error": { "maxLength": 65536, "minLength": 1, "type": "string" }, "ExecutionId": { "maxLength": 36, "minLength": 1, "type": "string" }, "FailedAt": { "format": "date-time", "type": "string" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Result": { "maxLength": 65536, "minLength": 1, "type": "string" }, "Revision": { "type": "integer" }, "RevisionAlias": { "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]*$", "type": "string" }, "RunAt": { "format": "date-time", "type": "string" }, "Status": { "enum": [ "Queued", "Running", "Succeeded", "Failed", "Canceling", "Canceled" ], "type": "string" }, "StepCount": { "default": 0, "minimum": 0, "type": "integer" }, "SucceededAt": { "format": "date-time", "type": "string" }, "UpdatedAt": { "format": "date-time", "type": "string" }, "Workflow": { "properties": { "ConcurrencyMode": { "enum": [ "parallel", "lock", "queue" ], "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Description": { "maxLength": 1024, "minLength": 0, "type": "string" }, "Id": { "maxLength": 36, "minLength": 1, "type": "string" }, "Logging": { "type": "boolean" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Publish": { "type": "boolean" }, "ServicePrincipalId": { "oneOf": [ { "pattern": "^[0-9]{12}$", "type": "string" }, { "type": "number" } ] }, "Tags": { "items": { "properties": { "Name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "Name" ], "type": "object" }, "type": "array" }, "UpdatedAt": { "format": "date-time", "type": "string" } }, "required": [ "Id", "Name", "Publish", "Logging", "Tags", "CreatedAt", "UpdatedAt" ], "type": "object" } }, "required": [ "ExecutionId", "Name", "Workflow", "Status", "Revision", "RevisionAlias", "Args", "StepCount", "Result", "Error", "CreatedAt", "UpdatedAt" ], "type": "object" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Execution" ], "type": "object" } } }, "description": "ワークフローの実行の取得に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローの実行を取得する", "tags": [ "ワークフローの実行" ] } }, "/workflows/{id}/executions/{executionId}/cancel": { "post": { "description": "ワークフローの実行をキャンセルする", "operationId": "cancelExecution", "parameters": [ { "description": "Workflow ID", "example": "sampleString", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } }, { "description": "Execution ID", "example": "sampleString", "in": "path", "name": "executionId", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "Execution": { "Args": "sampleString", "CancelRequestedAt": "2020-01-01T00:00:00Z", "CanceledAt": "2020-01-01T00:00:00Z", "CreatedAt": "2020-01-01T00:00:00Z", "Error": "sampleString", "ExecutionId": "sampleString", "FailedAt": "2020-01-01T00:00:00Z", "Name": "sampleString", "Result": "sampleString", "Revision": 123, "RevisionAlias": "sampleString", "RunAt": "2020-01-01T00:00:00Z", "Status": "Queued", "StepCount": 0, "SucceededAt": "2020-01-01T00:00:00Z", "UpdatedAt": "2020-01-01T00:00:00Z", "Workflow": { "ConcurrencyMode": "parallel", "CreatedAt": "2020-01-01T00:00:00Z", "Description": "sampleString", "Id": "sampleString", "Logging": true, "Name": "sampleString", "Publish": true, "ServicePrincipalId": "sampleString", "Tags": [ { "Name": "sampleString" } ], "UpdatedAt": "2020-01-01T00:00:00Z" } }, "is_ok": true }, "schema": { "properties": { "Execution": { "properties": { "Args": { "maxLength": 65536, "minLength": 1, "type": "string" }, "CancelRequestedAt": { "format": "date-time", "type": "string" }, "CanceledAt": { "format": "date-time", "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Error": { "maxLength": 65536, "minLength": 1, "type": "string" }, "ExecutionId": { "maxLength": 36, "minLength": 1, "type": "string" }, "FailedAt": { "format": "date-time", "type": "string" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Result": { "maxLength": 65536, "minLength": 1, "type": "string" }, "Revision": { "type": "integer" }, "RevisionAlias": { "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]*$", "type": "string" }, "RunAt": { "format": "date-time", "type": "string" }, "Status": { "enum": [ "Queued", "Running", "Succeeded", "Failed", "Canceling", "Canceled" ], "type": "string" }, "StepCount": { "default": 0, "minimum": 0, "type": "integer" }, "SucceededAt": { "format": "date-time", "type": "string" }, "UpdatedAt": { "format": "date-time", "type": "string" }, "Workflow": { "properties": { "ConcurrencyMode": { "enum": [ "parallel", "lock", "queue" ], "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Description": { "maxLength": 1024, "minLength": 0, "type": "string" }, "Id": { "maxLength": 36, "minLength": 1, "type": "string" }, "Logging": { "type": "boolean" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Publish": { "type": "boolean" }, "ServicePrincipalId": { "oneOf": [ { "pattern": "^[0-9]{12}$", "type": "string" }, { "type": "number" } ] }, "Tags": { "items": { "properties": { "Name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "Name" ], "type": "object" }, "type": "array" }, "UpdatedAt": { "format": "date-time", "type": "string" } }, "required": [ "Id", "Name", "Publish", "Logging", "Tags", "CreatedAt", "UpdatedAt" ], "type": "object" } }, "required": [ "ExecutionId", "Name", "Workflow", "Status", "Revision", "RevisionAlias", "Args", "StepCount", "Result", "Error", "CreatedAt", "UpdatedAt" ], "type": "object" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Execution" ], "type": "object" } } }, "description": "ワークフローの実行キャンセルが完了した" }, "202": { "content": { "application/json": { "example": { "Execution": { "Args": "sampleString", "CancelRequestedAt": "2020-01-01T00:00:00Z", "CanceledAt": "2020-01-01T00:00:00Z", "CreatedAt": "2020-01-01T00:00:00Z", "Error": "sampleString", "ExecutionId": "sampleString", "FailedAt": "2020-01-01T00:00:00Z", "Name": "sampleString", "Result": "sampleString", "Revision": 123, "RevisionAlias": "sampleString", "RunAt": "2020-01-01T00:00:00Z", "Status": "Queued", "StepCount": 0, "SucceededAt": "2020-01-01T00:00:00Z", "UpdatedAt": "2020-01-01T00:00:00Z", "Workflow": { "ConcurrencyMode": "parallel", "CreatedAt": "2020-01-01T00:00:00Z", "Description": "sampleString", "Id": "sampleString", "Logging": true, "Name": "sampleString", "Publish": true, "ServicePrincipalId": "sampleString", "Tags": [ { "Name": "sampleString" } ], "UpdatedAt": "2020-01-01T00:00:00Z" } }, "is_ok": true }, "schema": { "properties": { "Execution": { "properties": { "Args": { "maxLength": 65536, "minLength": 1, "type": "string" }, "CancelRequestedAt": { "format": "date-time", "type": "string" }, "CanceledAt": { "format": "date-time", "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Error": { "maxLength": 65536, "minLength": 1, "type": "string" }, "ExecutionId": { "maxLength": 36, "minLength": 1, "type": "string" }, "FailedAt": { "format": "date-time", "type": "string" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Result": { "maxLength": 65536, "minLength": 1, "type": "string" }, "Revision": { "type": "integer" }, "RevisionAlias": { "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]*$", "type": "string" }, "RunAt": { "format": "date-time", "type": "string" }, "Status": { "enum": [ "Queued", "Running", "Succeeded", "Failed", "Canceling", "Canceled" ], "type": "string" }, "StepCount": { "default": 0, "minimum": 0, "type": "integer" }, "SucceededAt": { "format": "date-time", "type": "string" }, "UpdatedAt": { "format": "date-time", "type": "string" }, "Workflow": { "properties": { "ConcurrencyMode": { "enum": [ "parallel", "lock", "queue" ], "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Description": { "maxLength": 1024, "minLength": 0, "type": "string" }, "Id": { "maxLength": 36, "minLength": 1, "type": "string" }, "Logging": { "type": "boolean" }, "Name": { "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]+$", "type": "string" }, "Publish": { "type": "boolean" }, "ServicePrincipalId": { "oneOf": [ { "pattern": "^[0-9]{12}$", "type": "string" }, { "type": "number" } ] }, "Tags": { "items": { "properties": { "Name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "Name" ], "type": "object" }, "type": "array" }, "UpdatedAt": { "format": "date-time", "type": "string" } }, "required": [ "Id", "Name", "Publish", "Logging", "Tags", "CreatedAt", "UpdatedAt" ], "type": "object" } }, "required": [ "ExecutionId", "Name", "Workflow", "Status", "Revision", "RevisionAlias", "Args", "StepCount", "Result", "Error", "CreatedAt", "UpdatedAt" ], "type": "object" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Execution" ], "type": "object" } } }, "description": "ワークフローの実行キャンセルをキューに登録した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "example": { "Message": "sampleString", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "ワークフローの実行をキャンセルできない状態" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローの実行をキャンセルする", "tags": [ "ワークフローの実行" ] } }, "/workflows/{id}/executions/{executionId}/exec_history": { "get": { "description": "ワークフローの実行履歴を取得する", "operationId": "listExecutionHistories", "parameters": [ { "description": "ページ番号", "example": 1, "in": "query", "name": "Page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "description": "1ページあたりのリソースの取得数", "example": 20, "in": "query", "name": "PageLimit", "required": false, "schema": { "default": 20, "maximum": 500, "minimum": 5, "type": "integer" } }, { "description": "ソートの順序", "example": "asc", "in": "query", "name": "SortOrder", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Workflow ID", "example": "sampleString", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } }, { "description": "Execution ID", "example": "sampleString", "in": "path", "name": "executionId", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "Count": 0, "From": 0, "Histories": [ { "CreatedAt": "2020-01-01T00:00:00Z", "JobId": "sampleString", "Meta": "sampleString", "StackTrace": "sampleString", "ThreadId": "sampleString", "Type": "workflowWillStart", "Variables": "sampleString", "WorkflowExecutionId": "sampleString" } ], "Total": 0, "is_ok": true }, "schema": { "properties": { "Count": { "default": 0, "minimum": 0, "type": "integer" }, "From": { "default": 0, "minimum": 0, "type": "integer" }, "Histories": { "items": { "properties": { "CreatedAt": { "format": "date-time", "type": "string" }, "JobId": { "maxLength": 64, "minLength": 1, "type": "string" }, "Meta": { "minLength": 1, "type": "string" }, "StackTrace": { "minLength": 1, "type": "string" }, "ThreadId": { "maxLength": 64, "minLength": 1, "type": "string" }, "Type": { "enum": [ "workflowWillStart", "workflowDidSuspended", "workflowWillResume", "workflowDidCompleted", "workflowDidFailed", "workflowDidCanceled", "stepWillExecute", "stepDidExecuted", "functionWillCall", "functionWillRun", "functionDidRun", "functionDidFailed" ], "type": "string" }, "Variables": { "minLength": 1, "type": "string" }, "WorkflowExecutionId": { "maxLength": 36, "minLength": 1, "type": "string" } }, "required": [ "WorkflowExecutionId", "JobId", "ThreadId", "Type", "CreatedAt", "Meta", "StackTrace", "Variables" ], "type": "object" }, "type": "array" }, "Total": { "default": 0, "minimum": 0, "type": "integer" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Total", "From", "Count", "Histories" ], "type": "object" } } }, "description": "ワークフローの実行履歴の取得に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローの実行履歴を取得する", "tags": [ "ワークフローの実行" ] } }, "/workflows/{id}/revisions": { "get": { "description": "ワークフローのリビジョンの一覧を取得する", "operationId": "listRevisions", "parameters": [ { "description": "ページ番号", "example": 1, "in": "query", "name": "Page", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "description": "1ページあたりのリソースの取得数", "example": 20, "in": "query", "name": "PageLimit", "required": false, "schema": { "default": 20, "maximum": 500, "minimum": 5, "type": "integer" } }, { "description": "Workflowのソートに利用するプロパティ", "example": "createdAt", "in": "query", "name": "SortBy", "required": false, "schema": { "enum": [ "createdAt", "updatedAt", "id" ], "type": "string" } }, { "description": "ソートの順序", "example": "asc", "in": "query", "name": "Order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "公開状態の絞り込み", "example": true, "in": "query", "name": "Published", "required": false, "schema": { "type": "boolean" } }, { "description": "Workflow ID", "example": "sampleString", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "Count": 0, "From": 0, "Revisions": [ { "CreatedAt": "2020-01-01T00:00:00Z", "RevisionAlias": "sampleString", "RevisionId": 123, "Runbook": "sampleString", "UpdatedAt": "2020-01-01T00:00:00Z", "WorkflowId": "sampleString" } ], "Total": 0, "is_ok": true }, "schema": { "properties": { "Count": { "default": 0, "minimum": 0, "type": "integer" }, "From": { "default": 0, "minimum": 0, "type": "integer" }, "Revisions": { "items": { "properties": { "CreatedAt": { "format": "date-time", "type": "string" }, "RevisionAlias": { "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]*$", "type": "string" }, "RevisionId": { "type": "integer" }, "Runbook": { "type": "string" }, "UpdatedAt": { "format": "date-time", "type": "string" }, "WorkflowId": { "maxLength": 36, "minLength": 1, "type": "string" } }, "required": [ "RevisionId", "WorkflowId", "Runbook", "CreatedAt", "UpdatedAt" ], "type": "object" }, "type": "array" }, "Total": { "default": 0, "minimum": 0, "type": "integer" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Total", "From", "Count", "Revisions" ], "type": "object" } } }, "description": "ワークフローのリビジョンの一覧の取得に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローのリビジョンの一覧を取得する", "tags": [ "ワークフローの管理" ] }, "post": { "description": "ワークフローのリビジョンを追加する", "operationId": "createRevision", "parameters": [ { "description": "Workflow ID", "example": "sampleString", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "RevisionAlias": "sampleString", "Runbook": "sampleString" }, "schema": { "properties": { "RevisionAlias": { "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]*$", "type": "string" }, "Runbook": { "type": "string" } }, "required": [ "Runbook" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "Revision": { "CreatedAt": "2020-01-01T00:00:00Z", "RevisionAlias": "sampleString", "RevisionId": 123, "Runbook": "sampleString", "UpdatedAt": "2020-01-01T00:00:00Z", "WorkflowId": "sampleString" }, "is_ok": true }, "schema": { "properties": { "Revision": { "properties": { "CreatedAt": { "format": "date-time", "type": "string" }, "RevisionAlias": { "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]*$", "type": "string" }, "RevisionId": { "type": "integer" }, "Runbook": { "type": "string" }, "UpdatedAt": { "format": "date-time", "type": "string" }, "WorkflowId": { "maxLength": 36, "minLength": 1, "type": "string" } }, "required": [ "RevisionId", "WorkflowId", "Runbook", "CreatedAt", "UpdatedAt" ], "type": "object" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Revision" ], "type": "object" } } }, "description": "ワークフローのリビジョンの追加に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "example": { "Message": "sampleString", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Duplicate revision alias" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローのリビジョンを追加する", "tags": [ "ワークフローの管理" ] } }, "/workflows/{id}/revisions/{revisionId}": { "get": { "description": "ワークフローのリビジョンを取得する", "operationId": "readRevision", "parameters": [ { "description": "Workflow ID", "example": "sampleString", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } }, { "description": "Revision ID", "example": 123, "in": "path", "name": "revisionId", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "Revision": { "CreatedAt": "2020-01-01T00:00:00Z", "RevisionAlias": "sampleString", "RevisionId": 123, "Runbook": "sampleString", "UpdatedAt": "2020-01-01T00:00:00Z", "WorkflowId": "sampleString" }, "is_ok": true }, "schema": { "properties": { "Revision": { "properties": { "CreatedAt": { "format": "date-time", "type": "string" }, "RevisionAlias": { "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]*$", "type": "string" }, "RevisionId": { "type": "integer" }, "Runbook": { "type": "string" }, "UpdatedAt": { "format": "date-time", "type": "string" }, "WorkflowId": { "maxLength": 36, "minLength": 1, "type": "string" } }, "required": [ "RevisionId", "WorkflowId", "Runbook", "CreatedAt", "UpdatedAt" ], "type": "object" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Revision" ], "type": "object" } } }, "description": "ワークフローのリビジョンの取得に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローのリビジョンを取得する", "tags": [ "ワークフローの管理" ] } }, "/workflows/{id}/revisions/{revisionId}/revision_alias": { "delete": { "description": "ワークフローのリビジョンエイリアスを削除する", "operationId": "deleteRevisionAlias", "parameters": [ { "description": "Workflow ID", "example": "sampleString", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } }, { "description": "Revision ID", "example": 123, "in": "path", "name": "revisionId", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "Revision": { "CreatedAt": "2020-01-01T00:00:00Z", "RevisionAlias": "sampleString", "RevisionId": 123, "Runbook": "sampleString", "UpdatedAt": "2020-01-01T00:00:00Z", "WorkflowId": "sampleString" }, "is_ok": true }, "schema": { "properties": { "Revision": { "properties": { "CreatedAt": { "format": "date-time", "type": "string" }, "RevisionAlias": { "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]*$", "type": "string" }, "RevisionId": { "type": "integer" }, "Runbook": { "type": "string" }, "UpdatedAt": { "format": "date-time", "type": "string" }, "WorkflowId": { "maxLength": 36, "minLength": 1, "type": "string" } }, "required": [ "RevisionId", "WorkflowId", "Runbook", "CreatedAt", "UpdatedAt" ], "type": "object" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Revision" ], "type": "object" } } }, "description": "ワークフローのリビジョンエイリアスの削除に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローのリビジョンエイリアスを削除する", "tags": [ "ワークフローの管理" ] }, "put": { "description": "ワークフローのリビジョンエイリアスを更新する", "operationId": "updateRevisionAlias", "parameters": [ { "description": "Workflow ID", "example": "sampleString", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 36, "minLength": 1, "type": "string" } }, { "description": "Revision ID", "example": 123, "in": "path", "name": "revisionId", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "example": { "RevisionAlias": "sampleString" }, "schema": { "properties": { "RevisionAlias": { "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]*$", "type": "string" } }, "required": [ "RevisionAlias" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "Revision": { "CreatedAt": "2020-01-01T00:00:00Z", "RevisionAlias": "sampleString", "RevisionId": 123, "Runbook": "sampleString", "UpdatedAt": "2020-01-01T00:00:00Z", "WorkflowId": "sampleString" }, "is_ok": true }, "schema": { "properties": { "Revision": { "properties": { "CreatedAt": { "format": "date-time", "type": "string" }, "RevisionAlias": { "maxLength": 64, "minLength": 0, "pattern": "^[a-zA-Z0-9_\\-ーぁ-んァ-ヶ一-龠]*$", "type": "string" }, "RevisionId": { "type": "integer" }, "Runbook": { "type": "string" }, "UpdatedAt": { "format": "date-time", "type": "string" }, "WorkflowId": { "maxLength": 36, "minLength": 1, "type": "string" } }, "required": [ "RevisionId", "WorkflowId", "Runbook", "CreatedAt", "UpdatedAt" ], "type": "object" }, "is_ok": { "type": "boolean" } }, "required": [ "is_ok", "Revision" ], "type": "object" } } }, "description": "ワークフローのリビジョンエイリアスの更新に成功した" }, "400": { "content": { "application/json": { "example": { "Message": "Bad Request", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "example": { "Message": "Unauthorized", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "example": { "Message": "Payment Required", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Payment Required" }, "403": { "content": { "application/json": { "example": { "Message": "Forbidden", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "example": { "Message": "Not Found", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "example": { "Message": "sampleString", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Duplicate revision alias" }, "500": { "content": { "application/json": { "example": { "Message": "Internal Server Error", "is_ok": false }, "schema": { "properties": { "Message": { "type": "string" }, "is_ok": { "default": false, "type": "boolean" } }, "required": [ "is_ok", "Message" ], "type": "object" } } }, "description": "Internal Server Error" } }, "summary": "ワークフローのリビジョンエイリアスを更新する", "tags": [ "ワークフローの管理" ] } } }, "security": [ { "ApiKeyAuth": [] } ], "servers": [ { "url": "https://secure.sakura.ad.jp/cloud/zone/tk1b/api/workflow/1.0" } ], "tags": [ { "name": "ワークフローの管理" }, { "name": "ワークフローの実行" }, { "name": "プラン" }, { "name": "サブスクリプション" } ] }