7.1.12　計画一時変更（日時変更）API

指定した実行登録済みのジョブネットの実行開始予定日時を，一時的に変更します。変更した内容で実行したあとは，ジョブネットに定義されたスケジュールに従って実行します。

実行開始予定日時の一時変更の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド　4.5.3 ジョブネットの実行日時を一時変更する」を参照してください。

このAPIは，JP1/AJS3 - Web Consoleのバージョンが11-10以降のときに使用できます。バージョン情報の取得APIの戻り値（productVersionNumber）が111000以上であることを確認して，使用してください。

実行権限

ログインしたJP1ユーザーが，計画一時変更（日時変更）するユニットに対して，次に示すどれかのJP1権限が与えられている必要があります。

JP1_AJS_Admin権限
JP1_AJS_Manager権限
JP1_AJS_Operator権限

リクエストの形式

リクエスト行

POST /application/component/apiVersion/objects/statuses/unitName:execID/actions/changeStartTime/invoke httpVersion

メッセージボディ

{
  "parameters":{
    "manager":"マネージャーホスト名またはIPアドレス",
    "serviceName":"スケジューラーサービス名",
    "kindTime":"実行開始日時の種類",
    "absoluteTime":"実行開始日時",
    "relativeSign":"実行開始日時を相対指定する場合の記号",
    "relativeDay":実行開始日時を相対指定する場合の相対日,
    "relativeTime":"実行開始日時を相対指定する場合の相対時刻",
    "pushedAhead":"開始時間を前倒しにするときの動作",
    "changeLower":"配下のジョブネットの開始日時の動作"
  }
}

APIのバージョン

リソースを一意に識別する情報

リソースを一意に識別する情報を次の表に示します。

なお，パラメーターの指定に誤りがある場合，またはパラメーターを指定しなかった場合は，リソースを一意に識別できないため，ステータスコード「404」のエラーになります。

リソースを一意に識別する情報	データ型	値の説明	必須・任意
unitName	string	要求対象のユニットのユニット完全名を，1〜930バイトの文字列で指定します。	必須
execID	string	実行IDを，文字列で指定します。指定する形式は「`@[`mmmm`]{`A〜Z`}`nnnn」です（例：`@10A200`）`。`	必須

リソースを一意に識別する情報

データ型

値の説明

必須・任意

unitName

string

要求対象のユニットのユニット完全名を，1〜930バイトの文字列で指定します。

必須

execID

string

実行IDを，文字列で指定します。

指定する形式は「@[mmmm]{A〜Z}nnnn」です（例：@10A200）。

必須

パラメーター

リクエストのメッセージボディのparametersに指定するパラメーターを次の表に示します。

表7‒12　計画一時変更（日時変更）APIのパラメーター一覧
パラメーター	データ型	値の説明	必須・任意
`manager`	string	マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。	必須
`serviceName`	string	スケジューラーサービス名を，1〜30バイトの文字列で指定します。	必須
`kindTime`	string	実行開始日時を，絶対日時で指定するか相対日時で指定するか，定数`ChangeStartTimeType`に規定されている文字列定数で指定します。定数`ChangeStartTimeType`の詳細については，「7.4.9(1) ChangeStartTimeType」を参照してください。	必須
`absoluteTime`^※1	string	実行開始日時を絶対日時で指定する場合，実行開始日時を「YYYY`-`MM`-`DD`T`hh`:`mm」の形式で指定します。指定する日時は，要求先JP1/AJS3 - Managerのスケジューラーサービスローカル日時で指定してください。指定できる値を次に示します。 YYYY：年を指定します。年に指定できる値は，1994〜2036（単位：年）です。 MM：月を指定します。月に指定できる値は，01〜12（単位：月）です。 DD：日にちを指定します。日にちに指定できる値は，01〜指定した月の最終日（単位：日）です。 hh：時間を指定します。時間に指定できる値は，00〜47（単位：時）です。 mm：分を指定します。分に指定できる値は，00〜59（単位：分）です。パラメーター`kindTime`で「`ABSOLUTETIME`（絶対日時を指定する）」を指定した場合だけ，このパラメーターを指定できます。パラメーター`kindTime`で「`RELATIVETIME`（相対日時を指定する）」を指定した場合，このパラメーターの指定は無視されます。	任意
`relativeSign`^※2	string	変更前の実行開始日時を基準に実行開始日時を相対指定する場合，変更前の実行開始日時より後ろに変更するか，前に変更するかを「`+`」または「`-`」で指定します。 `+`：実行開始日時を，変更前の実行開始日時より後ろに変更します。 `-`：実行開始日時を，変更前の実行開始日時より前に変更します。パラメーター`kindTimeで`「`RELATIVETIME`（相対日時を指定する）」を指定した場合だけ，このパラメーターを指定できます。パラメーター`kindTime`で「`ABSOLUTETIME`（絶対日時を指定する）」を指定した場合，このパラメーターの指定は無視されます。	任意
`relativeDay`^※2，※3	int	変更前の実行開始日時を基準に実行開始日時を相対指定する場合，相対日を指定します。相対日は0〜99の範囲の数値を指定します。指定する日時は，要求先JP1/AJS3 - Managerのスケジューラーサービスローカル日時で指定してください。パラメーター`kindTime`で「`RELATIVETIME`（相対日時を指定する）」を指定した場合だけ，このパラメーターを指定できます。パラメーター`kindTime`で「`ABSOLUTETIME`（絶対日時を指定する）」を指定した場合，このパラメーターの指定は無視されます。	任意
`relativeTime`^※2，※3	string	変更前の実行開始日時を基準に実行開始日時を相対指定する場合，相対時刻を指定します。相対時刻は「hh`:`mm」の形式で指定します。指定する時刻は，要求先JP1/AJS3 - Managerのスケジューラーサービスローカル日時で指定してください。指定できる値を次に示します。 hh：時間を指定します。時間に指定できる値は，00〜47（単位：時）です。 mm：分を指定します。分に指定できる値は，00〜59（単位：分）です。パラメーター`kindTimeで`「`RELATIVETIME`（相対日時を指定する）」を指定した場合だけ，このパラメーターを指定できます。パラメーター`kindTimeで`「`ABSOLUTETIME`（絶対日時を指定する）」を指定した場合，このパラメーターの指定は無視されます。	任意
`pushedAhead`	string	ルートジョブネットの場合で，開始時間を前倒しに変更するとき，変更前の開始時間に実行予定を追加するかどうかを，定数`ChangePushedAheadType`に規定されている文字列定数で指定します。定数`ChangePushedAheadType`の詳細については，「7.4.9(2) ChangePushedAheadType」を参照してください。このパラメーターを指定しなかった場合，またはこのパラメーターに「`null`」を指定した場合は，「`ADD`（次回予定追加）」が仮定されます。このパラメーターは，計画一時変更（日時変更）するユニットが，ルートジョブネットの場合だけ有効です。ルートジョブネット以外の場合，このパラメーターの指定は無視されます。	任意
`changeLower`	string	指定したジョブネット配下のネストジョブネットの開始日時を連動して変更するかどうかを，定数`ChangeLowerType`に規定されている文字列定数で指定します。定数`ChangeLowerType`の詳細については，「7.4.9(3) ChangeLowerType」を参照してください。このパラメーターを指定しなかった場合，またはこのパラメーターに「`null`」を指定した場合は，「`NOTSHIFT`（配下のジョブネットの開始日時は変更しない）」が仮定されます。	任意

