2.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 service templates |
Acquires a list of service templates registered in JP1/AO. |
|
Acquisition of information about a service template |
Acquires information about the specified service template. |
|
Deletion of a service template |
Deletes the specified service template. |
|
Acquisition of a list of operations for a service template |
Acquires a list of operations that can be executed for the specified service template. |
2.4.4 Acquisition of a list of operations for a service template |
Acquisition of the HTML file necessary for importing a service template |
Acquires the HTML file necessary for importing the specified service template. |
2.4.5 Acquisition of the HTML file necessary for importing a service template |
Import of a service template |
Imports the specified service template. |
|
Acquisition of information necessary for exporting a service template |
Acquires information necessary for exporting the specified service template. |
2.4.7 Acquisition of information necessary for exporting a service template |
Export of a service template |
Exports the specified service template. |
|
Acquisition of the URL for displaying the details of a service template |
Acquires the URL for displaying the details of the specified service template. |
2.4.9 Acquisition of the URL for displaying the details of a service template |
Acquisition of information necessary for creating a service based on a service template |
Acquires information necessary for creating a service from the specified service template. |
2.4.10 Acquisition of information necessary for creating a service based on a service template |
Creation of a service based on a service template |
Creates a service from the specified service template. You can specify properties when creating a service. |
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. |
|
Editing a service |
Edits the specified service. |
|
Deletion of a service |
Deletes 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. |
2.5.6 Acquisition of information necessary for executing a service |
Execution of a service |
Executes the specified service. |
|
Acquisition of information necessary for resetting the counter for a service |
Acquires information necessary for resetting the counter for the specified service (initialization of statistics). |
2.5.8 Acquisition of information necessary for resetting the counter for a service |
Reset of the counter for a service |
Resets the counter for the specified service (initialization of statistics). |
|
Acquisition of information necessary for the operation to change the status of a service to release |
Acquires information necessary for the operation to change the status of the specified service to release. |
|
Change of the status of a service to release |
Changes the status of the specified service to release. |
|
Acquisition of information necessary for the operation to change the status of a service to maintenance |
Acquires information necessary for the operation to change the status of the specified service to maintenance. |
|
Change of the status of a service to maintenance |
Changes the status of the specified service to maintenance. |
|
Acquisition of information necessary for the operation to change the status of a service to disabled |
Acquires information necessary for the operation to change the status of the specified service to disabled. |
|
Change of the status of a service to disabled |
Changes the status of the specified service to disabled. |
|
Acquisition of the URL for the details of a service |
Acquires the URL for displaying the details of the specified service. |
|
Acquisition of information necessary for changing the version of the service template used by a service |
Acquires information necessary for changing the version of the service template used by the specified service. |
|
Change of the version of the service template used by a service |
Applies the service template of any version to the specified service. |
2.5.18 Change of the version of the service template used by a 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. |
2.6.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. |
2.6.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. |
2.6.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. |
|
Editing a task |
Edits the notes and TODO for the specified task. |
|
Deletion of a task |
Deletes the specified task. If the specified task is not a debug task, this API function acquires the URL for archiving the 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. |
2.7.6 Acquisition of information necessary for stopping task execution |
Stoppage of task execution |
Stops execution of the specified task. |
|
Acquisition of information necessary for forcibly stopping a task |
Acquires information necessary for forcibly stopping the specified task. |
2.7.8 Acquisition of information necessary for forcibly stopping a task |
Forced stoppage of a task |
Forcibly stops the specified task. |
|
Acquisition of information necessary for re-executing a task |
Acquires information necessary for re-executing the specified task. |
2.7.10 Acquisition of information necessary for re-executing a task |
Re-execution of a task |
Re-executes the specified task. |
|
Acquisition of information necessary for responding to a task that is in the status Waiting for Response |
Acquires information necessary for responding to a task that is in the status Waiting for Response. Among the steps of the task that has the specified ID, information about the step that was least recently placed in the status Waiting for Response is acquired. |
|
Response to a task that is in the status Waiting for Response |
Among the steps of the task that has specified ID, performs a response input for the step that was least recently placed in the status Waiting for Response. |
2.7.13 Response to a task that is in the status Waiting for Response |
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. |
2.7.14 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 information necessary for archiving a task |
Acquires the argument template necessary for archiving the specified task. |
2.7.18 Acquisition of information necessary for archiving a task |
Archiving a task |
Archives the specified task. |
|
Acquisition of a list of steps |
Among the steps included in the specified task, acquires a list of steps displayed in the Task Details window. |
|
Acquisition of task logs |
Acquires the task logs for the specified task. |
API name |
Function |
See |
---|---|---|
Acquisition of a list of history records |
Acquires a list of history records. |
|
Deletion of history records (with conditions specified) |
Deletes history records according to the conditions specified by query parameters. |
2.8.2 Deletion of history records (with conditions specified) |
Acquisition of a history record |
Acquires the history record that has the specified ID. |
|
Deletion of history records (with an ID specified) |
Deletes the history record that has the specified ID. |
|
Acquisition of a list of operations for a history record |
Acquires a list of operations that can be executed for the history record that has the specified ID. |
2.8.5 Acquisition of a list of operations for a history record |
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. |
2.9.3 Acquisition of a list of operations for a property definition |
Acquisition of lists of property definitions and property values |
Acquires lists of property definitions and property values. |
2.9.4 Acquisition of lists of property definitions and property values |
Acquisition of a list of property values |
Acquires a list of the values of the following properties:
|
|
Batch update of property values |
Updates the following property values in a batch:
|
|
Acquisition of a property value |
Acquires information about the specified property value. |
|
Update of a property value |
Updates the property value that has the specified ID. |
|
Acquisition of a list of operations for a property value |
Acquires a list of operations for the specified property value. |
2.9.9 Acquisition of a list of operations for a property value |
Acquisition of a list of property groups |
Acquires a list of property groups that the properties retained by a service belong to. |
API name |
Function |
See |
---|---|---|
Acquisition of a list of service groups |
Acquires a list of service groups. |
|
Acquisition of information about a service group |
Acquires information about the specified service group. |
|
Acquisition of a list of operations for a service group |
Acquires a list of operations that can be executed for the specified service group. |
2.10.3 Acquisition of a list of operations for a service group |
API name |
Function |
See |
---|---|---|
Acquisition of a list of tag groups |
Acquires a list of tag groups. In addition, this API function acquires a list of tags that belong to each tag group. |
|
Acquisition of a list of tags |
Acquires a list of tags that are set for the specified resource. |
API name |
Function |
See |
---|---|---|
Acquisition of user information |
Acquires information about users that execute API functions. |
|
Acquisition of version information |
Acquires the JP1/AO and API versions. |