Search 1.9 billion lines of Odoo code on GitHub

odoocodesearch

Search 1.9 billion lines of Odoo code on GitHub

restful

Author:	Babatope Ajepe
License:	LGPL-3
Branch:	14.0
Repository:	ajepe/odoo-addons
Dependencies:	base, base_setup, and web
Languages:	HTML (14, 1.9%), Markdown (285, 37.8%), Python (390, 51.8%), XML (41, 5.4%), and reStructuredText (23, 3.1%)
Other branches:	10.0, 11.0, 12.0, 13.0, 15.0, master, and sola
Other repositories:	Bedo1212/odoo-addons, Coding-Squad/odoo-addons, Jaquedeveloper/odoo-addons, Rodasac/odoo-addons, akurey/ajepe-odoo-addons, cialuo/odoo-addons-3, cnkenny/odoo-addons, consultingerp/odoo_redis_session_storage, elmosolutions/odoo-addons, haylahi/odoo-addons-6, latera/odoo-restful, leodoooca/odoo-addons, niulinlnc/odoo-addons-1, scbrianti/odoo-addons-2, sspankaj/odoo-addons, thinkwelltwd/odoo-addons, wahello/ajepe-odoo-addons, wahhid/odoo-addons, wbsouza/odoo-addons-1, and wuhuizhong/odoo-addons

