The RESTful v2 API uses dot notation for field paths when using the filter, fields, and ordering query parameters.
For example, the User id
field in the following UserSession resource can be
referenced with user.id
:
{
"id": 36,
"type": "UserSession",
"state": "LOGGED_IN",
"user": {
"id": 3,
"type": "User",
"name": "admin",
"_links": {
"self": {
"href": "/api/v2/users/3"
}
}
},
...
}