Test: Difference between revisions

From Endeavour Knowledge Base
No edit summary
No edit summary
Line 35: Line 35:
|-
|-
|
|
<span style="color:green">queryIri</span>
 
|rowspan="2"|colspan="2"|1..1
|<span style="color:green">queryIri</span>
|colspan="1"|1..1
|colspan="2"|1..1
||<span title="international resource identifier">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23IRI/ sh:IRI]</span>
||<span title="international resource identifier">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23IRI/ sh:IRI]</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
Line 77: Line 77:
|-
|-
|
|
<span style="color:green">valueVariable</span>
 
|rowspan="4"|colspan="2"|1..1
|<span style="color:green">valueVariable</span>
|colspan="1"|1..1
|colspan="2"|1..1
||<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
||<span title="any valid json value characters with json escapes">[https://www.w3.org/TR/xmlschema-2/#string xsd:string]</span>
|argumenT value which is a variable name to be resolved at run time
|argumenT value which is a variable name to be resolved at run time
Line 85: Line 85:
|-
|-
|
|
<span style="color:green">valueSelect</span>
 
|rowspan="4"|colspan="2"|1..1
|<span style="color:green">valueSelect</span>
|colspan="1"|1..1
|colspan="2"|1..1
||<span title="">[[#class_SelectClause|SelectClause]]</span>
||<span title="">[[#class_SelectClause|SelectClause]]</span>
|Argument value that is the result of a select query
|Argument value that is the result of a select query
Line 93: Line 93:
|-
|-
|
|
<span style="color:green">valueIri</span>
 
|rowspan="4"|colspan="2"|1..1
|<span style="color:green">valueIri</span>
|colspan="1"|1..1
|colspan="2"|1..1
||<span title="international resource identifier">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23IRI/ sh:IRI]</span>
||<span title="international resource identifier">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2Fns%2Fshacl%23IRI/ sh:IRI]</span>
|Argument value that is an iri
|Argument value that is an iri
Line 130: Line 130:
|-
|-
|
|
<span style="color:green">ask</span>
 
|rowspan="2"|colspan="2"|1..1
|<span style="color:green">ask</span>
|colspan="1"|0..1
|colspan="2"|0..1
||<span title="A clause that matches a path to entity, its properties and its values or intersections unions or negation. Equivalent to a sparql wheew filter clause">[[#class_MatchClause|MatchClause]]</span>
||<span title="A clause that matches a path to entity, its properties and its values or intersections unions or negation. Equivalent to a sparql wheew filter clause">[[#class_MatchClause|MatchClause]]</span>
|If the query is a boolean true or false use match clauses as an ask
|If the query is a boolean true or false use match clauses as an ask
Line 159: Line 159:
|-
|-
|
|
<span style="color:green">pathToTarget</span>
 
|rowspan="2"|colspan="2"|0..1
|<span style="color:green">pathToTarget</span>
|colspan="1"|1..1
|colspan="2"|1..1
||<span title="">[[#class_PathTargetClause|PathTargetClause]]</span>
||<span title="">[[#class_PathTargetClause|PathTargetClause]]</span>
|Special function for path query. Information about the target entity when the query is looking to return paths between a source and a target. Both are likely to be passed in as parameters
|Special function for path query. Information about the target entity when the query is looking to return paths between a source and a target. Both are likely to be passed in as parameters
Line 187: Line 187:
|-
|-
|
|
<span style="color:green">entityId</span>
 
|rowspan="3"|colspan="2"|0..1
|<span style="color:green">entityId</span>
|colspan="1"|1..1
|colspan="2"|1..1
||<span title="">[[#class_ConceptReference|ConceptReference]]</span>
||<span title="">[[#class_ConceptReference|ConceptReference]]</span>
|An instance of an enttu for which this select clause operates. As in entity type, optionally to include subtypes, where the entity id is a concept
|An instance of an enttu for which this select clause operates. As in entity type, optionally to include subtypes, where the entity id is a concept
Line 195: Line 195:
|-
|-
|
|
<span style="color:green">entityIn</span>
 
|rowspan="3"|colspan="2"|0..1
|<span style="color:green">entityIn</span>
|colspan="1"|1..1
|colspan="2"|1..1
||<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
||<span title="">[https://im.endeavourhealth.net/viewer/#/concept/http%3A%2F%2Fwww.w3.org%2F2000%2F01%2Frdf-schema%23Resource/ rdfs:Resource]</span>
|The consept set, value set, or query result set that forms the base population of instances on which the select clause operates. e.g. a parent cohort.
|The consept set, value set, or query result set that forms the base population of instances on which the select clause operates. e.g. a parent cohort.

Revision as of 11:57, 24 August 2022

Class Field c Type Comment
QueryRequest page 0..1 PageInformation optional page number and size if the client is looking for paged results
textSearch 0..1 xsd:string If a free text search is part of the query
argument 0..* Argument arguments to pass in to the query as parameters. Parameter name and value pairs. Values ,may be strings, numbers or IRIs
or query colspan="2"|1..1 1..1 Query The query definition for an inline dynamic query. If the query is already defined, use the queryIri. Arguments may be used in eoither approach
queryIri 1..1 sh:IRI The IRI of a predefined query in the information model. i.e. request the system to run query X
referenceDate 0..1 im:DateTime reference date for date ranges that use reference date. Note that it could be passed in as an argeument
PageInformation pageNumber 1..1 xsd:integer Page number (starting at 1)
pageSize 1..1 xsd:integer number of entries per page
Argument parameter 1..1 xsd:string Parameter name for a function or the parameter name for an argument
or valueData colspan="2"|1..1 1..1 xsd:string Vaue that is a literal such as a string or number
valueVariable 1..1 xsd:string argumenT value which is a variable name to be resolved at run time
valueSelect 1..1 SelectClause Argument value that is the result of a select query
valueIri 1..1 sh:IRI Argument value that is an iri
Query
(subtype of ModelHeading)
resultFormat 0..1 xsd:string Whether the result set is required flat select style json or a nested graphql json object style 'RELATIONAL' or 'OBJECT. Default is OBJECT
usePrefixes 0..1 xsd:boolean true if you want the results to use IRI prefixes
activeOnly 0..1 xsd:boolean Whether only active entities are included in the match clauses or select clauses
or select colspan="2"|1..1 1..1 SelectClause Select query clause logically similar to SQL/SPARQL select but with GraphQL nesting ability
ask 0..1 MatchClause If the query is a boolean true or false use match clauses as an ask
mainEntity 0..1 sh:NodeShape The main entity to which all matches must be related e.g. Patient or organisation. i.e. the IRI of a data model entity (SHACL shape)
SelectClause
(subtype of ModelHeading)
count 0..1 xsd:boolean If the query result is simply a sum of the main entities found. equivalent to COUNT(ie)
or property colspan="2"|0..1 0..* PropertySelectClause Information about a property or field to includein the results. Property select supports nesting with selects for the objects that may be values of the property
pathToTarget 1..1 PathTargetClause Special function for path query. Information about the target entity when the query is looking to return paths between a source and a target. Both are likely to be passed in as parameters
match 0..* MatchClause The match pattern to which the select clause must comply. Equivalent to a where/filter in SPARQL and JOIN/WHERE in SQL
distinct 0..1 xsd:boolean Whether the entity objects returned should be distinct
or entityType colspan="2"|0..1 1..1 ConceptReference The entity type for instances this select clause operates on. Options include including subtypes.
entityId 1..1 ConceptReference An instance of an enttu for which this select clause operates. As in entity type, optionally to include subtypes, where the entity id is a concept
entityIn 1..1 rdfs:Resource The consept set, value set, or query result set that forms the base population of instances on which the select clause operates. e.g. a parent cohort.
groupBy 0..* PropertySelectClause If the results need to be grouped, the grouping properties.
orderLimit 0..* OrderLimitClause Ordering of instances via a property value and limiting th enumber returned.
subselect 0..* SelectClause For a query with column groups such as a list report, the select query for each group
ModelHeading
(subtype of Entity)
alias 1..1 xsd:string An alias or reference term that can be used throughout a query as shorthand for the result set
MatchClause
PropertySelectClause
PathTargetClause
ConceptReference
OrderLimitClause
Entity label 1..1 xsd:string the name of the entity
comment 0..1 xsd:string the description of the entity
type 1..1 rdfs:Resource the base type of the entity i.e. one of the high level entity types
status 1..1 im:Status the status of the entity being active, inactive, draft or unassigned
scheme 1..1 im:Graph The code scheme or graph which the entity belongs to