Test: Difference between revisions

From Endeavour Knowledge Base
No edit summary
No edit summary
Line 5: Line 5:
!Cardinality
!Cardinality
!colspan="2"|Subrule or lexical pattern
!colspan="2"|Subrule or lexical pattern
!Explanation
|-
|-
|rowspan="5"|<span id="rule_'''QueryRequest'''">'''QueryRequest'''</span>
|rowspan="5"|<span id="rule_'''QueryRequest'''">'''QueryRequest'''</span>
Line 11: Line 10:
|0..1<br>
|0..1<br>
|colspan="2"|[[#rule_page|page]]
|colspan="2"|[[#rule_page|page]]
|optional page number and size if the client is looking for paged results
|-
|-
|0..1<br>
|0..1<br>
|colspan="2"|[[#rule_textSearch|textSearch]]
|colspan="2"|[[#rule_textSearch|textSearch]]
|If a free text search is part of the query
|-
|-
|0..*<br>
|0..*<br>
|colspan="2"|[[#rule_argument|argument]]
|colspan="2"|[[#rule_argument|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<br>or
|rowspan="2"|1..1<br>or
|1..1<br>
|1..1<br>
|[[#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
|-
|-
|
|
1..1<br>
1..1<br>
|[[#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
|-
|-
|
|
Line 35: Line 29:
|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>
|<span id="rule_page">page</span>
Line 45: Line 38:
|If a free text search is part of the query
|If a free text search is part of the query
|
|
|Text
|colspan="2"|Text
|-
|-
|<span id="rule_argument">argument</span>
|<span id="rule_argument">argument</span>
Line 60: Line 53:
|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
|colspan="2"|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
|colspan="2"|unknown
|-
|-


|}
|}

Revision as of 20:32, 22 August 2022

Rule Overview Cardinality Subrule or lexical pattern
QueryRequest A request containing a query to be passed as a payload to the queryIM API. 0..1
page
0..1
textSearch
0..*
argument
1..1
or
1..1
query

1..1

queryIri
0..1
referenceDate
page null
textSearch If a free text search is part of the query Text
argument null
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