2.1 List of APIs

The following tables list and describe the APIs that can be used for JP1/AO.

Table 2‒1: List of API functions for service template functionality
API name	Function	See
Acquisition of a list of service templates	Acquires a list of service templates registered in JP1/AO.	2.4.1 Acquisition of a list of service templates
Acquisition of information about a service template	Acquires information about the specified service template.	2.4.2 Acquisition of information about a service template
Deletion of a service template	Deletes the specified service template.	2.4.3 Deletion of a 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.	2.4.6 Import of a 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.	2.4.8 Export of a 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.	2.4.11 Creation of a service based on a service template

Table 2‒3: List of APIs for schedule functionality
API name	Function	See
Acquisition of a list of schedules	Acquires a list of schedules set for a task.	2.6.1 Acquisition of a list of schedules
Acquisition of schedule information	Acquires information about the specified schedule.	2.6.2 Acquisition of schedule information
Acquisition of a list of operations for a schedule	Acquires a list of operations that can be executed for the specified schedule.	2.6.3 Acquisition of a list of operations for a 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.	2.6.5 Cancellation of a 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.	2.6.7 Pause of a 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.	2.6.9 Resume of a schedule

Table 2‒5: List of history-related API functions
API name	Function	See
Acquisition of a list of history records	Acquires a list of history records.	2.8.1 Acquisition of 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.	2.8.3 Acquisition of a history record
Deletion of history records (with an ID specified)	Deletes the history record that has the specified ID.	2.8.4 Deletion of history records (with an ID specified)
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

Table 2‒6: List of property-related APIs
API name	Function	See
Acquisition of a list of property definitions	Acquires a list of property definitions.	2.9.1 Acquisition of a list of property definitions
Acquisition of property definition information	Acquires information about the specified property definition.	2.9.2 Acquisition of property definition information
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: Service share properties Properties related to specific services Properties related to specific schedules	2.9.5 Acquisition of a list of property values
Batch update of property values	Updates the following property values in a batch: Property values related to specific tasks Property values related to specific services Service share property values Property values for multiple services	2.9.6 Batch update of property values
Acquisition of a property value	Acquires information about the specified property value.	2.9.7 Acquisition of a property value
Update of a property value	Updates the property value that has the specified ID.	2.9.8 Update of a property value
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.	2.9.10 Acquisition of a list of property groups

Table 2‒7: List of service group-related API functions
API name	Function	See
Acquisition of a list of service groups	Acquires a list of service groups.	2.10.1 Acquisition of a list of service groups
Acquisition of information about a service group	Acquires information about the specified service group.	2.10.2 Acquisition of information about a 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

Table 2‒8: List of tag-related API functions
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.	2.11.1 Acquisition of a list of tag groups
Acquisition of a list of tags	Acquires a list of tags that are set for the specified resource.	2.11.2 Acquisition of a list of tags

Table 2‒9: List of APIs for information management
API name	Function	See
Acquisition of user information	Acquires information about users that execute API functions.	2.12.1 Acquisition of user information
Acquisition of version information	Acquires the JP1/AO and API versions.	2.12.2 Acquisition of version information

To Page Top

API name	Function	See
Acquisition of a list of services	Acquires a list of services registered in JP1/AO.	2.5.1 Acquisition of a list of services
Acquisition of service information	Acquires information about the specified service.	2.5.2 Acquisition of service information
Editing a service	Edits the specified service.	2.5.3 Editing a service
Deletion of a service	Deletes the specified service.	2.5.4 Deletion of a service
Acquisition of a list of operations for a service	Acquires a list of operations that can be executed for the specified service.	2.5.5 Acquisition of a list of operations for a 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.	2.5.7 Execution of a 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).	2.5.9 Reset of the counter for a service
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`.	2.5.10 Acquisition of information necessary for the operation to change the status of a service to release
Change of the status of a service to `release`	Changes the status of the specified service to `release`.	2.5.11 Change of the status of a 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`.	2.5.12 Acquisition of information necessary for the operation to change the status of a service to maintenance
Change of the status of a service to `maintenance`	Changes the status of the specified service to `maintenance`.	2.5.13 Change of the status of a 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`.	2.5.14 Acquisition of information necessary for the operation to change the status of a service to disabled
Change of the status of a service to `disabled`	Changes the status of the specified service to `disabled`.	2.5.15 Change of the status of a service to disabled
Acquisition of the URL for the details of a service	Acquires the URL for displaying the details of the specified service.	2.5.16 Acquisition of the URL for the details of a 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.	2.5.17 Acquisition of information necessary for changing the version of the service template used by a 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 tasks	Acquires a list of tasks.	2.7.1 Acquisition of a list of tasks
Acquisition of task information	Acquires information about the specified task.	2.7.2 Acquisition of task information
Editing a task	Edits the notes and TODO for the specified task.	2.7.3 Editing a 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.	2.7.4 Deletion of a task
Acquisition of a list of task operations	Acquires a list of operations that can be executed for the specified task.	2.7.5 Acquisition of a list of task operations
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.	2.7.7 Stoppage of task execution
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.	2.7.9 Forced stoppage of a 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.	2.7.11 Re-execution of a 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.	2.7.12 Acquisition of information necessary for responding to a task that is in the status Waiting for Response
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.	2.7.15 Retry 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.	2.7.16 Acquisition of information necessary for retrying a task (retry 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.	2.7.17 Retry 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.	2.7.19 Archiving a 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.	2.7.20 Acquisition of a list of steps
Acquisition of task logs	Acquires the task logs for the specified task.	2.7.21 Acquisition of task logs