Test

From Endeavour Knowledge Base
Revision as of 15:52, 24 August 2022 by DavidStables (talk | contribs)
Class Field Card. 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
1..1
query 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
1..1
valueData 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
1..1
select 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(id)
or
0..1
property 1..* 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
0..1
entityType 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
(subtype of ConceptReference)
or
0..1
sum 0..1 xsd:boolean Whether the result is a summation of this property's values

average

0..1 xsd:boolean Whether the result is an average of this property's values

max

0..1 xsd:boolean Whether the result is the maximum of this property's values
select 0..1 SelectClause Nested select clause for graphql style results format
inverseOf 0..1 xsd:boolean Indicates if true that the selected property is an inverse relationship with the target object
function 0..1 im:Function The iri of a function indicating that the result is the result of a function operating on the property values, and any arguments passed in
argument 0..* Argument Arguments to pass into the function
PathTargetClause
ConceptReference
(subtype of IrirRef)
includeSubtypes 0..1 xsd:boolean Whether to include the subtypes of the entites selected or matched
includeSupertypes 0..1 xsd:boolean Whether to include the supertypes of the entity in a match clause. Used for ascending the hierarch to look for properties inherited
excludeSelf 0..1 xsd:boolean Whether to exclude this entity when either include supbtypes or include suprtypes is set. Rarely used but sometimes found in ECL definitions
alias 0..1 xsd:string The column name in a select clause for this property, or a variable used to reference the result set of the values matched
OrderLimitClause
Entity
(subtype of IrirRef)
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
IrirRef label 1..1 xsd:string the name of the entity