![]() ![]() In addition to those operators, a server MAY support IN, NOT IN, BETWEEN, IS NULL and IS NOT NULL. A JSON API server SHOULD implement, at least, the following operators: =. If nothing is specified, then the operator defaults to '='. The value used in the comparison made against the data value of the property identified by the path.Ī conditional object MAY also contain the following keys: A path MAY be able to traverse relationships. A path MUST be able to select any attribute property of an entity. The path selects the data value against which the conditional object will be applied. The path identifies the property within the entity type that hosts it. ![]() The path property MUST adhere to the property accessor format. Additionally, a conditional object MUST contain the following keys: These are called where clauses in many data query languages, like SQL.Ī conditional object MUST have an arbitrary ID which uniquely idenfies the conditional object inside of the filter parameter of a JSON API request URI. These object codify a conditional statement that a JSON API server will execute in order to retrieve a subset of eligible records. For example, queries with AND operators within a higher level OR condition.įilter conditions are represented by conditional objects. Filter groups.: These allow the creation of complex, nested queries.Filter conditions: These are the assertions made against the data store which qualify a record for inclusion in a collection result. ![]() This specification covers the gap by specifying an strategy that can be adopted by any JSON API server. The filter query parameter can be used as the basis for any number of filtering strategies. Note: JSON API is agnostic about the strategies supported by a server. The JSON API specification is agnostic about how a server implements filtering strategies. This extension was developed as part of the jsonapi module for Drupal. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |