Search 1.9 billion lines of Odoo code on GitHub
smile_api_rest
<p><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg">
<a class="reference external" href="https://github.com/Smile-SA/odoo_addons/tree/11.0/smile_api_rest"><img alt="Smile-SA/odoo_addons" src="https://img.shields.io/badge/github-Smile--SA%2Fodoo_addons-lightgray.png?logo=github" /></a></p>
<a name="smile-api-rest"></a>
<h2>Smile API Rest</h2>
<p>This module provisions you with an API which allows you to access models through HTTP requests.</p>
<p>Documentation generate with Swagger OpenAPI Specification - Version 2.0 (<a class="reference external" href="https://swagger.io/specification/v2/">https://swagger.io/specification/v2/</a>)</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#requirements" id="id1">Requirements</a></li>
<li><a class="reference internal" href="#usage" id="id2">Usage</a><ul>
<li><a class="reference internal" href="#documentation-uris" id="id3">Documentation URIs</a></li>
<li><a class="reference internal" href="#api-uris" id="id4">API URIs</a></li>
<li><a class="reference internal" href="#error-response" id="id5">Error response</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bug-tracker" id="id6">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id7">Credits</a><ul>
<li><a class="reference internal" href="#contributors" id="id8">Contributors</a></li>
<li><a class="reference internal" href="#maintainer" id="id9">Maintainer</a></li>
</ul>
</li>
</ul>
</div>
<a name="requirements"></a>
<h3><a class="toc-backref" href="#id1">Requirements</a></h3>
<p>There are no requirements to use this module.</p>
<a name="usage"></a>
<h3><a class="toc-backref" href="#id2">Usage</a></h3>
<a name="documentation-uris"></a>
<h4><a class="toc-backref" href="#id3">Documentation URIs</a></h4>
<table class="docutils">
<colgroup>
<col width="50%" />
<col width="50%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">URI</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><cite>/<api-docs>/v<api_version></cite></td>
<td>API Documentation (generate with swagger)</td>
</tr>
<tr><td><cite>/<api-docs>/v<api_version>/swagger.json</cite></td>
<td>Json Swagger</td>
</tr>
</tbody>
</table>
<a name="api-uris"></a>
<h4><a class="toc-backref" href="#id4">API URIs</a></h4>
<table class="docutils">
<colgroup>
<col width="40%" />
<col width="6%" />
<col width="54%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">URI</th>
<th class="head">Method</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><cite>/<api>/v<api_version>/<api_name></cite></td>
<td>GET</td>
<td>Read all (with optional domain, fields, offset, limit, order)</td>
</tr>
<tr><td><cite>/api/v<api_version>/<api_name>/<id></cite></td>
<td>GET</td>
<td>Read one (with optional fields)</td>
</tr>
<tr><td><cite>/api/v<api_version>/<api_name></cite></td>
<td>POST</td>
<td>Create a record</td>
</tr>
<tr><td><cite>/api/v<api_version>/<api_name>/<id></cite></td>
<td>PUT</td>
<td>Update a record</td>
</tr>
<tr><td><cite>/api/v<api_version>/<api_name>/<id></cite></td>
<td>DELETE</td>
<td>Delete a record</td>
</tr>
<tr><td><cite>/api/v<api_version>/<api_name>/custom</cite></td>
<td>PUT</td>
<td>Call method (with optional parameters)</td>
</tr>
<tr><td><cite>/api/v<api_version>/<api_name>/custom/<id></cite></td>
<td>PUT</td>
<td>Call method on record (with optional parameters)</td>
</tr>
</tbody>
</table>
<a name="error-response"></a>
<h4><a class="toc-backref" href="#id5">Error response</a></h4>
<pre class="code">
<code class="code">{
'code': <code> # Error code,
'error': <error> # Error name,
'description': <description> # Description of the error,
}</code>
</pre>
<a name="bug-tracker"></a>
<h3><a class="toc-backref" href="#id6">Bug Tracker</a></h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/Smile-SA/odoo_addons/issues">GitHub Issues</a>.
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
<a class="reference external" href="https://github.com/Smile-SA/odoo_addons/issues/new?body=module:%20smile_api_rest%0Aversion:%211.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">here</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="credits"></a>
<h3><a class="toc-backref" href="#id7">Credits</a></h3>
<a name="contributors"></a>
<h4><a class="toc-backref" href="#id8">Contributors</a></h4>
<ul class="simple">
<li>Corentin POUHET-BRUNERIE</li>
<li>Julien DRECQ</li>
</ul>
<a name="maintainer"></a>
<h4><a class="toc-backref" href="#id9">Maintainer</a></h4>
<p>This module is maintained by Smile SA.</p>
<p>Since 1991 Smile has been a pioneer of technology and also the European expert in open source solutions.</p>