2.2.15 Members to be returned for APIs that execute JP1/AO operations

Some API functions provided by JP1/AO execute JP1/AO operations. Applicable API functions and returned members are shown below. For details about requests, see the request format in the description of each API function.

APIs that execute JP1/AO operations

Import of a service template
Export of a service template
Creation of a service based on a service template
Execution of a service
Reset of the counter for a service
Change of the status of a service to release
Change of the status of a service to maintenance
Change of the status of a service to disabled
Change of the version of the service template used by a service
Cancellation of a schedule
Pause of a schedule
Resume of a schedule
Stoppage of task execution
Forced stoppage of a task
Re-execution of a task
Response to a task that is in the status Waiting for Response
Retry from the failed step
Retry from the step after the failed step
Archiving a task

Table 2‒42: Members to be returned for APIs that execute JP1/AO operations
Member name	Data type	Description
instanceID	string	Indicates the instance ID.
created	string	Indicates (in ISO8601 format) the date and time the object was generated.
updated	string	Indicates the time this object was updated, if asynchronous processing was executed. If synchronous processing is executed, this member indicates the same time as created. This member is expressed in ISO8601 format.
completed	string	Indicates the time the processing was completed, if asynchronous processing was executed. If synchronous processing is executed, this member indicates the same time as created. This member is expressed in ISO8601 format.
state	string	queued: The operation has not started processing yet. In this status, only stop processing is accepted. running: The operation is running. In this status, only stop processing is accepted. failed: The operation failed. success: The operation has been successfully completed. stopping: The operation is being stopped. stopped: The operation is stopped before completion.
affectedResource	string	Indicates the URL of the API resource created or updated as a result of the operation.

To Page Top