Search 1.8 billion lines of Odoo code on GitHub


Author: ACSONE SA/NV, Odoo Community Association (OCA)
License: LGPL-3
Branch: 15.0
Repository: acsone/rest-framework
Languages: HTML (412, 35.4%), Python (689, 59.2%), and reStructuredText (63, 5.4%)
Other branches: 12.0, 12.0-base_rest-cors-options, 12.0-datamodel-experiment, 12.0-new-api-wip, 13.0, 13.0-48-port, 13.0-backport-base-rest-pydantic, 13.0-backport-extendable, 13.0-base_rest-cors-options, 13.0-fixcrashdesc, 14.0, 14.0-abi_master, 14.0-add-pydantic, 14.0-base-rest-pydantic-lmi, 14.0-base_res_service_add_properties-qgr, 14.0-deprecated-implicit-rest-method, 14.0-fdl_master, 14.0-fix-path-parameter-name, 14.0-fix-response-processing, 14.0-fixcrashdesc, 14.0-moz_master, 15.0-initial, 16.0, 16.0-fastapi, 16.0-upgrade-pre-commit, and oca-port-pr--from-14.0-to-13.0
Other repositories: Change2improve/rest-framework, Digital5-Odoo/rest-framework, Gabinete-Digital/rest-framework, NeatNerdPrime/rest-framework, OCA/rest-framework, SeuMarco/rest-framework, akretion/rest-framework, coopiteasy/rest-framework, gastonfeng/rest-framework, guewen/rest-framework, gurneyalex/rest-framework, odoogap/rest-framework, simahawk/rest-framework, ursais/rest-framework, and wahello/rest-framework


Beta License: LGPL-3 OCA/rest-framework Translate me on Weblate Try me on Runbot

This addon allows you to define simple data models supporting serialization/deserialization to/from json

Datamodels are Marshmallow models classes that can be inherited as Odoo Models.

Table of contents


To define your own datamodel you just need to create a class that inherits from odoo.addons.datamodel.core.Datamodel

from marshmallow import fields

from odoo.addons.base_rest import restapi
from odoo.addons.component.core import Component
from odoo.addons.datamodel.core import Datamodel

class PartnerShortInfo(Datamodel):
    _name = ""

    id = fields.Integer(required=True, allow_none=False)
    name = fields.String(required=True, allow_none=False)

class PartnerInfo(Datamodel):
    _name = ""
    _inherit = ""

    street = fields.String(required=True, allow_none=False)
    street2 = fields.String(required=False, allow_none=True)
    zip_code = fields.String(required=True, allow_none=False)
    city = fields.String(required=True, allow_none=False)
    phone = fields.String(required=False, allow_none=True)
    is_componay = fields.Boolean(required=False, allow_none=False)

As for odoo models, you can extend the base datamodel by inheriting of base.

class Base(Datamodel):
    _inherit = "base"

    def _my_method(self):

Datamodels are available through the datamodels registry provided by the Odoo's environment.

class ResPartner(Model):
    _inherit = "res.partner"

    def _to_partner_info(self):
        PartnerInfo = self.env.datamodels[""]
        partner_info = PartnerInfo(partial=True) = =
        partner_info.street = partner.street
        partner_info.street2 = partner.street2
        partner_info.zip_code = = =
        partner_info.is_company = partner.is_company
        return partner_info

The Odoo's environment is also available into the datamodel instance.

class MyDataModel(Datamodel):
    _name = ""

    def _my_method(self):
        partners = self.env["res.partner"].search([])


The env property into a Datamodel instance is mutable. IOW, you can't rely on information (context, user) provided by the environment. The env property is a helper property that give you access to the odoo's registry and must be use with caution.

Known issues / Roadmap

The roadmap and known issues can be found on GitHub.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.






This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

Current maintainer:


This module is part of the OCA/rest-framework project on GitHub.

You are welcome to contribute. To learn how please visit