cn.vertxup.ambient.api

Interface HistoryAgent

@EndPoint
 @Path(value="/api")
public interface HistoryAgent

Zero History Api Definition

This is interface to query history of each records from zero framework. It’s for X_ACTIVITY and X_ACTIVITY_CHANGE table that enabled following features.

1. Trash to store all the records that have been deleted from our system.
2. Query all records’ histories that have been removed.

Method Summary

Modifier and Type	Method and Description
io.vertx.core.Future<io.vertx.core.json.JsonArray>	fetch(String identifier, String key)
io.vertx.core.Future<io.vertx.core.json.JsonArray>	fetch(String identifier, String key, String field)
io.vertx.core.Future<io.vertx.core.json.JsonObject>	fetchActivity(String key)
io.vertx.core.Future<io.vertx.core.json.JsonArray>	fetchItems(String key)
io.vertx.core.Future<io.vertx.core.json.JsonObject>	searchActivities(io.vertx.core.json.JsonObject body)

Method Detail

fetch

@Path(value="/history/:identifier/:key")
 @GET
 @Address(value="\u1f08\u03c4\u03bb\u03b1\u03bd\u03c4\u1f76\u03c2 \u03bd\u1fc6\u03c3\u03bf\u03c2://\u03c0\u03b5\u03c1\u03b9\u03b2\u03ac\u03bb\u03bb\u03c9\u03bd/X-ACTIVITY/HISTORIES")
io.vertx.core.Future<io.vertx.core.json.JsonArray> fetch(@PathParam(value="identifier")
                                                                                                                                                                                                                                                                                               String identifier,
                                                                                                                                                                                                                                                                                               @PathParam(value="key")
                                                                                                                                                                                                                                                                                               String key)

fetch

@Path(value="/history/:identifier/:key/:field")
 @GET
 @Address(value="\u1f08\u03c4\u03bb\u03b1\u03bd\u03c4\u1f76\u03c2 \u03bd\u1fc6\u03c3\u03bf\u03c2://\u03c0\u03b5\u03c1\u03b9\u03b2\u03ac\u03bb\u03bb\u03c9\u03bd/X-ACTIVITY/HISTORY-BY-FIELDS")
io.vertx.core.Future<io.vertx.core.json.JsonArray> fetch(@PathParam(value="identifier")
                                                                                                                                                                                                                                                                                                              String identifier,
                                                                                                                                                                                                                                                                                                              @PathParam(value="key")
                                                                                                                                                                                                                                                                                                              String key,
                                                                                                                                                                                                                                                                                                              @PathParam(value="field")
                                                                                                                                                                                                                                                                                                              String field)

fetchItems

@Path(value="/history/:key")
 @GET
 @Address(value="\u1f08\u03c4\u03bb\u03b1\u03bd\u03c4\u1f76\u03c2 \u03bd\u1fc6\u03c3\u03bf\u03c2://\u03c0\u03b5\u03c1\u03b9\u03b2\u03ac\u03bb\u03bb\u03c9\u03bd/X-ACTIVITY/HISTORY-ITEMS")
io.vertx.core.Future<io.vertx.core.json.JsonArray> fetchItems(@PathParam(value="key")
                                                                                                                                                                                                                                                                                            String key)

searchActivities

@Path(value="/x-activity/search")
 @POST
 @Address(value="\u1f08\u03c4\u03bb\u03b1\u03bd\u03c4\u1f76\u03c2 \u03bd\u1fc6\u03c3\u03bf\u03c2://\u03c0\u03b5\u03c1\u03b9\u03b2\u03ac\u03bb\u03bb\u03c9\u03bd/X-ACTIVITY/SEARCH")
io.vertx.core.Future<io.vertx.core.json.JsonObject> searchActivities(@BodyParam
                                                                                                                                                                                                                                                                                                  io.vertx.core.json.JsonObject body)

fetchActivity

@Path(value="/x-activity/:key")
 @GET
 @Address(value="\u1f08\u03c4\u03bb\u03b1\u03bd\u03c4\u1f76\u03c2 \u03bd\u1fc6\u03c3\u03bf\u03c2://\u03c0\u03b5\u03c1\u03b9\u03b2\u03ac\u03bb\u03bb\u03c9\u03bd/X-ACTIVITY/GET")
io.vertx.core.Future<io.vertx.core.json.JsonObject> fetchActivity(@PathParam(value="key")
                                                                                                                                                                                                                                                                                         String key)