フローサービスAPI

機能名	説明
list	チェックポイントフローのリクエストの一覧を取得します
show	チェックポイントフローのリクエストの情報を取得します
rerun	チェックポイントフローのリクエストを再実行します
delete	チェックポイントフローのリクエストを削除します
dates	チェックポイントフローのリクエストを格納している日付の一覧を返します
isAvailable	チェックポイントが正常に起動しているかを確認します
isEnabled	チェックポイントが有効になっているかを確認します
showStatistics	チェックポイントフローのリクエストの統計情報を取得します
downloadStatistics	チェックポイントフローのリクエストの統計情報のCSVファイルをダウンロードします

機能名: list

説明

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

リクエスト

HTTPメソッド	リクエストURL
GET	`http://{Hostname}:{Port}/api/checkpoint/list`

リクエストパラメーター

パラメーター	必須	説明
date	いいえ	リクエストの開始日付をYYYYMMDDの形式で指定します。省略時はAPI実行時の当日の日付となります。
serverId	いいえ	リクエストの担当サーバーIDを指定して一覧を絞り込みます。
domain	いいえ	チェックポイントフローのプロジェクトオーナーのドメイン名を指定して一覧を絞り込みます。
user	いいえ	チェックポイントフローのプロジェクトオーナーのユーザー名を指定して一覧を絞り込みます。
project	いいえ	チェックポイントフローのプロジェクト名を指定して一覧を絞り込みます。
flow	いいえ	チェックポイントフローのフロー名を指定して一覧を絞り込みます。
status	いいえ	リクエストの実行ステータスを次のいずれかで指定して一覧を絞り込みます。 preparing - 実行準備中 running - 実行中 waiting - リトライ待ち success - 正常終了 error - 異常終了
page	いいえ	一覧のページ番号を指定します。他のパラメーターを変えずに、このパラメーターを変更することで一覧を取得する範囲を変更することができます。省略時は1となります。
size	いいえ	一度に取得するサイズ（リクエスト数）を指定します。省略時は50となります。

リクエスト例

GET /api/checkpoint/list?date=20121005 HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D

レスポンス

HTTPステータスコード

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

実行結果

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

リクエストID
ステータス
「preparing」（実行準備中）、「runnning」（実行中）、「waiting」（リトライ待ち）、「success」（正常終了）、「error」（異常終了）のいずれか。
プロジェクト名
フロー名
プロジェクトオーナー名
開始日時
チェックポイントステータス
終了日時
担当サーバーID
リトライ数
最大リトライ数
リトライ間隔
次回リトライ時刻
スタートサーバーID
他サーバーリトライ

<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>2013-10-05T18:07:04 JST</startTime>
			<checkPointStatus></checkPointStatus>
			<endTime>2013-10-05T18:08:04 JST</endTime>
			<serverId>2abf15cc-0307-4df9-83c4-cbbac5804c5f</serverId>
			<retryCount>1</retryCount>
			<maxRetryCount>10</maxRetryCount>
			<retryInterval>30</retryInterval>
			<nextRetryTime>2013-10-05T18:08:34 JST</nextRetryTime>
			<startServerId>2abf15cc-0307-4df9-83c4-cbbac5804c5</startServerId>
			<otherServerRetry>true</otherServerRetry>
		</request>
		<request>
			<requestId>eedd0d83-ac7a-482d-ae95-aa16c1d87d43</requestId>
			<status>error</status>
			<project>Project1</project>
			<flow>Flow2</flow>
			<owner>/guest</owner>
			<startTime>2013-10-05T18:06:59 JST</startTime>
			<checkPointStatus>CheckPoint2</checkPointStatus>
			<endTime>2013-10-05T20:47:12 JST</endTime>
			<serverId>d7a96e5c-62f7-4a52-91e3-96b01257866b</serverId>
			<retryCount>3</retryCount>
			<maxRetryCount>10</maxRetryCount>
			<retryInterval>30</retryInterval>
			<nextRetryTime>2013-10-05T20:47:42 JST</nextRetryTime>
			<startServerId>d7a96e5c-62f7-4a52-91e3-96b01257866b</startServerId>
			<otherServerRetry>true</otherServerRetry>
		</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が返ります。

実行結果

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

リクエストID
ステータス
「preparing」（実行準備中）、「runnning」（実行中）、「waiting」（リトライ待ち）、「success」（正常終了）、「error」（異常終了）のいずれか。
プロジェクト名
フロー名
プロジェクトオーナー名
実行ユーザー名
開始日時
チェックポイントステータス
終了日時
再実行日時
再実行時のチェックポイントステータス
担当サーバーID
キュータイプ名
リトライ数
最大リトライ数
リトライ間隔
次回リトライ時刻
スタートサーバーID
他サーバーリトライ