注※1

絶対日時を指定して日時変更する場合は，パラメーターabsoluteTimeを指定してください。省略した場合（nullを指定した場合を含む），エラーになります。

注※2

相対日時を指定して日時変更する場合は，パラメーターrelativeSign，relativeDayおよびrelativeTimeをすべて指定してください。どれか一つでも省略した場合（nullを指定した場合を含む），エラーになります。

注※3

相対日時を指定して日時変更する場合は，相対日時が1分以上になるように値を指定してください。パラメーターrelativeDayに0，relativeTimeに"00:00"を指定するとエラーになります。

ステータスコード

レスポンスで返却するステータスコードを次の表に示します。

ステータスコード	メッセージ	説明
200	OK	計画一時変更（日時変更）が成功しました。
400	Bad Request	引数が不正です。
401	Unauthorized	認証が必要です。
403	Forbidden	実行権限がありません。
404	Not found	リソースにアクセスする権限がありません。または，リソースがありません。
409	Conflict	リクエストは現在のリソースの状態と矛盾しているため，処理を続行できません。
412	Precondition failed	Web Consoleサーバが利用できません。
500	Server-side error	Web Consoleサーバ処理エラーが発生しました。

戻り値

なし（レスポンスのメッセージボディのサイズは0バイトです）

使用例1

指定したルートジョブネットの実行開始日時を，絶対日時で指定して変更するAPIの使用例を次に示します。

リクエストの例

POST /ajs/api/v1/objects/statuses/%2FJobGroup%2FJobnet:%40A100/actions/changeStartTime/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "kindTime":"ABSOLUTETIME",
    "absoluteTime":"2016-09-07T08:30",
    "pushedAhead":"ADD",
    "changeLower":"NOTSHIFT"
  }
}

レスポンスの例

HTTP/1.1 200 OK
Content-Type: text/plain
Cache-Control: no-store, no-cache, max-age=0
Date: Mon, 08 Aug 2016 09:39:28 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server

使用例2

指定したネストジョブネットの実行開始日時を，相対日時で指定して変更するAPIの使用例を次に示します。

リクエストの例

POST /ajs/api/v1/objects/statuses/%2FJobGroup%2FJobnet%2FNestJobnet:%40A100/actions/changeStartTime/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "kindTime":"RELATIVETIME",
    "relativeSign":"-",
    "relativeDay":0,
    "relativeTime":"01:00",
    "changeLower":"NOTSHIFT"
  }
}

レスポンスの例

HTTP/1.1 200 OK
Content-Type: text/plain
Cache-Control: no-store, no-cache, max-age=0
Date: Mon, 08 Aug 2016 09:39:28 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server

使用例3

実行予定のないネストジョブネットを指定して，実行予定を追加するAPIの使用例を次に示します。

なお，実行予定のあるネストジョブネットを指定した場合，実行開始日時が変更されることに注意してください。

リクエストの例

POST /ajs/api/v1/objects/statuses/%2FJobGroup%2FJobnet%2FNestJobnet:%40A100/actions/changeStartTime/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "kindTime":"ABSOLUTETIME",
    "absoluteTime":"2016-09-07T08:30"
  }
}

レスポンスの例

HTTP/1.1 200 OK
Content-Type: text/plain
Cache-Control: no-store, no-cache, max-age=0
Date: Mon, 08 Aug 2016 09:39:28 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server

ページの先頭へ

7.1.12 計画一時変更（日時変更）API

7.1.12　計画一時変更（日時変更）API