<h2>AUTHENTICATION</h2> <ul> <li>login </li> <li>logout </li> </ul> Before you can make use of ths module, an access token is required for all requests except for the authentication endpoints. <h4>Get Token</h4> These following fields are needed for token generation 1. login: a valid user login name or email 2. password: the related password to the account in [1] 3. db: the database the user is trying to connect to. ```python <h1>Sample request.</h1> import requests url = "http://localhost:8069/api/auth/token" headers = { "login": "admin", "password": "admin", "db": "api.ng", "content-type": "application/jsonp" } response = requests.get(url, headers=headers) print(response.json()) ``` <h4>Get Token Response</h4> ```python { "uid": 2, "usercontext": { "lang": "enUS", "tz": "Europe/Brussels", "uid": 2 }, "companyid": 1, "companyids": [ 1 ], "partnerid": 3, "accesstoken": "accesstokenbb4545413125847104b02a4e9a4aa8088a90903d", "companyname": "YourCompany", "currency": "USD", "country": "United States", "contactaddress": "YourCompany\n215 Vine St\n\nScranton PA 18503\nUnited States", "customer_rank": 0 } ``` <h3>Delete token [LOGOUT]</h3> To logout means that the token need to be deleted. ```python import requests url = "http://localhost:8069/api/sale.order/36" headers = { "Content-Type": "application/jsonp", "access-token": "accesstokenbb4545413125847104b02a4e9a4aa8088a90903d" } response = requests.delete(url, headers=headers) print(response.json()) ``` <h4>CRUD Operation</h4> To get or fetch existing sale order ```python import requests url = "http://192.168.43.58:8069/api/sale.order" payload = "{ "limit": 2, "fields": "['id', 'partner_id', 'name']", "domain":"[('id', 'in', [10,11,12,13,14])]", "offset":0 }" headers = { 'access-token': "accesstoken79406d541ea0a79a942e19871a9c806236d5638c", 'content-type': "application/json" } response = requests.request("GET", url, data=payload, headers=headers) print(response.text) ``` There is posibilty of applying some record filters in order to get just the specific record. * limit: This define the total number of record we are expecting * offset: where the query will start from * fields: this is the list of field that we wanted to return, this can be leave empty if we wanted to return all the fields. * domain: domain is like a filter it is always a list of tuples (field, operator, value) These payload applies to all records in Odoo. We can perform create, update and delete operation on any records using corresponding HTTP request headers. GET: For retriving existing records POST: For creating new records PATCH: Call an action button on a record DELETE: To delete a record All the API of currently installed modules or any module that may be installed has already cattered for dynamically. The API follows this sematic pattern /api{api route}/modelP{model name}/id{optional id for delete request} e.g for sale order Get request to api/sale.order endpoint will return all the sale order in the system. <h1>Sale Order</h1> <ul> <li>GET Request ```python import requests</li> </ul> url = "http://192.168.43.58:8069/api/sale.order" payload = "{}" headers = { 'content-type': "application/json" } response = requests.request("GET", url, data=payload, headers=headers) print(response.text) <code> * Response </code>python { "count": 1, "data": [ { "id": 30, "name": "SO029", "origin": false, "clientorderref": false, "reference": false, "state": "draft", "dateorder": "2020-06-30T20:58:48.269652", "validitydate": false, "requiresignature": true, "requirepayment": true, "createdate": "2020-06-30T20:58:39.806639", "confirmationdate": false, "userid": [ 6, "Marc Demo" ], "partnerid": [ 11, "Gemini Furniture" ], "partnerinvoiceid": [ 31, "Gemini Furniture, Oscar Morgan" ], "partnershippingid": [ 31, "Gemini Furniture, Oscar Morgan" ], "pricelistid": [ 1, "Public Pricelist (USD)" ], "analyticaccountid": false, "orderline": [ 55 ], "invoicestatus": "no", "note": "", "amountuntaxed": 33.0, "amounttax": 0.0, "amounttotal": 33.0, "currencyrate": 1.5289, "paymenttermid": false, "fiscalpositionid": false, "companyid": [ 1, "YourCompany" ], "teamid": [ 2, "Website" ], "signature": false, "signedby": false, "commitmentdate": false, "transactionids": [], "cartrecoveryemailsent": false, "websiteid": false, "campaignid": false, "sourceid": false, "mediumid": false, "activityids": [], "messagefollowerids": [ 167, 168 ], "messageids": [ 218, 217 ], "messagemainattachmentid": false, "websitemessageids": [], "accesstoken": false, "createuid": [ 1, "OdooBot" ], "writeuid": [ 1, "OdooBot" ], "writedate": "2020-06-30T20:58:39.806639", "isexpired": false, "remainingvaliditydays": 0, "currencyid": [ 2, "USD" ], "invoicecount": 0, "invoiceids": [], "amountbygroup": [], "expecteddate": "2020-07-03T06:54:53", "amountundiscounted": 33.0, "typename": "Quotation", "authorizedtransactionids": [], "websiteorderline": [ 55 ], "cartquantity": 2, "onlyservices": false, "isabandonedcart": true, "activitystate": false, "activityuserid": false, "activitytypeid": false, "activitydatedeadline": false, "activitysummary": false, "messageisfollower": false, "messagepartnerids": [ 2, 7 ], "messagechannelids": [], "messageunread": false, "messageunreadcounter": 0, "messageneedaction": false, "messageneedactioncounter": 0, "messagehaserror": false, "messagehaserrorcounter": 0, "messageattachmentcount": 0, "accessurl": "/my/orders/30", "accesswarning": "", "displayname": "SO029", "lastupdate": "2020-06-30T20:58:39.806639" } ] } <code> The reponse with all the fields, but the return fields can specified along side the request, and also, specific records can be specified by sending along the request Odoo domain as json body. </code>python {"limit": 2, "fields": "['id', 'partner_id', 'name']", "domain":"[('id', 'in', [10,11,12,13,14])]", "offset":0} ``` The above will only return 2 maximum records, id, partner and sale order name, that have an ID in the given list [10,11,12,13,14], the offset can be set also. <ul> <li>POST (Create Sale Order) ```python import requests</li> </ul> url = "http://192.168.43.58:8069/api/sale.order" payload = {'partnerid': 10, 'apiorderline':[(0, 0, {'productid': 1,'priceunit':4000})]"} headers = { 'content-type': "application/json", 'access-token': "accesstoken79406d541ea0a79a942e19871a9c806236d5638c" } response = requests.request("POST", url, data=payload, headers=headers) print(response.text) ``` Note the apiorderline the bolded part. The _api__ is a shortcut (instead of created the line item separately from the main record), it is a way of telling the system that an order line or line Items is being created from an api endpoint. order_line is the One2many field that line sale order and order line together. <blockquote> This pattern is applicable to other models </blockquote> <ul> <li>PATCH REQUEST Path request is meant for calling an action button on a record. e.g validating sale order.</li> </ul> ```python import requests url = "http://192.168.43.58:8069/api/sale.order/37" payload = {"method":"actionconfirm"} headers = { 'content-type': "application/json", 'access-token': "accesstoken79406d541ea0a79a942e19871a9c806236d5638c" } response = requests.request("PATCH", url, data=payload, headers=headers) print(response.text) ``` In the above request, we send a json body like this {"method":"actionconfirm"} The _method is the action/button name in odoo. This is similar to clicking Confirm Button on sale order with ID 37 <ul> <li>DELETE SALE ORDER ```python import requests</li> </ul> url = "http://192.168.43.58:8069/api/sale.order/37" payload = "{}" headers = { 'content-type': "application/json", 'access-token': "accesstoken79406d541ea0a79a942e19871a9c806236d5638c" } response = requests.request("DELETE", url, data=payload, headers=headers) print(response.text) ``` We only need to make a delete request to the resource. <h1>New Documentation</h1> http://localhost:8069/api/sale.order?limit=10&domain=id:>:1&fields=name,id,partner_id,origin&order=id asc&offset=10