DavidStables (talk | contribs) No edit summary |
DavidStables (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ | |+ | ||
!Rule | !Rule/property/API | ||
!Overview | !Overview | ||
!Cardinality | !Cardinality | ||
!colspan="2"|Subrule/property or literal type | !colspan="2"|Subrule/property or literal type | ||
|- | |- | ||
|rowspan="6"|<span style="color:green" id=" | |rowspan="6"|<span style="color:green" id="rule_.../queryIM">'''.../queryIM'''</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 88: | Line 64: | ||
| | | | ||
|- | |- | ||
|<span style="color:green" id="rule_query">'''query'''<br> ( | |<span style="color:green" id="rule_query">'''query'''<br> (subtype of [[#rule_ModelHeading|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 138: | Line 114: | ||
|colspan="2"|IRI | |colspan="2"|IRI | ||
|- | |- | ||
|rowspan="1"|<span style="color:green" id="rule_ModelHeading">'''ModelHeading'''<br> ( | |rowspan="1"|<span style="color:green" id="rule_ModelHeading">'''ModelHeading'''<br> (subtype of [[#rule_Resource shape|Resource shape]])</span> | ||
|rowspan="1"|General headings such as name description and alias | |rowspan="1"|General headings such as name description and alias | ||
|1..1<br> | |1..1<br> | ||
|colspan="2"|[[#rule_alias|alias]] | |colspan="2"|[[#rule_alias|alias]] | ||
|- | |- | ||
|<span style="color:green" id=" | |rowspan="5"|<span style="color:green" id="rule_Resource shape">'''Resource shape'''</span> | ||
|The | |rowspan="5"|The abstract data model for all resources with IRIs in the model i.e. the data model of the entities that are labelled with iri | ||
| | |1..1<br> | ||
|colspan="2"|[[#rule_label|label]] | |||
|- | |||
|1..1<br> | |||
|colspan="2"|[[#rule_comment|comment]] | |||
|- | |||
|0..*<br> | |||
|colspan="2"|[[#rule_type|type]] | |||
|- | |||
|1..*<br> | |||
|colspan="2"|[[#rule_status|status]] | |||
|- | |- | ||
|1..*<br> | |||
|colspan="2"|[[#rule_scheme|scheme]] | |||
|- | |- | ||
|} | |} | ||
Revision as of 14:52, 23 August 2022
| Rule/property/API | Overview | Cardinality | Subrule/property or literal type | |
|---|---|---|---|---|
| .../queryIM | 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 (subtype of 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 (subtype of Resource shape) |
General headings such as name description and alias | 1..1 |
alias | |
| Resource shape | The abstract data model for all resources with IRIs in the model i.e. the data model of the entities that are labelled with iri | 1..1 |
label | |
| 1..1 |
comment | |||
| 0..* |
type | |||
| 1..* |
status | |||
| 1..* |
scheme | |||