DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) No edit summary |
||
| Line 4: | Line 4: | ||
!Overview | !Overview | ||
!Cardinality | !Cardinality | ||
!colspan="2"|Subrule or | !colspan="2"|Subrule/property or literal type | ||
|- | |- | ||
|rowspan="6"|<span style="color:green" id="rule_QueryRequest">'''QueryRequest'''</span> | |rowspan="6"|<span style="color:green" id="rule_QueryRequest">'''QueryRequest'''</span> | ||
| Line 42: | Line 42: | ||
|- | |- | ||
|rowspan="5"|<span style="color:green" id="rule_argument">'''argument'''</span> | |rowspan="5"|<span style="color:green" id="rule_argument">'''argument'''</span> | ||
|rowspan="5"|A named | |rowspan="5"|A named parameter and a value for passing into a function | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|[[#rule_property|property]] | |colspan="2"|[[#rule_property|property]] | ||
|- | |- | ||
|rowspan="4"|1..1<br>or | |||
|1..1<br> | |1..1<br> | ||
|[[#rule_valueData|valueData]] | |||
|- | |- | ||
|1..1<br> | | | ||
1..1<br> | |||
|[[#rule_valueVariable|valueVariable]] | |||
|- | |||
| | |||
1..1<br> | |||
|[[#rule_valueSelect|valueSelect]] | |||
|- | |- | ||
|1..1<br> | | | ||
1..1<br> | |||
|[[#rule_valueIri|valueIri]] | |||
|- | |- | ||
| | | | ||
|- | |- | ||
|<span style="color:green" id="rule_query">'''query'''<br> (includes [[#rule_ModelHeading|ModelHeading]])</span> | |<span style="color:green" id="rule_query">'''query'''<br> (includes [[#rule_ModelHeading|ModelHeading]])</span> | ||
| Line 107: | Line 113: | ||
| | | | ||
|colspan="2"|IRI | |colspan="2"|IRI | ||
|- | |||
|rowspan="1"|<span style="color:green" id="rule_ModelHeading">'''ModelHeading'''<br> (includes [[#rule_Entity|Entity]])</span> | |||
|rowspan="1"|General headings such as name description and alias | |||
|1..1<br> | |||
|colspan="2"|[[#rule_alias|alias]] | |||
|- | |||
|<span style="color:green" id="rule_Entity">'''Entity'''</span> | |||
|The super class of all entities in the information model. Equivalent to a RDF resource with IRI, label, comment and status | |||
| | |||
|- | |||
|- | |- | ||
|} | |} | ||
Revision as of 10:27, 23 August 2022
| Rule | Overview | Cardinality | Subrule/property or literal type | |
|---|---|---|---|---|
| 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 parameter and a value for passing into a function | 1..1 |
property | |
| 1..1 or |
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 | ||
| ModelHeading (includes Entity) |
General headings such as name description and alias | 1..1 |
alias | |
| Entity | The super class of all entities in the information model. Equivalent to a RDF resource with IRI, label, comment and status | |||