DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) No edit summary |
||
| Line 6: | Line 6: | ||
!colspan="2"|Subrule or lexical pattern | !colspan="2"|Subrule or lexical pattern | ||
|- | |- | ||
|rowspan="6"|<span id="rule_'''QueryRequest'''">'''QueryRequest'''</span> | |rowspan="6"|<span style="color:green" id="rule_'''QueryRequest'''">'''QueryRequest'''</span> | ||
|rowspan="6"|A request containing a query to be passed as a payload to the queryIM API. | |rowspan="6"|A request containing a query to be passed as a payload to the queryIM API. | ||
|0..1<br> | |0..1<br> | ||
| Line 28: | Line 28: | ||
|colspan="2"|[[#rule_referenceDate|referenceDate]] | |colspan="2"|[[#rule_referenceDate|referenceDate]] | ||
|- | |- | ||
|rowspan="2"|<span | |rowspan="2"|<span style="color:green" id="rule_page">page</span> | ||
|rowspan="2"|Information about paging if the client wishes to page results, including page number and page size | |rowspan="2"|Information about paging if the client wishes to page results, including page number and page size | ||
|1..1<br> | |1..1<br> | ||
| Line 41: | Line 41: | ||
|colspan="2"|Text | |colspan="2"|Text | ||
|- | |- | ||
|rowspan="5"|<span id="rule_argument">argument</span> | |rowspan="5"|<span style="color:green" id="rule_argument">argument</span> | ||
|rowspan="5"|A named paramater and a value for passing into a function | |rowspan="5"|A named paramater and a value for passing into a function | ||
|1..1<br> | |1..1<br> | ||
| Line 58: | Line 58: | ||
|colspan="2"|[[#rule_valueIri|valueIri]] | |colspan="2"|[[#rule_valueIri|valueIri]] | ||
|- | |- | ||
|<span id="rule_query">query<br> (includes ModelHeading)</span> | |<span style="color:green" id="rule_query">query<br> (includes ModelHeading)</span> | ||
|A Query definition holding the logical definition of a query in a standard language | |A Query definition holding the logical definition of a query in a standard language | ||
| | | | ||
| Line 98: | Line 98: | ||
|colspan="2"|Text | |colspan="2"|Text | ||
|- | |- | ||
|<span id="rule_valueSelect">valueSelect</span> | |<span style="color:green" id="rule_valueSelect">valueSelect</span> | ||
|points to a select clause | |points to a select clause | ||
| | | | ||
Revision as of 09:17, 23 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 | Information about paging if the client wishes to page results, including page number and page size | 1..1 |
pageNumber | |
| 1..1 |
pageSize | |||
| textSearch | If a free text search is part of the query | Text | ||
| argument | A named paramater and a value for passing into a function | 1..1 |
property | |
| 1..1 |
valueData | |||
| 1..1 |
valueVariable | |||
| 1..1 |
valueSelect | |||
| 1..1 |
valueIri | |||
| query (includes ModelHeading) |
A Query definition holding the logical definition of a query in a standard 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 | Date | ||
| pageNumber | Page number (starting at 1) | Number | ||
| pageSize | number of entries per page | Number | ||
| property | Parameter name for a function or the parameter name for an argument | Text | ||
| valueData | Vaue that is a literal such as a string or number | Text | ||
| valueVariable | argumetn value which is a variable name to be resolved at run time | Text | ||
| valueSelect | points to a select clause | |||
| valueIri | Argument value that is an iri | IRI | ||