Maple Apps Management APIs

Maple Apps Management APIs

Application Management

GET /maple/app

Description

Get the execution queue of current running maple applications.

Response

List<Object>.

Name	Type	Description
appId	uuid	The uuid of maple application.
app	object<app>	The information of maple application. (Same as this response.)

GET /maple/app/{uuid}

Description

Get the information of a special running maple application by uuid.

Response

Object. (App)

Name	Type	Description
name	string	The name of the maple application.
description	string	(Optional) The description of the maple application.
counter	integer	The number of packets which triggered this maple application.
TBD	TBD	TBD

PUT /maple/app

Description

Load (register) a new maple application into the queue.

Parameters

Object.

Name	Type	Description
name	string	The name of the maple application.
uri	string	The uri of the maple application feature. It can be parsed and loaded by karaf framework.
description	string	(Optional) The description of the maple application.
index	integer	(Optional) The position of the maple application in the execution queue.

Response

Object.

Name	Type	Description
appId	uuid	Return the uuid of the registered maple application.
error	string	(Optional) If error, return error message.

POST /maple/app/{uuid}

Description

Update a special maple application in the queue.

Parameters

Object.

Name	Type	Description
name	string	(Optional) The name of the maple application.
uri	string	(Optional) The uri of the maple application feature. It can be parsed and loaded by karaf framework.
description	string	(Optional) The description of the maple application.
index	integer	(Optional) The position of the maple application in the execution queue.

Response

Object.

Name	Type	Description
success	boolean	true, if update the maple application, else return false.
error	string	(Optional) If error, return error message.

POST /maple/app

Description

Update the execution queue of maple applications.

Parameters

Object.

TBD

Response

Object.

Name	Type	Description
success	boolean	true, if update the execution queue, else return false.
error	string	(Optional) If error, return error message.

DELETE /maple/app

Description

Empty the whole queue of maple applications.

Response

Object.

Name	Type	Description
success	boolean	true, if empty the execution queue, else return false.
error	string	(Optional) If error, return error message.

DELETE /maple/app/{uuid}

Description

Delete a special maple application by uuid.

Response

Object.

Name	Type	Description
success	boolean	true, if delete the maple application, else return false.
error	string	(Optional) If error, return error message.

Trace Tree Tracking

GET /maple/tracetree

Description

Get the whole trace tree.

Response

Object.

Name	Type	Description
ttnodes	list<ttnode>	The set of trace tree nodes.
ttlinks	list<ttlink>	The set of trace tree links.

Object. (Trace Tree Node)

Name	Type	Description
id	integer	The id of the trace tree node.
type	string	The type of the trace tree node.

Object. (Trace Tree Link)

Name	Type	Description
id	integer	The id of the trace tree link.
source	integer	The id of the source trace tree node.
target	integer	The id of the target trace tree node.
operator	string	The operator of the trace tree link.
condition	string	The condition of the trace tree link.