io.apiman.manager.api.rest.contract

Interface IActionResource

@Path(value="actions")
public interface IActionResource

The Action API. This API allows callers to perform actions on various entities - actions other than the standard REST "crud" actions.

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
void	performAction(io.apiman.manager.api.beans.actions.ActionBean action) Call this endpoint in order to execute actions for apiman entities such as Plans, Services, or Applications.

Method Detail

performAction

@POST
@Consumes(value="application/json")
void performAction(io.apiman.manager.api.beans.actions.ActionBean action)
                   throws ActionException

Call this endpoint in order to execute actions for apiman entities such as Plans, Services, or Applications. The type of the action must be included in the request payload.

Parameters:

action - The details about what action to execute.

Throws:

ActionException - action is performed but an error occurs during processing