omeroweb.api package

Submodules

omeroweb.api.api_exceptions module

Exceptions used by the api/views methods.

exception omeroweb.api.api_exceptions.ApiException(message, stacktrace=None)

Bases: exceptions.Exception

A base exception class that handles message and stactrace.

exception omeroweb.api.api_exceptions.BadRequestError(message, stacktrace=None)

Bases: omeroweb.api.api_exceptions.ApiException

An exception that will result in a response status of 400.

Due to invalid client input

status = 400

exception omeroweb.api.api_exceptions.CreatedObject(response)

Bases: exceptions.Exception

An exception that is thrown when new object created.

This is not really an error but indicates to the handler that a JsonResponse with status 201 should be returned. The dict content is passed in as ‘response’.

status = 201

exception omeroweb.api.api_exceptions.MethodNotSupportedError(message, stacktrace=None)

Bases: omeroweb.api.api_exceptions.ApiException

An exception that will result in a response status of 405.

Raised if user tries to DELETE, POST or PUT for an Object where we don’t support those methods.

status = 405

exception omeroweb.api.api_exceptions.NotFoundError(message, stacktrace=None)

Bases: omeroweb.api.api_exceptions.ApiException

An exception that will result in a response status of 404.

Raised due to objects not being found.

status = 404

omeroweb.api.api_marshal module

omeroweb.api.api_query module

omeroweb.api.api_settings module

Settings for the OMERO JSON api app.

omeroweb.api.decorators module

omeroweb.api.urls module

omeroweb.api.views module

Module contents

api module provides JSON OMERO API.