API docs by Redocly

Workflows β APIドキュメント (1.0.0)

Download OpenAPI specification:Download

License: Copyright(C) SAKURA internet Inc. all rights reserved.

「Workflows」が提供するAPIの利用方法とサンプルを公開しております。

基本的な使い方

APIキーの発行

APIを利用するためには、認証のための「APIキー」が必要です。事前にキーを発行しておきます。
APIキーは「ユーザーID」「パスワード」に相当する「トークン」と呼ばれる認証情報で構成されています。

項目名 APIキー発行時の項目名 このドキュメント内での例
ユーザーID アクセストークン(UUID) 01234567-89ab-cdef-0123-456789abcdef
パスワード アクセストークンシークレット SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM
操作マニュアル

ワークフローの管理

ワークフローを作成する

ワークフローを作成する

Request Body schema: application/json
Name
required
string [ 1 .. 64 ] characters
Description
string [ 1 .. 64 ] characters
Runbook
required
string
Publish
required
boolean
RoleId
required
string [ 1 .. 1024 ] characters
Logging
required
boolean
Array of objects
RevisionAlias
string [ 1 .. 64 ] characters

Responses

Request samples

Content type
application/json
{
  • "Name": "sampleString",
  • "Description": "sampleString",
  • "Runbook": "sampleString",
  • "Publish": true,
  • "RoleId": "sampleString",
  • "Logging": true,
  • "Tags": [
    ],
  • "RevisionAlias": "sampleString"
}

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "Workflow": {
    }
}

ワークフローの一覧を取得する

ワークフローの一覧を取得する

Responses

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "Total": 123,
  • "From": 123,
  • "Count": 123,
  • "Workflows": [
    ]
}

ワークフローを取得する

ワークフローを取得する

path Parameters
id
required
string [ 1 .. 36 ] characters
Example: sampleString

Workflow ID

Responses

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "Workflow": {
    }
}

ワークフローを更新する

ワークフローを更新する

path Parameters
id
required
string [ 1 .. 36 ] characters
Example: sampleString

Workflow ID

Responses

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "Workflow": {
    }
}

ワークフローを削除する

ワークフローを削除する

path Parameters
id
required
string [ 1 .. 36 ] characters
Example: sampleString

Workflow ID

Responses

Response samples

Content type
application/json
{
  • "is_ok": true
}

ワークフローのリビジョンを追加する

ワークフローのリビジョンを追加する

path Parameters
id
required
string [ 1 .. 36 ] characters
Example: sampleString

Workflow ID

Responses

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "Revision": {
    }
}

ワークフローのリビジョンの一覧を取得する

ワークフローのリビジョンの一覧を取得する

path Parameters
id
required
string [ 1 .. 36 ] characters
Example: sampleString

Workflow ID

Responses

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "Total": 123,
  • "From": 123,
  • "Count": 123,
  • "Revisions": [
    ]
}

ワークフローのリビジョンを取得する

ワークフローのリビジョンを取得する

path Parameters
id
required
string [ 1 .. 36 ] characters
Example: sampleString

Workflow ID

revisionId
required
number
Example: 123

Revision ID

Responses

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "Revision": {
    }
}

ワークフローのリビジョンエイリアスを更新する

ワークフローのリビジョンエイリアスを更新する

path Parameters
id
required
string [ 1 .. 36 ] characters
Example: sampleString

Workflow ID

revisionId
required
number
Example: 123

Revision ID

Responses

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "Revision": {
    }
}

ワークフローのリビジョンエイリアスを削除する

ワークフローのリビジョンエイリアスを削除する

path Parameters
id
required
string [ 1 .. 36 ] characters
Example: sampleString

Workflow ID

revisionId
required
number
Example: 123

Revision ID

Responses

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "Workflow": {
    }
}

ワークフローの実行

ワークフローを実行する

ワークフローを実行する

path Parameters
id
required
string [ 1 .. 36 ] characters
Example: sampleString

Workflow ID

Responses

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "Execution": {
    }
}

ワークフローの実行をキャンセルする

ワークフローの実行をキャンセルする

path Parameters
id
required
string [ 1 .. 36 ] characters
Example: sampleString

Workflow ID

required
object
Example: workflowId,sampleString

Execution ID

Responses

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "Execution": {
    }
}

ワークフローの実行を取得する

ワークフローの実行を取得する

path Parameters
id
required
string [ 1 .. 36 ] characters
Example: sampleString

Workflow ID

required
object
Example: workflowId,sampleString

Execution ID

Responses

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "Execution": {
    }
}

ワークフローの削除する

ワークフローの削除する

path Parameters
id
required
string [ 1 .. 36 ] characters
Example: sampleString

Workflow ID

required
object
Example: workflowId,sampleString

Execution ID

Responses

Response samples

Content type
application/json
{
  • "is_ok": true
}

ワークフローの実行の一覧を取得する

ワークフローの実行の一覧を取得する

path Parameters
id
required
string [ 1 .. 36 ] characters
Example: sampleString

Workflow ID

Responses

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "Total": 123,
  • "From": 123,
  • "Count": 123,
  • "Executions": [
    ]
}

ワークフローの実行履歴を取得する

ワークフローの実行履歴を取得する

path Parameters
id
required
string [ 1 .. 36 ] characters
Example: sampleString

Workflow ID

required
object
Example: workflowId,sampleString

Execution ID

Responses

Response samples

Content type
application/json
{
  • "is_ok": true,
  • "Total": 123,
  • "From": 123,
  • "Count": 123,
  • "History": [
    ]
}