モジュール名: trigger

機能名 説明
list トリガーの一覧を取得します
show トリガーの詳細情報を取得します
create トリガーの情報を追加します
update トリガーの情報を変更します
execute トリガーを実行します
delete トリガーを削除します
status/set トリガーを「有効」または「無効」に設定します

機能名: list

説明

トリガーの一覧を取得します。
管理者と運用者はドメイン配下のすべてのユーザーのトリガー情報を取得できます。
デベロッパーは自己のトリガー情報のみを取得できます。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/trigger/list
リクエストパラメーター
パラメーター 必須 説明
type いいえ トリガーのタイプを指定します。
  • url - URL
  • schedule - スケジュール(指定日時、一定間隔、毎日、毎週、毎月)
  • oneTime - 指定日時
  • interval - 一定間隔
  • daily - 毎日
  • weekly - 毎週
  • monthly - 毎月
  • soap - SOAP
  • ftp - FTP
  • mail - メール
  • queue - メッセージキュー
指定しなかった場合は指定したユーザーの全てのタイプを取得します。
userName いいえ 取得するトリガーのユーザー名を指定します。
指定しなかった場合はログインユーザーとなります。
リクエスト例
GET /mcapi/trigger/list HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果
実行に成功するとトリガーの一覧が返ります。
管理者または運用者はuserNameを指定しなかった場合、ドメイン配下のすべてのユーザーのトリガー一覧が返ります。
各種トリガーの共通の情報として、次の情報が取得できます。
実行結果(URLの場合)

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",
                    "enableStartTime": "00:00:01",
                    "enableEndTime": "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の場合)

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の場合)

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 必要なサービスが起動していなかった場合

▲ このページのトップへ

機能名: show

説明

トリガーの詳細情報を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/trigger/show
リクエストパラメーター
パラメーター 必須 説明
type はい トリガーのタイプを指定します。
  • url - URL
  • oneTime - 指定日時
  • interval - 一定間隔
  • daily - 毎日
  • weekly - 毎週
  • monthly - 毎月
  • soap - SOAP
  • ftp - FTP
  • mail - メール
  • queue - メッセージキュー
name はい トリガー名を指定します。
userName いいえ トリガーのユーザー名を指定します。
指定しなかった場合はログインユーザーとなります。

リクエスト例
GET /mcapi/trigger/show?type=url&name=URL0001 HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

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

実行結果
実行に成功するとトリガーの詳細情報が返ります。
指定したパラメーターで複数のトリガーを取得した場合、結果が配列で返ります。
各種トリガーの共通の情報として、次の情報が取得できます。
実行結果(URLの場合)
URLの個別の情報としては次の情報が取得できます。
{
    "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の場合)

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の場合)

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 必要なサービスが起動していなかった場合

▲ このページのトップへ

機能名: create

説明

トリガーの情報を追加します。
管理者の場合、すべてのユーザーのトリガーを追加できます。
管理者以外の場合、自分のトリガーのみを追加できます。

権限

administrator、developer

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/trigger/create
リクエストパラメーター
パラメーター 必須 説明
userName いいえ トリガーのユーザー名を指定します。
指定しなかった場合はログインユーザーとなります。
リクエスト例
設定する情報は、showの設定情報と同じ形式でリクエストのボディに設定します。
ただし、次の項目はshowの場合と異なります。
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
    }
}
レスポンス
HTTPステータスコード

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 プロセス情報の解析に失敗した場合

▲ このページのトップへ

機能名: update

説明

トリガーの情報を変更します。
管理者の場合、すべてのユーザーのトリガーを変更できます。
管理者以外の場合、自分のトリガーのみを変更できます。

権限

administrator、developer

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/trigger/update
リクエストパラメーター
パラメーター 必須 説明
type はい トリガーのタイプを指定します。
  • url - URL
  • oneTime - 指定日時
  • interval - 一定間隔
  • daily - 毎日
  • weekly - 毎週
  • monthly - 毎月
  • soap - SOAP
  • ftp - FTP
  • mail - メール
  • queue - メッセージキュー
name はい トリガー名を指定します。
userName いいえ トリガーのユーザー名を指定します。
指定しなかった場合はログインユーザーとなります。

リクエスト例
設定する情報は、createの設定情報と同じ形式でリクエストのボディに設定します。
ログインユーザーの指定したトリガーの情報を変更します。しかし、タイプを変更することはできません。
トリガー名(name)は指定されなかった場合変更しません。
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
    }
}
レスポンス
HTTPステータスコード

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 名前の重複しているトリガーが存在していた場合

▲ このページのトップへ

機能名: execute

説明

トリガーを実行します。
トリガーの実行を開始すると、その終了を待たずに直ちにAPIの実行が完了します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/trigger/execute
リクエストパラメーター
パラメーター 必須 説明
type はい トリガーのタイプを指定します。
  • oneTime - 指定日時
  • interval - 一定間隔
  • daily - 毎日
  • weekly - 毎週
  • monthly - 毎月
  • mail - メール
  • queue - メッセージキュー
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
レスポンス
HTTPステータスコード

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 名前の重複しているトリガーが存在していた場合

▲ このページのトップへ

機能名: delete

説明

トリガーを削除します。
管理者の場合、すべてのユーザーのトリガーを削除できます。
管理者以外の場合、自分のトリガーのみを削除できます。

権限

administrator、developer

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/trigger/delete
リクエストパラメーター
パラメーター 必須 説明
type はい トリガーのタイプを指定します。
  • url - URL
  • oneTime - 指定日時
  • interval - 一定間隔
  • daily - 毎日
  • weekly - 毎週
  • monthly - 毎月
  • soap - SOAP
  • ftp - FTP
  • mail - メール
  • queue - メッセージキュー
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
レスポンス
HTTPステータスコード

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 名前の重複しているトリガーが存在していた場合

▲ このページのトップへ

機能名: status/set

説明

トリガーを「有効」または「無効」に設定します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/trigger/status/set
リクエストパラメーター
パラメーター 必須 説明
type はい トリガーのタイプを指定します。
  • url - URL
  • oneTime - 指定日時
  • interval - 一定間隔
  • daily - 毎日
  • weekly - 毎週
  • monthly - 毎月
  • soap - SOAP
  • ftp - FTP
  • mail - メール
  • queue - メッセージキュー
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
レスポンス
HTTPステータスコード

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 名前の重複しているトリガーが存在していた場合

▲ このページのトップへ