Skip to content

Update "Returning specific fields" #1004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 7.x-2.x
Choose a base branch
from
Open

Update "Returning specific fields" #1004

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/api_url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down