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:	12.0
Repository:	ajepe/odoo-addons
Dependencies:	base, and web
Languages:	HTML (14, 1.8%), Markdown (301, 37.7%), Python (411, 51.4%), XML (50, 6.3%), and reStructuredText (23, 2.9%)
Other branches:	10.0, 11.0, 13.0, 14.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

<h1>AUTHENTICATION</h1> <ul> <li>login </li> <li>logout</li> </ul> In order to be able to access any document an access token needs to generated which serves as session cookies in a regular web language. The token will be needed for every subsequent requests. Except for /api/auth/token enpoint that accept multipart/form-data as the Content type every other endpoints accept application/json as the 'Content Type' <h2>Request for access token(login)</h2> <code>bash curl --request GET --url http://192.168.43.58:8069/api/auth/token --form db=api.ng --form login=admin --form password=admin </code> Example using python <code>python </code>python import requests url = "http://192.168.43.58:8069/api/auth/token" payload = { "db":"api.ng", "login": "admin", "password": "admin" } headers = { 'content-type': "multipart/form-data; 'access-token': "accesstokenebb1914bbdb5622cd782a1a0ff51f81a2cba042a" } response = requests.request("GET", url, data=payload, headers=headers) print(response.text) <code> </code> To retrive an access token these following parameters needs to be set. * the database name as db * the connecting username as login * the user password as password The above request will return a response like below. <code>python { "uid": 2, "user_context": { "lang": "en_US", "tz": "Europe/Brussels", "uid": 2 }, "company_id": 1, "company_ids": [ 1 ], "partner_id": 3, "access_token": "access_token_ebb1914bbdb5622cd782a1a0ff51f81a2cba042a", "expires_in": "31536000" } </code> The most interesting part of the response is the access token field, accesstokenebb1914bbdb5622cd782a1a0ff51f81a2cba042a for every other request the token should to be send along the request headers else an invalid token response will be generated. <h2>Logout</h2> To logout of the system the token needs to be destroyed i.e deleted, by doing that the user/application making the request on behalf of the user will have not futher access to Odoo. The token /api/auth/token listen to both GET and DELETE requests, GET will fetch the token while delete request will deleted the token. ```python import requests url = "http://192.168.43.58:8069/api/auth/token" payload = { "db":"api.ng", "login": "admin", "password": "admin" } headers = { 'content-type': "multipart/form-data; 'access-token': "accesstokenebb1914bbdb5622cd782a1a0ff51f81a2cba042a" } response = requests.request("DELETE", url, data=payload, headers=headers) print(response.text) ``` <h1>Sales</h1> 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.