Package nzilbb.labbcat.server.api.admin

Class Corpora

  • @RequiredRole("admin")
public class Corpora
extends TableServletBase
    /api/admin/corpora : Administration of corpus records.

    Allows administration (Create/Read/Update/Delete) of corpus records via JSON-encoded objects with the following attributes:

    corpus_id
    The database key for the record.
    corpus_name
    The name of the corpus.
    corpus_language
    The ISO 639-1 code for the default language.
    corpus_description
    The description of the corpus.
    _cantDelete
    This is not a database field, but rather is present in records returned from the server that can not currently be deleted; a string representing the reason the record can't be deleted.

    The following operations, specified by the HTTP method, are supported:

    POST
    Create a new record.
    • Request Body - a JSON-encoded object representing the new record (excluding corpus_id).
    • Response Body - the standard JSON envelope, with the model as an object representing the new record (including corpus_id).
    • Response Status
      • 200 : The record was successfully created.
      • 409 : The record could not be added because it was already there.
    GET
    Read the records.
    • Parameters
      • pageNumber (integer) : The (zero-based) page to return.
      • pageLength (integer) : How many rows per page (default is 20).
      • Accept (string) : Equivalent of the "Accept" request header (see below).
    • "Accept" request header/parameter "text/csv" to return records as Comma Separated Values. If not specified, records are returned as a JSON-encoded array of objects.
    • Response Body - the standard JSON envelope, with the model as a corresponding list of records.
    • Response Status
      • 200 : The records could be listed.
    PUT
    Update an existing record, specified by the corpus_name given in the request body.
    • Request Body - a JSON-encoded object representing the record.
    • Response Body - the standard JSON envelope, with the model as an object representing the record.
    • Response Status
      • 200 : The record was successfully updated.
      • 404 : The record was not found.
    DELETE
    Delete an existing record.
    • Request Path - /api/admin/corpora/corpus_name where corpus_name is the name of the corpus to delete.
    • Response Body - the standard JSON envelope, including a message if the request succeeds or an error explaining the reason for failure.
    • Response Status
      • 200 : The record was successfully deleted.
      • 400 : No corpus_id was specified in the URL path, or the record exists but could not be deleted.
      • 404 : The record was not found.

    Author:
    Robert Fromont robert@fromont.net.nz

    • Constructor Detail

      • Corpora

        public Corpora()