DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) No edit summary |
||
Line 1: | Line 1: | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
! | !Rule | ||
! | !Overview!Subrule or lexical pattern | ||
!Explanation | !Explanation | ||
|- | |- | ||
|rowspan="5"|<span id="rule_QueryRequest">QueryRequest</span> | |rowspan="5"|<span id="rule_QueryRequest">QueryRequest</span> | ||
| | |A request containing a query to be passed as a payload to the queryIM API. | ||
| | |||
||[[#rule_page|[page]]] | |||
|optional page number and size if the client is looking for paged results | |optional page number and size if the client is looking for paged results | ||
|- | |- | ||
||[[#rule_textSearch|[textSearch]]] | |||
| | |||
|If a free text search is part of the query | |If a free text search is part of the query | ||
|- | |- | ||
||[[#rule_argument|*argument]] | |||
| | |||
|arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs | |arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs | ||
|- | |- | ||
| | |||
|(|[[#rule_query|query]] | |||
|The query definition for an inline dynamic query. If the query is already defined, use the queryIri. Arguments may be used in eoither approach/|[[#rule_queryIri|queryIri]] | |||
|The IRI of a predefined query in the information model. i.e. request the system to run query X) | |||
||[[#rule_referenceDate|[referenceDate]]] | |||
|reference date for date ranges that use reference date. Note that it could be passed in as an argeument | |||
|- | |- | ||
| | | | ||
|} | |} | ||
Revision as of 08:47, 22 August 2022
Rule | Overview!Subrule or lexical pattern | Explanation | ||
---|---|---|---|---|
QueryRequest | A request containing a query to be passed as a payload to the queryIM API. | [page] | optional page number and size if the client is looking for paged results | |
[textSearch] | If a free text search is part of the query | |||
*argument | arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs | |||
query | queryIri | The IRI of a predefined query in the information model. i.e. request the system to run query X) | [referenceDate] | reference date for date ranges that use reference date. Note that it could be passed in as an argeument |