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 |
Wait condition status list acquisition |
Acquires a list of the wait conditions for the specified unit and the statuses of the units that are specified in the wait conditions as the units whose end is to be waited for. |
SC-046 |
||
5 |
Execution registration of a jobnet and cancellation of the execution registration |
Planned execution |
Performs planned execution registration of the specified jobnet. |
SC-017 |
|
6 |
Fixed execution |
Performs fixed execution registration of the specified jobnet. |
SC-018 |
||
7 |
Immediate execution |
Performs immediate execution registration of the specified jobnet. |
SC-019 |
||
8 |
Registration cancellation |
Cancels the execution registration of the specified jobnet for which execution registration has been performed. |
SC-020 |
||
9 |
Unit operation |
Change hold attribute |
Changes the hold attribute of the specified jobnet or job. |
SC-012 |
|
10 |
Change delay monitor |
Temporarily changes the delay monitoring settings for the specified jobnet registered for execution. |
SC-024 |
||
11 |
Change job status |
Changes the status of the specified job. |
SC-025 |
||
12 |
Change plan (change time) |
Temporarily changes the scheduled execution start time of the specified jobnet registered for execution. |
SC-026 |
||
13 |
Change plan (execute immediately) |
Temporarily changes the execution schedule of the specified jobnet registered for execution, and then immediately executes the jobnet. |
SC-027 |
||
14 |
Change plan (execution prohibited) |
Temporarily changes the execution schedule of the specified jobnet registered for execution, and then prohibits execution. |
SC-028 |
||
15 |
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 |
||
16 |
Interrupt |
Interrupts the specified root jobnet being executed. |
SC-030 |
||
17 |
Kill |
Kills the specified job and root jobnet that are being executed. |
SC-031 |
||
18 |
Rerun |
Reruns the specified jobnet or job. |
SC-032 |
||
19 |
Wait status change |
Temporarily changes the wait status of the specified unit. |
SC-047 |
||
20 |
Execution order control method change |
Temporarily changes the execution order control method for the specified root jobnet. |
SC-045 |
||
21 |
Execution agent operation |
Execution agent status list acquisition |
Acquires a list of the statuses of the execution agents that are registered in the connection-destination JP1/AJS3 - Manager. |
AG-001 |
|
22 |
Execution agent status acquisition |
Acquires the statuses of the execution agents that are registered in the connection-destination JP1/AJS3 - Manager. |
AG-002 |
||
23 |
Execution agent definition acquisition |
Acquires the definitions of the execution agents that are registered in the connection-destination JP1/AJS3 - Manager. |
AG-003 |
||
24 |
Execution agent addition |
Adds an execution agent to the connection-destination JP1/AJS3 - Manager. |
AG-004 |
||
25 |
Execution agent deletion |
Deletes the specified execution agent from the connection-destination JP1/AJS3 - Manager. |
AG-005 |
||
26 |
Execution agent reconfiguration |
Changes the settings of an execution agent that is registered in the connection-destination JP1/AJS3 - Manager. |
AG-006 |
||
27 |
Change the job transfer restriction status of an execution agent |
Changes the job transfer restriction status of an execution agent that is registered in the connection-destination JP1/AJS3 - Manager. |
AG-007 |
||
28 |
Execution agent status change |
Changes the status of an execution agent that is registered in the connection-destination JP1/AJS3 - Manager. |
AG-008 |
||
29 |
Checks the communication status of the job distribution delay reduction function |
Checks the communication status of the job distribution delay reduction function on the connection-destination JP1/AJS3 - Manager host. |
AG-016 |
||
30 |
Execution agent group status list acquisition |
Acquires a list of the statuses of the execution agent groups that are registered in the connection-destination JP1/AJS3 - Manager. |
AG-009 |
||
31 |
Execution agent group definition acquisition |
Acquires the definitions of the execution agent groups that are registered in the connection-destination JP1/AJS3 - Manager. |
AG-010 |
||
32 |
Execution agent group addition |
Adds an execution agent group to the connection-destination JP1/AJS3 - Manager. |
AG-011 |
||
33 |
Execution agent group deletion |
Deletes the specified execution agent group from the connection-destination JP1/AJS3 - Manager. |
AG-012 |
||
34 |
Execution agent group reconfiguration |
Changes the settings of an execution agent group that is set in the connection-destination JP1/AJS3 - Manager. |
AG-013 |
||
35 |
Changes the job transfer restriction status of an execution agent group |
Changes the job transfer restriction status of an execution agent group that is registered in the connection-destination JP1/AJS3 - Manager. |
AG-014 |
||
36 |
Exclude or add execution agents, or to change their priority levels |
Excludes or adds execution agents for an execution agent group that is registered in the connection-destination JP1/AJS3 - Manager, or changes the priority level of such execution agents. |
AG-015 |
||
37 |
Other |
Version information acquisition |
Acquires the version information of the product. |
OT-003 |
|
38 |
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. |
|
6 |
Execution agent operation result |
Indicates the result of operating an execution agent or execution agent group. |
|
7 |
Execution agent definition information |
Indicates the definition information of an execution agent or execution agent group. |
|
8 |
Execution agent status |
Indicates the status of an execution agent or execution agent group. |
(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 |
Status |
Indicates the unit status. |
||
3 |
DelayStart |
Indicates whether the start delayed. |
||
4 |
DelayEnd |
Indicates whether the end delayed. |
||
5 |
Constants used by the unit list acquisition API |
LowerType |
Indicates how to acquire the units under the specified unit. |
|
6 |
SearchTargetType |
Indicates the range of the units to be acquired. |
||
7 |
MatchMethods |
Indicates how to collate the character string. |
||
8 |
UnitType |
Indicates the unit type. |
||
9 |
GenerationType |
Indicates how to acquire the generation. |
||
10 |
UnitStatus |
Indicates the unit status. |
||
11 |
DelayType |
Indicates whether the start delay or end delay is specified. |
||
12 |
HoldPlan |
Indicates whether there is a hold plan. |
||
13 |
ReleaseInfoSearchMethods |
Indicates how to acquire release information. |
||
14 |
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. |
|
15 |
Constants used by the unit definition information object |
Type |
Indicates the unit type. |
|
16 |
RegisterStatus |
Indicates the registration status of the unit. |
||
17 |
Constants used by the status information object |
ChangeType |
Indicates whether the plan was temporarily changed. |
|
18 |
HoldAttr |
Indicates the hold attribute. |
||
19 |
TimeType |
Indicates the time type for the valid range of start condition. |
||
20 |
Waiting |
Indicates whether there are wait conditions that have not been met. |
||
21 |
DelayMonitor |
Indicates the method of monitoring delays for jobnets. |
||
22 |
MonitoringJobnet |
Indicates the method of monitoring end delays based on the time required for jobnet execution. |
||
23 |
ExecOrderMethod |
Indicates the execution order control method of a jobnet. |
||
24 |
Constant used by the release information object |
ReleaseStatus |
Indicates the release status. |
|
25 |
Constant used by the start condition parameter object |
TimeType |
Indicates the time type for the valid range of start condition. |
|
26 |
Constant used for changing the hold attribute |
ChangeHoldAttr |
Indicates a change in the hold attribute. |
|
27 |
Constants used for temporarily changing a plan |
ChangeStartTimeType |
Indicates the type of execution start time when the plan is temporarily changed. |
|
28 |
ChangePushedAheadType |
Indicates how the schedule is pushed ahead when the plan is temporarily changed. |
||
29 |
ChangeLowerType |
Indicates whether to change the start time of lower jobnets when the plan is temporarily changed. |
||
30 |
Constants used by the rerun API |
RootRerunType |
Indicates how to rerun a root jobnet. |
|
31 |
RerunType |
Indicates how to rerun a nested jobnet or job. |
||
32 |
RerunOption |
Indicates the rerun option. |
||
33 |
Constants used for changing delay monitoring |
DelayMonitorType |
Indicates the method of monitoring delays for jobnets. |
|
34 |
MonitoringJobnetType |
Indicates the method of end delay monitoring based on the time required for executing the jobnet. |
||
35 |
Constant used for job status change |
ChangeStatus |
Indicates the job status after the change. |
|
36 |
Constants used for waiting |
WaitMethod |
Indicates the conditions under which a unit can wait. |
|
37 |
WaitingAction |
Indicates the behavior of a unit with wait conditions. |
||
38 |
WaitingStatus |
Indicates a unit with wait conditions and the statuses of the units whose end is being waited for. |
||
39 |
WaitingStatusAction |
Indicates whether to waiting is enabled or disabled. |
||
40 |
Constants used for execution agent objects |
ExecAgentStatus |
Indicates the job transfer restriction status of an execution agent or execution agent group. |
|
41 |
ComStatus |
Indicates the status of an execution agent. |
||
42 |
Constants used by the execution order control method change API |
ChangeExecOrderMethod |
Indicates the new execution order control method to which the current method is to be changed. |
|
43 |
Constant used by the unit information acquisition API |
ConnectInfoType |
Indicates whether to obtain connection information when obtaining the Status information object (unitStatus) of the Resource for status monitoring. |