9.3.1 What you can do with user applications
A user application is a user-created program that is capable of interacting with a web (HTTP) interface. By sending requests from the user application to the web (HTTP) API provided by JP1/AJS3, you can perform various operations via the Internet, such as batch processing to register jobs for execution or to collect information about units.
Because user applications use the APIs provided by JP1/AJS3, the functions that can be implemented depend on the APIs that are available.
The following table describes the operations that can be performed by using user applications.
No. |
Operation |
Description |
|
---|---|---|---|
1 |
Executing units |
Immediate execution registration |
You can register jobnets for immediate execution. |
2 |
Planned execution registration |
You can register jobnets for planned execution. |
|
3 |
Fixed execution registration |
You can register jobnets for fixed execution. |
|
4 |
Cancellation of registration for execution |
You can unregister jobnets that have been registered for execution. |
|
5 |
Operating units |
Change plan (change time) |
You can temporarily change the execution time for a unit that has already been registered for execution. |
6 |
Change plan (execute immediately) |
You can immediately execute a unit that has already been registered for execution by temporarily changing the execution schedule of the unit. |
|
7 |
Change plan (execution prohibited) |
You can cancel execution of a unit that has already been registered for execution by temporarily changing the execution schedule of the unit. |
|
8 |
Change plan (release change) |
You can undo a change that was temporarily made to the execution schedule of a unit. |
|
9 |
Change hold attribute |
You can set the hold attribute for a unit or remove the hold attribute from a unit. |
|
10 |
Interrupt |
You can interrupt the execution of a unit. |
|
11 |
Kill |
You can forcibly terminate the execution of a unit. |
|
12 |
Rerun |
You can rerun a unit. |
|
13 |
Change delay monitor |
You can temporarily change the delay monitoring settings for a unit that has already been registered for execution. |
|
14 |
Change job status |
You can change the job status. |
|
15 |
Obtaining unit information |
Obtaining a list of units |
You can obtain the unit name, unit type, execution status, and other unit information about a specified unit or about the units belonging to that specified unit. |
16 |
Obtaining unit information |
You can obtain the unit information about a specified unit. |
|
17 |
Obtaining the detailed execution result of a unit |
You can obtain the detailed execution result of a unit that has already been executed. |
|
18 |
Operating execution agents |
Obtaining a list of execution agents and the job execution status of each execution agent |
You can obtain a list of execution agents and the job execution status of each execution agent.#1 |
19 |
Obtaining definitions |
You can obtain the definitions of the specified execution agent. |
|
20 |
Add |
You can add the definitions of an execution agent. |
|
21 |
Delete |
You can delete the definitions of the specified execution agent.#2 |
|
22 |
Change settings |
You can change the definitions of the specified execution agent. |
|
23 |
Updating the job transfer restriction status |
You can change the job transfer restriction status of the specified execution agent.#2 |
|
24 |
Change the status |
You can change the status of the specified execution agent.#2, #3 |
|
25 |
Start the communication status check |
You can start the communication status check of the job distribution delay reduction function.#3 |
|
26 |
End the communication status check |
You can end the communication status check of the job distribution delay reduction function.#3 |
|
27 |
Check the result of the communication status check |
You can check the result of the communication status check of the job distribution delay reduction function.#3 |
|
28 |
Operating execution agent groups |
Obtaining a list of definitions |
You can obtain a list of definitions of execution agent groups. |
29 |
Obtaining definitions |
You can obtain the definitions of the specified execution agent group. |
|
30 |
Obtaining the status |
You can obtain the job execution status of an execution agent group. |
|
31 |
Add |
You can add the definitions of an execution agent group. |
|
32 |
Delete |
You can delete the definitions of the specified execution agent group.#2 |
|
33 |
Change settings |
You can change the definitions of the specified execution agent group. |
|
34 |
Updating the job transfer restriction status |
You can change the job transfer restriction status of the specified execution agent group.#2 |
|
35 |
Performing addition, exclusion, and change of priority levels for execution agents |
You can perform addition, exclusion, and change of priority levels for the execution agents that are associated with the specified execution agent group. |
|
36 |
Other operations |
Obtaining version information |
You can obtain information about the versions of products. |
37 |
Obtaining protocol version of JP1/AJS3 - Manager |
You can obtain the protocol version of JP1/AJS3 - Manager to which you are connecting. |
- #1
-
To view the statuses of the execution agents, you must enable the job distribution delay reduction function.
- #2
-
When you perform operations on multiple execution agent groups, you can specify a maximum of 100 execution agent groups at one time.
- #3
-
You must enable the job distribution delay reduction function.