<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>201310-05T18:06:59 JST</startTime>
			<checkPointStatus>CheckPoint2</checkPointStatus>
			<endTime>2013-10-05T20:47:12 JST</endTime>
			<restartTime>2013-10-05T20:46:44 JST</restartTime>
			<checkPointRestartStatus>CheckPoint1</checkPointRestartStatus>
			<serverId>2abf15cc-0307-4df9-83c4-cbbac5804c5f</serverId>
			<queueTypeName>DEFAULT</queueTypeName>
			<retryCount>3</retryCount>
			<maxRetryCount>10</maxRetryCount>
			<retryInterval>30</retryInterval>
			<nextRetryTime>2013-10-05T20:47:42 JST</nextRetryTime>
			<startServerId>d7a96e5c-62f7-4a52-91e3-96b01257866b</startServerId>
			<otherServerRetry>true</otherServerRetry>
		</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」（異常終了）でなかった場合

▲ このページのトップへ

機能名: delete

説明

チェックポイントフローの指定のリクエストを削除します。
実行中のリクエストは削除できません。

リクエスト

HTTPメソッド	リクエストURL
POST	`http://{Hostname}:{Port}/api/checkpoint/delete`

リクエストパラメーター

パラメーター	必須	説明
date	はい	削除するリクエストの開始日付をYYYYMMDDの形式で指定します。開始日付は、list, show APIの実行結果で取得できます。
requestId	はい	削除するリクエストのリクエストIDを指定します。リクエストIDは、list, show APIの実行結果で取得できます。

リクエスト例

POST /api/checkpoint/delete 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	指定したリクエストが存在しなかった場合

▲ このページのトップへ

機能名: dates

説明

チェックポイントフローのリクエストを格納している日付の一覧を返します。

リクエスト

HTTPメソッド	リクエストURL
GET	`http://{Hostname}:{Port}/api/checkpoint/dates`

リクエストパラメーター

なし

リクエスト例

GET /api/checkpoint/dates HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D

レスポンス

HTTPステータスコード

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

実行結果

実行に成功するとチェックポイントフローのリクエストを格納している日付のリストが返ります。

<result>
	<status>success</status>
	<data>
		<dates>
			<date>20140401</date>
			<date>20140402</date>
		</dates>
	</data>
</result>

エラーケース

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

エラーコード	HTTPステータスコード	説明
2001	403 Forbidden	ログインしていなかった場合エンタープライズライセンスがなかった場合
2002	404 Not Found	指定したリクエストが存在しなかった場合

▲ このページのトップへ

機能名: isAvailable

説明

チェックポイントが正常に起動しているかを確認します。

リクエスト

HTTPメソッド	リクエストURL
GET	`http://{Hostname}:{Port}/api/checkpoint/isAvailable`

リクエストパラメーター

なし

リクエスト例

GET /api/checkpoint/isAvailable HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D

レスポンス

HTTPステータスコード

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

実行結果

実行に成功するとチェックポイントが正常に起動している場合はtrueが返り、正常に起動できていない場合はfalseが返ります。

<result>
	<status>success</status>
	<data>
		<available>true</available>
	</data>
</result>

エラーケース

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

エラーコード	HTTPステータスコード	説明
2001	403 Forbidden	ログインしていなかった場合エンタープライズライセンスがなかった場合
2002	404 Not Found	指定したリクエストが存在しなかった場合

▲ このページのトップへ

機能名: isEnabled

説明

チェックポイントが有効になっているかを確認します。

リクエスト

HTTPメソッド	リクエストURL
GET	`http://{Hostname}:{Port}/api/checkpoint/isEnabled`

リクエストパラメーター

なし

リクエスト例

GET /api/checkpoint/isEnabled HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D

レスポンス

HTTPステータスコード

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

実行結果

実行に成功するとチェックポイントが有効な場合はtrueが返り、無効な場合はfalseが返ります。

<result>
	<status>success</status>
	<data>
		<enabled>true</enabled>
	</data>
</result>

エラーケース

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

エラーコード	HTTPステータスコード	説明
2001	403 Forbidden	ログインしていなかった場合エンタープライズライセンスがなかった場合
2002	404 Not Found	指定したリクエストが存在しなかった場合

▲ このページのトップへ

機能名: showStatistics

説明

チェックポイントフローのリクエストの統計情報を取得します。
チェックポイントフローのプロジェクトオーナーやプロジェクト名、フロー名などで取得する統計情報を絞り込むことができます。統計結果のグループ化を指定することもできます。

リクエスト

HTTPメソッド	リクエストURL
GET	`http://{Hostname}:{Port}/api/checkpoint/showStatistics`

リクエストパラメーター

