DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) No edit summary |
||
Line 44: | Line 44: | ||
|<span id="rule_textSearch">textSearch</span> | |<span id="rule_textSearch">textSearch</span> | ||
|If a free text search is part of the query | |If a free text search is part of the query | ||
| | | | ||
|Text | |||
|- | |- | ||
|<span id="rule_argument">argument</span> | |<span id="rule_argument">argument</span> | ||
Line 59: | Line 59: | ||
|<span id="rule_queryIri">queryIri</span> | |<span id="rule_queryIri">queryIri</span> | ||
|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 | ||
| | | | ||
|IRI | |||
|- | |- | ||
|<span id="rule_referenceDate">referenceDate</span> | |<span id="rule_referenceDate">referenceDate</span> | ||
|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 | ||
| | | | ||
|unknown | |||
|- | |- | ||
|} | |} |
Revision as of 20:20, 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 | |||
page | null | ||||
textSearch | If a free text search is part of the query | Text | |||
argument | null | ||||
<span id="rule_query subclass of ModelHeading">query subclass of ModelHeading |
An information model class holding the logical definition of a query in the IM language | ||||
queryIri | The IRI of a predefined query in the information model. i.e. request the system to run query X | IRI | |||
referenceDate | reference date for date ranges that use reference date. Note that it could be passed in as an argeument | unknown |