2.5.7 サービスの実行
機能
指定したサービスを実行します。
実行権限
Adminロール,Developロール,Modifyロール,Submitロール
APIのバージョン
v1
リクエスト形式
POST http://host:port/Automation/version/objects/Services/id/actions/submit/invoke
リクエストボディーの構造は,次のようになっています。
{ "name" : "submit", "href" : "http://host:port/Automation/version/objects/Services/id/actions/submit/invoke", "method" : "POST", "parameters" : [ {...} ] }
リクエストのスキーマで「parameters」のメンバーとして指定できるオブジェクトを,次の表で説明します。
機能 |
リソース名称 |
数 |
説明 |
---|---|---|---|
スケジュール |
Schedule |
1 |
サービスの実行予定 |
プロパティ値の一覧 |
PropertyValue |
0~n |
サービスの入力プロパティ |
これらのオブジェクトに指定必須のプロパティについて,次に説明します。どのタイミング(即時実行,指定日時実行または定期実行)でサービスを実行する場合でも,プロパティに次のメンバーを指定できます。
リソース名称 |
メンバー名 |
数 |
---|---|---|
Schedule |
name |
1 |
description |
||
scheduleType |
||
PropertyValue |
keyName |
0~n |
value |
指定日時実行または定期実行の場合は,プロパティに次のメンバーを指定できます。
リソース名称 |
メンバー名 |
数 |
プロパティの指定可否 |
---|---|---|---|
Schedule |
scheduledStartTime |
1 |
指定日時実行の場合に指定できます。 |
recurrenceInterval |
定期実行の場合に指定できます。 |
||
recurrenceMinutes |
|||
recurrenceDayOfWeek |
|||
recurrenceDayOfMonth |
|||
recurrenceLastDayOfMonth |
|||
recurrenceStartDate |
|||
recurrenceTime |
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
---|---|---|
200 |
OK |
成功しました。 |
400 |
Bad Request |
引数が不正です。 |
401 |
Unauthorized |
ログイン権限がありません。 |
403 |
Forbidden |
サービス実行権限がありません。 |
404 |
Not found |
サービス取得権限がありません。または,サービスがありません。 |
412 |
Precondition failed |
サーバが利用できません。 |
500 |
Server-side error |
サーバ処理エラーが発生しました。 |
レスポンスのスキーマ
リクエストに対するレスポンスボディーの構造は,次のようになっています。
{ "instanceId" : "instance-id", "created" : "created-date-and-time", "updated" : "updated-date-and-time", "completed" : "completed-date-and-time", "state" : "state", "affectedResources" : [ {...} ] }
「affectedResources」のメンバーとして出力されるオブジェクトを,次の表で説明します。
出力 |
リソース名称 |
数 |
説明 |
---|---|---|---|
作成されたスケジュールへのリンク |
String |
1 |
作成されたスケジュール機能のリソース(Schedules)へのリンク |
作成されたタスクへのリンク |
String |
作成されたタスク機能のリソース(Tasks)へのリンク |
使用例
instanceID=2015のサービスを実行する場合の使用例を示します。
リクエストヘッダー: POST /Automation/v1/objects/Services/2015/actions/submit/invoke HTTP/1.1 Host: 10.196.184.182:22015 Accept: application/json Content-Type: application/json Content-Length: 811 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: useragent1 Accept-Language: ja レスポンスヘッダー: HTTP/1.1 200 OK Date: Mon, 14 Jul 2014 11:45:34 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 72fe74c462e2a50793542df0c0589289ce3f3_Vlo8Y30JdDBUB3ljJSVPaRtjBSA=_V0810 Access-Control-Allow-Origin: * Access-Control-Allow-Methods: GET, POST, DELETE, PUT, HEAD, OPTIONS Access-Control-Allow-Credentials: true Cache-Control: no-cache Transfer-Encoding: chunked Content-Type: application/json レスポンスボディー: { "instanceID" : "3d9069ca-444f-4757-b0c5-a57ddd7d44cf", "created" : "2014-07-14T04:45:35.293-0700", "updated" : "2014-07-14T04:45:35.293-0700", "completed" : "2014-07-14T04:45:35.293-0700", "state" : "success", "affectedResource" : [ "http://10.196.184.182:22015/Automation/v1/objects/Schedules/2025", "http://10.196.184.182:22015/Automation/v1/objects/Tasks/2026" ] }