モジュール名: checkpoint

機能名 説明
list チェックポイントフローのリクエストの一覧を取得します
show チェックポイントフローのリクエストの情報を取得します
rerun チェックポイントフローのリクエストを再実行します

機能名: list

説明

チェックポイントフローのリクエストの一覧を取得します。
リクエストの開始日付を指定することで過去のリクエストの一覧も取得することができます。
また、チェックポイントフローのプロジェクトオーナーやプロジェクト名、フロー名などで一覧を絞り込むことができます。

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/api/checkpoint/list
リクエストパラメーター
パラメーター 必須 説明
date いいえ リクエストの開始日付をYYYYMMDDの形式で指定します。
省略時はAPI実行時の当日の日付となります。
domain いいえ チェックポイントフローのプロジェクトオーナーのドメイン名を指定して一覧を絞り込みます。
user いいえ チェックポイントフローのプロジェクトオーナーのユーザー名を指定して一覧を絞り込みます。
project いいえ チェックポイントフローのプロジェクト名を指定して一覧を絞り込みます。
flow いいえ チェックポイントフローのフロー名を指定して一覧を絞り込みます。
status いいえ リクエストの実行ステータスを次のいずれかで指定して一覧を絞り込みます。
  • running - 実行中
  • success - 正常終了
  • error - 異常終了
page いいえ 一覧のページ番号を指定します。
他のパラメーターを変えずに、このパラメーターを変更することで一覧を取得する範囲を変更することができます。
省略時は1となります。
size いいえ 一度に取得するサイズ(リクエスト数)を指定します。
省略時は50となります。
リクエスト例
GET /api/checkpoint/list?date=20121005 HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとチェックポイントフローのリクエストの一覧が返ります。
リクエストの情報としては次の情報が取得できます。

<result>
	<status>success</status>
	<data>
		<request>
			<requestId>ec303dfa-c317-40f2-a396-d776918253df</requestId>
			<status>success</status>
			<project>Project1</project>
			<flow>Flow1</flow>
			<owner>/guest</owner>
			<startTime>2012-10-05T18:07:04 JST</startTime>
			<checkPointStatus></checkPointStatus>
			<endTime>2012-10-05T18:07:04 JST</endTime>
		</request>
		<request>
			<requestId>eedd0d83-ac7a-482d-ae95-aa16c1d87d43</requestId>
			<status>error</status>
			<project>Project1</project>
			<flow>Flow2</flow>
			<owner>/guest</owner>
			<startTime>2012-10-05T18:06:59 JST</startTime>
			<checkPointStatus>CheckPoint2</checkPointStatus>
			<endTime>2012-10-05T20:47:12 JST</endTime>
		</request>
	</data>
</result>
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード HTTPステータスコード 説明
2000 400 Bad Request statusパラメーターの値に誤りがあった場合
2001 403 Forbidden ログインしていなかった場合
エンタープライズライセンスがなかった場合
9000 500 Internal Server Error チェックポイント情報の取得に失敗した場合

▲ このページのトップへ

機能名: show

説明

チェックポイントフローの指定のリクエストについての情報を取得します。

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/api/checkpoint/show
リクエストパラメーター
パラメーター 必須 説明
requestId はい 情報を取得するリクエストのリクエストIDを指定します。
リクエストIDは、list APIの実行結果で取得できます。
date いいえ リクエストの開始日付をYYYYMMDDの形式で指定します。
省略してもリクエストの情報は取得することができますが、このパラメーターを指定すると省略時よりAPIの実行が早く完了します。
リクエスト例
GET /api/checkpoint/show?requestId=eedd0d83-ac7a-482d-ae95-aa16c1d87d43 HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとチェックポイントフローのリクエストの情報が返ります。
リクエストの情報としては次の情報が取得できます。

<result>
	<status>success</status>
	<data>
		<request>
			<requestId>ec303dfa-c317-40f2-a396-d776918253df</requestId>
			<status>error</status>
			<project>Project1</project>
			<flow>Flow1</flow>
			<owner>/guest</owner>
			<executeUser></executeUser>
			<startTime>2012-10-05T18:06:59 JST</startTime>
			<checkPointStatus>CheckPoint2</checkPointStatus>
			<endTime>2012-10-05T20:47:12 JST</endTime>
			<restartTime>2012-10-05T20:46:44 JST</restartTime>
			<checkPointRestartStatus>CheckPoint1</checkPointRestartStatus>
		</request>
	</data>
</result>
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード HTTPステータスコード 説明
2000 400 Bad Request requestIdパラメーターが存在しなかった場合
2001 403 Forbidden ログインしていなかった場合
エンタープライズライセンスがなかった場合
2002 404 Not Found requestIdパラメーターで指定されたリクエストが存在しなかった場合
9000 500 Internal Server Error チェックポイント情報の取得に失敗した場合

▲ このページのトップへ

機能名: rerun

説明

異常終了しているチェックポイントフローのリクエストを、異常終了する直前のチェックポイントから再実行します。
リクエストの実行を開始すると、その終了を待たずに直ちにAPIの実行が完了します。

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/api/checkpoint/rerun
リクエストパラメーター
パラメーター 必須 説明
date はい 再実行するリクエストの開始日付をYYYYMMDDの形式で指定します。
開始日付は、list, show APIの実行結果で取得できます。
requestId はい 再実行するリクエストのリクエストIDを指定します。
リクエストIDは、list, show APIの実行結果で取得できます。
リクエスト例
POST /api/checkpoint/rerun HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 61

date=20121005&requestId=eedd0d83-ac7a-482d-ae95-aa16c1d87d432
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功すると再実行したリクエストのリクエストIDが返ります。

<result>
	<status>success</status>
	<data>
		<requestId>eedd0d83-ac7a-482d-ae95-aa16c1d87d432</requestId>
	</data>
</result>
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード HTTPステータスコード 説明
2000 400 Bad Request dateまたはrequestIdパラメーターが存在しなかった場合
2001 403 Forbidden ログインしていなかった場合
エンタープライズライセンスがなかった場合
2002 404 Not Found 指定したリクエストが存在しなかった場合
指定したリクエストのステータスが「error」(異常終了)でなかった場合

▲ このページのトップへ