パラメーター	必須	説明
startDate	いいえ	リクエストの開始日付をYYYY-MM-DDの形式で指定します。省略時はAPI実行時の当日の日付となります。
period	はい	統計情報を取得する期間をstartDateからの日数で指定します。
serverId	いいえ	リクエストの担当サーバーIDを指定して取得する統計情報を絞り込みます。
domain	いいえ	チェックポイントフローのプロジェクトオーナーのドメイン名を指定して取得する統計情報を絞り込みます。
user	いいえ	チェックポイントフローのプロジェクトオーナーのユーザー名を指定して取得する統計情報を絞り込みます。
project	いいえ	チェックポイントフローのプロジェクト名を指定して取得する統計情報を絞り込みます。
flow	いいえ	チェックポイントフローのフロー名を指定して取得する統計情報を絞り込みます。
status	いいえ	リクエストの実行ステータスを次のいずれかで指定して取得する統計情報を絞り込みます。 preparing - 実行準備中 running - 実行中 waiting - リトライ待ち success - 正常終了 error - 異常終了
groupBy	いいえ	結果のグループ化を指定します。 server - サーバーID user - ユーザー名 flow - フロー名 status - ステータス省略時は「サーバーID」となります。
timeBy	いいえ	結果の時間のグループ化を指定します。 hour - １時間ごと date - １日ごと time - 時間帯別 week - 曜日別省略時は「１時間ごと」となります。

リクエスト例

GET /api/checkpoint/showStatistics?period=1&timeBy=week HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D

レスポンス

HTTPステータスコード

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

実行結果

実行に成功すると統計情報が返ります。
統計情報としては次の情報が取得できます。

実行回数
エラー回数
平均実行時間
リトライ回数
時間帯

<result>
  <status>success</status>
  <data>
    <total>
      <name>/test/user</name>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>2</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
    </total>
    <total>
      <name>/sub/user1</name>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>5</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
    </total>
    <error>
      <name>/test/user</name>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
    </error>
    <error>
      <name>/sub/user1</name>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>2</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
    </error>
    <time>
      <name>/test/user</name>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0.00000</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
    </time>
    <time>
      <name>/sub/user1</name>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>4403.40000</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
    </time>
    <retry>
      <name>/test/user</name>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
    </retry>
    <retry>
      <name>/sub/user1</name>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>6</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
      <values>
        <value>0</value>
      </values>
    </retry>
    <xAxis>
      <x>Sunday</x>
    </xAxis>
    <xAxis>
      <x>Monday</x>
    </xAxis>
    <xAxis>
      <x>Tuesday</x>
    </xAxis>
    <xAxis>
      <x>Wednesday</x>
    </xAxis>
    <xAxis>
      <x>Thursday</x>
    </xAxis>
    <xAxis>
      <x>Friday</x>
    </xAxis>
    <xAxis>
      <x>Saturday</x>
    </xAxis>
  </data>
</result>

エラーケース

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

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

▲ このページのトップへ

機能名: downloadStatistics

説明

チェックポイントフローのリクエストの統計情報をCSVファイルの形式でダウンロードします。
チェックポイントフローのプロジェクトオーナーやプロジェクト名、フロー名などで取得する統計情報を絞り込むことができます。統計結果のグループ化を指定することもできます。

リクエスト

HTTPメソッド	リクエストURL
GET	`http://{Hostname}:{Port}/api/checkpoint/downloadStatistics`

リクエストパラメーター

パラメーター	必須	説明
startDate	いいえ	リクエストの開始日付をYYYY-MM-DDの形式で指定します。省略時はAPI実行時の当日の日付となります。
period	はい	統計情報を取得する期間をstartDateからの日数で指定します。
serverId	いいえ	リクエストの担当サーバーIDを指定して取得する統計情報を絞り込みます。
domain	いいえ	チェックポイントフローのプロジェクトオーナーのドメイン名を指定して取得する統計情報を絞り込みます。
user	いいえ	チェックポイントフローのプロジェクトオーナーのユーザー名を指定して取得する統計情報を絞り込みます。
project	いいえ	チェックポイントフローのプロジェクト名を指定して取得する統計情報を絞り込みます。
flow	いいえ	チェックポイントフローのフロー名を指定して取得する統計情報を絞り込みます。
status	いいえ	リクエストの実行ステータスを次のいずれかで指定して取得する統計情報を絞り込みます。 preparing - 実行準備中 running - 実行中 waiting - リトライ待ち success - 正常終了 error - 異常終了
groupBy	いいえ	結果のグループ化を指定します。 server - サーバーID user - ユーザー名 flow - フロー名 status - ステータス省略時は「サーバーID」となります。
timeBy	いいえ	結果の時間のグループ化を指定します。 hour - １時間ごと date - １日ごと time - 時間帯別 week - 曜日別省略時は「１時間ごと」となります。

リクエスト例

GET /api/checkpoint/downloadStatistics?period=1&timeBy=time HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D

レスポンス

HTTPステータスコード

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

実行結果

実行に成功すると統計情報のCSVファイルのZIPが返ります。
CSVファイルの内容としては次の情報が取得できます。

実行回数
エラー回数
平均実行時間
リトライ回数

HTTP/1.1 200 OK
Content-Type: application/zip
Content-Length: 44556
Content-Disposition: filename="statistics_20110101_20110201.zip"

[レスポンスのボディとしてzipファイルがバイナリ形式で付加されます]

エラーケース

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

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

▲ このページのトップへ

モジュール名: checkpoint

機能名: list

機能名: show

機能名: rerun

機能名: delete

機能名: dates

機能名: isAvailable

機能名: isEnabled

機能名: showStatistics

機能名: downloadStatistics