Datahub 管理画面での設定や Datahub Jobflow Exec API などから実行されたジョブフローについて、開始時や終了時の hook を利用できます。
ご利用いただく場合は、「hook設定」から「KARTE Datahub: ジョブフローの開始時」「KARTE Datahub: ジョブフローの終了時」を選択してください(両方選択可)。
「KARTE Datahub: ジョブフローの終了時」はジョブフローエラー時にも hook が実行されます。
Required Scope
datahub.jobflow.get
Request Body
{
"id": "{ユニークなID}",
"api_key": "{Api Key}",
"event_type": "{Event Type}",
"client_id": "{Client Id}",
"data": {
"id": "{ジョブフローID}",
"name": "{ジョブフロー名}",
"status": "{ジョブフローのステータス}",
"archived": "{ジョブフローがアーカイブされているかどうか}",
"author": "{ジョブフロー作成者}",
"created": "{ジョブフロー作成日}"
},
"extra": {},
}
Name | Type | |
---|---|---|
id | String | hookの実行ごとに割り振られるユニークな ID |
api_key | String | プロジェクトの api key |
event_type | String | hook のトリガーを表す文字列、開始時の場合は datahub/jobflow/start 、終了時の場合は datahub/jobflow/end または datahub/jobflow/error になります。 |
client_id | String | アプリの Client Id |
data.id | String | ジョブフローの ID |
data.name | String | ジョブフロー名 |
data.status | String | ジョブフローのステータス |
data.archived | Boolean | ジョブフローがアーカイブされているか |
data.author | String | ジョブフローの作成者 |
data.created | String | ジョブフローが作成された日時(タイムゾーンは UTC ) |