53 lines
No EOL
1.4 KiB
HTML
53 lines
No EOL
1.4 KiB
HTML
<!-- title: frappe.api --><div class="dev-header">
|
|
|
|
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
|
|
Version 6.6.5</a>
|
|
|
|
|
|
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/api.py"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.api.handle" href="#frappe.api.handle" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.api.<b>handle</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>Handler for <code>/api</code> methods</p>
|
|
|
|
<h3>Examples:</h3>
|
|
|
|
<p><code>/api/method/{methodname}</code> will call a whitelisted method</p>
|
|
|
|
<p><code>/api/resource/{doctype}</code> will query a table
|
|
examples:
|
|
- <code>?fields=["name", "owner"]</code>
|
|
- <code>?filters=[["Task", "name", "like", "%005"]]</code>
|
|
- <code>?limit_start=0</code>
|
|
- <code>?limit_page_length=20</code></p>
|
|
|
|
<p><code>/api/resource/{doctype}/{name}</code> will point to a resource
|
|
<code>GET</code> will return doclist
|
|
<code>POST</code> will insert
|
|
<code>PUT</code> will update
|
|
<code>DELETE</code> will delete</p>
|
|
|
|
<p><code>/api/resource/{doctype}/{name}?run_method={method}</code> will run a whitelisted controller method</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc --> |