モジュール名: request

機能名	説明
list	リクエストの一覧を取得します
show	リクエスト情報を取得します
kill	リクエストを強制終了します

機能名: list

説明

現在実行中およびキューで待機中のリクエストの一覧を取得します。

リクエスト

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

リクエストパラメーター

なし

リクエスト例

GET /api/request/list HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D

レスポンス

HTTPステータスコード

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

実行結果

実行に成功するとリクエストの一覧が返ります。
リクエストの情報としては次の情報が取得できます。

リクエストID
プロジェクト名
フロー名
セッションID
リクエスト時刻
状態
「in queue」（キュー待機中）、「running」（実行中）、「suspend」（停止中）、「end」（終了）のいずれか。

<result>
	<status>success</status>
	<data>
		<request>
			<requestId>bb429065-8bad-4d82-8e61-b4aa1ac3435a</requestId>
			<project>/guest.Project1</project>
			<flow>Flow1</flow>
			<sessionId>1d42b6bc-6257-475f-8b00-aedd59a84d93</sessionId>
			<createdTime>2012-08-27T18:38:49 JST</createdTime>
			<status>running</status>
		</request>
		<request>
			<requestId>ff15e7d3-ba55-43d2-8ef6-f5a999ffe0c8</requestId>
			<project>/guest.Project1</project>
			<flow>Flow2</flow>
			<sessionId>0d45b15e-e994-419f-92e7-c6eaff311651</sessionId>
			<createdTime>2012-08-27T18:41:10 JST</createdTime>
			<status>suspend</status>
		</request>
	</data>
</result>

エラーケース

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

エラーコード	HTTPステータスコード	説明
2000	400 Bad Request	userパラメーターが存在しなかった場合
2001	403 Forbidden	ログインしていなかった場合
2002	404 Not Found	リクエスト管理マネージャーが見つからなかった場合

▲ このページのトップへ

機能名: show

説明

指定のリクエストについての情報を取得します。

リクエスト

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

リクエストパラメーター

パラメーター	必須	説明
requestId	はい	情報を取得するリクエストのリクエストIDを指定します。リクエストIDは、list APIの実行結果で取得できます。
timeout	いいえ	リクエストの情報を取得するためのタイムアウト値を秒単位で指定します。省略時は５秒となります。

リクエスト例

GET /api/request/show?requestId=1ff784bf-1080-4275-b898-b5b9ac9625d3 HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D

レスポンス

HTTPステータスコード

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

実行結果

実行に成功するとリクエストの情報が返ります。
リクエストの情報としては次の情報が取得できます。

状態
「in queue」（キュー待機中）、「running」（実行中）、「suspend」（停止中）、「end」（終了）のいずれか。
プロジェクト名
フロー名
コンポーネント情報
コンポーネント名とコンポーネントのプロパティ情報
マッパー内で設定したステータス
フロー変数情報
フロー変数の名前と値
ストリーム情報
ストリームの型と値
エラー情報

<result>
	<status>success</status>
	<data>
		<status>running</status>
		<project>/guest.Project1</project>
		<flow>Flow1</flow>
		<component>
			<name>XPathString1</name>
			<properties>
				<property>
					<name>Exception</name>
					<value></value>
				</property>
				<property>
					<name>ExecuteCount</name>
					<value>1</value>
				</property>
				<property>
					<name>ExceptionString</name>
					<value></value>
				</property>
			</properties>
			<categoryProperties>
				<categoryProperty>
					<name>XPath</name>
					<properties>
						<property>
							<name>name</name>
							<value>/root/items/item/name</value>
						</property>
					</properties>
				</categoryProperty>
			</categoryProperties>
		</component>
		<statusStr>12回目</statusStr>
		<flowVariables>
			<variable>
				<name>フロー変数１</name>
				<value>フロー変数の値１</value>
			</variable>
			<variable>
				<name>フロー変数２</name>
				<value>フロー変数の値２</value>
			</variable>
		</flowVariables>
		<stream>
			<type>XML</type>
			<value>
				<?xml version="1.0" encoding="utf-8"?>
				<root>
					<items>
						<item>
							<name>item1</name>
							<value>100</value>
						</item>
						<item>
							<name>item2</name>
							<value>200</value>
						</item>
					</items>
				</root>
			</value>
		</stream>
		<exception></exception>
	</data>
</result>

エラーケース

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

エラーコード	HTTPステータスコード	説明
2000	400 Bad Request	requestIdパラメーターが存在しなかった場合
2001	403 Forbidden	ログインしていなかった場合
2002	404 Not Found	requestIdパラメーターで指定されたセッションが存在しなかった場合リクエスト管理マネージャーが見つからなかった場合

▲ このページのトップへ

機能名: kill

説明

実行中のフローを強制終了します。
強制終了に成功した場合は、最後に実行されたコンポーネント名を取得できます。
他のAPIと異なり、強制終了できなかった場合でもAPIの実行は成功しますので、結果の確認には実行結果の<status>を使用してください。

リクエスト

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

リクエストパラメーター

requestId	はい	強制終了するリクエストのリクエストIDを指定します。リクエストIDは、list APIの実行結果で取得できます。複数指定する場合は、「,」区切りで指定します。
timeout	いいえ	強制終了の実行結果を待つタイムアウト値を秒単位で指定します。省略時は５秒となります。

リクエスト例

POST /api/request/kill HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 46

requestId=ef7f6a74-8ddd-431a-849b-e1cc383a6e30,ef7f6a74-8ddd-431a-849b-e1cc383a6e31

レスポンス

HTTPステータスコード

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

実行結果

実行に成功すると強制終了結果が返ります。
強制終了結果の情報としては次の情報が取得できます。
リクエストIDを複数指定した場合で、リクエストの強制終了がすべて成功した場合は、dataのstatusが「true」となります。１つでも失敗した場合は「false」となります。

リクエストID
状態
強制終了に成功した場合は「true」、失敗した場合は「false」
コンポーネント名
強制終了に成功した場合には、最後に実行されたコンポーネント名が設定されます
エラー情報
強制終了に失敗した場合には、失敗した原因が設定されます

<result>
	<status>success</status>
	<data>
		<status>false</status>
		<request>
			<id>ef7f6a74-8ddd-431a-849b-e1cc383a6e30</id>
			<status>true</status>
			<component>/guest.Project1.Flow4.Sleep1</component>
			<exception></exception>
		</request>
		<request>
			<id>ef7f6a74-8ddd-431a-849b-e1cc383a6e31</id>
			<status>false</status>
			<component>/guest.Project1.Flow5.Sleep1</component>
			<exception>some error messages</exception>
		</request>
	</data>
</result>

エラーケース

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

エラーコード	HTTPステータスコード	説明
2000	400 Bad Request	requestIdパラメーターが存在しなかった場合
2001	403 Forbidden	ログインしていなかった場合
2002	404 Not Found	リクエスト管理マネージャーが見つからなかった場合

▲ このページのトップへ