Package nzilbb.labbcat.server.api.dashboard

Class Express

java.lang.Object

nzilbb.labbcat.server.api.APIRequestHandler

nzilbb.labbcat.server.api.TableServletBase

nzilbb.labbcat.server.api.Dashboard

nzilbb.labbcat.server.api.dashboard.Express

public class Express
extends Dashboard

/api/dashboard/express : Access to dashboard items.

Lists items for the 'express' page dashboard, with the following attributes:

• item_id : ID of the item.
• type : The type of the item: "link", "sql", or "exec".
• label : The item's text label.
• icon : The item's icon.

GET HTTP method is supported,

Only the GET

HTTP method is supported.

• Response Body - the standard JSON envelope, with the model as an object with the above structure.
• Response Status
  • 200 : The attributes were listed.

These are generally single statistics about the corpus that are displayed on the 'statistics' page, which are individually configurable. However items can also be links, or the output of a command.

/api/dashboard/item/item_id can be used to evaluate each item.

Author:

Robert Fromont robert@fromont.net.nz

Nested Class Summary

Nested classes/interfaces inherited from class nzilbb.labbcat.server.api.TableServletBase

TableServletBase.DeleteCheck

Field Summary

Fields inherited from class nzilbb.labbcat.server.api.APIRequestHandler

SC_BAD_REQUEST, SC_CONFLICT, SC_FORBIDDEN, SC_INTERNAL_SERVER_ERROR, SC_METHOD_NOT_ALLOWED, SC_NOT_FOUND, SC_OK, SC_UNPROCESSABLE_CONTENT, SC_UNSUPPORTED_MEDIA_TYPE

Constructor Summary

Constructors

Constructor	Description
Express()

Method Summary

Methods inherited from class nzilbb.labbcat.server.api.TableServletBase

delete, get, post, put

Methods inherited from class nzilbb.labbcat.server.api.APIRequestHandler

GetSystemAttribute, init, writeResponse

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Express

public Express()