9.1 List of APIs
The following tables list and describe the APIs that can be used for JP1/AO.
API name |
Function |
See |
---|---|---|
Acquisition of a list of services |
Acquires a list of services registered in JP1/AO. |
|
Acquisition of service information |
Acquires information about the specified service. |
|
Acquisition of a list of operations for a service |
Acquires a list of operations that can be executed for the specified service. |
|
Acquisition of information necessary for executing a service |
Acquires information necessary for executing the specified service. |
9.4.4 Acquisition of information necessary for executing a service |
Execution of a service |
Executes the specified service. |
API name |
Function |
See |
---|---|---|
Acquisition of a list of schedules |
Acquires a list of schedules set for a task. |
|
Acquisition of schedule information |
Acquires information about the specified schedule. |
|
Acquisition of a list of operations for a schedule |
Acquires a list of operations that can be executed for the specified schedule. |
|
Acquisition of information necessary for canceling a schedule |
Acquires information necessary for canceling the specified schedule. |
9.5.4 Acquisition of information necessary for canceling a schedule |
Cancellation of a schedule |
Cancels the specified schedule. |
|
Acquisition of information necessary for pausing a schedule |
Acquires information necessary for pausing the specified schedule. |
9.5.6 Acquisition of information necessary for pausing a schedule |
Pause of a schedule |
Pauses the specified schedule. |
|
Acquisition of information necessary for resuming a schedule |
Acquires information necessary for resuming the specified schedule. |
9.5.8 Acquisition of information necessary for resuming a schedule |
Resume of a schedule |
Resumes the specified schedule. |
API name |
Function |
See |
---|---|---|
Acquisition of a list of tasks |
Acquires a list of tasks. |
|
Acquisition of task information |
Acquires information about the specified task. |
|
Acquisition of a list of task operations |
Acquires a list of operations that can be executed for the specified task. |
|
Acquisition of information necessary for stopping task execution |
Acquires information necessary for stopping execution of the specified task. |
9.6.4 Acquisition of information necessary for stopping task execution |
Stoppage of task execution |
Stops execution of the specified task. |
|
Acquisition of information necessary for re-executing a task |
Acquires information necessary for re-executing the specified task. |
9.6.6 Acquisition of information necessary for re-executing a task |
Re-execution of a task |
Re-executes the specified task. |
|
Acquisition of information necessary for retrying a task (retry from the failed step) |
Specifies a task, and acquires information necessary for retrying the task from the failed step. |
9.6.8 Acquisition of information necessary for retrying a task (retry from the failed step) |
Retry from the failed step |
Specifies a task, and retries the task from the failed step. |
|
Acquisition of information necessary for retrying a task (retry from the step after the failed step) |
Specifies a task, and acquires information necessary for retrying the task from the step after the failed step. |
|
Retry from the step after the failed step |
Specifies a task, and retries the task from the step after the failed step. |
|
Acquisition of a list of steps |
Acquires a list of steps (displayed in the Task Details dialog box) among the steps included in the specified task. |
|
Acquisition of task logs |
Acquires the task logs for the specified task. |
API name |
Function |
See |
---|---|---|
Acquisition of a list of property definitions |
Acquires a list of property definitions. |
|
Acquisition of property definition information |
Acquires information about the specified property definition. |
|
Acquisition of a list of operations for a property definition |
Acquires a list of operations that can be executed for the specified property definition. |
9.7.3 Acquisition of a list of operations for a property definition |
Acquisition of a list of property values |
Acquires a list of values for the following properties:
|
|
Acquisition of a property value |
Acquires information about the specified property value. |
|
Acquisition of a list of operations for a property value |
Acquires a list of operations for the specified property value. |
9.7.6 Acquisition of a list of operations for a property value |
API name |
Function |
See |
---|---|---|
Acquisition of user information |
Acquires information about the user who executed the API. |
|
Acquisition of version information |
Acquires the JP1/AO and API versions. |