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