DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) No edit summary |
||
| Line 36: | Line 36: | ||
|colspan="2"|[[#rule_pageSize|pageSize]] | |colspan="2"|[[#rule_pageSize|pageSize]] | ||
|- | |- | ||
|<span id="rule_textSearch">textSearch</span> | |<span style="color:green" 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 | ||
| | | | ||
| Line 63: | Line 63: | ||
|- | |- | ||
|- | |- | ||
|<span style="color:green" id=" | |<span style="color:green" 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 | ||
| | | | ||
|colspan="2"|IRI | |colspan="2"|IRI | ||
|- | |- | ||
|<span id="rule_referenceDate">referenceDate</span> | |<span style="color:green" 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 | ||
| | | | ||
|colspan="2"|Date | |colspan="2"|Date | ||
|- | |- | ||
|<span id="rule_pageNumber">pageNumber</span> | |<span style="color:green" id="rule_pageNumber">'''pageNumber'''</span> | ||
|Page number (starting at 1) | |Page number (starting at 1) | ||
| | | | ||
|colspan="2"|Number | |colspan="2"|Number | ||
|- | |- | ||
|<span id="rule_pageSize">pageSize</span> | |<span style="color:green" id="rule_pageSize">'''pageSize'''</span> | ||
|number of entries per page | |number of entries per page | ||
| | | | ||
|colspan="2"|Number | |colspan="2"|Number | ||
|- | |- | ||
|<span id="rule_property">property</span> | |<span style="color:green" id="rule_property">'''property'''</span> | ||
|Parameter name for a function or the parameter name for an argument | |Parameter name for a function or the parameter name for an argument | ||
| | | | ||
|colspan="2"|Text | |colspan="2"|Text | ||
|- | |- | ||
|<span id="rule_valueData">valueData</span> | |<span style="color:green" id="rule_valueData">'''valueData'''</span> | ||
|Vaue that is a literal such as a string or number | |Vaue that is a literal such as a string or number | ||
| | | | ||
|colspan="2"|Text | |colspan="2"|Text | ||
|- | |- | ||
|<span id="rule_valueVariable">valueVariable</span> | |<span style="color:green" id="rule_valueVariable">'''valueVariable'''</span> | ||
|argumetn value which is a variable name to be resolved at run time | |argumetn value which is a variable name to be resolved at run time | ||
| | | | ||
| Line 103: | Line 103: | ||
|- | |- | ||
|- | |- | ||
|<span style="color:green" id=" | |<span style="color:green" id="rule_valueIri">'''valueIri'''</span> | ||
|Argument value that is an iri | |Argument value that is an iri | ||
| | | | ||
Revision as of 10:01, 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 | ||