Hitachi

Job Management Partner 1 Version 10 Job Management Partner 1/Automatic Operation GUI, Command, and API Reference


9.1 List of APIs

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

Table 9‒1: List of APIs for service functionality

API name

Function

See

Acquisition of a list of services

Acquires a list of services registered in JP1/AO.

9.4.1 Acquisition of a list of services

Acquisition of service information

Acquires information about the specified service.

9.4.2 Acquisition of service information

Acquisition of a list of operations for a service

Acquires a list of operations that can be executed for the specified service.

9.4.3 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.

9.4.4 Acquisition of information necessary for executing a service

Execution of a service

Executes the specified service.

9.4.5 Execution of a service

Table 9‒2: 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.

9.5.1 Acquisition of a list of schedules

Acquisition of schedule information

Acquires information about the specified schedule.

9.5.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.

9.5.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.

9.5.4 Acquisition of information necessary for canceling a schedule

Cancellation of a schedule

Cancels the specified schedule.

9.5.5 Cancellation of a 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.

9.5.7 Pause of a 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.

9.5.9 Resume of a schedule

Table 9‒3: List of APIs for task functionality

API name

Function

See

Acquisition of a list of tasks

Acquires a list of tasks.

9.6.1 Acquisition of a list of tasks

Acquisition of task information

Acquires information about the specified task.

9.6.2 Acquisition of task information

Acquisition of a list of task operations

Acquires a list of operations that can be executed for the specified task.

9.6.3 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.

9.6.4 Acquisition of information necessary for stopping task execution

Stoppage of task execution

Stops execution of the specified task.

9.6.5 Stoppage of task execution

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.

9.6.7 Re-execution of a 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.

9.6.9 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.

9.6.10 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.

9.6.11 Retry 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.

9.6.12 Acquisition of a list of steps

Acquisition of task logs

Acquires the task logs for the specified task.

9.6.13 Acquisition of task logs

Table 9‒4: List of property-related APIs

API name

Function

See

Acquisition of a list of property definitions

Acquires a list of property definitions.

9.7.1 Acquisition of a list of property definitions

Acquisition of property definition information

Acquires information about the specified property definition.

9.7.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.

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:

  • Service share properties

  • Properties related to specific services

  • Properties related to specific schedules

  • Properties related to specific tasks

9.7.4 Acquisition of a list of property values

Acquisition of a property value

Acquires information about the specified property value.

9.7.5 Acquisition of a 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

Table 9‒5: List of APIs for information management

API name

Function

See

Acquisition of user information

Acquires information about the user who executed the API.

9.8.1 Acquisition of user information

Acquisition of version information

Acquires the JP1/AO and API versions.

9.8.2 Acquisition of version information