6.6.1 List of API configuration components
The following lists and describes the APIs, resources, objects, and constants.
- Organization of this subsection
(1) List of APIs
The following table lists and describes the APIs that can be used.
No. |
Category |
API |
Description |
API type |
See |
---|---|---|---|---|---|
1 |
Unit information acquisition |
Unit list acquisition |
Acquires information about the jobnet groups, jobnets, and jobs of the specified unit or under the specified unit. |
SC-004 |
|
2 |
Unit information acquisition |
Acquires information about the specified unit. |
SC-007 |
||
3 |
Execution result details acquisition |
Acquires details about the job for which execution has ended. |
SC-010 |
||
4 |
Execution registration of a jobnet and cancellation of the execution registration |
Planned execution |
Performs planned execution registration of the specified jobnet. |
SC-017 |
|
5 |
Fixed execution |
Performs fixed execution registration of the specified jobnet. |
SC-018 |
||
6 |
Immediate execution |
Performs immediate execution registration of the specified jobnet. |
SC-019 |
||
7 |
Registration cancellation |
Cancels the execution registration of the specified jobnet for which execution registration has been performed. |
SC-020 |
||
8 |
Unit operation |
Change hold attribute |
Changes the hold attribute of the specified jobnet or job. |
SC-012 |
|
9 |
Change delay monitor |
Temporarily changes the delay monitoring settings for the specified jobnet registered for execution. |
SC-024 |
||
10 |
Change job status |
Changes the status of the specified job. |
SC-025 |
||
11 |
Change plan (change time) |
Temporarily changes the scheduled execution start time of the specified jobnet registered for execution. |
SC-026 |
||
12 |
Change plan (execute immediately) |
Temporarily changes the execution schedule of the specified jobnet registered for execution, and then immediately executes the jobnet. |
SC-027 |
||
13 |
Change plan (execution prohibited) |
Temporarily changes the execution schedule of the specified jobnet registered for execution, and then prohibits execution. |
SC-028 |
||
14 |
Change plan (release change) |
Releases the temporary change in the execution schedule of the unit to resume according to the information before the change. |
SC-029 |
||
15 |
Interrupt |
Interrupts the specified root jobnet being executed. |
SC-030 |
||
16 |
Kill |
Kills the specified job and root jobnet that are being executed. |
SC-031 |
||
17 |
Rerun |
Reruns the specified jobnet or job. |
SC-032 |
||
18 |
Other |
Version information acquisition |
Acquires the version information of the product. |
OT-003 |
|
19 |
JP1/AJS3 - Manager protocol version acquisition |
Acquires the protocol version of connection-destination JP1/AJS3 - Manager. |
OT-005 |
(2) List of resources
The following table lists and describes the resources that can be used.
No. |
Resource |
Description |
See |
---|---|---|---|
1 |
Resource for status monitoring |
Indicates the unit for status monitoring, or generation information. The resource for status monitoring contains the following objects:
|
|
2 |
Resource for unit definition |
Indicates the resource for unit definition. This resource is specified for the API for which execution registration of the jobnet is performed. |
None |
(3) List of objects
The following table lists and describes the objects that can be used.
No. |
Object |
Description |
See |
---|---|---|---|
1 |
Unit definition information |
Indicates the unit definition information, such as the unit name and unit type. |
|
2 |
Status information |
Indicates the status information of a unit, such as the start time and status. |
|
3 |
Release information |
Indicates the release information of a unit, such as the release date and release ID. |
|
4 |
Start condition parameter |
Indicates the setting values, such as the count and time in the start condition. |
|
5 |
Macro variable |
Indicates the macro variable name and passing information. |
(4) List of constants
The following table lists and describes the constants that can be used.
No. |
Category |
Constant |
Description |
See |
---|---|---|---|---|
1 |
Constant commonly used by various APIs |
DateType |
Indicates the type of specifying the start and end times. |
|
2 |
Constants used by the unit list acquisition API |
LowerType |
Indicates how to acquire the units under the specified unit. |
|
3 |
SearchTargetType |
Indicates the range of the units to be acquired. |
||
4 |
MatchMethods |
Indicates how to collate the character string. |
||
5 |
UnitType |
Indicates the unit type. |
||
6 |
GenerationType |
Indicates how to acquire the generation. |
||
7 |
UnitStatus |
Indicates the unit status. |
||
8 |
DelayType |
Indicates whether the start delay or end delay is specified. |
||
9 |
HoldPlan |
Indicates whether there is a hold plan. |
||
10 |
ReleaseInfoSearchMethods |
Indicates how to acquire release information. |
||
11 |
Constant used by the execution registration API |
PlannedTimePassedType |
Indicates the execution timing of the unit for which the planned time has passed when the scheduler service starts and when the execution registration is performed. |
|
12 |
Constants used by the unit definition information object |
Type |
Indicates the unit type. |
|
13 |
RegisterStatus |
Indicates the registration status of the unit. |
||
14 |
Constants used by the status information object |
Status |
Indicates the unit status. |
|
15 |
DelayStart |
Indicates whether the start delayed. |
||
16 |
DelayEnd |
Indicates whether the end delayed. |
||
17 |
ChangeType |
Indicates whether the plan was temporarily changed. |
||
18 |
HoldAttr |
Indicates the hold attribute. |
||
19 |
HoldPlan |
Indicates whether there is a hold plan. |
||
20 |
ExecutionType |
Indicates the registration type. |
||
21 |
StatusInSummary |
Indicates the summary (status category and whether a delay occurred). |
||
22 |
TimeType |
Indicates the time type for the valid range of start condition. |
||
23 |
JobnetDelayMonitorType |
Indicates the method of monitoring delays for jobnets. |
||
24 |
TimeRequiredForExecutionType |
Indicates whether jobnet execution end delays are monitored based on the time required for jobnet execution. |
||
25 |
Constant used by the release information object |
ReleaseStatus |
Indicates the release status. |
|
26 |
Constant used by the start condition parameter object |
TimeType |
Indicates the time type for the valid range of start condition. |
|
27 |
Constant used for changing the hold attribute |
ChangeHoldAttr |
Indicates a change in the hold attribute. |
|
28 |
Constants used for temporarily changing a plan |
ChangeStartTimeType |
Indicates the type of execution start time when the plan is temporarily changed. |
|
29 |
ChangePushedAheadType |
Indicates how the schedule is pushed ahead when the plan is temporarily changed. |
||
30 |
ChangeLowerType |
Indicates whether to change the start time of lower jobnets when the plan is temporarily changed. |
||
31 |
Constants used by the rerun API |
RootRerunType |
Indicates how to rerun a root jobnet. |
|
32 |
RerunType |
Indicates how to rerun a nested jobnet or job. |
||
33 |
RerunOption |
Indicates the rerun option. |
||
34 |
Constants used for changing delay monitoring |
DelayMonitorType |
Indicates the method of monitoring delays for jobnets. |
|
35 |
MonitoringJobnetType |
Indicates the method of end delay monitoring based on the time required for executing the jobnet. |
||
36 |
Constant used for job status change |
ChangeStatus |
Indicates the job status after the change. |