機能名 | 説明 |
---|---|
list | トリガーの一覧を取得します |
show | トリガーの詳細情報を取得します |
create | トリガーの情報を追加します |
update | トリガーの情報を変更します |
execute | トリガーを実行します |
delete | トリガーを削除します |
status/set | トリガーを「有効」または「無効」に設定します |
status/all/get | 全トリガー有効・無効の状態を取得します |
status/all/enable | 全トリガーを「有効」に設定します |
status/all/disable | 全トリガーを「無効」に設定します |
トリガーの一覧を取得します。
管理者と運用者はドメイン配下のすべてのユーザーのトリガー情報を取得できます。
デベロッパーは自己のトリガー情報のみを取得できます。
administrator、developer、operator
HTTPメソッド | リクエストURL |
---|---|
GET | http://{Hostname}:{Port}/mcapi/trigger/list |
パラメーター | 必須 | 説明 |
---|---|---|
type | いいえ | トリガーのタイプを指定します。
|
userName | いいえ | 取得するトリガーのユーザー名を指定します。 指定しなかった場合はログインユーザーとなります。 |
GET /mcapi/trigger/list HTTP/1.1 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
APIの実行が成功した場合、HTTPステータスコードは200
が返ります。
URLの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "url": [ { "name": "URL0001", "owner": "/test", "project": "Project1", "flow": "Flow1", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "", "url": "/Project1/Flow1" } ] } } }
{ "result": { "status": "success", "data": { "oneTime": [ { "name": "SCH0001", "owner": "/test", "project": "Project2", "flow": "Flow1", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "", "nextExecuteTime": "2013-01-01 01:13:01" } ] } } }
一定間隔スケジュールの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "interval": [ { "name": "SCH0002", "owner": "/test", "project": "Project2", "flow": "Flow2", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "", "nextExecuteTime": "2013-01-01 01:13:01", "startTime": "2013-01-01 01:13:01", "endTime": "2013-01-02 01:13:01", "validTimeStart": "00:00:01", "validTimeEnd": "20:00:01", "interval": 600 } ] } } }
毎日スケジュールの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "daily": [ { "name": "SCH0003", "owner": "/test", "project": "Project2", "flow": "Flow3", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "", "nextExecuteTime": "2013-01-01 13:13:01", "startTime": "2013-01-01 01:13:01", "endTime": "", "executeTime": "13:13:01" } ] } } }
毎週スケジュールの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "weekly": [ { "name": "SCH0004", "owner": "/test", "project": "Project2", "flow": "Flow4", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "", "nextExecuteTime": "2013-01-01 13:13:01", "startTime": "2013-01-01 01:13:01", "endTime": "", "executeTime": "13:13:01", "daysOfWeek": [ "Tuesday", "Sunday" ] } ] } } }
毎月スケジュールの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "monthly": [ { "name": "SCH0004", "owner": "/test", "project": "Project2", "flow": "Flow4", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "", "nextExecuteTime": "2013-01-01 13:13:01", "startTime": "2013-01-01 01:13:01", "endTime": "", "executeTime": "13:13:01", "dates": [ 1, 4, 17, 31 ] } ] } } }
SOAPの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "soap": [ { "name": "SOAP0001", "owner": "/test", "project": "Project3", "flow": "Flow1", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "", "targetNamespace": "urn:test-service-flowservice", "soapMethod": "", "style": "document" } ] } } }
FTPの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "ftp": [ { "name": "FTP0001", "owner": "/test", "project": "Project4", "flow": "Flow1", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "", "folder": "", "containsSubfolders": true } ] } } }
メールの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "mail": [ { "name": "MAIL0001", "owner": "/test", "project": "Project5", "flow": "Flow1", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "", "connection": "test_mail", "interval": 300 } ] } } }
メッセージキューの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "queue": [ { "name": "QUEUE0001", "owner": "/test", "project": "Project6", "flow": "Flow1", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "", "connection": "test_queue", "interval": 600 } ] } } }
下記以外のエラーについては、共通エラーコードを参照してください。
エラーコード | HTTPステータスコード | 説明 |
---|---|---|
400 Bad Request | 2001 | パラメーター type の値が正しくなかった場合 |
403 Forbidden | 3001 | ログインしていなかった場合 |
3101 | 権限が不足していた場合 | |
404 Not Found | 4002 | パラメーター userName で指定したユーザーが存在しなかった場合 |
500 Internal Server Error | 5001 | ファイルの読み込みでエラーが発生した場合 |
5003 | ファイルの解析でエラーが発生した場合 | |
5101 | 内部の通信に失敗した場合 | |
5102 | サーバー内部にエラーが発生した場合 | |
5106 | 必要なサービスが起動していなかった場合 |
トリガーの詳細情報を取得します。
administrator、developer、operator
HTTPメソッド | リクエストURL |
---|---|
GET | http://{Hostname}:{Port}/mcapi/trigger/show |
パラメーター | 必須 | 説明 |
---|---|---|
type | はい | トリガーのタイプを指定します。
|
name | はい | トリガー名を指定します。 |
userName | いいえ | トリガーのユーザー名を指定します。 指定しなかった場合はログインユーザーとなります。 |
GET /mcapi/trigger/show?type=url&name=URL0001 HTTP/1.1 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
APIの実行が成功した場合、HTTPステータスコードは200
が返ります。
{ "result": { "status": "success", "data": { "url": { "name": "URL0001", "owner": "/test", "project": "Project1", "flow": "Flow1", "mode": "profile", "executeUser": "/test", "status": true, "lastExecutedTime": "2013-01-01 13:13:01", "url": "/test/path", "description": "test description", "executedTimes": 8, "enableHttp": true, "enableHttps": true, "sessionTimeOut": 900 } } } }
指定日時スケジュールの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "oneTime": { "name": "SCH0005", "owner": "/test", "project": "Project1", "flow": "Flow3", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "", "nextExecuteTime": "2013-01-41 13:13:01", "description": "", "executedTimes": 0, "scheduleId": "e788a18c7b9a4c9fac299578aec287e6", "workOnHolidays": "after", "calendar": "test_calendar", "executeAfterRestart": false "arguments": [ { "name": "Param1", "type": "Integer", "value": "1" }, { "name": "Param2", "type": "String", "value": "test" } ] } } } }
一定間隔スケジュールの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "interval": { "name": "SCH0002", "owner": "/test", "project": "Project1", "flow": "Flow4", "mode": "debug", "executeUser": "", "status": false, "lastExecutedTime": "2013-01-01 20:03:40", "nextExecuteTime": "2013-01-01 20:06:40", "startTime": "2013-01-01 01:00:40", "endTime": "", "validTimeStart": "20:00:00", "validTimeEnd": "21:00:00", "interval": 180, "description": "", "executedTimes": 3, "scheduleId": "76d0c38b9b834e6ab0d0c8e2bd0be004", "workOnHolidays": "never", "calendar": "test_calendar", "executeAfterRestart": true "arguments": [ { "name": "Param1", "type": "Integer", "value": "1" }, { "name": "Param2", "type": "String", "value": "test" } ] } } } }
毎日スケジュールの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "daily": { "name": "SCH0001", "owner": "/test", "project": "Project1", "flow": "Flow3", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "2013-01-01 20:03:40", "nextExecuteTime": "2013-01-02 20:03:40", "startTime": "2013-01-01 01:00:40", "endTime": "", "executeTime": "20:03:40", "description": "", "executedTimes": 1, "scheduleId": "fa08bc430c3e465fb0c0ababd12e13ff", "workOnHolidays": "always", "executeAfterRestart": true "arguments": [ { "name": "Param1", "type": "Integer", "value": "1" }, { "name": "Param2", "type": "String", "value": "test" } ] } } } }
毎週スケジュールの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "weekly": { "name": "SCH0004", "owner": "/test", "project": "Project1", "flow": "Flow5", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "2013-01-01 20:03:40", "nextExecuteTime": "2013-01-02 20:03:40", "startTime": "2013-01-01 01:00:40", "endTime": "", "executeTime": "20:03:40", "daysOfWeek": [ "Tuesday", "Wednesday" ], "description": "", "executedTimes": 1, "scheduleId": "61e3e190fefe4a04a936c42edf48aea5", "workOnHolidays": "always", "executeAfterRestart": true "arguments": [ { "name": "Param1", "type": "Integer", "value": "1" }, { "name": "Param2", "type": "String", "value": "test" } ] } } } }
毎月スケジュールの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "monthly": { "name": "SCH0006", "owner": "/test", "project": "Project1", "flow": "Flow6", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "", "nextExecuteTime": "2013-01-13 20:03:40", "startTime": "2013-01-01 01:00:40", "endTime": "", "executeTime": "20:03:40", "dates": [ 13, 17, 24 ], "description": "", "executedTimes": 0, "scheduleId": "4ffe24efeeec4486ae7bd9f9feea3381", "workOnHolidays": "always", "executeAfterRestart": true, "arguments": [ { "name": "Param1", "type": "Integer", "value": "1" }, { "name": "Param2", "type": "String", "value": "test" } ] } } } }
SOAPの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "soap": { "name": "SOAP0001", "owner": "/test", "project": "Project4", "flow": "Flow1", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "", "targetNamespace": "urn:test-service-flowservice", "soapMethod": "testMethod", "style": "document", "description": "", "executedTimes": 0, "use": "literal", "endPoint": "http://localhost/soap/test" } } } }
FTPの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "ftp": { "name": "FTP0001", "owner": "/test", "project": "Project2", "flow": "Flow1", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "2013-01-01 13:13:01", "folder": "output", "containsSubfolders": true, "description": "", "executedTimes": 3 } } } }
メールの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "mail": { "name": "MAIL0001", "owner": "/test", "project": "Project3", "flow": "Flow1", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "2013-01-01 13:13:01", "connection": "test2", "interval": 60, "description": "", "executedTimes": 2, "attachementFlow": { "project": "Project3", "flow": "Flow2" }, "exceptionFlow": { "project": "Project3", "flow": "Flow3" }, "sameTransaction": true, "htmlMail": "text", "waitForMultiStart": false, "deleteMail": "dependsOnReturnValue", "returnValueForDelete": "test", "workOnHolidays": "always" } } } }
メッセージキューの個別の情報としては次の情報が取得できます。
{ "result": { "status": "success", "data": { "queue": { "name": "QUEUE0001", "owner": "/test", "project": "Project4", "flow": "Flow1", "mode": "normal", "executeUser": "", "status": true, "lastExecutedTime": "", "connection": "test_queue", "interval": 120, "description": "", "executedTimes": 0, "waitForMultiStart": false, "queueName": "test", "selector": "option=value", "delete": "always", "deleteWhen": "beforeStart", "workOnHolidays": "always" } } } }
下記以外のエラーについては、共通エラーコードを参照してください。
エラーコード | HTTPステータスコード | 説明 |
---|---|---|
400 Bad Request | 2001 | パラメーター type の値が正しくなかった場合 |
403 Forbidden | 3001 | ログインしていなかった場合 |
3101 | 権限が不足していた場合 | |
404 Not Found | 4002 | パラメーター userName で指定したユーザーが存在しなかった場合 |
4009 | 指定したトリガーが存在しなかった場合 | |
500 Internal Server Error | 5001 | ファイルの読み込みでエラーが発生した場合 |
5003 | ファイルの解析でエラーが発生した場合 | |
5101 | 内部の通信に失敗した場合 | |
5102 | サーバー内部にエラーが発生した場合 | |
5106 | 必要なサービスが起動していなかった場合 |
トリガーの情報を追加します。
管理者の場合、すべてのユーザーのトリガーを追加できます。
管理者以外の場合、自分のトリガーのみを追加できます。
administrator、developer
HTTPメソッド | リクエストURL |
---|---|
POST | http://{Hostname}:{Port}/mcapi/trigger/create |
パラメーター | 必須 | 説明 |
---|---|---|
userName | いいえ | トリガーのユーザー名を指定します。 指定しなかった場合はログインユーザーとなります。 |
POST /mcapi/trigger/create HTTP/1.1 Content-Type: application/json; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 222 { "url": { "project": "Project1", "flow": "Flow1", "mode": "normal", "executeUser": "/test2", "executePassword": "", "description": "url test update", "url": "/Project1/Flow1", "enableHttp": true, "enableHttps": false, "status": true, "sessionTimeOut": 30 } }
APIの実行が成功した場合、HTTPステータスコードは200
が返ります。
実行に成功するとトリガー情報を追加します。
{ "result": { "status": "success", "data": {} } }
下記以外のエラーについては、共通エラーコードを参照してください。
エラーコード | HTTPステータスコード | 説明 |
---|---|---|
400 Bad Request | 2101 | Jsonデータの値が正しくなかった場合 |
2102 | Jsonデータの必須項目が入力されなかった場合 | |
2103 | Jsonデータの値のデータ型が正しくなかった場合 | |
2108 | Jsonデータのキーが正しくなかった場合 | |
2305 | 時刻の解析でエラーが発生した場合 | |
2401 | パスワードが正しくなかった場合 | |
2501 | 同じタイプと名前のトリガーが既に存在していた場合 | |
2502 | トリガーが重複していた場合 | |
2503 | パラメーターの値の変換に失敗した場合 | |
403 Forbidden | 3001 | ログインしていなかった場合 |
3101 | 権限が不足していた場合 | |
404 Not Found | 4002 | 指定したユーザーが存在しなかった場合 |
4005 | 指定したコネクションが存在しなかった場合 | |
500 Internal Server Error | 5001 | ファイルの読み込みでエラーが発生した場合 |
5003 | ファイルの解析でエラーが発生した場合 | |
5101 | 内部の通信に失敗した場合 | |
5102 | サーバー内部にエラーが発生した場合 | |
5106 | 必要なサービスが起動していなかった場合 | |
5201 | 指定したプロセス情報が存在しなかった場合 | |
5202 | プロセス情報が存在しなかった場合 | |
5205 | プロセス情報の解析に失敗した場合 |
トリガーの情報を変更します。
管理者の場合、すべてのユーザーのトリガーを変更できます。
管理者以外の場合、自分のトリガーのみを変更できます。
administrator、developer
HTTPメソッド | リクエストURL |
---|---|
POST | http://{Hostname}:{Port}/mcapi/trigger/update |
パラメーター | 必須 | 説明 |
---|---|---|
type | はい | トリガーのタイプを指定します。
|
name | はい | トリガー名を指定します。 |
userName | いいえ | トリガーのユーザー名を指定します。 指定しなかった場合はログインユーザーとなります。 |
POST /mcapi/trigger/update?type=url&name=URL0001 HTTP/1.1 Content-Type: application/json; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 198 { "url": { "project": "Project1", "flow": "Flow1", "mode": "normal", "executeUser": "/test2", "executePassword": "", "description": "url test update", "url": "/Project1/Flow1", "enableHttp": true, "enableHttps": false, "status": true, "sessionTimeOut": 30 } }
APIの実行が成功した場合、HTTPステータスコードは200
が返ります。
実行に成功するとトリガー情報を変更します。
{ "result": { "status": "success", "data": {} } }
下記以外のエラーについては、共通エラーコードを参照してください。
エラーコード | HTTPステータスコード | 説明 |
---|---|---|
400 Bad Request | 2001 | パラメーター type の値が正しくなかった場合 |
2002 | パラメーター type, name の値が設定されなかった場合 | |
2101 | Jsonデータの値が正しくなかった場合 | |
2102 | Jsonデータの必須項目が入力されなかった場合 | |
2103 | Jsonデータの値のデータ型が正しくなかった場合 | |
2305 | 時刻の解析にエラーが発生した場合 | |
2401 | パスワードは正しくなかった場合 | |
2501 | 同じタイプと名前のトリガーが既に存在していた場合 | |
2502 | トリガーが重複していた場合 | |
2503 | パラメーターの値の変換に失敗した場合 | |
403 Forbidden | 3001 | ログインしていなかった場合 |
3101 | 権限が不足していた場合 | |
404 Not Found | 4002 | 指定したユーザーが存在しなかった場合 |
4005 | 指定したコネクションが存在しなかった場合 | |
4009 | 指定したトリガーが存在しなかった場合 | |
500 Internal Server Error | 5001 | ファイルの読み込みでエラーが発生した場合 |
5003 | ファイルの解析でエラーが発生した場合 | |
5101 | 内部の通信に失敗した場合 | |
5102 | サーバー内部にエラーが発生した場合 | |
5106 | 必要なサービスが起動していなかった場合 | |
5201 | 指定したプロセス情報が存在しなかった場合 | |
5202 | プロセス情報が存在しなかった場合 | |
5205 | プロセス情報の解析に失敗した場合 | |
5401 | 名前の重複しているトリガーが存在していた場合 |
トリガーを実行します。
トリガーの実行を開始すると、その終了を待たずに直ちにAPIの実行が完了します。
administrator、developer、operator
HTTPメソッド | リクエストURL |
---|---|
POST | http://{Hostname}:{Port}/mcapi/trigger/execute |
パラメーター | 必須 | 説明 |
---|---|---|
type | はい | トリガーのタイプを指定します。
|
name | はい | トリガー名を指定します。 |
userName | いいえ | 取得するトリガーのユーザー名を指定します。 指定しなかった場合はログインユーザーとなります。 |
POST /mcapi/trigger/execute HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 27 type=oneTime&name=SCHED0001
APIの実行が成功した場合、HTTPステータスコードは200
が返ります。
実行に成功すると指定されたトリガーを実行します。
{ "result": { "status": "success", "data": {} } }
下記以外のエラーについては、共通エラーコードを参照してください。
エラーコード | HTTPステータスコード | 説明 |
---|---|---|
400 Bad Request | 2001 | パラメーター type の値が正しくなかった場合 |
2002 | パラメーター type, name の値が設定されなかった場合 | |
403 Forbidden | 3001 | ログインしていなかった場合 |
3101 | 権限が不足していた場合 | |
404 Not Found | 4002 | 指定したユーザーが存在しなかった場合 |
4009 | 指定したトリガーが存在しなかった場合 | |
500 Internal Server Error | 5001 | ファイルの読み込みでエラーが発生した場合 |
5003 | ファイルの解析でエラーが発生した場合 | |
5101 | 内部の通信に失敗した場合 | |
5102 | サーバー内部にエラーが発生した場合 | |
5106 | 必要なサービスが起動していなかった場合 | |
5401 | 名前の重複しているトリガーが存在していた場合 |
トリガーを削除します。
管理者の場合、すべてのユーザーのトリガーを削除できます。
管理者以外の場合、自分のトリガーのみを削除できます。
administrator、developer
HTTPメソッド | リクエストURL |
---|---|
POST | http://{Hostname}:{Port}/mcapi/trigger/delete |
パラメーター | 必須 | 説明 |
---|---|---|
type | はい | トリガーのタイプを指定します。
|
name | はい | トリガー名を指定します。 |
userName | いいえ | 取得するトリガーのユーザー名を指定します。 指定しなかった場合はログインユーザーとなります。 |
POST /mcapi/trigger/delete HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 21 type=url&name=URL0001
APIの実行が成功した場合、HTTPステータスコードは200
が返ります。
実行に成功するとトリガーを削除します。
{ "result": { "status": "success", "data": {} } }
下記以外のエラーについては、共通エラーコードを参照してください。
エラーコード | HTTPステータスコード | 説明 |
---|---|---|
400 Bad Request | 2001 | パラメーター type の値が正しくなかった場合 |
2002 | パラメーター type, name の値が設定されなかった場合 | |
403 Forbidden | 3001 | ログインしていなかった場合 |
3101 | 権限が不足していた場合 | |
404 Not Found | 4009 | 指定したトリガーが存在しなかった場合 |
500 Internal Server Error | 5001 | ファイルの読み込みでエラーが発生した場合 |
5003 | ファイルの解析でエラーが発生した場合 | |
5101 | 内部の通信に失敗した場合 | |
5102 | サーバー内部にエラーが発生した場合 | |
5106 | 必要なサービスが起動していなかった場合 | |
5401 | 名前の重複しているトリガーが存在していた場合 |
トリガーを「有効」または「無効」に設定します。
administrator、developer、operator
HTTPメソッド | リクエストURL |
---|---|
POST | http://{Hostname}:{Port}/mcapi/trigger/status/set |
パラメーター | 必須 | 説明 |
---|---|---|
type | はい | トリガーのタイプを指定します。
|
name | はい | トリガー名を指定します。 |
userName | いいえ | 取得するトリガーのユーザー名を指定します。 指定しなかった場合はログインユーザーとなります。 |
status | はい | トリガーのステータスを指定します。 「有効」の場合は「true」、「無効」の場合は「false」 |
POST /mcapi/trigger/status/set HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 33 type=url&name=URL0001&status=true
APIの実行が成功した場合、HTTPステータスコードは200
が返ります。
実行に成功するとトリガーのステータスを変更します。
{ "result": { "status": "success", "data": {} } }
下記以外のエラーについては、共通エラーコードを参照してください。
エラーコード | HTTPステータスコード | 説明 |
---|---|---|
400 Bad Request | 2001 | パラメーター type の値が正しくなかった場合 |
2002 | パラメーター type, name, status の値が設定されなかった場合 | |
403 Forbidden | 3001 | ログインしていなかった場合 |
3101 | 権限が不足していた場合 | |
404 Not Found | 4002 | 指定したユーザーが存在しなかった場合 |
4009 | 指定したトリガーが存在しなかった場合 | |
500 Internal Server Error | 5001 | ファイルの読み込みでエラーが発生した場合 |
5003 | ファイルの解析でエラーが発生した場合 | |
5101 | 内部の通信に失敗した場合 | |
5102 | サーバー内部にエラーが発生した場合 | |
5106 | 必要なサービスが起動していなかった場合 | |
5401 | 名前の重複しているトリガーが存在していた場合 |
全トリガー有効・無効の状態を取得します。
administrator、developer、operator
HTTPメソッド | リクエストURL |
---|---|
GET | http://{Hostname}:{Port}/mcapi/trigger/status/all/get |
なし
GET /mcapi/trigger/status/all/get HTTP/1.1 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
APIの実行が成功した場合、HTTPステータスコードは200
が返ります。
実行に成功すると全トリガー有効・無効の状態を取得します。
{ "result": { "status": "success", "data": { "status": true } } }
下記以外のエラーについては、共通エラーコードを参照してください。
エラーコード | HTTPステータスコード | 説明 |
---|---|---|
403 Forbidden | 3001 | ログインしていなかった場合 |
500 Internal Server Error | 5001 | ファイルの読み込みでエラーが発生した場合 |
5003 | ファイルの解析でエラーが発生した場合 | |
5101 | 内部の通信に失敗した場合 | |
5102 | サーバー内部にエラーが発生した場合 |
全トリガーを「有効」に設定します。
administrator、operator
HTTPメソッド | リクエストURL |
---|---|
POST | http://{Hostname}:{Port}/mcapi/trigger/status/all/enable |
なし
POST /mcapi/trigger/status/all/enable HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 0
APIの実行が成功した場合、HTTPステータスコードは200
が返ります。
実行に成功するとすべてのトリガー機能の状態を「有効」に設定します。
{ "result": { "status": "success", "data": {} } }
下記以外のエラーについては、共通エラーコードを参照してください。
エラーコード | HTTPステータスコード | 説明 |
---|---|---|
403 Forbidden | 3001 | ログインしていなかった場合 |
3101 | 権限が不足していた場合 | |
500 Internal Server Error | 5001 | ファイルの読み込みでエラーが発生した場合 |
5003 | ファイルの解析でエラーが発生した場合 | |
5101 | 内部の通信に失敗した場合 | |
5102 | サーバー内部にエラーが発生した場合 |
全トリガーを「無効」に設定します。
administrator、operator
HTTPメソッド | リクエストURL |
---|---|
POST | http://{Hostname}:{Port}/mcapi/trigger/status/all/disable |
なし
POST /mcapi/trigger/status/all/disable HTTP/1.1 Content-Type: application/x-www-form-urlencoded; charset=UTF-8 X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4 Content-Length: 0
APIの実行が成功した場合、HTTPステータスコードは200
が返ります。
実行に成功するとすべてのトリガー機能の状態を「無効」に設定します。
{ "result": { "status": "success", "data": {} } }
下記以外のエラーについては、共通エラーコードを参照してください。
エラーコード | HTTPステータスコード | 説明 |
---|---|---|
403 Forbidden | 3001 | ログインしていなかった場合 |
3101 | 権限が不足していた場合 | |
500 Internal Server Error | 5001 | ファイルの読み込みでエラーが発生した場合 |
5003 | ファイルの解析でエラーが発生した場合 | |
5101 | 内部の通信に失敗した場合 | |
5102 | サーバー内部にエラーが発生した場合 |