DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) No edit summary |
||
| Line 7: | Line 7: | ||
!Explanation | !Explanation | ||
|- | |- | ||
|rowspan="5"|<span id=" | |rowspan="5"|<span id="rule_'''QueryRequest'''">'''QueryRequest'''</span> | ||
|rowspan="5"|A request containing a query to be passed as a payload to the queryIM API. | |rowspan="5"|A request containing a query to be passed as a payload to the queryIM API. | ||
|0..1<br> | |0..1<br> | ||
| Line 35: | Line 35: | ||
|0..1<br> | |0..1<br> | ||
|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|<span id="rule_page">page</span> | |reference date for date ranges that use reference date. Note that it could be passed in as an argeument | ||
|-|<span id="rule_page">page</span> | |||
|null | |null | ||
| | | | ||
|- | |||
|-|<span id="rule_textSearch">textSearch</span> | |-|<span id="rule_textSearch">textSearch</span> | ||
|Text | |Text | ||
| Line 44: | Line 46: | ||
|null | |null | ||
| | | | ||
|- | |||
|-|<span id="rule_referenceDate">referenceDate</span> | |-|<span id="rule_referenceDate">referenceDate</span> | ||
| | | | ||
| Line 50: | Line 53: | ||
|An information model class holding the logical definition of a query in the IM language | |An information model class holding the logical definition of a query in the IM language | ||
| | | | ||
|- | |||
|-|<span id="rule_queryIri">queryIri</span> | |-|<span id="rule_queryIri">queryIri</span> | ||
|IRI | |IRI | ||
Revision as of 16:29, 22 August 2022
| Rule | Overview | Cardinality | Subrule or lexical pattern | Explanation | |
|---|---|---|---|---|---|
| QueryRequest | A request containing a query to be passed as a payload to the queryIM API. | 0..1 |
page | optional page number and size if the client is looking for paged results | |
| 0..1 |
textSearch | If a free text search is part of the query | |||
| 0..* |
argument | arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs | |||
| 1..1 or |
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 |
referenceDate | reference date for date ranges that use reference date. Note that it could be passed in as an argeument | |||
| null | |||||
| Text | |||||
| null | |||||
| An information model class holding the logical definition of a query in the IM language | |||||
| IRI | |||||