Reckoner External API (1.1.0)

Download OpenAPI specification:

Reckoner外部API仕様

Workflows

ワークフロー実行

指定されたワークフローを実行します

Authorizations:
BearerAuth
path Parameters
workflowId
required
integer

ワークフローID

Request Body schema: application/json
optional

ワークフロー実行時に上書きするパラメータ変数

Array of objects (WorkflowRunParameterItem)

Responses

Request samples

Content type
application/json
{
  • "parameters": [
    ]
}

Response samples

Content type
application/json
{
  • "job_id": 0
}

ワークフロージョブ実行結果取得

指定されたワークフロージョブの実行結果を取得します

Authorizations:
BearerAuth
path Parameters
workflowId
required
integer

ワークフローID

jobId
required
integer

ワークフロージョブID

Responses

Response samples

Content type
application/json
{
  • "started_at": "2019-08-24T14:15:22Z",
  • "ended_at": "2019-08-24T14:15:22Z",
  • "status": "SUBMITTING",
  • "trigger": "button",
  • "errors": [
    ]
}

ワークフロージョブ実行結果一覧取得

指定されたワークフローのジョブ実行結果一覧を取得します

Authorizations:
BearerAuth
path Parameters
workflowId
required
integer

ワークフローID

query Parameters
limit
integer <= 100

1ページあたりの最大件数。未指定時は100として扱われる

page
integer

ページ番号。1ページあたりの最大件数は limit で指定。未指定時は1として扱われる

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "jobs": [
    ]
}

ワークフロー取得

指定されたワークフローの詳細情報を取得します

Authorizations:
BearerAuth
path Parameters
workflowId
required
integer

ワークフローID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "tasks": [
    ],
  • "task_dependencies": [
    ],
  • "parameters": [
    ],
  • "schedule": {
    },
  • "webhooks": [
    ],
  • "notifications": {
    },
  • "labels": [
    ]
}

ワークフロー一覧取得

指定されたプロジェクト内のワークフローの一覧を取得します

Authorizations:
BearerAuth
path Parameters
projectId
required
integer

プロジェクトID

query Parameters
limit
integer <= 100

1ページあたりの最大件数。未指定時は100として扱われる

page
integer

ページ番号。1ページあたりの最大件数は limit で指定。未指定時は1として扱われる

search_words
string

検索文字列。ワークフロー名に対して部分一致検索する。未指定時はすべてのワークフローが対象となる

label_ids
string

ラベルID。未指定時はすべてのワークフローが対象となる。複数指定する場合はカンマ区切りで指定する

schedule_filtering_by
string
Enum: "active" "inactive" "all"

スケジュール設定の有無。未指定時はすべてのワークフローが対象となる

  • active: スケジュール設定有効のみ
  • inactive: スケジュール設定無効のみ
  • all: スケジュール設定に関わらずすべて
sort
string
Enum: "name:asc" "name:desc" "updated_at:asc" "updated_at:desc" "last_started_at:asc" "last_started_at:desc"

ソート順。"ソート項目名:ソート順"のように指定する。ソート項目名は下記の通り。ソート項目名未指定時は更新日時によりソートされる

  • name: ワークフロー名
  • updated_at: 更新日時
  • last_started_at: 最終実行日時 ソート順は以下の通り。ソート順未指定の場合は降順でソートされる
  • asc: 昇順
  • desc: 降順

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "workflows": [
    ]
}

ワークフローエクスポート

指定されたワークフローを、インポート可能な形式でエクスポートします

Authorizations:
BearerAuth
path Parameters
workflowId
required
integer

ワークフローID

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "type": "string",
  • "tasks": [
    ],
  • "dependencies": [
    ],
  • "parameters": [
    ]
}

Integrations

接続情報取得

指定されたプロジェクト内の接続情報の一覧を取得します

Authorizations:
BearerAuth
path Parameters
projectId
required
integer

プロジェクトID

query Parameters
service
string
Example: service=mysql

取得対象のサービス名。未指定時は全サービスの接続情報が対象となる

Responses

Response samples

Content type
application/json
{
  • "total": 2,
  • "adobe_analytics": [ ],
  • "airtable": [ ],
  • "amazon_redshift": [ ],
  • "amazon_ses": [ ],
  • "app_store_connect": [ ],
  • "aws_s3": [ ],
  • "azure_blob_storage": [ ],
  • "azure_sql": [ ],
  • "bcart": [ ],
  • "box": [ ],
  • "braze": [ ],
  • "bugyo_cloud": [ ],
  • "chatwork": [ ],
  • "climber_cloud": [ ],
  • "cloudsign": [ ],
  • "collaboflow": [ ],
  • "denodo": [ ],
  • "dr_sum": [ ],
  • "excel": [
    ],
  • "facebook_ads": [ ],
  • "freee": [ ],
  • "ftp": [ ],
  • "gmo_makeshop": [ ],
  • "gmo_makeshop_gen2": [ ],
  • "google_ads": [ ],
  • "google_ad_manager": [ ],
  • "google_analytics": [ ],
  • "google_apis": [ ],
  • "google_bigquery": [ ],
  • "google_cloud_storage": [ ],
  • "google_datastore": [ ],
  • "google_drive": [ ],
  • "google_lighthouse": [ ],
  • "google_search_console": [ ],
  • "google_spreadsheets": [ ],
  • "hennge_one": [ ],
  • "hubspot": [ ],
  • "hue_workflow": [ ],
  • "ibm_db_2": [ ],
  • "jira": [ ],
  • "haihai_mail": [ ],
  • "kaonavi": [ ],
  • "kingoftime": [ ],
  • "kintone": [ ],
  • "line_works": [ ],
  • "manage_workflow": [ ],
  • "mariadb": [ ],
  • "marketo": [ ],
  • "microsoft365": [ ],
  • "miraimil": [ ],
  • "mysql": [ ],
  • "one_drive": [ ],
  • "oracledatabase": [ ],
  • "pca_cloud": [ ],
  • "postgresql": [ ],
  • "rtoaster_action_plus": [ ],
  • "salesforce": [ ],
  • "salesforce_marketing_cloud": [ ],
  • "salesforce_pardot": [ ],
  • "sansan": [ ],
  • "sendgrid": [ ],
  • "sftp": [ ],
  • "sharepoint": [ ],
  • "shopify": [ ],
  • "slack": [ ],
  • "smart_hr": [ ],
  • "snowflake": [ ],
  • "sqlserver": [ ],
  • "stripe": [ ],
  • "tableau_cloud": [ ],
  • "trino": [ ],
  • "twitter": [ ],
  • "webhook_endpoint": [ ],
  • "yahoo_ads": [ ],
  • "zohocrm": [ ]
}

接続情報削除

指定された接続情報を削除します

Authorizations:
BearerAuth
path Parameters
serviceName
required
string
Example: mysql

削除対象の接続情報のサービス名

integrationId
required
integer

削除対象の接続情報のID

query Parameters
force
boolean
Default: false

trueを指定した場合、ワークフローで利用中の接続情報であっても強制的に削除する。 未指定またはfalseの場合、ワークフローで利用中の接続情報は削除できずエラーが返される。

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}