From ae8b0dd1eb1eb82a7c525b23e962dc3a88efa044 Mon Sep 17 00:00:00 2001 From: Dan Rogers Date: Thu, 21 Sep 2017 14:53:29 -0600 Subject: [PATCH] Update "Returning specific fields" Update "Returning specific fields" to explain arrays. Could not find documentation on calling fields that contained arrays, and took me quite a while to figure out. Thought this might clarify a bit. --- docs/api_url.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/api_url.md b/docs/api_url.md index 24e5a0d8..ab25ea1b 100644 --- a/docs/api_url.md +++ b/docs/api_url.md @@ -161,7 +161,24 @@ Returns: }] } ``` +It is worth noting, that if field returns an array, you will need to specifically call each field, you cannot simply call field=a_field. For example, if your data looks like the following: +```javascript +{ + "data": [{ + "a_field": { + "id": "123", + "label": "Label", + } +}] +} +``` +To return both, you would need to specifically call: + +```shell +# Handler v1.0 +curl https://example.com/api/v1/articles/2?fields=a_field.id,a_field.label +``` ## Applying a query filter RESTful allows applying filters to the database query used to generate the list.