Skip to main content

SENAITE JSON API

Project description

senaite.jsonapi

RESTful JSON API for SENAITE LIMS

https://img.shields.io/pypi/v/senaite.jsonapi.svg?style=flat-square https://img.shields.io/github/actions/workflow/status/senaite/senaite.jsonapi/build-and-test.yml?branch=2.x https://readthedocs.org/projects/pip/badge/ https://img.shields.io/github/issues-pr/senaite/senaite.jsonapi.svg?style=flat-square https://img.shields.io/github/issues/senaite/senaite.jsonapi.svg?style=flat-square https://img.shields.io/badge/Made%20for%20SENAITE-%E2%AC%A1-lightgrey.svg

About

This SENAITE.JSONAPI is a RESTful JSON API for SENAITE LIMS, that allows to Create, Read and Update (CRU operations) through http GET/POST requests. It uses JSON as the format for data representation.

Installation

Add senaite.jsonapi in the eggs section of your buildout:

eggs =
    senaite.lims
    senaite.jsonapi

and run bin/buildout.

Documentation

Feedback and support

License

SENAITE.JSONAPI Copyright (C) RIDING BYTES & NARALABS

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Changelog

2.6.0 (2025-04-04)

  • #66 Fix dexterity objects are not validated on creation

  • #63 Compatibility with senaite.core#2584 (SampleType to DX)

  • #61 Compatibility with senaite.core#2567 (AnalysisCategory to DX)

  • #61 Compatibility with senaite.core#2471 (Department to DX)

2.5.0 (2024-01-03)

  • #59 Fix search route for (multi-) portal type queries

  • #58 Fix missing portal type in query

  • #57 Fix search catalog for metadata lookup

  • #56 Fix implicit imports for controlpanel mappings

  • #54 Lookup mapped catalogs for CatalogBrains

2.4.0 (2023-03-10)

  • #51 Handle no access to parent object gracefully

2.3.0 (2022-10-03)

  • #49 Fix no error message is sent back for push consumer calls

2.2.0 (2022-06-10)

  • #47 Use searchable text index converter from catalog API

  • #46 Fix ZCTextIndex lookup for custom searchable text query

2.1.0 (2022-01-05)

  • #43 Fix malformed API call

2.0.0 (2021-07-27)

  • Version bump

2.0.0rc2 (2020-10-13)

  • #41 Added push endpoint for custom jobs

2.0.0rc1 (2020-08-05)

  • Compatibility with senaite.core 2.x

1.2.4 (unreleased)

  • #41 Push endpoint for custom jobs

1.2.3 (2020-08-05)

  • #40 Prevent the id of objects of being accidentally updated

  • #40 Do not allow to update objects from setup folder

  • #40 Do not allow to update objects from portal root

  • #40 Fix upgrade does not work on post-only mode

  • #40 Adapter for custom handling of update operation

  • #37 Do not allow to create objects in setup folder

  • #37 Do not allow to create objects in portal root

  • #37 Adapter for custom handling of create operation

  • #37 Make the creation operation to be portal_type-naive

  • #35 Added catalogs route

  • #34 Make senaite.jsonapi catalog-agnostic on searches

1.2.2 (2020-03-03)

  • Missing package data

1.2.1 (2020-03-02)

  • Fixed tests and updated build system

1.2.0 (2018-01-03)

Added

  • Added parent_path to response data

  • Allow custom methods as attributes in adapter

Removed

Changed

  • Integration to SENAITE CORE

  • License changed to GPLv2

Fixed

  • #25 Null values are saved as ‘NOW’ in Date Time Fields

  • Fixed Tests

Security

1.1.0 (2017-11-04)

1.0.1 (2017-09-30)

  • Fixed broken release (missing MANIFEST.in)

1.0.0 (2017-09-30)

  • First release

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page