Module “actions”

    The action module provides the infrastructure for defining low-level HTTP actions.

    If you want to define HTTP endpoints in ArangoDB you should probably use the Foxx microservice framework instead.

    actions.getErrorMessage(code)

    Returns the error message for an error code.

    actions.defineHttp(options)

    Defines a new action. The options are as follows:

    options.url

    The URL, which can be used to access the action. This path might contain slashes. Note that this action will also be called, if a url is given such that options.url is a prefix of the given url and no longer definition matches.

    options.prefix

    If false, then only use the action for exact matches. The default is true.

    The callback must define fill the response.

    • response.responseCode: the response code
    • response.contentType: the content type of the response

    You can use the functions ResultOk and ResultError to easily generate a response.

    Result ok

    actions.resultOk(req, res, code, result, headers)

    The function defines a response. code is the status code to return. result is the result object, which will be returned as JSON object in the body. headers is an array of headers to returned. The function adds the attribute error with value false and code with value code to the result.

    Result bad

    actions.resultBad(req, res, error-code, msg, headers)

    The function generates an error response.

    Result not found

    actions.resultNotFound(req, res, code, msg, headers)

    The function generates an error response.

    actions.resultUnsupported(req, res, headers)

    The function generates an error response.

    Result error

    actions.resultError(req, \res, code, errorNum, errorMessage, headers, keyvals)*

    Result not Implemented

    The function generates an error response.

    Result permanent redirect

    actions.resultPermanentRedirect(req, res, options, headers)

    The function generates a redirect response.

    actions.resultTemporaryRedirect(req, res, options, headers)

    The function generates a redirect response.

    Collection not found

    actions.collectionNotFound(req, res, collection, headers)

    The function generates an error response.

    Index not found

    actions.indexNotFound(req, res, collection, index, headers)

    The function generates an error response.

    Result exception