Test: Difference between revisions

From Endeavour Knowledge Base
No edit summary
No edit summary
Line 1: Line 1:
{| class="wikitable"
{| class="wikitable"
|+
|+
!Class
!Rule
!Properties (as json fields) or lexical pattern
!Overview!Subrule or lexical pattern
!Explanation
!Explanation
|-
|-
|rowspan="5"|<span id="rule_QueryRequest">QueryRequest</span>
|rowspan="5"|<span id="rule_QueryRequest">QueryRequest</span>
| |[[#rule_page|[page]]]  
|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]]]
| |[[#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]]
| |[[#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
|-
|-
|  (|[[#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
|-
|
|-
|
|}


{| class="wikitable"
|+
<br />
!Rule
!Model class
!Subrules or lexical pattern
!Explanation
|-
|
|<span id="rule_QueryRequest">QueryRequest</span>
|[[#rule_name|name]]  [[#rule_page|page]]  [[#rule_pageSize|pageSize]]  [[#rule_textSearch|textSearch]]  [[#rule_argument|argument]]  [[#rule_query|query]]  [[#rule_queryIri|queryIri]]  [[#rule_referenceDate|referenceDate]]
|
|
|-
|<span id="rule_pageSize">pageSize</span>
|A page
|}
|}
{{scroll box||
*Example 01&nbsp;<br/> *Example 02&nbsp;<br/> *Example 03&nbsp;<br/> *Example 04&nbsp;<br/> *Example 05&nbsp;<br/> *Example 06&nbsp;<br/> *Example 07&nbsp;<br/> *Example 08&nbsp;<br/> *Example 09&nbsp;<br/> *Example 10&nbsp;<br/> *Example 11&nbsp;<br/> *Example 12&nbsp;<br/> *Example 13&nbsp;<br/> *Example 14&nbsp;
}}
Additional test text

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