Test: Difference between revisions

From Endeavour Knowledge Base
No edit summary
No edit summary
Line 1: Line 1:
<span title="Hello, how are you ?" >Hover over me.</span>
''Syntax:'' <nowiki>
<span title="Hello, how are you ?" >Hover over me.</span>
</nowiki>
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 14: Line 6:
!colspan="2"|Subrule/property or literal type  
!colspan="2"|Subrule/property or literal type  
|-
|-
|rowspan="6"|<span title="some comment or other" style="color:green" id="rule_.../queryIM">'''.../queryIM'''</span>
|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>
|colspan="2"|[[#rule_page|page]]
|colspan="2"|<span title="optional page number and size if the client is looking for paged results"> [[#rule_page|page]]</span
|-
|-
|0..1<br>
|0..1<br>
|colspan="2"|[[#rule_textSearch|textSearch]]
|colspan="2"|<span title="If a free text search is part of the query"> [[#rule_textSearch|textSearch]]</span
|-
|-
|0..*<br>
|0..*<br>
|colspan="2"|[[#rule_argument|argument]]
|colspan="2"|<span title="arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs"> [[#rule_argument|argument]]</span
|-
|-
|rowspan="2"|1..1<br>or
|rowspan="2"|1..1<br>or
|1..1<br>
|1..1<br>
|[[#rule_query|query]]
|<span title="The query definition for an inline dynamic query. If the query is already defined, use the queryIri. Arguments may be used in eoither approach"> [[#rule_query|query]]</span
|-
|-
|
|
1..1<br>
1..1<br>
|[[#rule_queryIri|queryIri]]
|<span title="The IRI of a predefined query in the information model. i.e. request the system to run query X"> [[#rule_queryIri|queryIri]]</span
|-
|-
|0..1<br>
|0..1<br>
|colspan="2"|[[#rule_referenceDate|referenceDate]]
|colspan="2"|<span title="reference date for date ranges that use reference date. Note that it could be passed in as an argeument"> [[#rule_referenceDate|referenceDate]]</span
|-
|-
|rowspan="2"|<span style="color:green" id="rule_page">'''page'''</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>
|colspan="2"|[[#rule_pageNumber|pageNumber]]
|colspan="2"|<span title="Page number (starting at 1)"> [[#rule_pageNumber|pageNumber]]</span
|-
|-
|1..1<br>
|1..1<br>
|colspan="2"|[[#rule_pageSize|pageSize]]
|colspan="2"|<span title="number of entries per page"> [[#rule_pageSize|pageSize]]</span
|-
|-
|<span style="color:green" id="rule_textSearch">'''textSearch'''</span>
|<span style="color:green" id="rule_textSearch">'''textSearch'''</span>
Line 52: Line 44:
|rowspan="5"|A named parameter and a value for passing into a function
|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"|<span title="Parameter name for a function or the parameter name for an argument"> [[#rule_parameter|parameter]]</span
|-
|-
|rowspan="4"|1..1<br>or
|rowspan="4"|1..1<br>or
|1..1<br>
|1..1<br>
|[[#rule_valueData|valueData]]
|<span title="Vaue that is a literal such as a string or number"> [[#rule_valueData|valueData]]</span
|-
|-
|
|
1..1<br>
1..1<br>
|[[#rule_valueVariable|valueVariable]]
|<span title="argumetn value which is a variable name to be resolved at run time"> [[#rule_valueVariable|valueVariable]]</span
|-
|-
|
|
1..1<br>
1..1<br>
|[[#rule_valueSelect|valueSelect]]
|<span title="Argument value that is the result of a select query"> [[#rule_valueSelect|valueSelect]]</span
|-
|-
|
|
1..1<br>
1..1<br>
|[[#rule_valueIri|valueIri]]
|<span title="Argument value that is an iri"> [[#rule_valueIri|valueIri]]</span
|-
|-
|
|
Line 97: Line 89:
|colspan="2"|Number
|colspan="2"|Number
|-
|-
|<span style="color:green" id="rule_property">'''property'''</span>
|<span style="color:green" id="rule_parameter">'''parameter'''</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
|
|
Line 125: Line 117:
|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"|<span title="An alias or reference term that can be used throughout a query as shorthand for the result set"> [[#rule_alias|alias]]</span
|-
|-
|rowspan="5"|<span style="color:green" id="rule_Entity">'''Entity'''</span>
|rowspan="5"|<span style="color:green" id="rule_Entity">'''Entity'''</span>
|rowspan="5"|The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status
|rowspan="5"|The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status
|1..1<br>
|1..1<br>
|colspan="2"|[[#rule_label|label]]
|colspan="2"|<span title="the name of the entity"> [[#rule_label|label]]</span
|-
|-
|0..1<br>
|0..1<br>
|colspan="2"|[[#rule_comment|comment]]
|colspan="2"|<span title="the description of the entity"> [[#rule_comment|comment]]</span
|-
|-
|1..1<br>
|1..1<br>
|colspan="2"|[[#rule_type|type]]
|colspan="2"|<span title="the base type of the entity i.e. one of the high level entity types"> [[#rule_type|type]]</span
|-
|-
|1..1<br>
|1..1<br>
|colspan="2"|[[#rule_status|status]]
|colspan="2"|<span title="the status of the entity being active, inactive, draft or unassigned"> [[#rule_status|status]]</span
|-
|-
|1..1<br>
|1..1<br>
|colspan="2"|[[#rule_scheme|scheme]]
|colspan="2"|<span title="The code scheme or graph which the entity belongs to"> [[#rule_scheme|scheme]]</span
|-
|-
|<span style="color:green" id="rule_alias">'''alias'''</span>
|<span style="color:green" id="rule_alias">'''alias'''</span>
Line 167: Line 159:
|the status of the entity being active, inactive, draft or unassigned
|the status of the entity being active, inactive, draft or unassigned
|
|
|colspan="2"|:Status
|colspan="2"|im:Status
|-
|-
|<span style="color:green" id="rule_scheme">'''scheme'''</span>
|<span style="color:green" id="rule_scheme">'''scheme'''</span>
|The coe scheme or graph which the entity belongs to
|The code scheme or graph which the entity belongs to
|
|
|colspan="2"|:Graph
|colspan="2"|im:Graph
|-
|-


|}
|}

Revision as of 15:50, 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</span
0..1
 textSearch</span
0..*
 argument</span
1..1
or 		1..1
 query</span

1..1

 queryIri</span
0..1
 referenceDate</span
page Information about paging if the client wishes to page results, including page number and page size 1..1
 pageNumber</span
1..1
 pageSize</span
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
 parameter</span
1..1
or 		1..1
 valueData</span

1..1

 valueVariable</span

1..1

 valueSelect</span

1..1

 valueIri</span
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
parameter 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 Entity) 		General headings such as name description and alias 1..1
 alias</span
Entity The super class and data model for all named resources in the model i.e. the data model of the entities that are labelled with iri label and status 1..1
 label</span
0..1
 comment</span
1..1
 type</span
1..1
 status</span
1..1
 scheme</span
alias An alias or reference term that can be used throughout a query as shorthand for the result set Text
label the name of the entity Text
comment the description of the entity Text
type the base type of the entity i.e. one of the high level entity types rdfs:Resource
status the status of the entity being active, inactive, draft or unassigned im:Status
scheme The code scheme or graph which the entity belongs to im:Graph
Retrieved from ‘https://wiki.endeavourhealth.org/index.php?title=Test&oldid=6316’
Last modified
This page was last modified on 23 August 2022, at 15:50.