モジュール名: trigger

機能名 説明
list 実行設定の一覧を取得します
enable 実行設定を有効化します
disable 実行設定を無効化します
register 実行設定ファイルを使用して実行設定を登録します

機能名: list

説明

ログインユーザーの実行設定の一覧を取得します。
実行設定の種類はtypeパラメーターで指定できます。

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/api/trigger/list
リクエストパラメーター
パラメーター 必須 説明
type いいえ 取得する実行設定の種類を次のいずれで指定します。省略した場合はすべての実行設定の一覧を取得します。
  • url - URL実行設定
  • soap - SOAP実行設定
  • ftp - FTP実行設定
  • schedule - スケジュール実行設定
  • pop - メール監視実行設定
  • queue - メッセージキュー監視実行設定
リクエスト例
GET /api/trigger/list?type=url HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
レスポンス
HTTPステータスコード

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

実行結果(共通)

実行に成功すると実行設定の一覧が返ります。
各種実行設定の共通の情報として、次の情報が取得できます。

以下に各種実行設定個別の情報と実行結果の例を記します。

実行結果(URL実行設定の場合)

URL実行設定個別の情報としては次の情報が取得できます。

<result>
	<status>success</status>
	<data>
		<trigger>
			<type>url</type>
			<name>URL0001</name>
			<project>/guest.Project1</project>
			<flow>Flow1</flow>
			<owner>/guest</owner>
			<executeUser></executeUser>
			<mode>normal</mode>
			<isEnabled>true</isEnabled>
			<url>/Project1/Flow1</url>
		</trigger>
	</data>
</result>
実行結果(SOAP実行設定の場合)

SOAP実行設定個別の情報としては次の情報が取得できます。

<result>
	<status>success</status>
	<data>
		<trigger>
			<type>soap</type>
			<name>SOAP0001</name>
			<project>/guest.Project1</project>
			<flow>Flow1</flow>
			<owner>/guest</owner>
			<executeUser></executeUser>
			<mode>normal</mode>
			<isEnabled>true</isEnabled>
			<targetNamespace>urn:asteria-service-flowservice</targetNamespace>
			<operation>Flow1</operation>
			<endPoint>/test</endPoint>
		</trigger>
	</data>
</result>
実行結果(FTP実行設定の場合)

FTP実行設定個別の情報としては次の情報が取得できます。

<result>
	<status>success</status>
	<data>
		<trigger>
			<type>ftp</type>
			<name>FTP0001</name>
			<project>/test.Project1</project>
			<flow>Flow1</flow>
			<owner>/guest</owner>
			<executeUser></executeUser>
			<mode>normal</mode>
			<isEnabled>true</isEnabled>
			<folder>htdocs</folder>
			<subfolder>true</subfolder>
		</trigger>
	</data>
</result>
実行結果(スケジュール実行設定の場合)

スケジュール実行設定個別の情報としては次の情報が取得できます。取得できるのはスケジュールIDのみで、スケジュールの詳細な情報は取得できません。

<result>
	<status>success</status>
	<data>
		<trigger>
			<type>schedule</type>
			<name>SCH0001</name>
			<project>/test.Project1</project>
			<flow>Flow1</flow>
			<owner>/guest</owner>
			<executeUser></executeUser>
			<mode>normal</mode>
			<isEnabled>true</isEnabled>
			<scheduleId>0bb060443b0b489b85e7947473e69bc2</scheduleId>
		</trigger>
	</data>
</result>
実行結果(メール監視実行設定の場合)

メール監視実行設定個別の情報としては次の情報が取得できます。

<result>
	<status>success</status>
	<data>
		<trigger>
			<type>pop</type>
			<name>MAIL0001</name>
			<project>/test.Project1</project>
			<flow>Flow1</flow>
			<owner>/guest</owner>
			<executeUser></executeUser>
			<mode>normal</mode>
			<isEnabled>true</isEnabled>
			<connection>POP3-1</connection>
		</trigger>
	</data>
</result>
実行結果(メッセージキュー監視実行設定の場合)

メッセージキュー監視実行設定個別の情報としては次の情報が取得できます。

<result>
	<status>success</status>
	<data>
	<trigger>
		<type>queue</type>
		<name>QUEUE0001</name>
		<project>/test.Project1</project>
		<flow>Flow1</flow>
		<owner>/guest</owner>
		<executeUser></executeUser>
		<mode>normal</mode>
		<isEnabled>true</isEnabled>
		<connection>Queue1</connection>
		<queue>test</queue>
		<selector>type=2</selector>
	</trigger>
	</data>
</result>
エラーケース

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

エラーコード HTTPステータスコード 説明
2000 400 Bad Request typeパラメーターの値に誤りがあった場合
2001 403 Forbidden ログインしていなかった場合

▲ このページのトップへ

機能名: enable

説明

実行設定を有効化します。

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/api/trigger/enable
リクエストパラメーター
パラメーター 必須 説明
type はい 有効化する実行設定の種類を次のいずれかで指定します。
  • url - URL実行設定
  • soap - SOAP実行設定
  • ftp - FTP実行設定
  • schedule - スケジュール実行設定
  • pop - メール監視実行設定
  • queue - メッセージキュー監視実行設定
