How to return all fields when listing using REST Api?

aliriocastro · August 2, 2019, 1:02am

Hello Team,

I’m being diving how to retrieve all fields when listing a doc_type thru REST Api. Let’s say instead of explicitly asking for each field by its name, I would like to know if something like this: “https://demo.erpnext.com/api/resource/Currency Exchange/?fields=all” is possible.

Thanks in advance,

Alirio.

iRaySpace · August 2, 2019, 3:52am

Hello @aliriocastro

You may retrieve all fields using this.
https://demo.erpnext.com/api/resource/Currency Exchange?fields=["*"]

Just refer to the file below

github.com

frappe/frappe/blob/develop/frappe/api.py#L14


      
          import binascii
          import json
          from typing import Literal
          from urllib.parse import urlencode, urlparse
          
          
import frappe
          import frappe.client
          import frappe.handler
          from frappe import _
          from frappe.utils.data import sbool
          from frappe.utils.response import build_response
          
          

          
def handle():
          	"""
          	Handler for `/api` methods
          
          
	### Examples:
          
          
	`/api/method/{methodname}` will call a whitelisted method

Regards,

Ivan

aliriocastro · August 2, 2019, 2:08pm

Thank you Ivan,

Just to confirm. IT WORKS !!!

Regards,

Alirio.

LifeP · August 3, 2019, 2:05am

Hi
A related query would be how to list all child table rows. For example in quality inspection, how to fetch rows in quality inspection template?

Any ideas?

rmeyer · August 3, 2019, 5:05pm

GET /api/resource/Quality Inspection Template?fields=[“item_quality_inspection_parameter”]

aliriocastro · August 15, 2019, 4:28pm

Hello @rmeyer

For example, I need to bring all items from Sales Invoice with this query

GET /api/resource/Sales Invoice/?fields=[“items”]

But it does not work.

Throw this error:
InternalError: (1054, u"Unknown column ‘items’ in ‘field list’")

rmeyer · August 16, 2019, 11:54pm

Please request a single invoice to get the items. In the list of invoices, child tables are not included.

You can GET /api/resource/Sales Invoice for a list of invoice names. Then loop over the list and GET /api/resource/Sales Invoice/{current_invoice}. The latter will return all invoice data, including the items.

sezanzeb · March 29, 2021, 3:43pm

It would have been nice if at least listing items from child tables was possible. Instead of sending 20 get requests to the api to deeply fetch the parent it would be done in a single one and a filter like [['Material Request Item', 'parent', 'in', ['name1', 'name2', ...]]]

That would be much faster and close enough to a join for me.

But erpnext just keeps responding “Broken Pipe Error”. great. So instead I’ll just wait a few seconds each time the page refreshes for all requests to resolve… great user experience

wale · November 4, 2021, 2:09pm

Hi @sezanzeb

Did you create a Github Issue for this ?

Kind regards,