Module odoo_api::service

source ·
Expand description

The base Odoo API types

This module contains raw types and impls for the Odoo API methods.

As a crate user, you shouldn’t need to interact with these directly. Instead, see crate::client.


API Methods


object

Method
Description
Auth?
executeCall a business-logic method on an Odoo model (positional args)Yes
execute_kwCall a business-logic method on an Odoo model (positional & keyword args)Yes

orm

TBC

Method
Description
Auth?
createCreate a new record (or set of records)Yes
readRead data from a record (or set of records)Yes
read_groupRead some grouped data from a record (or set of records)Yes
writeWrite data to a record (or set of records)Yes
unlinkDelete a record (or set of records)Yes
searchReturn the ids of records matching a domainYes
search_countReturn the count of records matching a domainYes
search_readPerform a search and read in one callYes
copyCopy a recordYes
existsCheck if the record(s) exist in the Odoo databaseYes
check_access_rightsCheck model access rights (according to ir.model.access)Yes
check_access_rulesCheck model access rules (according to ir.rule)Yes
check_field_access_rightsCheck the user access rights on the given fieldsYes
get_metadataReturn some metadata about the given record(s)Yes
get_external_idFetch the XMLID for the given record(s)Yes
get_xml_idFetch the XMLID for the given record(s)Yes
name_getFetch the display_naame for the given record(s)Yes
name_createCreate a new record, passing only the name fieldYes
name_searchSearch for records based on their name fieldYes

common

Method
Description
Auth?
common_loginCheck the user credentials and return the user ID-
common_authenticateCheck the user credentials and return the user ID (web)-
common_versionFetch detailed information about the Odoo version-
common_aboutFetch basic information about the Odoo version-

db

Method
Description
Auth?
db_create_databaseCreate and initialize a new database-
db_duplicate_databaseDuplicate a database-
db_dropDrop (delete) a database-
db_dumpDump (backup) a database, optionally including the filestore folder-
db_restoreUpload and restore an Odoo dump to a new database-
db_renameRename a database-
db_change_admin_passwordChange the Odoo “master password”-
db_migrate_databasePerform a “database migration” (upgrade the base module)-
db_existCheck if a database exists-
db_listList the databases currently available to Odoo-
db_list_langList the languages available to Odoo (ISO name + code)-
db_list_countriesList the countries available to Odoo (ISO name + code)-
db_server_versionReturn the server version-

web

Method
Description
Auth?
web_session_authenticateDocs TBC-

Modules

  • The Odoo “common” service (JSON-RPC)
  • The Odoo “db” service (JSON-RPC)
  • The Odoo “object” service (JSON-RPC)
  • The Odoo “ORM” pseudo-service
  • The Odoo “Web” pseudo-service