name はい 有効化する実行設定の実行設定名を指定します。
リクエスト例
POST /api/trigger/enable HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 21

type=url&name=URL0001
レスポンス
HTTPステータスコード

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

実行結果

実行に成功しても特に情報は返りません。

<result>
	<status>success</status>
	<data></data>
</result>
エラーケース

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

エラーコード HTTPステータスコード 説明
2000 400 Bad Request typeまたはnameパラメーターが存在しなかった場合
typeパラメーターの値に誤りがあった場合
2001 403 Forbidden ログインしていなかった場合
2002 404 Not Found typeとnameパラメーターで指定された実行設定が存在しなかった場合
9000 500 Internal Server Error 実行設定を有効化できなかった場合

▲ このページのトップへ

機能名: disable

説明

実行設定を無効化します。

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/api/trigger/disable
リクエストパラメーター
パラメーター 必須 説明
type はい 無効化する実行設定の種類を次のいずれかで指定します。
  • url - URL実行設定
  • soap - SOAP実行設定
  • ftp - FTP実行設定
  • schedule - スケジュール実行設定
  • pop - メール監視実行設定
  • queue - メッセージキュー監視実行設定
name はい 無効化する実行設定の実行設定名を指定します。
リクエスト例
POST /api/trigger/disable HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 21

type=url&name=URL0001
レスポンス
HTTPステータスコード

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

実行結果

実行に成功しても特に情報は返りません。

<result>
	<status>success</status>
	<data></data>
</result>
エラーケース

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

エラーコード HTTPステータスコード 説明
2000 400 Bad Request typeまたはnameパラメーターが存在しなかった場合
typeパラメーターの値に誤りがあった場合
2001 403 Forbidden ログインしていなかった場合
2002 404 Not Found typeとnameパラメーターで指定された実行設定が存在しなかった場合
9000 500 Internal Server Error 実行設定を無効化できなかった場合

▲ このページのトップへ

機能名: register

説明

実行設定ファイルを使用して、ユーザーのプロジェクト情報と実行設定を登録します。
更新パラメーター(replaceまたはoverwrite)を指定しない場合、重複する実行設定は登録されません。
実行可能パラメーター(enableAllまたはdisableAll)を指定しない場合、実行設定を有効にするか無効にするかは実行設定ファイルの設定に従います。
他のAPIと異なり、登録に失敗した場合でもAPIの実行が成功することがあります。結果の確認には実行結果の<error>を使用してください。

実行設定ファイルは次のいずれかの手順で作成することができます。

各手順の詳細につきましては、それぞれのヘルプをご覧ください。

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/api/trigger/register
リクエストパラメーター
パラメーター 必須 説明
fileName はい 登録に使用する実行設定ファイル名を指定します。
サーバーに存在する実行設定ファイルを指定します。
replace いいえ すべてのプロジェクトの登録情報と実行設定を削除してから実行設定を登録する場合は「true」を指定します。
省略時は「false」(実行設定の登録前に削除しない)となります。
「overwrite」パラメーターと同時に指定された場合は、「replace」パラメーターが優先されます。
overwrite いいえ 実行設定名が同じ時に上書きする場合は「true」を指定します。
省略時は「false」(上書きしない)となります。
「replace」パラメーターと同時に指定された場合は、「replace」パラメーターが優先されます。
enableAll いいえ 登録した実行設定をすべて有効にする場合は「true」を指定します。
省略時は「false」(実行設定ファイルの設定に従う)となります。
「disableAll」パラメーターと同時に指定された場合は、「enableAll」パラメーターが優先されます。
disableAll いいえ 登録した実行設定をすべて無効にする場合は「true」を指定します。
省略時は「false」(実行設定ファイルの設定に従う)となります。
「enableAll」パラメーターと同時に指定された場合は、「enableAll」パラメーターが優先されます。
リクエスト例
POST /api/trigger/register HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 32

fileName=trigger.xml&replace=true
レスポンス
HTTPステータスコード

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

実行結果

実行に成功すると登録されたプロジェクトと実行設定の一覧が返ります。
登録されたプロジェクトと実行設定の情報としては次の情報が取得できます。

<result>
	<status>success</status>
	<data>
		<fileName>C:\asteriahome\flow\home\guest\trigger.xml</fileName>
		<project>
			<count>2</count>
			<error>0</error>
			<details>
				<detail>
					<message>プロジェクトをインポートしました : Project1.xfp</message>
				</detail>
				<detail>
					<message>プロジェクトをインポートしました : Project2.xfp</message>
				</detail>
			</details>
		</project>
		<trigger>
			<count>1</count>
			<error>0</error>
			<details>
				<detail>
					<message>実行設定をインポートしました : URL0001</message>
				</detail>
			</details>
		</trigger>
	</data>
</result>
エラーケース

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

2000 400 Bad Request fileNameパラメーターが存在しなかった場合
fileNameパラメーターで指定されたファイルが存在しなかった場合
fileNameパラメーターで指定されたファイルがXMLファイルでなかった場合
2001 403 Forbidden ログインしていなかった場合

▲ このページのトップへ