Package nzilbb.labbcat.server.api.dashboard

Class Item

java.lang.Object

nzilbb.labbcat.server.api.APIRequestHandler

nzilbb.labbcat.server.api.TableServletBase

nzilbb.labbcat.server.api.Dashboard

nzilbb.labbcat.server.api.dashboard.Item

public class Item
extends Dashboard

/api/dashboard/item/item_id : The value of one dashboard item.

Evaluate the given dashboard item, which is an item_id returned by /api/dashboard, /api/express, or /api/statistics

Only the GET

HTTP method is supported.

• Response Body - the standard JSON envelope, with the model as a string containing the value of the given item.
• Response Status
  • 200 : The item was evaluated.
  • 400 : No item ID was specified.
  • 404 : The specified item ID was not valid.
  • 500 : The item could not be evaluated.

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
Item()

Method Summary

Modifier and Type	Method	Description
javax.json.JsonObject	get(String pathInfo, Consumer<Integer> httpStatus)	Generate the response to a request.

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

Item

public Item()

Method Detail

get

public javax.json.JsonObject get(String pathInfo,
                                 Consumer<Integer> httpStatus)

Generate the response to a request.

This returns information about the current user - their ID and the roles they have.

Parameters:

pathInfo - The URL path.

httpStatus - Receives the response status code, in case of error.

Returns:

A JSON object as the request response.