Test: Difference between revisions

From Endeavour Knowledge Base
No edit summary
No edit summary
Line 52: Line 52:
|-
|-
|-
|-
|<span id="rule_query<br> subclass of ModelHeading">query<br> subclass of ModelHeading</span>
|<span id="rule_query">query<br> subclass of ModelHeading</span>
|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
|
|

Revision as of 20:24, 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
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