6.6.1 API構成要素の一覧
API,リソース,オブジェクト,および定数の一覧を示します。
- 〈この項の構成〉
(1) API一覧
使用できるAPIの一覧を次の表に示します。
項番 |
分類 |
API |
説明 |
API種別 |
参照先 |
---|---|---|---|---|---|
1 |
ユニット情報の取得 |
ユニット一覧の取得 |
指定したユニット,またはユニット配下のジョブグループ,ジョブネット,およびジョブの情報を取得します。 |
SC-004 |
|
2 |
ユニット情報の取得 |
指定したユニットの情報を取得します。 |
SC-007 |
||
3 |
実行結果詳細の取得 |
実行が終了したジョブの,実行結果詳細を取得します。 |
SC-010 |
||
4 |
待ち合わせ条件の状態一覧の取得 |
指定したユニットの待ち合わせ条件と,待ち合わせ条件に設定されている待ち合わせ対象ユニットの状態の一覧を取得します。 |
SC-046 |
||
5 |
ジョブネットの実行登録および実行登録解除 |
計画実行登録 |
指定したジョブネットを計画実行登録します。 |
SC-017 |
|
6 |
確定実行登録 |
指定したジョブネットを確定実行登録します。 |
SC-018 |
||
7 |
即時実行登録 |
指定したジョブネットを即時実行登録します。 |
SC-019 |
||
8 |
登録解除 |
指定した実行登録中のジョブネットの実行登録を解除します。 |
SC-020 |
||
9 |
ユニットの操作 |
保留属性変更 |
指定したジョブネットやジョブの保留属性を変更します。 |
SC-012 |
|
10 |
遅延監視変更 |
指定した実行登録済みのジョブネットの遅延監視の設定を,一時的に変更します。 |
SC-024 |
||
11 |
ジョブ状態変更 |
指定したジョブの状態を変更します。 |
SC-025 |
||
12 |
計画一時変更(日時変更) |
指定した実行登録済みのジョブネットの実行開始予定日時を,一時的に変更します。 |
SC-026 |
||
13 |
計画一時変更(即時実行) |
指定した実行登録済みのジョブネットの実行スケジュールを一時的に変更し,即時実行します。 |
SC-027 |
||
14 |
計画一時変更(実行中止) |
指定した実行登録済みのジョブネットの実行スケジュールを一時的に変更し,実行を中止します。 |
SC-028 |
||
15 |
計画一時変更(変更解除) |
ユニットの実行スケジュールの一時的な変更を解除し,変更前の情報に戻します。 |
SC-029 |
||
16 |
中断 |
指定した実行中のルートジョブネットを中断します。 |
SC-030 |
||
17 |
強制終了 |
指定した実行中のジョブおよびルートジョブネットを強制終了します。 |
SC-031 |
||
18 |
再実行 |
指定したジョブネットやジョブを再実行します。 |
SC-032 |
||
19 |
待ち合わせ状態の変更 |
指定したユニットの待ち合わせ状態を一時的に変更します。 |
SC-047 |
||
20 |
実行順序制御方式の変更 |
指定したルートジョブネットの実行順序制御方式を一時的に変更します。 |
SC-045 |
||
21 |
実行エージェントの操作 |
実行エージェントの状況一覧の取得 |
接続先のJP1/AJS3 - Managerに登録されている実行エージェントの状況一覧を取得します。 |
AG-001 |
|
22 |
実行エージェントの状況の取得 |
接続先のJP1/AJS3 - Managerに登録されている実行エージェントの状況を取得します。 |
AG-002 |
||
23 |
実行エージェントの定義の取得 |
接続先のJP1/AJS3 - Managerに登録されている実行エージェントの定義を取得します。 |
AG-003 |
||
24 |
実行エージェントの追加 |
接続先のJP1/AJS3 - Managerに実行エージェントを追加します。 |
AG-004 |
||
25 |
実行エージェントの削除 |
接続先のJP1/AJS3 - Managerから,指定した実行エージェントを削除します。 |
AG-005 |
||
26 |
実行エージェントの設定変更 |
接続先のJP1/AJS3 - Managerに登録されている実行エージェントの設定を変更します。 |
AG-006 |
||
27 |
実行エージェントの受付配信制限の状態の変更 |
接続先のJP1/AJS3 - Managerに登録されている実行エージェントの受付配信制限の状態を変更します。 |
AG-007 |
||
28 |
実行エージェントの状態の変更 |
接続先のJP1/AJS3 - Managerに登録されている実行エージェントの状態を変更します。 |
AG-008 |
||
29 |
ジョブ配信遅延の軽減機能の通信状態確認 |
接続先のJP1/AJS3 - Managerホストで,ジョブ配信遅延の軽減機能の通信状態の確認操作をします。 |
AG-016 |
||
30 |
実行エージェントグループの状況一覧の取得 |
接続先のJP1/AJS3 - Managerに登録されている実行エージェントグループの状況一覧を取得します。 |
AG-009 |
||
31 |
実行エージェントグループの定義の取得 |
接続先のJP1/AJS3 - Managerに登録されている実行エージェントグループの定義を取得します。 |
AG-010 |
||
32 |
実行エージェントグループの追加 |
接続先のJP1/AJS3 - Managerに実行エージェントグループを追加します。 |
AG-011 |
||
33 |
実行エージェントグループの削除 |
接続先のJP1/AJS3 - Managerから,指定した実行エージェントグループを削除します。 |
AG-012 |
||
34 |
実行エージェントグループの設定変更 |
接続先のJP1/AJS3 - Managerに設定されている実行エージェントグループの設定を変更します。 |
AG-013 |
||
35 |
実行エージェントグループの受付配信制限の状態の変更 |
接続先のJP1/AJS3 - Managerに登録されている実行エージェントグループの受付配信制限の状態を変更します。 |
AG-014 |
||
36 |
実行エージェントの除外,追加,優先順位の変更 |
接続先のJP1/AJS3 - Managerに登録されている実行エージェントグループに対して,実行エージェントの除外,追加,または優先順位の変更をします。 |
AG-015 |
||
37 |
その他 |
バージョン情報の取得 |
製品のバージョン情報を取得します。 |
OT-003 |
|
38 |
JP1/AJS3 - Managerのプロトコルバージョンの取得 |
接続先JP1/AJS3 - Managerのプロトコルバージョンを取得します。 |
OT-005 |
(2) リソース一覧
使用できるリソースの一覧を次の表に示します。
項番 |
リソース |
説明 |
参照先 |
---|---|---|---|
1 |
ステータス監視のリソース |
ステータス監視をするためのユニットや世代の情報を表します。ステータス監視のリソースは,次のオブジェクトを含みます。
|
|
2 |
ユニット定義のリソース |
ユニット定義のリソースを表します。このリソースはジョブネットを実行登録するAPIなどで指定します。 |
なし |
(3) オブジェクト一覧
使用できるオブジェクトの一覧を次の表に示します。
項番 |
オブジェクト |
説明 |
参照先 |
---|---|---|---|
1 |
ユニット定義情報 |
ユニット名やユニット種別などのユニット定義情報を表します。 |
|
2 |
ステータス情報 |
開始日時や状態などの,ユニットのステータス情報を表します。 |
|
3 |
リリース情報 |
リリース日時やリリースIDなどの,ユニットのリリース情報を表します。 |
|
4 |
起動条件パラメーター |
起動条件の回数や時間などの設定値を表します。 |
|
5 |
マクロ変数 |
マクロ変数名と引き継ぎ情報を表します。 |
|
6 |
実行エージェントの操作結果 |
実行エージェント,または実行エージェントグループを操作した結果を表します。 |
|
7 |
実行エージェント定義情報 |
実行エージェント,または実行エージェントグループの定義情報を表します。 |
|
8 |
実行エージェントの状況 |
実行エージェント,または実行エージェントグループの状況を表します。 |
(4) 定数一覧
使用できる定数の一覧を次の表に示します。
項番 |
分類 |
定数 |
説明 |
参照先 |
---|---|---|---|---|
1 |
各種API共通で使用する定数 |
DateType |
開始終了日時の指定種別を表します。 |
|
2 |
Status |
ユニットの状態を表します。 |
||
3 |
DelayStart |
開始遅延の有無を表します。 |
||
4 |
DelayEnd |
終了遅延の有無を表します。 |
||
5 |
ユニット一覧の取得APIで使用する定数 |
LowerType |
指定したユニット配下のユニットの取得方法を表します。 |
|
6 |
SearchTargetType |
取得対象のユニットの範囲を表します。 |
||
7 |
MatchMethods |
文字列の比較方法を表します。 |
||
8 |
UnitType |
ユニット種別を表します。 |
||
9 |
GenerationType |
世代の取得方法を表します。 |
||
10 |
UnitStatus |
ユニット状態を表します。 |
||
11 |
DelayType |
開始遅延または終了遅延の指定有無を表します。 |
||
12 |
HoldPlan |
保留予定の有無を表します。 |
||
13 |
ReleaseInfoSearchMethods |
リリース情報の取得方法を表します。 |
||
14 |
実行登録APIで使用する定数 |
PlannedTimePassedType |
スケジューラーサービス起動時および実行登録時に予定時刻を超過していたユニットの実行のタイミングを表します。 |
|
15 |
ユニット定義情報のオブジェクトで使用する定数 |
Type |
ユニットの種別を表します。 |
|
16 |
RegisterStatus |
ユニットの登録状態を表します。 |
||
17 |
ステータス情報のオブジェクトで使用する定数 |
ChangeType |
計画一時変更の有無を表します。 |
|
18 |
HoldAttr |
保留属性を表します。 |
||
19 |
TimeType |
起動条件の有効範囲の時間種別を表します。 |
||
20 |
Waiting |
成立していない待ち合わせ条件の有無を示します。 |
||
21 |
DelayMonitor |
ジョブネットの遅延監視方法を示します。 |
||
22 |
MonitoringJobnet |
ジョブネットの実行所要時間による終了遅延の監視の方法を示します。 |
||
23 |
ExecOrderMethod |
ジョブネットの実行順序制御方式を示します。 |
||
24 |
リリース情報のオジェクトで使用する定数 |
ReleaseStatus |
リリース状態を表します。 |
|
25 |
起動条件パラメーターのオブジェクトで使用する定数 |
TimeType |
起動条件の有効範囲の時間の種別を表します。 |
|
26 |
保留属性変更で使用する定数 |
ChangeHoldAttr |
保留属性の変更を表します。 |
|
27 |
計画一時変更で使用する定数 |
ChangeStartTimeType |
計画一時変更するときの,実行開始日時の種類を表します。 |
|
28 |
ChangePushedAheadType |
計画一時変更するときの,前倒しの動作を表します。 |
||
29 |
ChangeLowerType |
計画一時変更するとき,配下のジョブネットの開始日時をずらすかどうかを表します。 |
||
30 |
再実行で使用する定数 |
RootRerunType |
ルートジョブネットを再実行する方法を表します。 |
|
31 |
RerunType |
ネストジョブネットまたはジョブを再実行する方法を表します。 |
||
32 |
RerunOption |
再実行のオプションを表します。 |
||
33 |
遅延監視変更で使用する定数 |
DelayMonitorType |
ジョブネットの遅延監視方法を表します。 |
|
34 |
MonitoringJobnetType |
ジョブネットの実行所要時間による終了遅延の監視方法を表します。 |
||
35 |
ジョブ状態変更で使用する定数 |
ChangeStatus |
ジョブの変更後の状態を表します。 |
|
36 |
待ち合わせで使用する定数 |
WaitMethod |
待ち合わせが成立する条件を示します。 |
|
37 |
WaitingAction |
待ち合わせ条件付きユニットの動作を示します。 |
||
38 |
WaitingStatus |
待ち合わせ条件付きユニットと待ち合わせ対象ユニットの待ち合わせの状態を示します。 |
||
39 |
WaitingStatusAction |
待ち合わせを有効化するか無効化するかを示します。 |
||
40 |
実行エージェントのオブジェクトで使用する定数 |
ExecAgentStatus |
実行エージェント,または実行エージェントグループの受付配信制限の状態を表します。 |
|
41 |
ComStatus |
実行エージェントの状態を表します。 |
||
42 |
実行順序制御方式の変更APIで使用する定数 |
ChangeExecOrderMethod |
変更後の実行順序制御方式を示します。 |
|
43 |
ユニット情報の取得APIで使用する定数 |
ConnectInfoType |
ステータス監視リソースの「ステータス情報オブジェクト(unitStatus)」を取得するときに,接続情報を取得するか,接続情報を取得しないかを表します。 |